openflowjava/openflow-protocol-impl/src/test/java/org/opendaylight/openflowjava/protocol/impl/util/OF13InstructionsSerializerTest.java

   1 /*
   2  * Copyright (c) 2013 Pantheon Technologies s.r.o. 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 package org.opendaylight.openflowjava.protocol.impl.util;
   9
  10 import io.netty.buffer.ByteBuf;
  11 import io.netty.buffer.UnpooledByteBufAllocator;
  12 import java.util.ArrayList;
  13 import java.util.List;
  14 import org.junit.Assert;
  15 import org.junit.Before;
  16 import org.junit.Test;
  17 import org.opendaylight.openflowjava.protocol.api.extensibility.SerializerRegistry;
  18 import org.opendaylight.openflowjava.protocol.api.util.EncodeConstants;
  19 import org.opendaylight.openflowjava.protocol.impl.serialization.SerializerRegistryImpl;
  20 import org.opendaylight.openflowjava.util.ByteBufUtils;
  21 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.action.rev150203.action.grouping.action.choice.OutputActionCaseBuilder;
  22 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.action.rev150203.action.grouping.action.choice.PopPbbCaseBuilder;
  23 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.action.rev150203.action.grouping.action.choice.PushVlanCaseBuilder;
  24 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.action.rev150203.action.grouping.action.choice.SetNwTtlCaseBuilder;
  25 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.action.rev150203.action.grouping.action.choice.output.action._case.OutputActionBuilder;
  26 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.action.rev150203.action.grouping.action.choice.push.vlan._case.PushVlanActionBuilder;
  27 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.action.rev150203.action.grouping.action.choice.set.nw.ttl._case.SetNwTtlActionBuilder;
  28 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.action.rev150203.actions.grouping.Action;
  29 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.action.rev150203.actions.grouping.ActionBuilder;
  30 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.instruction.rev130731.instruction.grouping.instruction.choice.ApplyActionsCaseBuilder;
  31 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.instruction.rev130731.instruction.grouping.instruction.choice.ClearActionsCaseBuilder;
  32 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.instruction.rev130731.instruction.grouping.instruction.choice.GotoTableCaseBuilder;
  33 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.instruction.rev130731.instruction.grouping.instruction.choice.MeterCaseBuilder;
  34 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.instruction.rev130731.instruction.grouping.instruction.choice.WriteActionsCaseBuilder;
  35 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.instruction.rev130731.instruction.grouping.instruction.choice.WriteMetadataCaseBuilder;
  36 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.instruction.rev130731.instruction.grouping.instruction.choice._goto.table._case.GotoTableBuilder;
  37 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.instruction.rev130731.instruction.grouping.instruction.choice.apply.actions._case.ApplyActionsBuilder;
  38 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.instruction.rev130731.instruction.grouping.instruction.choice.meter._case.MeterBuilder;
  39 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.instruction.rev130731.instruction.grouping.instruction.choice.write.actions._case.WriteActionsBuilder;
  40 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.instruction.rev130731.instruction.grouping.instruction.choice.write.metadata._case.WriteMetadataBuilder;
  41 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.instruction.rev130731.instructions.grouping.Instruction;
  42 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.instruction.rev130731.instructions.grouping.InstructionBuilder;
  43 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.types.rev130731.EtherType;
  44 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.types.rev130731.PortNumber;
  45
  46 /**
  47  * Unit tests for OF13InstructionsSerializer.
  48  *
  49  * @author michal.polkorab
  50  */
  51 public class OF13InstructionsSerializerTest {
  52
  53     private SerializerRegistry registry;
  54
  55     /**
  56      * Initializes serializer table and stores correct factory in field.
  57      */
  58     @Before
  59     public void startUp() {
  60         registry = new SerializerRegistryImpl();
  61         registry.init();
  62     }
  63
  64     /**
  65      * Testing instructions translation.
  66      */
  67     @Test
  68     public void test() {
  69         final List<Instruction> instructions = new ArrayList<>();
  70         // Goto_table instruction
  71         InstructionBuilder builder = new InstructionBuilder();
  72         GotoTableCaseBuilder gotoCaseBuilder = new GotoTableCaseBuilder();
  73         GotoTableBuilder instructionBuilder = new GotoTableBuilder();
  74         instructionBuilder.setTableId((short) 5);
  75         gotoCaseBuilder.setGotoTable(instructionBuilder.build());
  76         builder.setInstructionChoice(gotoCaseBuilder.build());
  77         instructions.add(builder.build());
  78         // Write_metadata instruction
  79         builder = new InstructionBuilder();
  80         WriteMetadataCaseBuilder metadataCaseBuilder = new WriteMetadataCaseBuilder();
  81         WriteMetadataBuilder metadataBuilder = new WriteMetadataBuilder();
  82         metadataBuilder.setMetadata(ByteBufUtils.hexStringToBytes("00 01 02 03 04 05 06 07"));
  83         metadataBuilder.setMetadataMask(ByteBufUtils.hexStringToBytes("07 06 05 04 03 02 01 00"));
  84         metadataCaseBuilder.setWriteMetadata(metadataBuilder.build());
  85         builder.setInstructionChoice(metadataCaseBuilder.build());
  86         instructions.add(builder.build());
  87         // Clear_actions instruction
  88         builder = new InstructionBuilder();
  89         builder.setInstructionChoice(new ClearActionsCaseBuilder().build());
  90         instructions.add(builder.build());
  91         // Meter instruction
  92         builder = new InstructionBuilder();
  93         MeterCaseBuilder meterCaseBuilder = new MeterCaseBuilder();
  94         MeterBuilder meterBuilder = new MeterBuilder();
  95         meterBuilder.setMeterId(42L);
  96         meterCaseBuilder.setMeter(meterBuilder.build());
  97         builder.setInstructionChoice(meterCaseBuilder.build());
  98         instructions.add(builder.build());
  99         // Write_actions instruction
 100         builder = new InstructionBuilder();
 101         final WriteActionsCaseBuilder writeActionsCaseBuilder = new WriteActionsCaseBuilder();
 102         final WriteActionsBuilder writeActionsBuilder = new WriteActionsBuilder();
 103         OutputActionCaseBuilder caseBuilder = new OutputActionCaseBuilder();
 104         OutputActionBuilder outputBuilder = new OutputActionBuilder();
 105         outputBuilder.setPort(new PortNumber(45L));
 106         outputBuilder.setMaxLength(55);
 107         caseBuilder.setOutputAction(outputBuilder.build());
 108         ActionBuilder actionBuilder = new ActionBuilder();
 109         actionBuilder.setActionChoice(caseBuilder.build());
 110         List<Action> actions = new ArrayList<>();
 111         actions.add(actionBuilder.build());
 112         actionBuilder = new ActionBuilder();
 113         SetNwTtlCaseBuilder ttlCaseBuilder = new SetNwTtlCaseBuilder();
 114         SetNwTtlActionBuilder ttlActionBuilder = new SetNwTtlActionBuilder();
 115         ttlActionBuilder.setNwTtl((short) 64);
 116         ttlCaseBuilder.setSetNwTtlAction(ttlActionBuilder.build());
 117         actionBuilder.setActionChoice(ttlCaseBuilder.build());
 118         actions.add(actionBuilder.build());
 119         writeActionsBuilder.setAction(actions);
 120         writeActionsCaseBuilder.setWriteActions(writeActionsBuilder.build());
 121         builder.setInstructionChoice(writeActionsCaseBuilder.build());
 122         instructions.add(builder.build());
 123         // Apply_actions instruction
 124         builder = new InstructionBuilder();
 125         final ApplyActionsCaseBuilder applyActionsCaseBuilder = new ApplyActionsCaseBuilder();
 126         final ApplyActionsBuilder applyActionsBuilder = new ApplyActionsBuilder();
 127         actions = new ArrayList<>();
 128         actionBuilder = new ActionBuilder();
 129         PushVlanCaseBuilder vlanCaseBuilder = new PushVlanCaseBuilder();
 130         PushVlanActionBuilder vlanBuilder = new PushVlanActionBuilder();
 131         vlanBuilder.setEthertype(new EtherType(new EtherType(14)));
 132         vlanCaseBuilder.setPushVlanAction(vlanBuilder.build());
 133         actionBuilder.setActionChoice(vlanCaseBuilder.build());
 134         actions.add(actionBuilder.build());
 135         actionBuilder = new ActionBuilder();
 136         actionBuilder.setActionChoice(new PopPbbCaseBuilder().build());
 137         actions.add(actionBuilder.build());
 138         applyActionsBuilder.setAction(actions);
 139         applyActionsCaseBuilder.setApplyActions(applyActionsBuilder.build());
 140         builder.setInstructionChoice(applyActionsCaseBuilder.build());
 141         instructions.add(builder.build());
 142
 143         ByteBuf out = UnpooledByteBufAllocator.DEFAULT.buffer();
 144         ListSerializer.serializeList(instructions, TypeKeyMakerFactory
 145                 .createInstructionKeyMaker(EncodeConstants.OF13_VERSION_ID), registry, out);
 146
 147         Assert.assertEquals("Wrong instruction type", 1, out.readUnsignedShort());
 148         Assert.assertEquals("Wrong instruction length", 8, out.readUnsignedShort());
 149         Assert.assertEquals("Wrong instruction table-id", 5, out.readUnsignedByte());
 150         out.skipBytes(3);
 151         Assert.assertEquals("Wrong instruction type", 2, out.readUnsignedShort());
 152         Assert.assertEquals("Wrong instruction length", 24, out.readUnsignedShort());
 153         out.skipBytes(4);
 154         byte[] actual = new byte[8];
 155         out.readBytes(actual);
 156         Assert.assertEquals("Wrong instruction metadata", "00 01 02 03 04 05 06 07",
 157                 ByteBufUtils.bytesToHexString(actual));
 158         actual = new byte[8];
 159         out.readBytes(actual);
 160         Assert.assertEquals("Wrong instruction metadata-mask", "07 06 05 04 03 02 01 00",
 161                 ByteBufUtils.bytesToHexString(actual));
 162         Assert.assertEquals("Wrong instruction type", 5, out.readUnsignedShort());
 163         Assert.assertEquals("Wrong instruction length", 8, out.readUnsignedShort());
 164         out.skipBytes(4);
 165         Assert.assertEquals("Wrong instruction type", 6, out.readUnsignedShort());
 166         Assert.assertEquals("Wrong instruction length", 8, out.readUnsignedShort());
 167         Assert.assertEquals("Wrong instruction meter-id", 42, out.readUnsignedInt());
 168         Assert.assertEquals("Wrong instruction type", 3, out.readUnsignedShort());
 169         Assert.assertEquals("Wrong instruction length", 32, out.readUnsignedShort());
 170         out.skipBytes(4);
 171         Assert.assertEquals("Wrong action type", 0, out.readUnsignedShort());
 172         Assert.assertEquals("Wrong action length", 16, out.readUnsignedShort());
 173         Assert.assertEquals("Wrong action type", 45, out.readUnsignedInt());
 174         Assert.assertEquals("Wrong action type", 55, out.readUnsignedShort());
 175         out.skipBytes(6);
 176         Assert.assertEquals("Wrong action type", 23, out.readUnsignedShort());
 177         Assert.assertEquals("Wrong action length", 8, out.readUnsignedShort());
 178         Assert.assertEquals("Wrong action type", 64, out.readUnsignedByte());
 179         out.skipBytes(3);
 180         Assert.assertEquals("Wrong instruction type", 4, out.readUnsignedShort());
 181         Assert.assertEquals("Wrong instruction length", 24, out.readUnsignedShort());
 182         out.skipBytes(4);
 183         Assert.assertEquals("Wrong action type", 17, out.readUnsignedShort());
 184         Assert.assertEquals("Wrong action length", 8, out.readUnsignedShort());
 185         Assert.assertEquals("Wrong action ethertype", 14, out.readUnsignedShort());
 186         out.skipBytes(2);
 187         Assert.assertEquals("Wrong action type", 27, out.readUnsignedShort());
 188         Assert.assertEquals("Wrong action length", 8, out.readUnsignedShort());
 189         out.skipBytes(4);
 190         Assert.assertTrue("Not all data were read", out.readableBytes() == 0);
 191     }
 192
 193 }