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