Fix comparison between port numbers in match
[openflowplugin.git] / openflowplugin-impl / src / test / java / org / opendaylight / openflowplugin / impl / registry / flow / FlowRegistryKeyFactoryTest.java
1 /*
2  * Copyright (c) 2015 Cisco Systems, Inc. and others.  All rights reserved.
3  *
4  * This program and the accompanying materials are made available under the
5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
6  * and is available at http://www.eclipse.org/legal/epl-v10.html
7  */
8
9 package org.opendaylight.openflowplugin.impl.registry.flow;
10
11 import static org.junit.Assert.assertEquals;
12 import static org.junit.Assert.assertNotEquals;
13
14 import java.math.BigInteger;
15 import java.util.ArrayList;
16 import java.util.HashSet;
17 import java.util.List;
18 import org.junit.Assert;
19 import org.junit.Before;
20 import org.junit.Test;
21 import org.junit.runner.RunWith;
22 import org.mockito.Mock;
23 import org.mockito.Mockito;
24 import org.mockito.runners.MockitoJUnitRunner;
25 import org.opendaylight.openflowplugin.api.OFConstants;
26 import org.opendaylight.openflowplugin.api.openflow.device.DeviceContext;
27 import org.opendaylight.openflowplugin.api.openflow.device.DeviceInfo;
28 import org.opendaylight.openflowplugin.api.openflow.device.DeviceState;
29 import org.opendaylight.openflowplugin.api.openflow.registry.flow.FlowRegistryKey;
30 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Prefix;
31 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.table.FlowBuilder;
32 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.statistics.rev130819.FlowsStatisticsUpdate;
33 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.statistics.rev130819.FlowsStatisticsUpdateBuilder;
34 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.statistics.rev130819.flow.and.statistics.map.list.FlowAndStatisticsMapList;
35 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.statistics.rev130819.flow.and.statistics.map.list.FlowAndStatisticsMapListBuilder;
36 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.FlowCookie;
37 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.flow.MatchBuilder;
38 import org.opendaylight.yang.gen.v1.urn.opendaylight.model.match.types.rev131026.match.layer._3.match.Ipv4MatchBuilder;
39 import org.slf4j.Logger;
40 import org.slf4j.LoggerFactory;
41
42 @RunWith(MockitoJUnitRunner.class)
43 public class FlowRegistryKeyFactoryTest {
44
45     private static final Logger LOG = LoggerFactory.getLogger(FlowRegistryKeyFactoryTest.class);
46
47
48     private static final FlowsStatisticsUpdateBuilder FLOWS_STATISTICS_UPDATE_BUILDER = new FlowsStatisticsUpdateBuilder();
49     @Mock
50     private DeviceContext deviceContext;
51     @Mock
52     private DeviceState deviceState;
53     @Mock
54     private DeviceInfo deviceInfo;
55
56
57     @Before
58     public void setup() {
59         List<FlowAndStatisticsMapList> flowAndStatisticsMapListList = new ArrayList<>();
60         for (int i = 1; i < 4; i++) {
61             flowAndStatisticsMapListList.add(TestFlowHelper.createFlowAndStatisticsMapListBuilder(i).build());
62         }
63         FLOWS_STATISTICS_UPDATE_BUILDER.setFlowAndStatisticsMapList(flowAndStatisticsMapListList);
64         Mockito.when(deviceContext.getDeviceState()).thenReturn(deviceState);
65         Mockito.when(deviceInfo.getVersion()).thenReturn(OFConstants.OFP_VERSION_1_3);
66     }
67
68     @Test
69     public void testEquals() throws Exception {
70         FlowsStatisticsUpdate flowStats = FLOWS_STATISTICS_UPDATE_BUILDER.build();
71
72         HashSet<FlowRegistryKey> flowRegistryKeys = new HashSet<>();
73         for (FlowAndStatisticsMapList item : flowStats.getFlowAndStatisticsMapList()) {
74             final FlowRegistryKey key1 = FlowRegistryKeyFactory.create(deviceInfo.getVersion(), item);
75             final FlowRegistryKey key2 = FlowRegistryKeyFactory.create(deviceInfo.getVersion(), item);
76             flowRegistryKeys.add(key1);
77             flowRegistryKeys.add(key1);
78             flowRegistryKeys.add(key2);
79         }
80         assertEquals(3, flowRegistryKeys.size());
81     }
82
83     @Test
84     public void testEqualsNegative() throws Exception {
85         final FlowAndStatisticsMapList flowStatisticsMapList1 = TestFlowHelper.createFlowAndStatisticsMapListBuilder(1).build();
86         final FlowRegistryKey key1 = FlowRegistryKeyFactory.create(deviceInfo.getVersion(), flowStatisticsMapList1);
87
88         FlowRegistryKey key2;
89         FlowAndStatisticsMapListBuilder flowStatisticsMapListBld2;
90
91         // different priority
92         flowStatisticsMapListBld2 = new FlowAndStatisticsMapListBuilder(flowStatisticsMapList1);
93         flowStatisticsMapListBld2.setPriority(flowStatisticsMapListBld2.getPriority() + 1);
94         key2 = FlowRegistryKeyFactory.create(deviceInfo.getVersion(), flowStatisticsMapListBld2.build());
95         Assert.assertFalse(key1.equals(key2));
96
97         // different match
98         flowStatisticsMapListBld2 = new FlowAndStatisticsMapListBuilder(flowStatisticsMapList1);
99         flowStatisticsMapListBld2.setMatch(new MatchBuilder().build());
100         key2 = FlowRegistryKeyFactory.create(deviceInfo.getVersion(), flowStatisticsMapListBld2.build());
101         Assert.assertFalse(key1.equals(key2));
102
103         // different tableId
104         flowStatisticsMapListBld2 = new FlowAndStatisticsMapListBuilder(flowStatisticsMapList1);
105         flowStatisticsMapListBld2.setTableId((short) (flowStatisticsMapListBld2.getTableId() + 1));
106         key2 = FlowRegistryKeyFactory.create(deviceInfo.getVersion(), flowStatisticsMapListBld2.build());
107         Assert.assertFalse(key1.equals(key2));
108
109         Assert.assertFalse(key1.equals(null));
110     }
111
112     @Test
113     public void testGetHash2() throws Exception {
114         MatchBuilder match1Builder = new MatchBuilder().setLayer3Match(new Ipv4MatchBuilder()
115                 .setIpv4Destination(new Ipv4Prefix("10.0.1.157/32")).build());
116         FlowBuilder flow1Builder = new FlowBuilder()
117                 .setCookie(new FlowCookie(BigInteger.valueOf(483)))
118                 .setMatch(match1Builder.build())
119                 .setPriority(2)
120                 .setTableId((short) 0);
121
122         FlowRegistryKey flow1Hash = FlowRegistryKeyFactory.create(deviceInfo.getVersion(), flow1Builder.build());
123         LOG.info("flowHash1: {}", flow1Hash.hashCode());
124
125
126         MatchBuilder match2Builder = new MatchBuilder().setLayer3Match(new Ipv4MatchBuilder()
127                 .setIpv4Destination(new Ipv4Prefix("10.0.0.242/32")).build());
128         FlowBuilder flow2Builder = new FlowBuilder(flow1Builder.build())
129                 .setCookie(new FlowCookie(BigInteger.valueOf(148)))
130                 .setMatch(match2Builder.build());
131
132         FlowRegistryKey flow2Hash = FlowRegistryKeyFactory.create(deviceInfo.getVersion(), flow2Builder.build());
133         LOG.info("flowHash2: {}", flow2Hash.hashCode());
134
135         Assert.assertNotSame(flow1Hash, flow2Hash);
136     }
137
138     @Test
139     public void testGetHashNPE() throws Exception {
140         MatchBuilder match1Builder = new MatchBuilder().setLayer3Match(new Ipv4MatchBuilder()
141                 .setIpv4Destination(new Ipv4Prefix("10.0.1.157/32")).build());
142         FlowBuilder flow1Builder = new FlowBuilder()
143                 .setCookie(new FlowCookie(BigInteger.valueOf(483)))
144                 .setMatch(match1Builder.build())
145                 .setPriority(2)
146                 .setTableId((short) 0);
147
148         FlowBuilder fb1 = new FlowBuilder(flow1Builder.build());
149         fb1.setTableId(null);
150         try {
151             FlowRegistryKeyFactory.create(deviceInfo.getVersion(), fb1.build());
152             Assert.fail("hash creation should have failed because of NPE");
153         } catch (Exception e) {
154             // expected
155             Assert.assertEquals("flow tableId must not be null", e.getMessage());
156         }
157
158         FlowBuilder fb2 = new FlowBuilder(flow1Builder.build());
159         fb2.setPriority(null);
160         try {
161             FlowRegistryKeyFactory.create(deviceInfo.getVersion(), fb2.build());
162         } catch (Exception e) {
163             // not expected
164             Assert.fail("no exception was expected while hash was creating.");
165         }
166
167         FlowBuilder fb3 = new FlowBuilder(flow1Builder.build());
168         fb3.setCookie(null);
169         FlowRegistryKey flowRegistryKey = FlowRegistryKeyFactory.create(deviceInfo.getVersion(), fb3.build());
170         Assert.assertNotNull(flowRegistryKey.getCookie());
171         Assert.assertEquals(OFConstants.DEFAULT_COOKIE, flowRegistryKey.getCookie());
172     }
173
174     @Test
175     public void testGetHash() throws Exception {
176         FlowsStatisticsUpdate flowStats = FLOWS_STATISTICS_UPDATE_BUILDER.build();
177
178         for (FlowAndStatisticsMapList item : flowStats.getFlowAndStatisticsMapList()) {
179             FlowRegistryKey flowRegistryKey = FlowRegistryKeyFactory.create(deviceInfo.getVersion(), item);
180             FlowRegistryKey lastHash = null;
181             if (null != lastHash) {
182                 assertNotEquals(lastHash, flowRegistryKey);
183             } else {
184                 lastHash = flowRegistryKey;
185             }
186         }
187     }
188 }