tom | be98831 | 2014-09-19 18:38:47 -0700 | [diff] [blame] | 1 | package org.onlab.onos.net.flow.impl; |
Ayaka Koshibe | b55524f | 2014-09-18 09:59:24 -0700 | [diff] [blame] | 2 | |
| 3 | import static org.junit.Assert.assertEquals; |
| 4 | import static org.junit.Assert.assertFalse; |
| 5 | import static org.junit.Assert.assertNotNull; |
| 6 | import static org.junit.Assert.assertTrue; |
alshabib | 9704490 | 2014-09-18 14:52:16 -0700 | [diff] [blame] | 7 | import static org.onlab.onos.net.flow.FlowRuleEvent.Type.RULE_ADDED; |
| 8 | import static org.onlab.onos.net.flow.FlowRuleEvent.Type.RULE_REMOVED; |
alshabib | 219ebaa | 2014-09-22 15:41:24 -0700 | [diff] [blame] | 9 | import static org.onlab.onos.net.flow.FlowRuleEvent.Type.RULE_UPDATED; |
Ayaka Koshibe | b55524f | 2014-09-18 09:59:24 -0700 | [diff] [blame] | 10 | |
| 11 | import java.util.ArrayList; |
| 12 | import java.util.List; |
| 13 | |
| 14 | import org.junit.After; |
| 15 | import org.junit.Before; |
| 16 | import org.junit.Test; |
alshabib | a68eb96 | 2014-09-24 20:34:13 -0700 | [diff] [blame^] | 17 | import org.onlab.onos.ApplicationId; |
Ayaka Koshibe | b55524f | 2014-09-18 09:59:24 -0700 | [diff] [blame] | 18 | import org.onlab.onos.event.impl.TestEventDispatcher; |
| 19 | import org.onlab.onos.net.DefaultDevice; |
| 20 | import org.onlab.onos.net.Device; |
| 21 | import org.onlab.onos.net.Device.Type; |
| 22 | import org.onlab.onos.net.DeviceId; |
| 23 | import org.onlab.onos.net.MastershipRole; |
| 24 | import org.onlab.onos.net.Port; |
| 25 | import org.onlab.onos.net.PortNumber; |
| 26 | import org.onlab.onos.net.device.DeviceListener; |
| 27 | import org.onlab.onos.net.device.DeviceService; |
Ayaka Koshibe | b55524f | 2014-09-18 09:59:24 -0700 | [diff] [blame] | 28 | import org.onlab.onos.net.flow.DefaultFlowRule; |
Ayaka Koshibe | b55524f | 2014-09-18 09:59:24 -0700 | [diff] [blame] | 29 | import org.onlab.onos.net.flow.FlowRule; |
alshabib | bb8b128 | 2014-09-22 17:00:18 -0700 | [diff] [blame] | 30 | import org.onlab.onos.net.flow.FlowRule.FlowRuleState; |
Ayaka Koshibe | b55524f | 2014-09-18 09:59:24 -0700 | [diff] [blame] | 31 | import org.onlab.onos.net.flow.FlowRuleEvent; |
| 32 | import org.onlab.onos.net.flow.FlowRuleListener; |
| 33 | import org.onlab.onos.net.flow.FlowRuleProvider; |
| 34 | import org.onlab.onos.net.flow.FlowRuleProviderRegistry; |
| 35 | import org.onlab.onos.net.flow.FlowRuleProviderService; |
| 36 | import org.onlab.onos.net.flow.FlowRuleService; |
| 37 | import org.onlab.onos.net.flow.TrafficSelector; |
| 38 | import org.onlab.onos.net.flow.TrafficTreatment; |
| 39 | import org.onlab.onos.net.flow.criteria.Criterion; |
| 40 | import org.onlab.onos.net.flow.instructions.Instruction; |
| 41 | import org.onlab.onos.net.provider.AbstractProvider; |
| 42 | import org.onlab.onos.net.provider.ProviderId; |
alshabib | 219ebaa | 2014-09-22 15:41:24 -0700 | [diff] [blame] | 43 | import org.onlab.onos.net.trivial.impl.SimpleFlowRuleStore; |
Ayaka Koshibe | b55524f | 2014-09-18 09:59:24 -0700 | [diff] [blame] | 44 | |
| 45 | import com.google.common.collect.Lists; |
| 46 | import com.google.common.collect.Sets; |
| 47 | |
Ayaka Koshibe | b55524f | 2014-09-18 09:59:24 -0700 | [diff] [blame] | 48 | /** |
| 49 | * Test codifying the flow rule service & flow rule provider service contracts. |
| 50 | */ |
tom | 202175a | 2014-09-19 19:00:11 -0700 | [diff] [blame] | 51 | public class FlowRuleManagerTest { |
Ayaka Koshibe | b55524f | 2014-09-18 09:59:24 -0700 | [diff] [blame] | 52 | |
tom | f6ab215 | 2014-09-18 12:08:29 -0700 | [diff] [blame] | 53 | private static final ProviderId PID = new ProviderId("of", "foo"); |
Ayaka Koshibe | b55524f | 2014-09-18 09:59:24 -0700 | [diff] [blame] | 54 | private static final DeviceId DID = DeviceId.deviceId("of:001"); |
| 55 | private static final Device DEV = new DefaultDevice( |
| 56 | PID, DID, Type.SWITCH, "", "", "", ""); |
| 57 | |
tom | 202175a | 2014-09-19 19:00:11 -0700 | [diff] [blame] | 58 | private FlowRuleManager mgr; |
Ayaka Koshibe | b55524f | 2014-09-18 09:59:24 -0700 | [diff] [blame] | 59 | |
| 60 | protected FlowRuleService service; |
| 61 | protected FlowRuleProviderRegistry registry; |
alshabib | bb8b128 | 2014-09-22 17:00:18 -0700 | [diff] [blame] | 62 | protected FlowRuleProviderService providerService; |
Ayaka Koshibe | b55524f | 2014-09-18 09:59:24 -0700 | [diff] [blame] | 63 | protected TestProvider provider; |
| 64 | protected TestListener listener = new TestListener(); |
alshabib | a68eb96 | 2014-09-24 20:34:13 -0700 | [diff] [blame^] | 65 | private ApplicationId appId; |
Ayaka Koshibe | b55524f | 2014-09-18 09:59:24 -0700 | [diff] [blame] | 66 | |
| 67 | @Before |
| 68 | public void setUp() { |
tom | 202175a | 2014-09-19 19:00:11 -0700 | [diff] [blame] | 69 | mgr = new FlowRuleManager(); |
tom | be98831 | 2014-09-19 18:38:47 -0700 | [diff] [blame] | 70 | mgr.store = new SimpleFlowRuleStore(); |
Ayaka Koshibe | b55524f | 2014-09-18 09:59:24 -0700 | [diff] [blame] | 71 | mgr.eventDispatcher = new TestEventDispatcher(); |
| 72 | mgr.deviceService = new TestDeviceService(); |
| 73 | service = mgr; |
| 74 | registry = mgr; |
| 75 | |
| 76 | mgr.activate(); |
| 77 | mgr.addListener(listener); |
| 78 | provider = new TestProvider(PID); |
alshabib | bb8b128 | 2014-09-22 17:00:18 -0700 | [diff] [blame] | 79 | providerService = registry.register(provider); |
alshabib | a68eb96 | 2014-09-24 20:34:13 -0700 | [diff] [blame^] | 80 | appId = ApplicationId.getAppId(); |
Ayaka Koshibe | b55524f | 2014-09-18 09:59:24 -0700 | [diff] [blame] | 81 | assertTrue("provider should be registered", |
| 82 | registry.getProviders().contains(provider.id())); |
| 83 | } |
| 84 | |
| 85 | @After |
| 86 | public void tearDown() { |
| 87 | registry.unregister(provider); |
| 88 | assertFalse("provider should not be registered", |
alshabib | 9704490 | 2014-09-18 14:52:16 -0700 | [diff] [blame] | 89 | registry.getProviders().contains(provider.id())); |
Ayaka Koshibe | b55524f | 2014-09-18 09:59:24 -0700 | [diff] [blame] | 90 | service.removeListener(listener); |
| 91 | mgr.deactivate(); |
| 92 | mgr.eventDispatcher = null; |
| 93 | mgr.deviceService = null; |
| 94 | } |
| 95 | |
| 96 | private FlowRule flowRule(int tsval, int trval) { |
| 97 | TestSelector ts = new TestSelector(tsval); |
| 98 | TestTreatment tr = new TestTreatment(trval); |
alshabib | a68eb96 | 2014-09-24 20:34:13 -0700 | [diff] [blame^] | 99 | return new DefaultFlowRule(DID, ts, tr, 0, appId); |
Ayaka Koshibe | b55524f | 2014-09-18 09:59:24 -0700 | [diff] [blame] | 100 | } |
| 101 | |
alshabib | bb8b128 | 2014-09-22 17:00:18 -0700 | [diff] [blame] | 102 | private FlowRule flowRule(FlowRule rule, FlowRuleState state) { |
| 103 | return new DefaultFlowRule(rule, state); |
| 104 | } |
| 105 | |
| 106 | private FlowRule addFlowRule(int hval) { |
Ayaka Koshibe | b55524f | 2014-09-18 09:59:24 -0700 | [diff] [blame] | 107 | FlowRule rule = flowRule(hval, hval); |
alshabib | bb8b128 | 2014-09-22 17:00:18 -0700 | [diff] [blame] | 108 | providerService.flowAdded(rule); |
Ayaka Koshibe | b55524f | 2014-09-18 09:59:24 -0700 | [diff] [blame] | 109 | assertNotNull("rule should be found", service.getFlowEntries(DID)); |
alshabib | bb8b128 | 2014-09-22 17:00:18 -0700 | [diff] [blame] | 110 | return rule; |
Ayaka Koshibe | b55524f | 2014-09-18 09:59:24 -0700 | [diff] [blame] | 111 | } |
| 112 | |
| 113 | private void validateEvents(FlowRuleEvent.Type ... events) { |
| 114 | if (events == null) { |
| 115 | assertTrue("events generated", listener.events.isEmpty()); |
| 116 | } |
| 117 | |
| 118 | int i = 0; |
| 119 | for (FlowRuleEvent e : listener.events) { |
| 120 | assertTrue("unexpected event", e.type().equals(events[i])); |
| 121 | i++; |
| 122 | } |
| 123 | |
| 124 | assertEquals("mispredicted number of events", |
| 125 | events.length, listener.events.size()); |
| 126 | |
| 127 | listener.events.clear(); |
| 128 | } |
| 129 | |
| 130 | private int flowCount() { |
| 131 | return Sets.newHashSet(service.getFlowEntries(DID)).size(); |
| 132 | } |
| 133 | @Test |
| 134 | public void getFlowEntries() { |
| 135 | assertTrue("store should be empty", |
| 136 | Sets.newHashSet(service.getFlowEntries(DID)).isEmpty()); |
| 137 | addFlowRule(1); |
| 138 | addFlowRule(2); |
| 139 | assertEquals("2 rules should exist", 2, flowCount()); |
| 140 | validateEvents(RULE_ADDED, RULE_ADDED); |
| 141 | |
| 142 | addFlowRule(1); |
| 143 | assertEquals("should still be 2 rules", 2, flowCount()); |
alshabib | 219ebaa | 2014-09-22 15:41:24 -0700 | [diff] [blame] | 144 | validateEvents(RULE_UPDATED); |
Ayaka Koshibe | b55524f | 2014-09-18 09:59:24 -0700 | [diff] [blame] | 145 | } |
| 146 | |
alshabib | bb8b128 | 2014-09-22 17:00:18 -0700 | [diff] [blame] | 147 | |
| 148 | //backing store is sensitive to the order of additions/removals |
| 149 | private boolean validateState(FlowRuleState... state) { |
| 150 | Iterable<FlowRule> rules = service.getFlowEntries(DID); |
| 151 | int i = 0; |
| 152 | for (FlowRule f : rules) { |
| 153 | if (f.state() != state[i]) { |
| 154 | return false; |
| 155 | } |
| 156 | i++; |
| 157 | } |
| 158 | return true; |
| 159 | } |
| 160 | |
Ayaka Koshibe | b55524f | 2014-09-18 09:59:24 -0700 | [diff] [blame] | 161 | @Test |
| 162 | public void applyFlowRules() { |
alshabib | bb8b128 | 2014-09-22 17:00:18 -0700 | [diff] [blame] | 163 | |
Ayaka Koshibe | b55524f | 2014-09-18 09:59:24 -0700 | [diff] [blame] | 164 | FlowRule r1 = flowRule(1, 1); |
alshabib | a68eb96 | 2014-09-24 20:34:13 -0700 | [diff] [blame^] | 165 | FlowRule r2 = flowRule(2, 2); |
| 166 | FlowRule r3 = flowRule(3, 3); |
Ayaka Koshibe | b55524f | 2014-09-18 09:59:24 -0700 | [diff] [blame] | 167 | |
Ayaka Koshibe | b55524f | 2014-09-18 09:59:24 -0700 | [diff] [blame] | 168 | assertTrue("store should be empty", |
| 169 | Sets.newHashSet(service.getFlowEntries(DID)).isEmpty()); |
alshabib | 219ebaa | 2014-09-22 15:41:24 -0700 | [diff] [blame] | 170 | mgr.applyFlowRules(r1, r2, r3); |
Ayaka Koshibe | b55524f | 2014-09-18 09:59:24 -0700 | [diff] [blame] | 171 | assertEquals("3 rules should exist", 3, flowCount()); |
alshabib | bb8b128 | 2014-09-22 17:00:18 -0700 | [diff] [blame] | 172 | assertTrue("Entries should be pending add.", |
| 173 | validateState(FlowRuleState.PENDING_ADD, FlowRuleState.PENDING_ADD, |
| 174 | FlowRuleState.PENDING_ADD)); |
Ayaka Koshibe | b55524f | 2014-09-18 09:59:24 -0700 | [diff] [blame] | 175 | } |
| 176 | |
| 177 | @Test |
| 178 | public void removeFlowRules() { |
alshabib | bb8b128 | 2014-09-22 17:00:18 -0700 | [diff] [blame] | 179 | FlowRule f1 = addFlowRule(1); |
| 180 | FlowRule f2 = addFlowRule(2); |
Ayaka Koshibe | b55524f | 2014-09-18 09:59:24 -0700 | [diff] [blame] | 181 | addFlowRule(3); |
| 182 | assertEquals("3 rules should exist", 3, flowCount()); |
| 183 | validateEvents(RULE_ADDED, RULE_ADDED, RULE_ADDED); |
| 184 | |
alshabib | bb8b128 | 2014-09-22 17:00:18 -0700 | [diff] [blame] | 185 | FlowRule rem1 = flowRule(f1, FlowRuleState.REMOVED); |
| 186 | FlowRule rem2 = flowRule(f2, FlowRuleState.REMOVED); |
Ayaka Koshibe | b55524f | 2014-09-18 09:59:24 -0700 | [diff] [blame] | 187 | mgr.removeFlowRules(rem1, rem2); |
| 188 | //removing from north, so no events generated |
| 189 | validateEvents(); |
alshabib | 219ebaa | 2014-09-22 15:41:24 -0700 | [diff] [blame] | 190 | assertEquals("3 rule should exist", 3, flowCount()); |
alshabib | bb8b128 | 2014-09-22 17:00:18 -0700 | [diff] [blame] | 191 | assertTrue("Entries should be pending remove.", |
| 192 | validateState(FlowRuleState.CREATED, FlowRuleState.PENDING_REMOVE, |
| 193 | FlowRuleState.PENDING_REMOVE)); |
Ayaka Koshibe | b55524f | 2014-09-18 09:59:24 -0700 | [diff] [blame] | 194 | |
| 195 | mgr.removeFlowRules(rem1); |
alshabib | 219ebaa | 2014-09-22 15:41:24 -0700 | [diff] [blame] | 196 | assertEquals("3 rule should still exist", 3, flowCount()); |
Ayaka Koshibe | b55524f | 2014-09-18 09:59:24 -0700 | [diff] [blame] | 197 | } |
| 198 | |
| 199 | @Test |
| 200 | public void flowRemoved() { |
alshabib | bb8b128 | 2014-09-22 17:00:18 -0700 | [diff] [blame] | 201 | FlowRule f1 = addFlowRule(1); |
alshabib | a68eb96 | 2014-09-24 20:34:13 -0700 | [diff] [blame^] | 202 | service.removeFlowRules(f1); |
Ayaka Koshibe | b55524f | 2014-09-18 09:59:24 -0700 | [diff] [blame] | 203 | addFlowRule(2); |
alshabib | bb8b128 | 2014-09-22 17:00:18 -0700 | [diff] [blame] | 204 | FlowRule rem1 = flowRule(f1, FlowRuleState.REMOVED); |
| 205 | providerService.flowRemoved(rem1); |
Ayaka Koshibe | b55524f | 2014-09-18 09:59:24 -0700 | [diff] [blame] | 206 | validateEvents(RULE_ADDED, RULE_ADDED, RULE_REMOVED); |
| 207 | |
alshabib | bb8b128 | 2014-09-22 17:00:18 -0700 | [diff] [blame] | 208 | providerService.flowRemoved(rem1); |
Ayaka Koshibe | b55524f | 2014-09-18 09:59:24 -0700 | [diff] [blame] | 209 | validateEvents(); |
| 210 | } |
| 211 | |
alshabib | bb8b128 | 2014-09-22 17:00:18 -0700 | [diff] [blame] | 212 | @Test |
| 213 | public void flowMetrics() { |
| 214 | FlowRule f1 = flowRule(1, 1); |
| 215 | FlowRule f2 = flowRule(2, 2); |
| 216 | FlowRule f3 = flowRule(3, 3); |
| 217 | |
| 218 | FlowRule updatedF1 = flowRule(f1, FlowRuleState.ADDED); |
| 219 | FlowRule updatedF2 = flowRule(f2, FlowRuleState.ADDED); |
| 220 | mgr.applyFlowRules(f1, f2, f3); |
| 221 | |
| 222 | providerService.pushFlowMetrics(DID, Lists.newArrayList(updatedF1, updatedF2)); |
| 223 | |
| 224 | assertTrue("Entries should be added.", |
| 225 | validateState(FlowRuleState.PENDING_ADD, FlowRuleState.ADDED, |
| 226 | FlowRuleState.ADDED)); |
| 227 | //TODO: add tests for flowmissing and extraneous flows |
| 228 | } |
| 229 | |
Ayaka Koshibe | b55524f | 2014-09-18 09:59:24 -0700 | [diff] [blame] | 230 | private static class TestListener implements FlowRuleListener { |
| 231 | final List<FlowRuleEvent> events = new ArrayList<>(); |
| 232 | |
| 233 | @Override |
| 234 | public void event(FlowRuleEvent event) { |
| 235 | events.add(event); |
| 236 | } |
| 237 | } |
| 238 | |
| 239 | private static class TestDeviceService implements DeviceService { |
| 240 | |
| 241 | @Override |
| 242 | public int getDeviceCount() { |
| 243 | return 0; |
| 244 | } |
| 245 | |
| 246 | @Override |
| 247 | public Iterable<Device> getDevices() { |
| 248 | return null; |
| 249 | } |
| 250 | |
| 251 | @Override |
| 252 | public Device getDevice(DeviceId deviceId) { |
| 253 | return DEV; |
| 254 | } |
| 255 | |
| 256 | @Override |
| 257 | public MastershipRole getRole(DeviceId deviceId) { |
| 258 | return null; |
| 259 | } |
| 260 | |
| 261 | @Override |
| 262 | public List<Port> getPorts(DeviceId deviceId) { |
| 263 | return null; |
| 264 | } |
| 265 | |
| 266 | @Override |
| 267 | public Port getPort(DeviceId deviceId, PortNumber portNumber) { |
| 268 | return null; |
| 269 | } |
| 270 | |
| 271 | @Override |
| 272 | public boolean isAvailable(DeviceId deviceId) { |
| 273 | return false; |
| 274 | } |
| 275 | |
| 276 | @Override |
| 277 | public void addListener(DeviceListener listener) { |
| 278 | } |
| 279 | |
| 280 | @Override |
| 281 | public void removeListener(DeviceListener listener) { |
| 282 | } |
| 283 | |
| 284 | } |
| 285 | |
| 286 | private class TestProvider extends AbstractProvider implements FlowRuleProvider { |
| 287 | |
| 288 | protected TestProvider(ProviderId id) { |
| 289 | super(PID); |
| 290 | } |
| 291 | |
| 292 | @Override |
| 293 | public void applyFlowRule(FlowRule... flowRules) { |
| 294 | } |
| 295 | |
| 296 | @Override |
| 297 | public void removeFlowRule(FlowRule... flowRules) { |
| 298 | } |
| 299 | |
alshabib | a68eb96 | 2014-09-24 20:34:13 -0700 | [diff] [blame^] | 300 | @Override |
| 301 | public void removeRulesById(ApplicationId id, FlowRule... flowRules) { |
| 302 | } |
| 303 | |
| 304 | |
Ayaka Koshibe | b55524f | 2014-09-18 09:59:24 -0700 | [diff] [blame] | 305 | } |
| 306 | |
| 307 | private class TestSelector implements TrafficSelector { |
| 308 | |
| 309 | //for controlling hashcode uniqueness; |
alshabib | 9704490 | 2014-09-18 14:52:16 -0700 | [diff] [blame] | 310 | private final int testval; |
Ayaka Koshibe | b55524f | 2014-09-18 09:59:24 -0700 | [diff] [blame] | 311 | |
| 312 | public TestSelector(int val) { |
| 313 | testval = val; |
| 314 | } |
| 315 | |
| 316 | @Override |
| 317 | public List<Criterion> criteria() { |
| 318 | return null; |
| 319 | } |
| 320 | |
| 321 | @Override |
| 322 | public int hashCode() { |
| 323 | return testval; |
| 324 | } |
| 325 | |
| 326 | @Override |
| 327 | public boolean equals(Object o) { |
| 328 | if (o instanceof TestSelector) { |
| 329 | return this.testval == ((TestSelector) o).testval; |
| 330 | } |
| 331 | return false; |
| 332 | } |
| 333 | } |
| 334 | |
| 335 | private class TestTreatment implements TrafficTreatment { |
| 336 | |
| 337 | //for controlling hashcode uniqueness; |
alshabib | 9704490 | 2014-09-18 14:52:16 -0700 | [diff] [blame] | 338 | private final int testval; |
Ayaka Koshibe | b55524f | 2014-09-18 09:59:24 -0700 | [diff] [blame] | 339 | |
| 340 | public TestTreatment(int val) { |
| 341 | testval = val; |
| 342 | } |
| 343 | |
| 344 | @Override |
| 345 | public List<Instruction> instructions() { |
| 346 | return null; |
| 347 | } |
| 348 | |
| 349 | @Override |
| 350 | public int hashCode() { |
| 351 | return testval; |
| 352 | } |
| 353 | |
| 354 | @Override |
| 355 | public boolean equals(Object o) { |
| 356 | if (o instanceof TestTreatment) { |
| 357 | return this.testval == ((TestTreatment) o).testval; |
| 358 | } |
| 359 | return false; |
| 360 | } |
| 361 | |
| 362 | } |
| 363 | |
| 364 | } |