core/net/src/test/java/org/onosproject/cfg/impl/ComponentConfigLoaderTest.java

/*
 * Copyright 2015 Open Networking Laboratory
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.onosproject.cfg.impl;

import com.google.common.collect.ImmutableSet;
import com.google.common.io.Files;
import org.junit.Before;
import org.junit.Test;
import org.onosproject.cfg.ComponentConfigAdapter;

import java.io.File;
import java.io.IOException;
import java.lang.reflect.Field;
import java.util.Set;
import java.util.TimerTask;

import static com.google.common.io.ByteStreams.toByteArray;
import static com.google.common.io.Files.write;
import static org.junit.Assert.*;
import static org.onlab.junit.TestTools.assertAfter;

/**
 * UnitTest for ComponentLoader.
 */
public class ComponentConfigLoaderTest {

    static final File TEST_DIR = Files.createTempDir();

    private static final String FOO_COMPONENT = "fooComponent";

    private ComponentConfigLoader loader;

    private TestConfigService service;

    /*
     * Method to SetUp the test environment with test file, a config loader a service,
     * and assign it to the loader.configService for the test.
     */
    @Before
    public void setUp() {
        ComponentConfigLoader.cfgFile = new File(TEST_DIR, "test.json");
        loader = new ComponentConfigLoader();
        service = new TestConfigService();
        loader.configService = service;
        loader.retryDelay = 50;
        loader.stopRetryTime = 200;
    }

    /*
     * Tests that the component in the json receives the correct configuration.
     */
    @Test
    public void basics() throws IOException {
        stageTestResource("basic.json");
        loader.activate();
        assertAfter(1_000, () -> assertEquals("incorrect component", FOO_COMPONENT, service.component));
    }

    /*
     * Tests that the component is null if the file has a bad configuration format
     * for which it yielded an exception. Can't test the exception because it happens
     * in a different thread.
     */
    @Test
    public void badConfig() throws IOException {
        stageTestResource("badConfig.json");
        loader.activate();
        assertAfter(1_000, () -> assertNull("incorrect configuration", service.component));

    }

    /*
     * Tests that tasks stops itself after the stopRetryTime if the component was
     * not loaded.
     */
    @Test
    public void noComponentForConfig() throws IOException {
        stageTestResource("badComponent.json");
        loader.activate();
        assertAfter(loader.stopRetryTime + loader.retryDelay, () -> {
            try {
                Field state = TimerTask.class.getDeclaredField("state");
                state.setAccessible(true);
                assertEquals("incorrect component", state.getInt(loader.loader), 3);
            } catch (Exception e) {
                e.printStackTrace();
                fail();
            }
        });

    }

    /*
     * Writes the necessary file for the tests in the temporary directory
     */
    static void stageTestResource(String name) throws IOException {
        byte[] bytes = toByteArray(ComponentConfigLoaderTest.class.getResourceAsStream(name));
        write(bytes, ComponentConfigLoader.cfgFile);
    }

    /*
     * Mockup class for the config service.
     */
    private class TestConfigService extends ComponentConfigAdapter {

        private String component;
        private String name;
        private String value;

        @Override
        public Set<String> getComponentNames() {
            return ImmutableSet.of(FOO_COMPONENT);
        }

        @Override
        public void setProperty(String componentName, String name, String value) {
            this.component = componentName;
            this.name = name;
            this.value = value;

        }
    }
}