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