2 * Copyright (c) 2014 Pantheon Technologies s.r.o. and others. All rights reserved.
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
9 package org.opendaylight.openflowplugin.openflow.md.core.sal.convertor.flow;
11 import java.math.BigInteger;
12 import java.util.ArrayList;
13 import java.util.Collections;
14 import java.util.List;
15 import java.util.Optional;
16 import org.junit.Assert;
17 import org.junit.Before;
18 import org.junit.Test;
19 import org.opendaylight.openflowplugin.api.OFConstants;
20 import org.opendaylight.openflowplugin.openflow.md.core.sal.convertor.ConvertorManager;
21 import org.opendaylight.openflowplugin.openflow.md.core.sal.convertor.ConvertorManagerFactory;
22 import org.opendaylight.openflowplugin.openflow.md.core.sal.convertor.data.VersionDatapathIdConvertorData;
23 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Uri;
24 import org.opendaylight.yang.gen.v1.urn.opendaylight.action.types.rev131112.action.action.SetVlanIdActionCaseBuilder;
25 import org.opendaylight.yang.gen.v1.urn.opendaylight.action.types.rev131112.action.action.set.vlan.id.action._case.SetVlanIdActionBuilder;
26 import org.opendaylight.yang.gen.v1.urn.opendaylight.action.types.rev131112.action.list.Action;
27 import org.opendaylight.yang.gen.v1.urn.opendaylight.action.types.rev131112.action.list.ActionBuilder;
28 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.service.rev130819.AddFlowInput;
29 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.service.rev130819.AddFlowInputBuilder;
30 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.service.rev130819.FlowTableRef;
31 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.service.rev130819.RemoveFlowInput;
32 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.service.rev130819.RemoveFlowInputBuilder;
33 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.service.rev130819.flow.update.UpdatedFlow;
34 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.service.rev130819.flow.update.UpdatedFlowBuilder;
35 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.Flow;
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.FlowRef;
38 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.flow.Instructions;
39 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.flow.InstructionsBuilder;
40 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.flow.Match;
41 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.flow.MatchBuilder;
42 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.instruction.instruction.ApplyActionsCaseBuilder;
43 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.instruction.instruction.ClearActionsCaseBuilder;
44 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.instruction.instruction.GoToTableCaseBuilder;
45 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.instruction.instruction.MeterCaseBuilder;
46 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.instruction.instruction.WriteActionsCaseBuilder;
47 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.instruction.instruction.WriteMetadataCaseBuilder;
48 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.instruction.instruction.apply.actions._case.ApplyActionsBuilder;
49 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.instruction.instruction.clear.actions._case.ClearActionsBuilder;
50 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.instruction.instruction.go.to.table._case.GoToTableBuilder;
51 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.instruction.instruction.meter._case.MeterBuilder;
52 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.instruction.instruction.write.actions._case.WriteActionsBuilder;
53 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.instruction.instruction.write.metadata._case.WriteMetadataBuilder;
54 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.instruction.list.Instruction;
55 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.instruction.list.InstructionBuilder;
56 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeRef;
57 import org.opendaylight.yang.gen.v1.urn.opendaylight.l2.types.rev130827.EtherType;
58 import org.opendaylight.yang.gen.v1.urn.opendaylight.l2.types.rev130827.VlanId;
59 import org.opendaylight.yang.gen.v1.urn.opendaylight.meter.types.rev130918.MeterId;
60 import org.opendaylight.yang.gen.v1.urn.opendaylight.model.match.types.rev131026.ethernet.match.fields.EthernetTypeBuilder;
61 import org.opendaylight.yang.gen.v1.urn.opendaylight.model.match.types.rev131026.match.EthernetMatch;
62 import org.opendaylight.yang.gen.v1.urn.opendaylight.model.match.types.rev131026.match.EthernetMatchBuilder;
63 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.instruction.rev130731.instruction.grouping.instruction.choice.ApplyActionsCase;
64 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.instruction.rev130731.instruction.grouping.instruction.choice.GotoTableCase;
65 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.instruction.rev130731.instruction.grouping.instruction.choice.MeterCase;
66 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.instruction.rev130731.instruction.grouping.instruction.choice.WriteActionsCase;
67 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.instruction.rev130731.instruction.grouping.instruction.choice.WriteMetadataCase;
68 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.types.rev130731.FlowModCommand;
69 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.types.rev130731.FlowModFlags;
70 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.FlowModInputBuilder;
71 import org.opendaylight.yangtools.yang.binding.Augmentation;
72 import org.opendaylight.yangtools.yang.common.Uint16;
73 import org.opendaylight.yangtools.yang.common.Uint32;
74 import org.opendaylight.yangtools.yang.common.Uint64;
75 import org.opendaylight.yangtools.yang.common.Uint8;
78 * Unit tests for flow conversion.
80 * @author michal.polkorab
82 public class FlowConvertorTest {
83 private ConvertorManager convertorManager;
87 convertorManager = ConvertorManagerFactory.createDefaultManager();
91 * Tests {@link FlowConvertor#convert(Flow, VersionDatapathIdConvertorData)} }.
95 RemoveFlowInputBuilder flowBuilder = new RemoveFlowInputBuilder();
96 flowBuilder.setBarrier(false);
97 flowBuilder.setCookie(new FlowCookie(new BigInteger("4")));
98 flowBuilder.setCookieMask(new FlowCookie(new BigInteger("5")));
99 flowBuilder.setTableId((short) 6);
100 flowBuilder.setStrict(true);
101 flowBuilder.setIdleTimeout(50);
102 flowBuilder.setHardTimeout(500);
103 flowBuilder.setPriority(40);
104 flowBuilder.setBufferId(18L);
105 flowBuilder.setOutPort(new BigInteger("65535"));
106 flowBuilder.setOutGroup(5000L);
107 flowBuilder.setFlags(null);
108 flowBuilder.setMatch(null);
109 RemoveFlowInput flow = flowBuilder.build();
111 VersionDatapathIdConvertorData data = new VersionDatapathIdConvertorData(OFConstants.OFP_VERSION_1_3);
112 data.setDatapathId(Uint64.valueOf(42));
114 List<FlowModInputBuilder> flowMod = convert(flow, data);
116 Assert.assertEquals("Wrong version", 4, flowMod.get(0).getVersion().intValue());
117 Assert.assertEquals("Wrong cookie", 4, flowMod.get(0).getCookie().intValue());
118 Assert.assertEquals("Wrong cookie mask", 5, flowMod.get(0).getCookieMask().intValue());
119 Assert.assertEquals("Wrong table id", 6, flowMod.get(0).getTableId().getValue().intValue());
120 Assert.assertEquals("Wrong command", FlowModCommand.OFPFCDELETESTRICT, flowMod.get(0).getCommand());
121 Assert.assertEquals("Wrong idle timeout", 50, flowMod.get(0).getIdleTimeout().intValue());
122 Assert.assertEquals("Wrong hard timeout", 500, flowMod.get(0).getHardTimeout().intValue());
123 Assert.assertEquals("Wrong priority", 40, flowMod.get(0).getPriority().intValue());
124 Assert.assertEquals("Wrong buffer id", 18, flowMod.get(0).getBufferId().intValue());
125 Assert.assertEquals("Wrong out port", 65535, flowMod.get(0).getOutPort().getValue().intValue());
126 Assert.assertEquals("Wrong out group", 5000, flowMod.get(0).getOutGroup().intValue());
127 Assert.assertEquals("Wrong flags", new FlowModFlags(false, false, false, false, false),
128 flowMod.get(0).getFlags());
129 Assert.assertEquals("Wrong match",
130 "org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev150225.OxmMatchType",
131 flowMod.get(0).getMatch().getType().getName());
132 Assert.assertEquals("Wrong match entries size", 0, flowMod.get(0).getMatch().getMatchEntry().size());
136 * Tests {@link FlowConvertor#convert(Flow, VersionDatapathIdConvertorData)} }.
139 public void testOnlyModifyStrictCommand() {
140 UpdatedFlowBuilder flowBuilder = new UpdatedFlowBuilder();
141 flowBuilder.setStrict(true);
142 UpdatedFlow flow = flowBuilder.build();
144 VersionDatapathIdConvertorData data = new VersionDatapathIdConvertorData(OFConstants.OFP_VERSION_1_0);
145 data.setDatapathId(Uint64.valueOf(42));
147 List<FlowModInputBuilder> flowMod = convert(flow, data);
149 Assert.assertEquals("Wrong version", 1, flowMod.get(0).getVersion().intValue());
150 Assert.assertEquals("Wrong command", FlowModCommand.OFPFCADD, flowMod.get(0).getCommand());
154 * Tests {@link FlowConvertor#convert(Flow, VersionDatapathIdConvertorData)} }.
157 public void testInstructionsTranslation() {
158 InstructionBuilder instructionBuilder = new InstructionBuilder();
159 GoToTableCaseBuilder goToCaseBuilder = new GoToTableCaseBuilder();
160 GoToTableBuilder goToBuilder = new GoToTableBuilder();
161 goToBuilder.setTableId((short) 1);
162 goToCaseBuilder.setGoToTable(goToBuilder.build());
163 instructionBuilder.setInstruction(goToCaseBuilder.build());
164 instructionBuilder.setOrder(0);
166 List<Instruction> instructions = new ArrayList<>();
167 instructions.add(instructionBuilder.build());
168 instructionBuilder = new InstructionBuilder();
169 WriteMetadataCaseBuilder metaCaseBuilder = new WriteMetadataCaseBuilder();
170 WriteMetadataBuilder metaBuilder = new WriteMetadataBuilder();
171 metaBuilder.setMetadata(new BigInteger("2"));
172 metaBuilder.setMetadataMask(new BigInteger("3"));
173 metaCaseBuilder.setWriteMetadata(metaBuilder.build());
174 instructionBuilder.setInstruction(metaCaseBuilder.build());
175 instructionBuilder.setOrder(1);
176 instructions.add(instructionBuilder.build());
177 instructionBuilder = new InstructionBuilder();
178 WriteActionsCaseBuilder writeCaseBuilder = new WriteActionsCaseBuilder();
179 WriteActionsBuilder writeBuilder = new WriteActionsBuilder();
180 List<Action> actions = new ArrayList<>();
181 writeBuilder.setAction(actions);
182 writeCaseBuilder.setWriteActions(writeBuilder.build());
183 instructionBuilder.setInstruction(writeCaseBuilder.build());
184 instructionBuilder.setOrder(2);
185 instructions.add(instructionBuilder.build());
186 instructionBuilder = new InstructionBuilder();
187 ApplyActionsCaseBuilder applyCaseBuilder = new ApplyActionsCaseBuilder();
188 ApplyActionsBuilder applyBuilder = new ApplyActionsBuilder();
189 actions = new ArrayList<>();
190 applyBuilder.setAction(actions);
191 applyCaseBuilder.setApplyActions(applyBuilder.build());
192 instructionBuilder.setInstruction(applyCaseBuilder.build());
193 instructionBuilder.setOrder(3);
194 instructions.add(instructionBuilder.build());
195 instructionBuilder = new InstructionBuilder();
196 ClearActionsCaseBuilder clearCaseBuilder = new ClearActionsCaseBuilder();
197 ClearActionsBuilder clearBuilder = new ClearActionsBuilder();
198 actions = new ArrayList<>();
199 clearBuilder.setAction(actions);
200 clearCaseBuilder.setClearActions(clearBuilder.build());
201 instructionBuilder.setInstruction(clearCaseBuilder.build());
202 instructionBuilder.setOrder(4);
203 instructions.add(instructionBuilder.build());
204 instructionBuilder = new InstructionBuilder();
205 MeterCaseBuilder meterCaseBuilder = new MeterCaseBuilder();
206 MeterBuilder meterBuilder = new MeterBuilder();
207 meterBuilder.setMeterId(new MeterId(5L));
208 meterCaseBuilder.setMeter(meterBuilder.build());
209 instructionBuilder.setInstruction(meterCaseBuilder.build());
210 instructionBuilder.setOrder(5);
211 instructions.add(instructionBuilder.build());
213 InstructionsBuilder instructionsBuilder = new InstructionsBuilder();
214 instructionsBuilder.setInstruction(instructions);
216 AddFlowInputBuilder flowBuilder = new AddFlowInputBuilder();
217 flowBuilder.setInstructions(instructionsBuilder.build());
218 AddFlowInput flow = flowBuilder.build();
220 VersionDatapathIdConvertorData data = new VersionDatapathIdConvertorData(OFConstants.OFP_VERSION_1_0);
221 data.setDatapathId(Uint64.valueOf(42));
222 List<FlowModInputBuilder> flowMod = convert(flow, data);
224 Assert.assertEquals("Wrong version", 1, flowMod.get(0).getVersion().intValue());
225 Assert.assertEquals("Wrong command", FlowModCommand.OFPFCADD, flowMod.get(0).getCommand());
226 Assert.assertEquals("Wrong instructions size", 6, flowMod.get(0).getInstruction().size());
227 org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.instruction.rev130731.instructions
228 .grouping.Instruction instruction = flowMod.get(0).getInstruction().get(0);
229 Assert.assertEquals("Wrong type", "org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common"
230 + ".instruction.rev130731.instruction.grouping.instruction.choice.GotoTableCase",
231 instruction.getInstructionChoice().implementedInterface().getName());
232 GotoTableCase gotoTableCase = (GotoTableCase) instruction.getInstructionChoice();
233 Assert.assertEquals("Wrong table id", 1, gotoTableCase.getGotoTable().getTableId().intValue());
234 instruction = flowMod.get(0).getInstruction().get(1);
235 Assert.assertEquals("Wrong type", "org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common"
236 + ".instruction.rev130731.instruction.grouping.instruction.choice.WriteMetadataCase",
237 instruction.getInstructionChoice().implementedInterface().getName());
238 WriteMetadataCase writeMetadataCase = (WriteMetadataCase) instruction.getInstructionChoice();
239 Assert.assertArrayEquals("Wrong metadata", new byte[]{0, 0, 0, 0, 0, 0, 0, 2},
240 writeMetadataCase.getWriteMetadata().getMetadata());
241 Assert.assertArrayEquals("Wrong metadata mask", new byte[]{0, 0, 0, 0, 0, 0, 0, 3},
242 writeMetadataCase.getWriteMetadata().getMetadataMask());
244 instruction = flowMod.get(0).getInstruction().get(2);
245 Assert.assertEquals("Wrong type", "org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common"
246 + ".instruction.rev130731.instruction.grouping.instruction.choice.WriteActionsCase",
247 instruction.getInstructionChoice().implementedInterface().getName());
248 WriteActionsCase writeActionsCase = (WriteActionsCase) instruction.getInstructionChoice();
249 Assert.assertEquals("Wrong actions size", 0, writeActionsCase.getWriteActions().getAction().size());
250 instruction = flowMod.get(0).getInstruction().get(3);
251 Assert.assertEquals("Wrong type", "org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common"
252 + ".instruction.rev130731.instruction.grouping.instruction.choice.ApplyActionsCase",
253 instruction.getInstructionChoice().implementedInterface().getName());
254 ApplyActionsCase applyActionsCase = (ApplyActionsCase) instruction.getInstructionChoice();
255 Assert.assertEquals("Wrong actions size", 0, applyActionsCase.getApplyActions().getAction().size());
256 instruction = flowMod.get(0).getInstruction().get(4);
257 Assert.assertEquals("Wrong type", "org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common"
258 + ".instruction.rev130731.instruction.grouping.instruction.choice.ClearActionsCase",
259 instruction.getInstructionChoice().implementedInterface().getName());
260 instruction = flowMod.get(0).getInstruction().get(5);
261 Assert.assertEquals("Wrong type", "org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common"
262 + ".instruction.rev130731.instruction.grouping.instruction.choice.MeterCase",
263 instruction.getInstructionChoice().implementedInterface().getName());
264 MeterCase meterCase = (MeterCase) instruction.getInstructionChoice();
265 Assert.assertEquals("Wrong meter id", 5, meterCase.getMeter().getMeterId().intValue());
269 public void testCloneAndAugmentFlowWithSetVlanId() {
270 MockFlow mockFlow = new MockFlow();
271 Action action1 = createAction(
272 new SetVlanIdActionCaseBuilder().setSetVlanIdAction(
273 new SetVlanIdActionBuilder().setVlanId(new VlanId(10)).build())
277 mockFlow.setMatch(new MatchBuilder().setEthernetMatch(createEthernetMatch()).build());
278 mockFlow.setInstructions(toApplyInstruction(Collections.singletonList(action1)));
280 VersionDatapathIdConvertorData data = new VersionDatapathIdConvertorData(OFConstants.OFP_VERSION_1_3);
281 data.setDatapathId(Uint64.ONE);
283 List<FlowModInputBuilder> flowModInputBuilders = convert(mockFlow, data);
285 Assert.assertEquals(2, flowModInputBuilders.size());
289 private List<FlowModInputBuilder> convert(final Flow flow, final VersionDatapathIdConvertorData data) {
290 Optional<List<FlowModInputBuilder>> flowModOptional = convertorManager.convert(flow, data);
291 Assert.assertTrue("Flow convertor not found", flowModOptional.isPresent());
292 return flowModOptional.get();
295 private static Action createAction(
296 final org.opendaylight.yang.gen.v1.urn.opendaylight.action.types.rev131112.action.Action actionCase,
298 Action action = new ActionBuilder().setOrder(order).setAction(actionCase).build();
302 private static EthernetMatch createEthernetMatch() {
303 EthernetMatchBuilder ethernetMatchBuilder = new EthernetMatchBuilder();
304 ethernetMatchBuilder.setEthernetType(new EthernetTypeBuilder().setType(new EtherType(33024L)).build());
305 return ethernetMatchBuilder.build();
308 private static Instructions toApplyInstruction(
309 final List<org.opendaylight.yang.gen.v1.urn.opendaylight.action.types.rev131112.action.list
311 return new InstructionsBuilder().setInstruction(Collections.singletonList(new InstructionBuilder().setOrder(0)
312 .setInstruction(new ApplyActionsCaseBuilder()
313 .setApplyActions(new ApplyActionsBuilder().setAction(actions).build()).build())
317 private static class MockFlow implements AddFlowInput {
318 private Instructions instructions;
321 public void setInstructions(final Instructions instructions) {
322 this.instructions = instructions;
325 public void setMatch(final Match match) {
331 public FlowRef getFlowRef() {
336 public <E extends Augmentation<AddFlowInput>> E augmentation(final Class<E> augmentationType) {
341 public FlowTableRef getFlowTable() {
346 public Match getMatch() {
351 public Instructions getInstructions() {
356 public String getContainerName() {
361 public FlowCookie getCookieMask() {
366 public Uint32 getBufferId() {
371 public Uint64 getOutPort() {
376 public Uint32 getOutGroup() {
381 public org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.FlowModFlags getFlags() {
386 public String getFlowName() {
391 public Boolean isInstallHw() {
396 public Boolean isBarrier() {
401 public Boolean isStrict() {
406 public Uint16 getPriority() {
411 public Uint16 getIdleTimeout() {
416 public Uint16 getHardTimeout() {
421 public FlowCookie getCookie() {
426 public Uint8 getTableId() {
431 public NodeRef getNode() {
436 public Uri getTransactionUri() {
441 public Class<AddFlowInput> implementedInterface() {
442 return AddFlowInput.class;