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 =
  49             new FlowsStatisticsUpdateBuilder();
  50     @Mock
  51     private DeviceContext deviceContext;
  52     @Mock
  53     private DeviceState deviceState;
  54     @Mock
  55     private DeviceInfo deviceInfo;
  56
  57
  58     @Before
  59     public void setup() {
  60         List<FlowAndStatisticsMapList> flowAndStatisticsMapListList = new ArrayList<>();
  61         for (int i = 1; i < 4; i++) {
  62             flowAndStatisticsMapListList.add(TestFlowHelper.createFlowAndStatisticsMapListBuilder(i).build());
  63         }
  64         FLOWS_STATISTICS_UPDATE_BUILDER.setFlowAndStatisticsMapList(flowAndStatisticsMapListList);
  65         Mockito.when(deviceContext.getDeviceState()).thenReturn(deviceState);
  66         Mockito.when(deviceInfo.getVersion()).thenReturn(OFConstants.OFP_VERSION_1_3);
  67     }
  68
  69     @Test
  70     public void testEquals() throws Exception {
  71         FlowsStatisticsUpdate flowStats = FLOWS_STATISTICS_UPDATE_BUILDER.build();
  72
  73         HashSet<FlowRegistryKey> flowRegistryKeys = new HashSet<>();
  74         for (FlowAndStatisticsMapList item : flowStats.getFlowAndStatisticsMapList()) {
  75             final FlowRegistryKey key1 = FlowRegistryKeyFactory.create(deviceInfo.getVersion(), item);
  76             final FlowRegistryKey key2 = FlowRegistryKeyFactory.create(deviceInfo.getVersion(), item);
  77             flowRegistryKeys.add(key1);
  78             flowRegistryKeys.add(key1);
  79             flowRegistryKeys.add(key2);
  80         }
  81         assertEquals(3, flowRegistryKeys.size());
  82     }
  83
  84     @Test
  85     public void testEqualsNegative() throws Exception {
  86         final FlowAndStatisticsMapList flowStatisticsMapList1 =
  87                 TestFlowHelper.createFlowAndStatisticsMapListBuilder(1).build();
  88         final FlowRegistryKey key1 = FlowRegistryKeyFactory.create(deviceInfo.getVersion(), flowStatisticsMapList1);
  89
  90         FlowRegistryKey key2;
  91         FlowAndStatisticsMapListBuilder flowStatisticsMapListBld2;
  92
  93         // different priority
  94         flowStatisticsMapListBld2 = new FlowAndStatisticsMapListBuilder(flowStatisticsMapList1);
  95         flowStatisticsMapListBld2.setPriority(flowStatisticsMapListBld2.getPriority() + 1);
  96         key2 = FlowRegistryKeyFactory.create(deviceInfo.getVersion(), flowStatisticsMapListBld2.build());
  97         Assert.assertFalse(key1.equals(key2));
  98
  99         // different match
 100         flowStatisticsMapListBld2 = new FlowAndStatisticsMapListBuilder(flowStatisticsMapList1);
 101         flowStatisticsMapListBld2.setMatch(new MatchBuilder().build());
 102         key2 = FlowRegistryKeyFactory.create(deviceInfo.getVersion(), flowStatisticsMapListBld2.build());
 103         Assert.assertFalse(key1.equals(key2));
 104
 105         // different tableId
 106         flowStatisticsMapListBld2 = new FlowAndStatisticsMapListBuilder(flowStatisticsMapList1);
 107         flowStatisticsMapListBld2.setTableId((short) (flowStatisticsMapListBld2.getTableId() + 1));
 108         key2 = FlowRegistryKeyFactory.create(deviceInfo.getVersion(), flowStatisticsMapListBld2.build());
 109         Assert.assertFalse(key1.equals(key2));
 110
 111         Assert.assertFalse(key1.equals(null));
 112     }
 113
 114     @Test
 115     public void testGetHash2() throws Exception {
 116         MatchBuilder match1Builder = new MatchBuilder().setLayer3Match(new Ipv4MatchBuilder()
 117                 .setIpv4Destination(new Ipv4Prefix("10.0.1.157/32")).build());
 118         FlowBuilder flow1Builder = new FlowBuilder()
 119                 .setCookie(new FlowCookie(BigInteger.valueOf(483)))
 120                 .setMatch(match1Builder.build())
 121                 .setPriority(2)
 122                 .setTableId((short) 0);
 123
 124         FlowRegistryKey flow1Hash = FlowRegistryKeyFactory.create(deviceInfo.getVersion(), flow1Builder.build());
 125         LOG.info("flowHash1: {}", flow1Hash.hashCode());
 126
 127
 128         MatchBuilder match2Builder = new MatchBuilder().setLayer3Match(new Ipv4MatchBuilder()
 129                 .setIpv4Destination(new Ipv4Prefix("10.0.0.242/32")).build());
 130         FlowBuilder flow2Builder = new FlowBuilder(flow1Builder.build())
 131                 .setCookie(new FlowCookie(BigInteger.valueOf(148)))
 132                 .setMatch(match2Builder.build());
 133
 134         FlowRegistryKey flow2Hash = FlowRegistryKeyFactory.create(deviceInfo.getVersion(), flow2Builder.build());
 135         LOG.info("flowHash2: {}", flow2Hash.hashCode());
 136
 137         Assert.assertNotSame(flow1Hash, flow2Hash);
 138     }
 139
 140     @Test
 141     public void testGetHashNPE() throws Exception {
 142         MatchBuilder match1Builder = new MatchBuilder().setLayer3Match(new Ipv4MatchBuilder()
 143                 .setIpv4Destination(new Ipv4Prefix("10.0.1.157/32")).build());
 144         FlowBuilder flow1Builder = new FlowBuilder()
 145                 .setCookie(new FlowCookie(BigInteger.valueOf(483)))
 146                 .setMatch(match1Builder.build())
 147                 .setPriority(2)
 148                 .setTableId((short) 0);
 149
 150         FlowBuilder fb1 = new FlowBuilder(flow1Builder.build());
 151         fb1.setTableId(null);
 152         try {
 153             FlowRegistryKeyFactory.create(deviceInfo.getVersion(), fb1.build());
 154             Assert.fail("hash creation should have failed because of NPE");
 155         } catch (NullPointerException e) {
 156             // expected
 157             Assert.assertEquals("flow tableId must not be null", e.getMessage());
 158         }
 159
 160         FlowBuilder fb2 = new FlowBuilder(flow1Builder.build());
 161         fb2.setPriority(null);
 162         try {
 163             FlowRegistryKeyFactory.create(deviceInfo.getVersion(), fb2.build());
 164         } catch (NullPointerException e) {
 165             // not expected
 166             Assert.fail("no exception was expected while hash was creating.");
 167         }
 168
 169         FlowBuilder fb3 = new FlowBuilder(flow1Builder.build());
 170         fb3.setCookie(null);
 171         FlowRegistryKey flowRegistryKey = FlowRegistryKeyFactory.create(deviceInfo.getVersion(), fb3.build());
 172         Assert.assertNotNull(flowRegistryKey.getCookie());
 173         Assert.assertEquals(OFConstants.DEFAULT_COOKIE, flowRegistryKey.getCookie());
 174     }
 175
 176     @Test
 177     public void testGetHash() throws Exception {
 178         FlowsStatisticsUpdate flowStats = FLOWS_STATISTICS_UPDATE_BUILDER.build();
 179
 180         for (FlowAndStatisticsMapList item : flowStats.getFlowAndStatisticsMapList()) {
 181             FlowRegistryKey flowRegistryKey = FlowRegistryKeyFactory.create(deviceInfo.getVersion(), item);
 182             FlowRegistryKey lastHash = null;
 183             if (null != lastHash) {
 184                 assertNotEquals(lastHash, flowRegistryKey);
 185             } else {
 186                 lastHash = flowRegistryKey;
 187             }
 188         }
 189     }
 190 }