Andrea Campanella | 58454b9 | 2016-04-01 15:19:00 -0700 | [diff] [blame] | 1 | /* |
Brian O'Connor | a09fe5b | 2017-08-03 21:12:30 -0700 | [diff] [blame] | 2 | * Copyright 2016-present Open Networking Foundation |
Andrea Campanella | 58454b9 | 2016-04-01 15:19:00 -0700 | [diff] [blame] | 3 | * |
| 4 | * Licensed under the Apache License, Version 2.0 (the "License"); |
| 5 | * you may not use this file except in compliance with the License. |
| 6 | * You may obtain a copy of the License at |
| 7 | * |
| 8 | * http://www.apache.org/licenses/LICENSE-2.0 |
| 9 | * |
| 10 | * Unless required by applicable law or agreed to in writing, software |
| 11 | * distributed under the License is distributed on an "AS IS" BASIS, |
| 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 13 | * See the License for the specific language governing permissions and |
| 14 | * limitations under the License. |
| 15 | */ |
| 16 | |
| 17 | package org.onosproject.provider.snmp.device.impl; |
| 18 | |
Andrea Campanella | 59b549d | 2017-04-14 21:58:16 +0200 | [diff] [blame] | 19 | import com.fasterxml.jackson.databind.JsonNode; |
| 20 | import com.fasterxml.jackson.databind.ObjectMapper; |
Andrea Campanella | 58454b9 | 2016-04-01 15:19:00 -0700 | [diff] [blame] | 21 | import com.google.common.collect.ImmutableSet; |
| 22 | import org.junit.Before; |
| 23 | import org.junit.Test; |
Andrea Campanella | 58454b9 | 2016-04-01 15:19:00 -0700 | [diff] [blame] | 24 | import org.onosproject.TestApplicationId; |
| 25 | import org.onosproject.core.ApplicationId; |
| 26 | import org.onosproject.core.CoreService; |
| 27 | import org.onosproject.core.CoreServiceAdapter; |
Andrea Campanella | 58454b9 | 2016-04-01 15:19:00 -0700 | [diff] [blame] | 28 | import org.onosproject.net.AbstractProjectableModel; |
| 29 | import org.onosproject.net.DefaultAnnotations; |
| 30 | import org.onosproject.net.DefaultDevice; |
| 31 | import org.onosproject.net.Device; |
| 32 | import org.onosproject.net.DeviceId; |
| 33 | import org.onosproject.net.config.Config; |
Andrea Campanella | 59b549d | 2017-04-14 21:58:16 +0200 | [diff] [blame] | 34 | import org.onosproject.net.config.ConfigApplyDelegate; |
Andrea Campanella | 58454b9 | 2016-04-01 15:19:00 -0700 | [diff] [blame] | 35 | import org.onosproject.net.config.ConfigFactory; |
| 36 | import org.onosproject.net.config.NetworkConfigEvent; |
| 37 | import org.onosproject.net.config.NetworkConfigListener; |
| 38 | import org.onosproject.net.config.NetworkConfigRegistry; |
| 39 | import org.onosproject.net.config.NetworkConfigRegistryAdapter; |
| 40 | import org.onosproject.net.config.basics.BasicDeviceConfig; |
| 41 | import org.onosproject.net.device.DeviceDescription; |
| 42 | import org.onosproject.net.device.DeviceEvent; |
| 43 | import org.onosproject.net.device.DeviceProvider; |
| 44 | import org.onosproject.net.device.DeviceProviderRegistry; |
| 45 | import org.onosproject.net.device.DeviceProviderRegistryAdapter; |
| 46 | import org.onosproject.net.device.DeviceProviderService; |
| 47 | import org.onosproject.net.device.DeviceProviderServiceAdapter; |
| 48 | import org.onosproject.net.device.DeviceService; |
| 49 | import org.onosproject.net.device.DeviceServiceAdapter; |
| 50 | import org.onosproject.net.device.DeviceStore; |
| 51 | import org.onosproject.net.device.DeviceStoreAdapter; |
Andrea Campanella | 58454b9 | 2016-04-01 15:19:00 -0700 | [diff] [blame] | 52 | import org.onosproject.net.driver.DriverServiceAdapter; |
| 53 | import org.onosproject.net.provider.ProviderId; |
| 54 | import org.onosproject.snmp.SnmpController; |
| 55 | |
Andrea Campanella | 59b549d | 2017-04-14 21:58:16 +0200 | [diff] [blame] | 56 | import java.io.InputStream; |
Andrea Campanella | 58454b9 | 2016-04-01 15:19:00 -0700 | [diff] [blame] | 57 | import java.util.HashMap; |
| 58 | import java.util.HashSet; |
| 59 | import java.util.Set; |
| 60 | |
Ray Milkey | 4ad4a24 | 2018-02-13 13:54:40 -0800 | [diff] [blame^] | 61 | import static org.junit.Assert.assertEquals; |
| 62 | import static org.junit.Assert.assertFalse; |
| 63 | import static org.junit.Assert.assertNotNull; |
| 64 | import static org.junit.Assert.assertNull; |
| 65 | import static org.junit.Assert.assertTrue; |
Andrea Campanella | 58454b9 | 2016-04-01 15:19:00 -0700 | [diff] [blame] | 66 | import static org.onlab.junit.TestTools.assertAfter; |
| 67 | |
| 68 | /** |
| 69 | * Testing class for SnmpDeviceProvider. |
| 70 | */ |
| 71 | public class SnmpDeviceProviderTest { |
| 72 | |
Andrea Campanella | 59b549d | 2017-04-14 21:58:16 +0200 | [diff] [blame] | 73 | public static final int TEST_DURATION = 1500; |
| 74 | public static final int DELAY = 500; |
Andrea Campanella | 58454b9 | 2016-04-01 15:19:00 -0700 | [diff] [blame] | 75 | private final SnmpDeviceProvider provider = new SnmpDeviceProvider(); |
| 76 | private final SnmpController controller = new SnmpControllerAdapter(); |
| 77 | private final DeviceProviderRegistry providerRegistry = new MockDeviceProviderRegistry(); |
| 78 | private final DeviceService deviceService = new MockDeviceService(); |
| 79 | private final NetworkConfigRegistry netCfgService = new MockNetworkConfigRegistry(); |
| 80 | private final DeviceStore deviceStore = new MockDeviceStore(); |
| 81 | protected CoreService coreService = new MockCoreService(); |
| 82 | private final DeviceProviderService deviceProviderService = new MockDeviceProviderService(); |
| 83 | private final TestApplicationId applicationId = new TestApplicationId("TestAppId"); |
Andrea Campanella | 59b549d | 2017-04-14 21:58:16 +0200 | [diff] [blame] | 84 | private final DeviceId deviceId = DeviceId.deviceId("snmp:1.1.1.1:1"); |
| 85 | private final DeviceId wrongDeviceId = DeviceId.deviceId("snmp:2.2.2.2:2"); |
| 86 | private final Set<ConfigFactory> cfgFactories = new HashSet<>(); |
| 87 | private final Set<NetworkConfigListener> netCfgListeners = new HashSet<>(); |
Andrea Campanella | 58454b9 | 2016-04-01 15:19:00 -0700 | [diff] [blame] | 88 | private final NetworkConfigEvent deviceAddedIrrelevantEvent = |
| 89 | new NetworkConfigEvent(NetworkConfigEvent.Type.CONFIG_ADDED, |
| 90 | null, BasicDeviceConfig.class); |
Andrea Campanella | 59b549d | 2017-04-14 21:58:16 +0200 | [diff] [blame] | 91 | private final NetworkConfigEvent deviceAddedNewEvent = |
| 92 | new NetworkConfigEvent(NetworkConfigEvent.Type.CONFIG_ADDED, |
| 93 | deviceId, SnmpDeviceConfig.class); |
| 94 | private final SnmpDeviceConfig config = new SnmpDeviceConfig(); |
| 95 | //Testing Files |
| 96 | private final InputStream jsonStream = SnmpDeviceProviderTest.class |
| 97 | .getResourceAsStream("/device.json"); |
| 98 | private final ObjectMapper mapper = new ObjectMapper(); |
Yuta HIGUCHI | 4f56bbd | 2017-04-27 17:38:20 -0700 | [diff] [blame] | 99 | private static final String KEY = "snmp"; |
Andrea Campanella | 58454b9 | 2016-04-01 15:19:00 -0700 | [diff] [blame] | 100 | |
| 101 | |
| 102 | @Before |
| 103 | public void setUp() throws Exception { |
| 104 | provider.controller = controller; |
| 105 | provider.providerRegistry = providerRegistry; |
| 106 | provider.deviceService = deviceService; |
| 107 | provider.netCfgService = netCfgService; |
| 108 | provider.deviceStore = deviceStore; |
| 109 | provider.coreService = coreService; |
Andrea Campanella | 59b549d | 2017-04-14 21:58:16 +0200 | [diff] [blame] | 110 | JsonNode jsonNode = mapper.readTree(jsonStream); |
| 111 | ConfigApplyDelegate delegate = new MockDelegate(); |
| 112 | config.init(deviceId, KEY, jsonNode, mapper, delegate); |
Andrea Campanella | 58454b9 | 2016-04-01 15:19:00 -0700 | [diff] [blame] | 113 | provider.activate(null); |
| 114 | } |
| 115 | |
| 116 | @Test |
| 117 | public void testActivate() { |
| 118 | assertEquals("Incorrect provider service", deviceProviderService, provider.providerService); |
| 119 | assertEquals("Incorrect application id", applicationId, provider.appId); |
Ray Milkey | 4ad4a24 | 2018-02-13 13:54:40 -0800 | [diff] [blame^] | 120 | assertTrue("Incorrect config factories", cfgFactories.contains(provider.factory)); |
Andrea Campanella | 58454b9 | 2016-04-01 15:19:00 -0700 | [diff] [blame] | 121 | assertTrue("Incorrect network config listener", netCfgListeners.contains(provider.cfgLister)); |
| 122 | |
| 123 | |
| 124 | } |
| 125 | |
| 126 | @Test |
| 127 | public void testDeactivate() { |
| 128 | this.addDevice(); |
| 129 | provider.deactivate(null); |
Andrea Campanella | 59b549d | 2017-04-14 21:58:16 +0200 | [diff] [blame] | 130 | assertAfter(DELAY, TEST_DURATION, () -> |
Andrea Campanella | 58454b9 | 2016-04-01 15:19:00 -0700 | [diff] [blame] | 131 | assertNull("Device should be removed", controller.getDevice(deviceId))); |
Andrea Campanella | 59b549d | 2017-04-14 21:58:16 +0200 | [diff] [blame] | 132 | assertTrue("Network config factory not removed", cfgFactories.isEmpty()); |
Andrea Campanella | 58454b9 | 2016-04-01 15:19:00 -0700 | [diff] [blame] | 133 | assertFalse("Network config listener not removed", netCfgListeners.contains(provider.cfgLister)); |
| 134 | assertFalse("Provider not unregistered", providerRegistry.getProviders().contains(provider.id())); |
| 135 | assertNull("Provider registry not removed", provider.providerService); |
| 136 | } |
| 137 | |
| 138 | @Test |
| 139 | public void eventNotRelevant() { |
| 140 | assertFalse("Event should not be relevant", provider.cfgLister.isRelevant(deviceAddedIrrelevantEvent)); |
| 141 | assertFalse("Device should not be reachable", provider.isReachable(wrongDeviceId)); |
| 142 | } |
| 143 | |
| 144 | @Test |
| 145 | public void addDevice() { |
Andrea Campanella | 58454b9 | 2016-04-01 15:19:00 -0700 | [diff] [blame] | 146 | AbstractProjectableModel.setDriverService(null, new MockDriverService()); |
| 147 | //FIXME this needs sleep |
Andrea Campanella | 59b549d | 2017-04-14 21:58:16 +0200 | [diff] [blame] | 148 | assertAfter(DELAY, TEST_DURATION, () -> |
| 149 | assertNotNull("Device should be added to controller", controller.getDevice(deviceId))); |
| 150 | assertTrue("Device should be reachable", provider.isReachable(deviceId)); |
| 151 | } |
| 152 | |
| 153 | @Test |
| 154 | public void addDeviceNew() { |
| 155 | assertTrue("Event should be relevant", provider.cfgLister.isRelevant(deviceAddedNewEvent)); |
| 156 | provider.cfgLister.event(deviceAddedNewEvent); |
| 157 | AbstractProjectableModel.setDriverService(null, new MockDriverService()); |
| 158 | //FIXME this needs sleep |
| 159 | assertAfter(DELAY, TEST_DURATION, () -> |
Andrea Campanella | 58454b9 | 2016-04-01 15:19:00 -0700 | [diff] [blame] | 160 | assertNotNull("Device should be added to controller", controller.getDevice(deviceId))); |
| 161 | assertTrue("Device should be reachable", provider.isReachable(deviceId)); |
| 162 | } |
| 163 | |
| 164 | private class MockDeviceProviderRegistry extends DeviceProviderRegistryAdapter { |
| 165 | |
| 166 | Set<ProviderId> providers = new HashSet<>(); |
| 167 | |
| 168 | @Override |
| 169 | public DeviceProviderService register(DeviceProvider provider) { |
| 170 | providers.add(provider.id()); |
| 171 | return deviceProviderService; |
| 172 | } |
| 173 | |
| 174 | @Override |
| 175 | public void unregister(DeviceProvider provider) { |
| 176 | providers.remove(provider.id()); |
| 177 | } |
| 178 | |
| 179 | @Override |
| 180 | public Set<ProviderId> getProviders() { |
| 181 | return providers; |
| 182 | } |
| 183 | |
| 184 | } |
| 185 | |
| 186 | private class MockDeviceService extends DeviceServiceAdapter { |
| 187 | @Override |
| 188 | public Device getDevice(DeviceId deviceId) { |
| 189 | return deviceStore.getDevice(deviceId); |
| 190 | } |
| 191 | } |
| 192 | |
Andrea Campanella | 58454b9 | 2016-04-01 15:19:00 -0700 | [diff] [blame] | 193 | private class MockNetworkConfigRegistry extends NetworkConfigRegistryAdapter { |
| 194 | |
| 195 | @Override |
| 196 | public void registerConfigFactory(ConfigFactory configFactory) { |
Andrea Campanella | 59b549d | 2017-04-14 21:58:16 +0200 | [diff] [blame] | 197 | cfgFactories.add(configFactory); |
Andrea Campanella | 58454b9 | 2016-04-01 15:19:00 -0700 | [diff] [blame] | 198 | } |
| 199 | |
| 200 | @Override |
| 201 | public void unregisterConfigFactory(ConfigFactory configFactory) { |
Andrea Campanella | 59b549d | 2017-04-14 21:58:16 +0200 | [diff] [blame] | 202 | cfgFactories.remove(configFactory); |
Andrea Campanella | 58454b9 | 2016-04-01 15:19:00 -0700 | [diff] [blame] | 203 | } |
| 204 | |
| 205 | @Override |
| 206 | public void addListener(NetworkConfigListener listener) { |
| 207 | netCfgListeners.add(listener); |
| 208 | } |
| 209 | |
| 210 | @Override |
| 211 | public void removeListener(NetworkConfigListener listener) { |
| 212 | netCfgListeners.remove(listener); |
| 213 | } |
| 214 | |
| 215 | |
| 216 | @Override |
| 217 | public <S, C extends Config<S>> C getConfig(S subject, Class<C> configClass) { |
Ray Milkey | 4ad4a24 | 2018-02-13 13:54:40 -0800 | [diff] [blame^] | 218 | if (configClass.equals(SnmpDeviceConfig.class)) { |
Andrea Campanella | 59b549d | 2017-04-14 21:58:16 +0200 | [diff] [blame] | 219 | return (C) config; |
Andrea Campanella | 58454b9 | 2016-04-01 15:19:00 -0700 | [diff] [blame] | 220 | } else { |
| 221 | return (C) new BasicDeviceConfig(); |
| 222 | } |
| 223 | } |
Andrea Campanella | 59b549d | 2017-04-14 21:58:16 +0200 | [diff] [blame] | 224 | |
| 225 | @Override |
| 226 | public <S, C extends Config<S>> Set<S> getSubjects(Class<S> subjectClass, Class<C> configClass) { |
| 227 | return ImmutableSet.of((S) deviceId); |
| 228 | } |
Andrea Campanella | 58454b9 | 2016-04-01 15:19:00 -0700 | [diff] [blame] | 229 | } |
| 230 | |
| 231 | private class MockDeviceStore extends DeviceStoreAdapter { |
| 232 | protected HashMap<DeviceId, Device> devices = new HashMap<>(); |
| 233 | |
| 234 | @Override |
| 235 | public DeviceEvent createOrUpdateDevice(ProviderId providerId, DeviceId deviceId, |
| 236 | DeviceDescription desc) { |
| 237 | |
| 238 | devices.put(deviceId, new DefaultDevice(providerId, deviceId, desc.type(), |
| 239 | desc.manufacturer(), desc.hwVersion(), |
| 240 | desc.swVersion(), desc.serialNumber(), |
| 241 | desc.chassisId(), DefaultAnnotations.builder().build())); |
| 242 | return null; |
| 243 | } |
| 244 | |
| 245 | @Override |
| 246 | public Device getDevice(DeviceId deviceId) { |
| 247 | return devices.get(deviceId); |
| 248 | } |
| 249 | |
| 250 | } |
| 251 | |
| 252 | private class MockCoreService extends CoreServiceAdapter { |
| 253 | @Override |
| 254 | public ApplicationId registerApplication(String name) { |
| 255 | return applicationId; |
| 256 | } |
| 257 | } |
| 258 | |
| 259 | private class MockDeviceProviderService extends DeviceProviderServiceAdapter { |
| 260 | DeviceStore store = deviceStore; |
| 261 | |
| 262 | @Override |
| 263 | public void deviceConnected(DeviceId deviceId, DeviceDescription desc) { |
| 264 | store.createOrUpdateDevice(ProviderId.NONE, deviceId, desc); |
| 265 | } |
| 266 | } |
| 267 | |
Andrea Campanella | 58454b9 | 2016-04-01 15:19:00 -0700 | [diff] [blame] | 268 | private class MockDriverService extends DriverServiceAdapter { |
| 269 | |
| 270 | } |
Andrea Campanella | 59b549d | 2017-04-14 21:58:16 +0200 | [diff] [blame] | 271 | |
| 272 | private class MockDelegate implements ConfigApplyDelegate { |
| 273 | @Override |
| 274 | public void onApply(Config config) { |
| 275 | |
| 276 | } |
| 277 | } |
Ray Milkey | 2d572dd | 2017-04-14 10:01:24 -0700 | [diff] [blame] | 278 | } |