tom | be98831 | 2014-09-19 18:38:47 -0700 | [diff] [blame] | 1 | package org.onlab.onos.net.device.impl; |
tom | e5ec3fd | 2014-09-04 15:18:06 -0700 | [diff] [blame] | 2 | |
tom | b41d1ac | 2014-09-24 01:51:24 -0700 | [diff] [blame] | 3 | import com.google.common.collect.Sets; |
Yuta HIGUCHI | 33faeaf | 2014-10-07 18:19:44 -0700 | [diff] [blame] | 4 | |
tom | e5ec3fd | 2014-09-04 15:18:06 -0700 | [diff] [blame] | 5 | import org.junit.After; |
| 6 | import org.junit.Before; |
tom | b41d1ac | 2014-09-24 01:51:24 -0700 | [diff] [blame] | 7 | import org.junit.Ignore; |
tom | e5ec3fd | 2014-09-04 15:18:06 -0700 | [diff] [blame] | 8 | import org.junit.Test; |
Yuta HIGUCHI | 33faeaf | 2014-10-07 18:19:44 -0700 | [diff] [blame] | 9 | import org.onlab.onos.cluster.ClusterEventListener; |
| 10 | import org.onlab.onos.cluster.ClusterService; |
| 11 | import org.onlab.onos.cluster.ControllerNode; |
| 12 | import org.onlab.onos.cluster.DefaultControllerNode; |
tom | b41d1ac | 2014-09-24 01:51:24 -0700 | [diff] [blame] | 13 | import org.onlab.onos.cluster.MastershipServiceAdapter; |
Yuta HIGUCHI | 33faeaf | 2014-10-07 18:19:44 -0700 | [diff] [blame] | 14 | import org.onlab.onos.cluster.MastershipTerm; |
| 15 | import org.onlab.onos.cluster.MastershipTermService; |
Ayaka Koshibe | a7f044e | 2014-09-23 16:56:20 -0700 | [diff] [blame] | 16 | import org.onlab.onos.cluster.NodeId; |
Yuta HIGUCHI | 33faeaf | 2014-10-07 18:19:44 -0700 | [diff] [blame] | 17 | import org.onlab.onos.cluster.ControllerNode.State; |
tom | e5ec3fd | 2014-09-04 15:18:06 -0700 | [diff] [blame] | 18 | import org.onlab.onos.event.Event; |
tom | b41d1ac | 2014-09-24 01:51:24 -0700 | [diff] [blame] | 19 | import org.onlab.onos.event.impl.TestEventDispatcher; |
tom | e5ec3fd | 2014-09-04 15:18:06 -0700 | [diff] [blame] | 20 | import org.onlab.onos.net.Device; |
| 21 | import org.onlab.onos.net.DeviceId; |
| 22 | import org.onlab.onos.net.MastershipRole; |
tom | 24c55cd | 2014-09-06 10:47:25 -0700 | [diff] [blame] | 23 | import org.onlab.onos.net.Port; |
| 24 | import org.onlab.onos.net.PortNumber; |
tom | e5ec3fd | 2014-09-04 15:18:06 -0700 | [diff] [blame] | 25 | import org.onlab.onos.net.device.DefaultDeviceDescription; |
tom | 24c55cd | 2014-09-06 10:47:25 -0700 | [diff] [blame] | 26 | import org.onlab.onos.net.device.DefaultPortDescription; |
tom | e5ec3fd | 2014-09-04 15:18:06 -0700 | [diff] [blame] | 27 | import org.onlab.onos.net.device.DeviceAdminService; |
| 28 | import org.onlab.onos.net.device.DeviceDescription; |
| 29 | import org.onlab.onos.net.device.DeviceEvent; |
| 30 | import org.onlab.onos.net.device.DeviceListener; |
| 31 | import org.onlab.onos.net.device.DeviceProvider; |
| 32 | import org.onlab.onos.net.device.DeviceProviderRegistry; |
| 33 | import org.onlab.onos.net.device.DeviceProviderService; |
| 34 | import org.onlab.onos.net.device.DeviceService; |
tom | 24c55cd | 2014-09-06 10:47:25 -0700 | [diff] [blame] | 35 | import org.onlab.onos.net.device.PortDescription; |
tom | e5ec3fd | 2014-09-04 15:18:06 -0700 | [diff] [blame] | 36 | import org.onlab.onos.net.provider.AbstractProvider; |
| 37 | import org.onlab.onos.net.provider.ProviderId; |
Yuta HIGUCHI | 33faeaf | 2014-10-07 18:19:44 -0700 | [diff] [blame] | 38 | import org.onlab.onos.store.ClockProviderService; |
tom | ea961ff | 2014-10-01 12:45:15 -0700 | [diff] [blame] | 39 | import org.onlab.onos.store.trivial.impl.SimpleDeviceStore; |
Yuta HIGUCHI | 33faeaf | 2014-10-07 18:19:44 -0700 | [diff] [blame] | 40 | import org.onlab.packet.IpPrefix; |
tom | e5ec3fd | 2014-09-04 15:18:06 -0700 | [diff] [blame] | 41 | |
| 42 | import java.util.ArrayList; |
| 43 | import java.util.Iterator; |
| 44 | import java.util.List; |
Ayaka Koshibe | a7f044e | 2014-09-23 16:56:20 -0700 | [diff] [blame] | 45 | import java.util.Set; |
tom | e5ec3fd | 2014-09-04 15:18:06 -0700 | [diff] [blame] | 46 | |
| 47 | import static org.junit.Assert.*; |
| 48 | import static org.onlab.onos.net.Device.Type.SWITCH; |
| 49 | import static org.onlab.onos.net.DeviceId.deviceId; |
| 50 | import static org.onlab.onos.net.device.DeviceEvent.Type.*; |
| 51 | |
| 52 | /** |
| 53 | * Test codifying the device service & device provider service contracts. |
| 54 | */ |
tom | 41a2c5f | 2014-09-19 09:20:35 -0700 | [diff] [blame] | 55 | public class DeviceManagerTest { |
tom | e5ec3fd | 2014-09-04 15:18:06 -0700 | [diff] [blame] | 56 | |
tom | 7e02cda | 2014-09-18 12:05:46 -0700 | [diff] [blame] | 57 | private static final ProviderId PID = new ProviderId("of", "foo"); |
tom | e5ec3fd | 2014-09-04 15:18:06 -0700 | [diff] [blame] | 58 | private static final DeviceId DID1 = deviceId("of:foo"); |
| 59 | private static final DeviceId DID2 = deviceId("of:bar"); |
| 60 | private static final String MFR = "whitebox"; |
| 61 | private static final String HW = "1.1.x"; |
| 62 | private static final String SW1 = "3.8.1"; |
| 63 | private static final String SW2 = "3.9.5"; |
| 64 | private static final String SN = "43311-12345"; |
| 65 | |
tom | 24c55cd | 2014-09-06 10:47:25 -0700 | [diff] [blame] | 66 | private static final PortNumber P1 = PortNumber.portNumber(1); |
| 67 | private static final PortNumber P2 = PortNumber.portNumber(2); |
| 68 | private static final PortNumber P3 = PortNumber.portNumber(3); |
Yuta HIGUCHI | 33faeaf | 2014-10-07 18:19:44 -0700 | [diff] [blame] | 69 | private static final NodeId NID_LOCAL = new NodeId("local"); |
| 70 | private static final IpPrefix LOCALHOST = IpPrefix.valueOf("127.0.0.1"); |
tom | 24c55cd | 2014-09-06 10:47:25 -0700 | [diff] [blame] | 71 | |
tom | 41a2c5f | 2014-09-19 09:20:35 -0700 | [diff] [blame] | 72 | private DeviceManager mgr; |
tom | e5ec3fd | 2014-09-04 15:18:06 -0700 | [diff] [blame] | 73 | |
| 74 | protected DeviceService service; |
| 75 | protected DeviceAdminService admin; |
| 76 | protected DeviceProviderRegistry registry; |
| 77 | protected DeviceProviderService providerService; |
| 78 | protected TestProvider provider; |
| 79 | protected TestListener listener = new TestListener(); |
| 80 | |
| 81 | @Before |
| 82 | public void setUp() { |
tom | 41a2c5f | 2014-09-19 09:20:35 -0700 | [diff] [blame] | 83 | mgr = new DeviceManager(); |
tom | e5ec3fd | 2014-09-04 15:18:06 -0700 | [diff] [blame] | 84 | service = mgr; |
| 85 | admin = mgr; |
| 86 | registry = mgr; |
tom | 41a2c5f | 2014-09-19 09:20:35 -0700 | [diff] [blame] | 87 | mgr.store = new SimpleDeviceStore(); |
tom | e5ec3fd | 2014-09-04 15:18:06 -0700 | [diff] [blame] | 88 | mgr.eventDispatcher = new TestEventDispatcher(); |
Ayaka Koshibe | a7f044e | 2014-09-23 16:56:20 -0700 | [diff] [blame] | 89 | mgr.mastershipService = new TestMastershipService(); |
Yuta HIGUCHI | 33faeaf | 2014-10-07 18:19:44 -0700 | [diff] [blame] | 90 | mgr.clusterService = new TestClusterService(); |
| 91 | mgr.clockProviderService = new TestClockProviderService(); |
tom | e5ec3fd | 2014-09-04 15:18:06 -0700 | [diff] [blame] | 92 | mgr.activate(); |
| 93 | |
| 94 | service.addListener(listener); |
| 95 | |
| 96 | provider = new TestProvider(); |
| 97 | providerService = registry.register(provider); |
| 98 | assertTrue("provider should be registered", |
| 99 | registry.getProviders().contains(provider.id())); |
| 100 | } |
| 101 | |
| 102 | @After |
| 103 | public void tearDown() { |
| 104 | registry.unregister(provider); |
| 105 | assertFalse("provider should not be registered", |
| 106 | registry.getProviders().contains(provider.id())); |
| 107 | service.removeListener(listener); |
| 108 | mgr.deactivate(); |
| 109 | } |
| 110 | |
| 111 | private void connectDevice(DeviceId deviceId, String swVersion) { |
| 112 | DeviceDescription description = |
| 113 | new DefaultDeviceDescription(deviceId.uri(), SWITCH, MFR, |
| 114 | HW, swVersion, SN); |
| 115 | providerService.deviceConnected(deviceId, description); |
| 116 | assertNotNull("device should be found", service.getDevice(DID1)); |
| 117 | } |
| 118 | |
| 119 | @Test |
| 120 | public void deviceConnected() { |
| 121 | assertNull("device should not be found", service.getDevice(DID1)); |
| 122 | connectDevice(DID1, SW1); |
| 123 | validateEvents(DEVICE_ADDED); |
| 124 | |
| 125 | Iterator<Device> it = service.getDevices().iterator(); |
| 126 | assertNotNull("one device expected", it.next()); |
| 127 | assertFalse("only one device expected", it.hasNext()); |
tom | ad2d209 | 2014-09-06 23:24:20 -0700 | [diff] [blame] | 128 | assertEquals("incorrect device count", 1, service.getDeviceCount()); |
tom | ff7eb7c | 2014-09-08 12:49:03 -0700 | [diff] [blame] | 129 | assertTrue("device should be available", service.isAvailable(DID1)); |
tom | e5ec3fd | 2014-09-04 15:18:06 -0700 | [diff] [blame] | 130 | } |
| 131 | |
| 132 | @Test |
| 133 | public void deviceDisconnected() { |
| 134 | connectDevice(DID1, SW1); |
| 135 | connectDevice(DID2, SW1); |
| 136 | validateEvents(DEVICE_ADDED, DEVICE_ADDED); |
tom | ff7eb7c | 2014-09-08 12:49:03 -0700 | [diff] [blame] | 137 | assertTrue("device should be available", service.isAvailable(DID1)); |
tom | e5ec3fd | 2014-09-04 15:18:06 -0700 | [diff] [blame] | 138 | |
| 139 | // Disconnect |
| 140 | providerService.deviceDisconnected(DID1); |
| 141 | assertNotNull("device should not be found", service.getDevice(DID1)); |
tom | ff7eb7c | 2014-09-08 12:49:03 -0700 | [diff] [blame] | 142 | assertFalse("device should not be available", service.isAvailable(DID1)); |
tom | e5ec3fd | 2014-09-04 15:18:06 -0700 | [diff] [blame] | 143 | validateEvents(DEVICE_AVAILABILITY_CHANGED); |
| 144 | |
| 145 | // Reconnect |
| 146 | connectDevice(DID1, SW1); |
| 147 | validateEvents(DEVICE_AVAILABILITY_CHANGED); |
tom | ad2d209 | 2014-09-06 23:24:20 -0700 | [diff] [blame] | 148 | |
| 149 | assertEquals("incorrect device count", 2, service.getDeviceCount()); |
tom | e5ec3fd | 2014-09-04 15:18:06 -0700 | [diff] [blame] | 150 | } |
| 151 | |
| 152 | @Test |
| 153 | public void deviceUpdated() { |
| 154 | connectDevice(DID1, SW1); |
| 155 | validateEvents(DEVICE_ADDED); |
| 156 | |
| 157 | connectDevice(DID1, SW2); |
| 158 | validateEvents(DEVICE_UPDATED); |
| 159 | } |
| 160 | |
| 161 | @Test |
| 162 | public void getRole() { |
| 163 | connectDevice(DID1, SW1); |
tom | 80c0e5e | 2014-09-08 18:08:58 -0700 | [diff] [blame] | 164 | assertEquals("incorrect role", MastershipRole.MASTER, service.getRole(DID1)); |
tom | e5ec3fd | 2014-09-04 15:18:06 -0700 | [diff] [blame] | 165 | } |
| 166 | |
tom | b41d1ac | 2014-09-24 01:51:24 -0700 | [diff] [blame] | 167 | @Ignore("disabled until we settle the device-mastership wiring") |
tom | e5ec3fd | 2014-09-04 15:18:06 -0700 | [diff] [blame] | 168 | @Test |
tom | 5f35f7c | 2014-09-08 18:38:19 -0700 | [diff] [blame] | 169 | public void setRole() throws InterruptedException { |
tom | e5ec3fd | 2014-09-04 15:18:06 -0700 | [diff] [blame] | 170 | connectDevice(DID1, SW1); |
tom | e5ec3fd | 2014-09-04 15:18:06 -0700 | [diff] [blame] | 171 | validateEvents(DEVICE_ADDED, DEVICE_MASTERSHIP_CHANGED); |
tom | 80c0e5e | 2014-09-08 18:08:58 -0700 | [diff] [blame] | 172 | assertEquals("incorrect role", MastershipRole.STANDBY, service.getRole(DID1)); |
tom | e5ec3fd | 2014-09-04 15:18:06 -0700 | [diff] [blame] | 173 | assertEquals("incorrect device", DID1, provider.deviceReceived.id()); |
tom | 80c0e5e | 2014-09-08 18:08:58 -0700 | [diff] [blame] | 174 | assertEquals("incorrect role", MastershipRole.STANDBY, provider.roleReceived); |
tom | e5ec3fd | 2014-09-04 15:18:06 -0700 | [diff] [blame] | 175 | } |
| 176 | |
tom | 24c55cd | 2014-09-06 10:47:25 -0700 | [diff] [blame] | 177 | @Test |
| 178 | public void updatePorts() { |
| 179 | connectDevice(DID1, SW1); |
| 180 | List<PortDescription> pds = new ArrayList<>(); |
| 181 | pds.add(new DefaultPortDescription(P1, true)); |
| 182 | pds.add(new DefaultPortDescription(P2, true)); |
| 183 | pds.add(new DefaultPortDescription(P3, true)); |
| 184 | providerService.updatePorts(DID1, pds); |
| 185 | validateEvents(DEVICE_ADDED, PORT_ADDED, PORT_ADDED, PORT_ADDED); |
| 186 | pds.clear(); |
tom | e5ec3fd | 2014-09-04 15:18:06 -0700 | [diff] [blame] | 187 | |
tom | 24c55cd | 2014-09-06 10:47:25 -0700 | [diff] [blame] | 188 | pds.add(new DefaultPortDescription(P1, false)); |
| 189 | pds.add(new DefaultPortDescription(P3, true)); |
| 190 | providerService.updatePorts(DID1, pds); |
| 191 | validateEvents(PORT_UPDATED, PORT_REMOVED); |
| 192 | } |
| 193 | |
| 194 | @Test |
| 195 | public void updatePortStatus() { |
| 196 | connectDevice(DID1, SW1); |
| 197 | List<PortDescription> pds = new ArrayList<>(); |
| 198 | pds.add(new DefaultPortDescription(P1, true)); |
| 199 | pds.add(new DefaultPortDescription(P2, true)); |
| 200 | providerService.updatePorts(DID1, pds); |
| 201 | validateEvents(DEVICE_ADDED, PORT_ADDED, PORT_ADDED); |
| 202 | |
| 203 | providerService.portStatusChanged(DID1, new DefaultPortDescription(P1, false)); |
| 204 | validateEvents(PORT_UPDATED); |
| 205 | providerService.portStatusChanged(DID1, new DefaultPortDescription(P1, false)); |
| 206 | assertTrue("no events expected", listener.events.isEmpty()); |
| 207 | } |
| 208 | |
| 209 | @Test |
| 210 | public void getPorts() { |
| 211 | connectDevice(DID1, SW1); |
| 212 | List<PortDescription> pds = new ArrayList<>(); |
| 213 | pds.add(new DefaultPortDescription(P1, true)); |
| 214 | pds.add(new DefaultPortDescription(P2, true)); |
| 215 | providerService.updatePorts(DID1, pds); |
| 216 | validateEvents(DEVICE_ADDED, PORT_ADDED, PORT_ADDED); |
| 217 | assertEquals("wrong port count", 2, service.getPorts(DID1).size()); |
| 218 | |
| 219 | Port port = service.getPort(DID1, P1); |
| 220 | assertEquals("incorrect port", P1, service.getPort(DID1, P1).number()); |
| 221 | assertEquals("incorrect state", true, service.getPort(DID1, P1).isEnabled()); |
| 222 | } |
| 223 | |
| 224 | @Test |
| 225 | public void removeDevice() { |
| 226 | connectDevice(DID1, SW1); |
| 227 | connectDevice(DID2, SW2); |
tom | ad2d209 | 2014-09-06 23:24:20 -0700 | [diff] [blame] | 228 | assertEquals("incorrect device count", 2, service.getDeviceCount()); |
tom | 24c55cd | 2014-09-06 10:47:25 -0700 | [diff] [blame] | 229 | admin.removeDevice(DID1); |
| 230 | assertNull("device should not be found", service.getDevice(DID1)); |
| 231 | assertNotNull("device should be found", service.getDevice(DID2)); |
tom | ad2d209 | 2014-09-06 23:24:20 -0700 | [diff] [blame] | 232 | assertEquals("incorrect device count", 1, service.getDeviceCount()); |
| 233 | |
tom | 24c55cd | 2014-09-06 10:47:25 -0700 | [diff] [blame] | 234 | } |
tom | e5ec3fd | 2014-09-04 15:18:06 -0700 | [diff] [blame] | 235 | |
| 236 | protected void validateEvents(Enum... types) { |
| 237 | int i = 0; |
| 238 | assertEquals("wrong events received", types.length, listener.events.size()); |
| 239 | for (Event event : listener.events) { |
| 240 | assertEquals("incorrect event type", types[i], event.type()); |
| 241 | i++; |
| 242 | } |
| 243 | listener.events.clear(); |
| 244 | } |
| 245 | |
| 246 | |
| 247 | private class TestProvider extends AbstractProvider implements DeviceProvider { |
| 248 | private Device deviceReceived; |
| 249 | private MastershipRole roleReceived; |
| 250 | |
| 251 | public TestProvider() { |
| 252 | super(PID); |
| 253 | } |
| 254 | |
| 255 | @Override |
| 256 | public void triggerProbe(Device device) { |
| 257 | } |
| 258 | |
| 259 | @Override |
| 260 | public void roleChanged(Device device, MastershipRole newRole) { |
| 261 | deviceReceived = device; |
| 262 | roleReceived = newRole; |
| 263 | } |
| 264 | } |
| 265 | |
| 266 | private static class TestListener implements DeviceListener { |
| 267 | final List<DeviceEvent> events = new ArrayList<>(); |
| 268 | |
| 269 | @Override |
| 270 | public void event(DeviceEvent event) { |
| 271 | events.add(event); |
| 272 | } |
| 273 | } |
| 274 | |
tom | b41d1ac | 2014-09-24 01:51:24 -0700 | [diff] [blame] | 275 | private static class TestMastershipService extends MastershipServiceAdapter { |
Ayaka Koshibe | a7f044e | 2014-09-23 16:56:20 -0700 | [diff] [blame] | 276 | @Override |
tom | b41d1ac | 2014-09-24 01:51:24 -0700 | [diff] [blame] | 277 | public MastershipRole getLocalRole(DeviceId deviceId) { |
| 278 | return MastershipRole.MASTER; |
Ayaka Koshibe | a7f044e | 2014-09-23 16:56:20 -0700 | [diff] [blame] | 279 | } |
| 280 | |
| 281 | @Override |
| 282 | public Set<DeviceId> getDevicesOf(NodeId nodeId) { |
| 283 | return Sets.newHashSet(DID1, DID2); |
| 284 | } |
| 285 | |
| 286 | @Override |
| 287 | public MastershipRole requestRoleFor(DeviceId deviceId) { |
| 288 | return MastershipRole.MASTER; |
| 289 | } |
Yuta HIGUCHI | 33faeaf | 2014-10-07 18:19:44 -0700 | [diff] [blame] | 290 | |
| 291 | @Override |
| 292 | public MastershipTermService requestTermService() { |
| 293 | return new MastershipTermService() { |
| 294 | @Override |
| 295 | public MastershipTerm getMastershipTerm(DeviceId deviceId) { |
| 296 | // FIXME: just returning something not null |
| 297 | return MastershipTerm.of(NID_LOCAL, 1); |
| 298 | } |
| 299 | }; |
| 300 | } |
Ayaka Koshibe | a7f044e | 2014-09-23 16:56:20 -0700 | [diff] [blame] | 301 | } |
| 302 | |
Yuta HIGUCHI | 33faeaf | 2014-10-07 18:19:44 -0700 | [diff] [blame] | 303 | // code clone |
| 304 | private final class TestClusterService implements ClusterService { |
| 305 | |
| 306 | ControllerNode local = new DefaultControllerNode(NID_LOCAL, LOCALHOST); |
| 307 | |
| 308 | @Override |
| 309 | public ControllerNode getLocalNode() { |
| 310 | return local; |
| 311 | } |
| 312 | |
| 313 | @Override |
| 314 | public Set<ControllerNode> getNodes() { |
| 315 | return null; |
| 316 | } |
| 317 | |
| 318 | @Override |
| 319 | public ControllerNode getNode(NodeId nodeId) { |
| 320 | return null; |
| 321 | } |
| 322 | |
| 323 | @Override |
| 324 | public State getState(NodeId nodeId) { |
| 325 | return null; |
| 326 | } |
| 327 | |
| 328 | @Override |
| 329 | public void addListener(ClusterEventListener listener) { |
| 330 | } |
| 331 | |
| 332 | @Override |
| 333 | public void removeListener(ClusterEventListener listener) { |
| 334 | } |
| 335 | } |
| 336 | |
| 337 | private final class TestClockProviderService implements |
| 338 | ClockProviderService { |
| 339 | |
| 340 | @Override |
| 341 | public void setMastershipTerm(DeviceId deviceId, MastershipTerm term) { |
| 342 | // TODO Auto-generated method stub |
| 343 | } |
| 344 | } |
tom | e5ec3fd | 2014-09-04 15:18:06 -0700 | [diff] [blame] | 345 | } |