Fix "Bug 5589 - Deprecate PortNumberCache"
[openflowplugin.git] / openflowplugin-impl / src / test / java / org / opendaylight / openflowplugin / impl / translator / PacketReceivedTranslatorTest.java
1 package org.opendaylight.openflowplugin.impl.translator;
2
3 import com.google.common.collect.Lists;
4 import java.math.BigInteger;
5 import java.util.Arrays;
6 import java.util.List;
7
8 import org.junit.Assert;
9 import org.junit.Before;
10 import org.junit.Test;
11 import org.junit.runner.RunWith;
12 import org.mockito.Mock;
13 import org.mockito.Mockito;
14 import org.mockito.runners.MockitoJUnitRunner;
15 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
16 import org.opendaylight.openflowplugin.api.OFConstants;
17 import org.opendaylight.openflowplugin.api.openflow.connection.ConnectionContext;
18 import org.opendaylight.openflowplugin.api.openflow.device.DeviceContext;
19 import org.opendaylight.openflowplugin.api.openflow.device.DeviceState;
20 import org.opendaylight.openflowplugin.openflow.md.util.OpenflowPortsUtil;
21 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeId;
22 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.Nodes;
23 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.node.NodeConnector;
24 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.node.NodeConnectorKey;
25 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.Node;
26 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.NodeKey;
27 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.types.rev130731.PacketInReason;
28 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.types.rev130731.PortNumber;
29 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.types.rev130731.TableId;
30 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev150225.InPort;
31 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev150225.MatchField;
32 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev150225.OpenflowBasicClass;
33 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev150225.match.entries.grouping.MatchEntryBuilder;
34 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev150225.match.entry.value.grouping.match.entry.value.InPortCaseBuilder;
35 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev150225.match.entry.value.grouping.match.entry.value.in.port._case.InPortBuilder;
36 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev150225.match.grouping.MatchBuilder;
37 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.FeaturesReply;
38 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.GetFeaturesOutput;
39 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.PacketInMessage;
40 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.PacketInMessageBuilder;
41 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.features.reply.PhyPort;
42 import org.opendaylight.yang.gen.v1.urn.opendaylight.packet.service.rev130709.PacketReceived;
43 import org.opendaylight.yang.gen.v1.urn.opendaylight.packet.service.rev130709.packet.received.Match;
44 import org.opendaylight.yangtools.yang.binding.KeyedInstanceIdentifier;
45
46 /**
47  * Created by tkubas on 4/1/15.
48  */
49
50 @RunWith(MockitoJUnitRunner.class)
51 public class PacketReceivedTranslatorTest {
52
53     @Mock
54     ConnectionContext connectionContext;
55     @Mock
56     FeaturesReply featuresReply;
57     @Mock
58     GetFeaturesOutput getFeaturesOutput;
59     @Mock
60     DeviceState deviceState;
61     @Mock
62     DataBroker dataBroker;
63     @Mock
64     DeviceContext deviceContext;
65     @Mock
66     List<PhyPort> phyPorts;
67     @Mock
68     PhyPort phyPort;
69
70     static final Long PORT_NO = 5l;
71     static final String DATA = "Test_Data";
72     static final Long PORT_NUM_VALUE = 11l;
73
74     public PacketReceivedTranslatorTest() {
75         OpenflowPortsUtil.init();
76     }
77
78     @Before
79     public void setUp() throws Exception {
80         final List<PhyPort> phyPorts = Arrays.asList(phyPort);
81
82         Mockito.when(deviceContext.getPrimaryConnectionContext()).thenReturn(connectionContext);
83         Mockito.when(connectionContext.getFeatures()).thenReturn(featuresReply);
84         Mockito.when(featuresReply.getDatapathId()).thenReturn(BigInteger.TEN);
85         Mockito.when(deviceContext.getDeviceState()).thenReturn(deviceState);
86         Mockito.when(deviceState.getVersion()).thenReturn(OFConstants.OFP_VERSION_1_3);
87         Mockito.when(deviceState.getFeatures()).thenReturn(getFeaturesOutput);
88         Mockito.when(getFeaturesOutput.getDatapathId()).thenReturn(BigInteger.TEN);
89         Mockito.when(getFeaturesOutput.getPhyPort()).thenReturn(phyPorts);
90         Mockito.when(phyPort.getPortNo()).thenReturn(PORT_NO);
91     }
92
93     @Test
94     public void testTranslate() throws Exception {
95         final KeyedInstanceIdentifier<Node, NodeKey> nodePath = KeyedInstanceIdentifier
96                 .create(Nodes.class)
97                 .child(Node.class, new NodeKey(new NodeId("openflow:10")));
98         final PacketReceivedTranslator packetReceivedTranslator = new PacketReceivedTranslator();
99         final PacketInMessage packetInMessage = createPacketInMessage(DATA.getBytes(), PORT_NO);
100         Mockito.when(deviceState.getNodeInstanceIdentifier()).thenReturn(nodePath);
101
102         final PacketReceived packetReceived = packetReceivedTranslator.translate(packetInMessage, deviceContext, null);
103
104         Assert.assertArrayEquals(packetInMessage.getData(), packetReceived.getPayload());
105         Assert.assertEquals("org.opendaylight.yang.gen.v1.urn.opendaylight.packet.service.rev130709.SendToController",
106                 packetReceived.getPacketInReason().getName());
107         Assert.assertEquals("openflow:10:" + PORT_NO,
108                 packetReceived.getIngress().getValue().firstKeyOf(NodeConnector.class, NodeConnectorKey.class)
109                         .getId().getValue());
110         Assert.assertEquals(0L, packetReceived.getFlowCookie().getValue().longValue());
111         Assert.assertEquals(42L, packetReceived.getTableId().getValue().longValue());
112     }
113
114     private static PacketInMessage createPacketInMessage(final byte[] data,
115                                                          final long port) {
116         final PacketInReason reason = PacketInReason.OFPRACTION;
117
118         MatchEntryBuilder matchEntryBuilder = assembleMatchEntryBld(port);
119         MatchBuilder packetInMatchBld = new MatchBuilder()
120                 .setMatchEntry(Lists.newArrayList(matchEntryBuilder.build()));
121
122         return new PacketInMessageBuilder()
123                 .setVersion(OFConstants.OFP_VERSION_1_0)
124                 .setData(data).setReason(reason)
125                 .setMatch(packetInMatchBld.build())
126                 .setVersion(OFConstants.OFP_VERSION_1_3)
127                 .setCookie(BigInteger.ZERO)
128                 .setTableId(new TableId(42L))
129                 .build();
130
131     }
132
133     @Test
134     public void testGetPacketInMatch() throws Exception {
135         MatchEntryBuilder matchEntryBuilder = assembleMatchEntryBld(PORT_NUM_VALUE);
136         MatchBuilder packetInMatchBld = new MatchBuilder()
137                 .setMatchEntry(Lists.newArrayList(matchEntryBuilder.build()));
138         PacketInMessageBuilder inputBld = new PacketInMessageBuilder()
139                 .setMatch(packetInMatchBld.build())
140                 .setVersion(OFConstants.OFP_VERSION_1_3);
141         BigInteger dpid = BigInteger.TEN;
142
143         final Match packetInMatch = PacketReceivedTranslator.getPacketInMatch(inputBld.build(), dpid);
144
145         Assert.assertNotNull(packetInMatch.getInPort());
146         Assert.assertEquals("openflow:10:" + PORT_NUM_VALUE, packetInMatch.getInPort().getValue());
147     }
148
149     private static MatchEntryBuilder assembleMatchEntryBld(long portNumValue) {
150         MatchEntryBuilder matchEntryBuilder = prepareHeader(InPort.class, false);
151         InPortBuilder inPortBld = new InPortBuilder().setPortNumber(new PortNumber(portNumValue));
152         InPortCaseBuilder caseBuilder = new InPortCaseBuilder();
153         caseBuilder.setInPort(inPortBld.build());
154         matchEntryBuilder.setMatchEntryValue(caseBuilder.build());
155         return matchEntryBuilder;
156     }
157
158     private static MatchEntryBuilder prepareHeader(Class<? extends MatchField> oxmMatchField, boolean hasMask) {
159         MatchEntryBuilder builder = new MatchEntryBuilder();
160         builder.setOxmClass(OpenflowBasicClass.class);
161         builder.setOxmMatchField(oxmMatchField);
162         builder.setHasMask(hasMask);
163         return builder;
164     }
165
166
167     @Test
168     public void testGetPortNumberFromMatch() throws Exception {
169         final Long portNumber = PacketReceivedTranslator.getPortNumberFromMatch(Lists.newArrayList(assembleMatchEntryBld(11L).build()));
170         Assert.assertEquals(11L, portNumber.longValue());
171     }
172 }