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

   1 /*\r
   2  * Copyright (c) 2013 Pantheon Technologies s.r.o. and others.  All rights reserved.\r
   3  *\r
   4  * This program and the accompanying materials are made available under the\r
   5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,\r
   6  * and is available at http://www.eclipse.org/legal/epl-v10.html\r
   7  */\r
   8 package org.opendaylight.openflowjava.protocol.impl.util;\r
   9 \r
  10 import io.netty.buffer.ByteBuf;\r
  11 import io.netty.buffer.UnpooledByteBufAllocator;\r
  12 \r
  13 import java.util.ArrayList;\r
  14 import java.util.List;\r
  15 \r
  16 import org.junit.Assert;\r
  17 import org.junit.Before;\r
  18 import org.junit.Test;\r
  19 import org.opendaylight.openflowjava.protocol.api.extensibility.SerializerRegistry;\r
  20 import org.opendaylight.openflowjava.protocol.api.util.EncodeConstants;\r
  21 import org.opendaylight.openflowjava.protocol.impl.serialization.SerializerRegistryImpl;\r
  22 import org.opendaylight.openflowjava.util.ByteBufUtils;\r
  23 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.augments.rev131002.ActionsInstruction;\r
  24 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.augments.rev131002.ActionsInstructionBuilder;\r
  25 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.augments.rev131002.EthertypeAction;\r
  26 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.augments.rev131002.EthertypeActionBuilder;\r
  27 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.augments.rev131002.MaxLengthAction;\r
  28 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.augments.rev131002.MaxLengthActionBuilder;\r
  29 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.augments.rev131002.MetadataInstruction;\r
  30 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.augments.rev131002.MetadataInstructionBuilder;\r
  31 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.augments.rev131002.MeterIdInstruction;\r
  32 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.augments.rev131002.MeterIdInstructionBuilder;\r
  33 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.augments.rev131002.NwTtlAction;\r
  34 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.augments.rev131002.NwTtlActionBuilder;\r
  35 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.augments.rev131002.PortAction;\r
  36 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.augments.rev131002.PortActionBuilder;\r
  37 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.augments.rev131002.TableIdInstruction;\r
  38 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.augments.rev131002.TableIdInstructionBuilder;\r
  39 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.action.rev130731.Output;\r
  40 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.action.rev130731.PopPbb;\r
  41 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.action.rev130731.PushVlan;\r
  42 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.action.rev130731.SetNwTtl;\r
  43 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.action.rev130731.actions.grouping.Action;\r
  44 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.action.rev130731.actions.grouping.ActionBuilder;\r
  45 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.instruction.rev130731.ApplyActions;\r
  46 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.instruction.rev130731.ClearActions;\r
  47 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.instruction.rev130731.GotoTable;\r
  48 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.instruction.rev130731.Meter;\r
  49 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.instruction.rev130731.WriteActions;\r
  50 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.instruction.rev130731.WriteMetadata;\r
  51 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.instruction.rev130731.instructions.grouping.Instruction;\r
  52 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.instruction.rev130731.instructions.grouping.InstructionBuilder;\r
  53 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.types.rev130731.EtherType;\r
  54 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.types.rev130731.PortNumber;\r
  55 \r
  56 /**\r
  57  * @author michal.polkorab\r
  58  *\r
  59  */\r
  60 public class OF13InstructionsSerializerTest {\r
  61 \r
  62     private SerializerRegistry registry;\r
  63 \r
  64     /**\r
  65      * Initializes serializer table and stores correct factory in field\r
  66      */\r
  67     @Before\r
  68     public void startUp() {\r
  69         registry = new SerializerRegistryImpl();\r
  70         registry.init();\r
  71     }\r
  72 \r
  73     /**\r
  74      * Testing instructions translation\r
  75      */\r
  76     @Test\r
  77     public void test() {\r
  78         List<Instruction> instructions = new ArrayList<>();\r
  79         // Goto_table instruction\r
  80         InstructionBuilder builder = new InstructionBuilder();\r
  81         builder.setType(GotoTable.class);\r
  82         TableIdInstructionBuilder tableIdBuilder = new TableIdInstructionBuilder();\r
  83         tableIdBuilder.setTableId((short) 5);\r
  84         builder.addAugmentation(TableIdInstruction.class, tableIdBuilder.build());\r
  85         instructions.add(builder.build());\r
  86         builder = new InstructionBuilder();\r
  87         // Write_metadata instruction\r
  88         builder.setType(WriteMetadata.class);\r
  89         MetadataInstructionBuilder metaBuilder = new MetadataInstructionBuilder();\r
  90         metaBuilder.setMetadata(ByteBufUtils.hexStringToBytes("00 01 02 03 04 05 06 07"));\r
  91         metaBuilder.setMetadataMask(ByteBufUtils.hexStringToBytes("07 06 05 04 03 02 01 00"));\r
  92         builder.addAugmentation(MetadataInstruction.class, metaBuilder.build());\r
  93         instructions.add(builder.build());\r
  94         // Clear_actions instruction\r
  95         builder = new InstructionBuilder();\r
  96         builder.setType(ClearActions.class);\r
  97         instructions.add(builder.build());\r
  98         // Meter instruction\r
  99         builder = new InstructionBuilder();\r
 100         builder.setType(Meter.class);\r
 101         MeterIdInstructionBuilder meterBuilder = new MeterIdInstructionBuilder();\r
 102         meterBuilder.setMeterId(42L);\r
 103         builder.addAugmentation(MeterIdInstruction.class, meterBuilder.build());\r
 104         instructions.add(builder.build());\r
 105         // Write_actions instruction\r
 106         builder = new InstructionBuilder();\r
 107         builder.setType(WriteActions.class);\r
 108         ActionsInstructionBuilder actionsBuilder = new ActionsInstructionBuilder();\r
 109         List<Action> actions = new ArrayList<>();\r
 110         ActionBuilder actionBuilder = new ActionBuilder();\r
 111         actionBuilder.setType(Output.class);\r
 112         PortActionBuilder portBuilder = new PortActionBuilder();\r
 113         portBuilder.setPort(new PortNumber(45L));\r
 114         actionBuilder.addAugmentation(PortAction.class, portBuilder.build());\r
 115         MaxLengthActionBuilder maxBuilder = new MaxLengthActionBuilder();\r
 116         maxBuilder.setMaxLength(55);\r
 117         actionBuilder.addAugmentation(MaxLengthAction.class, maxBuilder.build());\r
 118         actions.add(actionBuilder.build());\r
 119         actionBuilder = new ActionBuilder();\r
 120         actionBuilder.setType(SetNwTtl.class);\r
 121         NwTtlActionBuilder nwTtl = new NwTtlActionBuilder();\r
 122         nwTtl.setNwTtl((short) 64);\r
 123         actionBuilder.addAugmentation(NwTtlAction.class, nwTtl.build());\r
 124         actions.add(actionBuilder.build());\r
 125         actionsBuilder.setAction(actions);\r
 126         builder.addAugmentation(ActionsInstruction.class, actionsBuilder.build());\r
 127         instructions.add(builder.build());\r
 128         // Apply_actions instruction\r
 129         builder = new InstructionBuilder();\r
 130         builder.setType(ApplyActions.class);\r
 131         actionsBuilder = new ActionsInstructionBuilder();\r
 132         actions = new ArrayList<>();\r
 133         actionBuilder = new ActionBuilder();\r
 134         actionBuilder.setType(PushVlan.class);\r
 135         EthertypeActionBuilder ethertypeBuilder = new EthertypeActionBuilder();\r
 136         ethertypeBuilder.setEthertype(new EtherType(14));\r
 137         actionBuilder.addAugmentation(EthertypeAction.class, ethertypeBuilder.build());\r
 138         actions.add(actionBuilder.build());\r
 139         actionBuilder = new ActionBuilder();\r
 140         actionBuilder.setType(PopPbb.class);\r
 141         actions.add(actionBuilder.build());\r
 142         actionsBuilder.setAction(actions);\r
 143         builder.addAugmentation(ActionsInstruction.class, actionsBuilder.build());\r
 144         instructions.add(builder.build());\r
 145         \r
 146         ByteBuf out = UnpooledByteBufAllocator.DEFAULT.buffer();\r
 147         ListSerializer.serializeList(instructions, EnhancedTypeKeyMakerFactory\r
 148                 .createInstructionKeyMaker(EncodeConstants.OF13_VERSION_ID), registry, out);\r
 149         \r
 150         Assert.assertEquals("Wrong instruction type", 1, out.readUnsignedShort());\r
 151         Assert.assertEquals("Wrong instruction length", 8, out.readUnsignedShort());\r
 152         Assert.assertEquals("Wrong instruction table-id", 5, out.readUnsignedByte());\r
 153         out.skipBytes(3);\r
 154         Assert.assertEquals("Wrong instruction type", 2, out.readUnsignedShort());\r
 155         Assert.assertEquals("Wrong instruction length", 24, out.readUnsignedShort());\r
 156         out.skipBytes(4);\r
 157         byte[] actual = new byte[8];\r
 158         out.readBytes(actual);\r
 159         Assert.assertEquals("Wrong instruction metadata", "00 01 02 03 04 05 06 07",\r
 160                 ByteBufUtils.bytesToHexString(actual));\r
 161         actual = new byte[8];\r
 162         out.readBytes(actual);\r
 163         Assert.assertEquals("Wrong instruction metadata-mask", "07 06 05 04 03 02 01 00",\r
 164                 ByteBufUtils.bytesToHexString(actual));\r
 165         Assert.assertEquals("Wrong instruction type", 5, out.readUnsignedShort());\r
 166         Assert.assertEquals("Wrong instruction length", 8, out.readUnsignedShort());\r
 167         out.skipBytes(4);\r
 168         Assert.assertEquals("Wrong instruction type", 6, out.readUnsignedShort());\r
 169         Assert.assertEquals("Wrong instruction length", 8, out.readUnsignedShort());\r
 170         Assert.assertEquals("Wrong instruction meter-id", 42, out.readUnsignedInt());\r
 171         Assert.assertEquals("Wrong instruction type", 3, out.readUnsignedShort());\r
 172         Assert.assertEquals("Wrong instruction length", 32, out.readUnsignedShort());\r
 173         out.skipBytes(4);\r
 174         Assert.assertEquals("Wrong action type", 0, out.readUnsignedShort());\r
 175         Assert.assertEquals("Wrong action length", 16, out.readUnsignedShort());\r
 176         Assert.assertEquals("Wrong action type", 45, out.readUnsignedInt());\r
 177         Assert.assertEquals("Wrong action type", 55, out.readUnsignedShort());\r
 178         out.skipBytes(6);\r
 179         Assert.assertEquals("Wrong action type", 23, out.readUnsignedShort());\r
 180         Assert.assertEquals("Wrong action length", 8, out.readUnsignedShort());\r
 181         Assert.assertEquals("Wrong action type", 64, out.readUnsignedByte());\r
 182         out.skipBytes(3);\r
 183         Assert.assertEquals("Wrong instruction type", 4, out.readUnsignedShort());\r
 184         Assert.assertEquals("Wrong instruction length", 24, out.readUnsignedShort());\r
 185         out.skipBytes(4);\r
 186         Assert.assertEquals("Wrong action type", 17, out.readUnsignedShort());\r
 187         Assert.assertEquals("Wrong action length", 8, out.readUnsignedShort());\r
 188         Assert.assertEquals("Wrong action ethertype", 14, out.readUnsignedShort());\r
 189         out.skipBytes(2);\r
 190         Assert.assertEquals("Wrong action type", 27, out.readUnsignedShort());\r
 191         Assert.assertEquals("Wrong action length", 8, out.readUnsignedShort());\r
 192         out.skipBytes(4);\r
 193         Assert.assertTrue("Not all data were read", out.readableBytes() == 0);\r
 194     }\r
 195 \r
 196 }\r