[ONOS-6564] Adding PiPeconf behaviours to driver for device.
Initial implementation of PiPipeconfService.
Tests for Initial implementation.
Change-Id: I9dea6fb3015788b8b61060c7f88395c3d45e6ed7
diff --git a/core/net/src/test/java/org/onosproject/net/pi/impl/PiPipeconfServiceImplTest.java b/core/net/src/test/java/org/onosproject/net/pi/impl/PiPipeconfServiceImplTest.java
new file mode 100644
index 0000000..e9a91d3
--- /dev/null
+++ b/core/net/src/test/java/org/onosproject/net/pi/impl/PiPipeconfServiceImplTest.java
@@ -0,0 +1,299 @@
+/*
+ * Copyright 2017-present 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.net.pi.impl;
+
+import com.fasterxml.jackson.databind.JsonNode;
+import com.fasterxml.jackson.databind.ObjectMapper;
+import com.google.common.collect.ImmutableList;
+import com.google.common.collect.ImmutableSet;
+import org.junit.Before;
+import org.junit.Test;
+import org.onlab.util.ItemNotFoundException;
+import org.onosproject.net.DeviceId;
+import org.onosproject.net.behaviour.Pipeliner;
+import org.onosproject.net.behaviour.PipelinerAdapter;
+import org.onosproject.net.config.Config;
+import org.onosproject.net.config.ConfigApplyDelegate;
+import org.onosproject.net.config.ConfigFactory;
+import org.onosproject.net.config.NetworkConfigListener;
+import org.onosproject.net.config.NetworkConfigRegistry;
+import org.onosproject.net.config.NetworkConfigRegistryAdapter;
+import org.onosproject.net.config.basics.BasicDeviceConfig;
+import org.onosproject.net.device.DeviceDescription;
+import org.onosproject.net.device.DeviceDescriptionDiscovery;
+import org.onosproject.net.device.PortDescription;
+import org.onosproject.net.driver.AbstractHandlerBehaviour;
+import org.onosproject.net.driver.Behaviour;
+import org.onosproject.net.driver.Driver;
+import org.onosproject.net.driver.DriverAdapter;
+import org.onosproject.net.driver.DriverAdminService;
+import org.onosproject.net.driver.DriverAdminServiceAdapter;
+import org.onosproject.net.driver.DriverProvider;
+import org.onosproject.net.driver.DriverService;
+import org.onosproject.net.driver.DriverServiceAdapter;
+import org.onosproject.net.pi.model.PiPipeconfId;
+import org.onosproject.net.pi.model.PiPipelineInterpreter;
+import org.onosproject.net.pi.runtime.PiPipeconfConfig;
+
+import java.io.IOException;
+import java.io.InputStream;
+import java.util.HashMap;
+import java.util.HashSet;
+import java.util.List;
+import java.util.Map;
+import java.util.Set;
+
+import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.assertFalse;
+import static org.junit.Assert.assertTrue;
+
+
+/**
+ * Unit Test Class for PiPipeconfServiceImpl.
+ */
+public class PiPipeconfServiceImplTest {
+
+ private static final DeviceId DEVICE_ID = DeviceId.deviceId("test:test");
+ private static final String BASE_DRIVER = "baseDriver";
+ private static final Set<Class<? extends Behaviour>> EXPECTED_BEHAVIOURS =
+ ImmutableSet.of(DeviceDescriptionDiscovery.class, Pipeliner.class, PiPipelineInterpreter.class);
+
+ //Mock util sets and classes
+ private final NetworkConfigRegistry cfgService = new MockNetworkConfigRegistry();
+ private final DriverService driverService = new MockDriverService();
+ private final DriverAdminService driverAdminService = new MockDriverAdminService();
+ private Driver baseDriver = new MockDriver();
+ private String completeDriverName;
+
+ private final Set<ConfigFactory> cfgFactories = new HashSet<>();
+ private final Set<NetworkConfigListener> netCfgListeners = new HashSet<>();
+ private final Set<DriverProvider> providers = new HashSet<>();
+
+ private final PiPipeconfConfig piPipeconfConfig = new PiPipeconfConfig();
+ private final InputStream jsonStream = PiPipeconfServiceImplTest.class
+ .getResourceAsStream("/org/onosproject/net/pi/impl/piPipeconfId.json");
+ private final BasicDeviceConfig basicDeviceConfig = new BasicDeviceConfig();
+ private final InputStream jsonStreamBasic = PiPipeconfServiceImplTest.class
+ .getResourceAsStream("/org/onosproject/net/pi/impl/basic.json");
+
+
+ //Services
+ private PiPipeconfServiceImpl piPipeconfService;
+ private MockPipeconf piPipeconf;
+
+ @Before
+ public void setUp() throws IOException {
+ piPipeconfService = new PiPipeconfServiceImpl();
+ piPipeconf = new MockPipeconf();
+ completeDriverName = BASE_DRIVER + ":" + piPipeconf.id();
+ piPipeconf.behaviours.put(Pipeliner.class, PipelinerAdapter.class);
+ piPipeconfService.cfgService = cfgService;
+ piPipeconfService.driverService = driverService;
+ piPipeconfService.driverAdminService = driverAdminService;
+ String key = "piPipeconf";
+ ObjectMapper mapper = new ObjectMapper();
+ JsonNode jsonNode = mapper.readTree(jsonStream);
+ ConfigApplyDelegate delegate = new MockDelegate();
+ piPipeconfConfig.init(DEVICE_ID, key, jsonNode, mapper, delegate);
+ String keyBasic = "basic";
+ JsonNode jsonNodeBasic = mapper.readTree(jsonStreamBasic);
+ basicDeviceConfig.init(DEVICE_ID, keyBasic, jsonNodeBasic, mapper, delegate);
+ piPipeconfService.activate();
+ }
+
+ @Test
+ public void activate() {
+ assertEquals("Incorrect driver service", driverService, piPipeconfService.driverService);
+ assertEquals("Incorrect driverAdminService service", driverAdminService, piPipeconfService.driverAdminService);
+ assertEquals("Incorrect configuration service", cfgService, piPipeconfService.cfgService);
+ assertTrue("Incorrect config factory", cfgFactories.contains(piPipeconfService.factory));
+ assertTrue("Incorrect network configuration listener", netCfgListeners.contains(piPipeconfService.cfgListener));
+ }
+
+ @Test
+ public void deactivate() {
+ piPipeconfService.deactivate();
+ assertEquals("Incorrect driver service", null, piPipeconfService.driverService);
+ assertEquals("Incorrect driverAdminService service", null, piPipeconfService.driverAdminService);
+ assertEquals("Incorrect configuration service", null, piPipeconfService.cfgService);
+ assertFalse("Config factory should be unregistered", cfgFactories.contains(piPipeconfService.factory));
+ assertFalse("Network configuration listener should be unregistered",
+ netCfgListeners.contains(piPipeconfService.cfgListener));
+ }
+
+ @Test
+ public void register() {
+ piPipeconfService.register(piPipeconf);
+ assertTrue("PiPipeconf should be registered", piPipeconfService.piPipeconfs.contains(piPipeconf));
+ }
+
+ @Test
+ public void getPipeconf() {
+ piPipeconfService.register(piPipeconf);
+ assertEquals("Returned PiPipeconf is not correct", piPipeconf,
+ piPipeconfService.getPipeconf(piPipeconf.id()).get());
+ }
+
+
+ @Test
+ public void bindToDevice() throws Exception {
+ PiPipeconfId piPipeconfId = cfgService.getConfig(DEVICE_ID, PiPipeconfConfig.class).piPipeconfId();
+ assertEquals(piPipeconf.id(), piPipeconfId);
+
+ String baseDriverName = cfgService.getConfig(DEVICE_ID, BasicDeviceConfig.class).driver();
+ assertEquals(BASE_DRIVER, baseDriverName);
+
+ piPipeconfService.register(piPipeconf);
+ assertEquals("Returned PiPipeconf is not correct", piPipeconf,
+ piPipeconfService.getPipeconf(piPipeconf.id()).get());
+
+ piPipeconfService.bindToDevice(piPipeconfId, DEVICE_ID).whenComplete((booleanResult, ex) -> {
+
+ //we assume that the provider is 1 and that it contains 1 driver
+ //we also assume that everything after driverAdminService.registerProvider(provider); has been tested.
+ assertTrue("Provider should be registered", providers.size() != 0);
+
+ assertTrue("Boolean Result of method should be True", booleanResult);
+
+ providers.forEach(p -> {
+ assertTrue("Provider should contain a driver", p.getDrivers().size() != 0);
+ p.getDrivers().forEach(driver -> {
+ assertEquals("The driver has wrong name", driver.name(), completeDriverName);
+ assertEquals("The driver contains wrong behaviours", EXPECTED_BEHAVIOURS, driver.behaviours());
+
+ });
+ });
+ }).exceptionally(ex -> {
+ throw new IllegalStateException(ex);
+ });
+ }
+
+ private class MockNetworkConfigRegistry extends NetworkConfigRegistryAdapter {
+ @Override
+ public void registerConfigFactory(ConfigFactory configFactory) {
+ cfgFactories.add(configFactory);
+ }
+
+ @Override
+ public void unregisterConfigFactory(ConfigFactory configFactory) {
+ cfgFactories.remove(configFactory);
+ }
+
+ @Override
+ public void addListener(NetworkConfigListener listener) {
+ netCfgListeners.add(listener);
+ }
+
+ @Override
+ public void removeListener(NetworkConfigListener listener) {
+ netCfgListeners.remove(listener);
+ }
+
+ @Override
+ public <S, C extends Config<S>> C getConfig(S subject, Class<C> configClass) {
+ DeviceId did = (DeviceId) subject;
+ if (configClass.equals(PiPipeconfConfig.class)
+ && did.equals(DEVICE_ID)) {
+ return (C) piPipeconfConfig;
+ } else if (configClass.equals(BasicDeviceConfig.class)
+ && did.equals(DEVICE_ID)) {
+ return (C) basicDeviceConfig;
+ }
+ return null;
+ }
+ }
+
+ private class MockDriverService extends DriverServiceAdapter {
+ @Override
+ public Driver getDriver(String driverName) {
+ if (driverName.equals(BASE_DRIVER)) {
+ return baseDriver;
+ }
+ throw new ItemNotFoundException("Driver not found");
+ }
+ }
+
+ private class MockDriverAdminService extends DriverAdminServiceAdapter {
+
+ @Override
+ public void registerProvider(DriverProvider provider) {
+ providers.add(provider);
+ }
+ }
+
+ private class MockDelegate implements ConfigApplyDelegate {
+ @Override
+ public void onApply(Config configFile) {
+ }
+ }
+
+ private class MockDriver extends DriverAdapter {
+
+ @Override
+ public List<Driver> parents() {
+ return ImmutableList.of();
+ }
+
+ @Override
+ public String manufacturer() {
+ return "On.Lab";
+ }
+
+ @Override
+ public String hwVersion() {
+ return "testHW";
+ }
+
+ @Override
+ public Class<? extends Behaviour> implementation(Class<? extends Behaviour> behaviour) {
+ return MockDeviceDescriptionDiscovery.class;
+ }
+
+ @Override
+ public Map<String, String> properties() {
+ return new HashMap<>();
+ }
+
+ @Override
+ public Set<Class<? extends Behaviour>> behaviours() {
+ return ImmutableSet.of(DeviceDescriptionDiscovery.class);
+ }
+
+ @Override
+ public String swVersion() {
+ return "testSW";
+ }
+
+ @Override
+ public String name() {
+ return BASE_DRIVER;
+ }
+ }
+
+ private class MockDeviceDescriptionDiscovery extends AbstractHandlerBehaviour
+ implements DeviceDescriptionDiscovery {
+ @Override
+ public DeviceDescription discoverDeviceDetails() {
+ return null;
+ }
+
+ @Override
+ public List<PortDescription> discoverPortDetails() {
+ return null;
+ }
+ }
+}
\ No newline at end of file