v3po/v3po2vpp/src/test/java/io/fd/honeycomb/translate/v3po/interfaces/acl/ingress/IetfAclCustomizerTest.java

   1 /*
   2  * Copyright (c) 2016 Cisco and/or its affiliates.
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at:
   7  *
   8  *     http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 package io.fd.honeycomb.translate.v3po.interfaces.acl.ingress;
  18
  19 import static org.mockito.Matchers.any;
  20 import static org.mockito.Matchers.argThat;
  21 import static org.mockito.Mockito.verify;
  22 import static org.mockito.Mockito.when;
  23
  24 import com.google.common.base.Optional;
  25 import io.fd.honeycomb.translate.vpp.util.NamingContext;
  26 import io.fd.honeycomb.translate.write.WriteFailedException;
  27 import io.fd.honeycomb.vpp.test.write.WriterCustomizerTest;
  28 import io.fd.vpp.jvpp.core.dto.ClassifyAddDelSession;
  29 import io.fd.vpp.jvpp.core.dto.ClassifyAddDelSessionReply;
  30 import io.fd.vpp.jvpp.core.dto.ClassifyAddDelTable;
  31 import io.fd.vpp.jvpp.core.dto.ClassifyAddDelTableReply;
  32 import io.fd.vpp.jvpp.core.dto.ClassifyTableByInterface;
  33 import io.fd.vpp.jvpp.core.dto.ClassifyTableByInterfaceReply;
  34 import io.fd.vpp.jvpp.core.dto.InputAclSetInterface;
  35 import io.fd.vpp.jvpp.core.dto.InputAclSetInterfaceReply;
  36 import java.util.Arrays;
  37 import java.util.Collections;
  38 import org.hamcrest.BaseMatcher;
  39 import org.hamcrest.Description;
  40 import org.hamcrest.Matcher;
  41 import org.junit.Test;
  42 import org.mockito.InOrder;
  43 import org.mockito.Mockito;
  44 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.access.control.list.rev160708.AclBase;
  45 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.access.control.list.rev160708.EthAcl;
  46 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.access.control.list.rev160708.access.lists.acl.AccessListEntriesBuilder;
  47 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.access.control.list.rev160708.access.lists.acl.access.list.entries.Ace;
  48 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.access.control.list.rev160708.access.lists.acl.access.list.entries.AceBuilder;
  49 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.access.control.list.rev160708.access.lists.acl.access.list.entries.ace.ActionsBuilder;
  50 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.access.control.list.rev160708.access.lists.acl.access.list.entries.ace.MatchesBuilder;
  51 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.access.control.list.rev160708.access.lists.acl.access.list.entries.ace.actions.PacketHandling;
  52 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.access.control.list.rev160708.access.lists.acl.access.list.entries.ace.actions.packet.handling.Deny;
  53 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.access.control.list.rev160708.access.lists.acl.access.list.entries.ace.actions.packet.handling.DenyBuilder;
  54 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.access.control.list.rev160708.access.lists.acl.access.list.entries.ace.actions.packet.handling.Permit;
  55 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.access.control.list.rev160708.access.lists.acl.access.list.entries.ace.actions.packet.handling.PermitBuilder;
  56 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.access.control.list.rev160708.access.lists.acl.access.list.entries.ace.matches.ace.type.AceIpBuilder;
  57 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.access.control.list.rev160708.access.lists.acl.access.list.entries.ace.matches.ace.type.ace.ip.ace.ip.version.AceIpv6Builder;
  58 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.Interfaces;
  59 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.Interface;
  60 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.InterfaceKey;
  61 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev161214.VppInterfaceAugmentation;
  62 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.vpp.acl.rev161214.ietf.acl.base.attributes.AccessListsBuilder;
  63 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.vpp.acl.rev161214.ietf.acl.base.attributes.access.lists.AclBuilder;
  64 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev161214.interfaces._interface.IetfAcl;
  65 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev161214.interfaces._interface.ietf.acl.Ingress;
  66 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev161214.interfaces._interface.ietf.acl.IngressBuilder;
  67 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  68
  69 public class IetfAclCustomizerTest extends WriterCustomizerTest {
  70
  71     private static final String IFC_TEST_INSTANCE = "ifc-test-instance";
  72     private static final String IF_NAME = "local0";
  73     private static final int IF_INDEX = 1;
  74     private static final InstanceIdentifier<Ingress> IID =
  75         InstanceIdentifier.create(Interfaces.class).child(Interface.class, new InterfaceKey(IF_NAME)).augmentation(
  76             VppInterfaceAugmentation.class).child(IetfAcl.class).child(Ingress.class);
  77     private static final String ACL_NAME = "acl1";
  78     private static final Class<? extends AclBase> ACL_TYPE = EthAcl.class;
  79
  80     private IetfAclCustomizer customizer;
  81     private Ingress acl;
  82     private int DENY = 0;
  83     private int PERMIT = -1;
  84
  85     @Override
  86     protected void setUp() {
  87         customizer = new IetfAclCustomizer(new IetfAClWriter(api), new NamingContext("prefix", IFC_TEST_INSTANCE));
  88         defineMapping(mappingContext, IF_NAME, IF_INDEX, IFC_TEST_INSTANCE);
  89         acl = new IngressBuilder().setAccessLists(
  90             new AccessListsBuilder().setAcl(
  91                 Collections.singletonList(new AclBuilder()
  92                     .setName(ACL_NAME)
  93                     .setType(ACL_TYPE)
  94                     .build())
  95             ).build()
  96         ).build();
  97     }
  98
  99     @Test
 100     public void testWrite() throws WriteFailedException {
 101         when(api.classifyAddDelTable(any())).thenReturn(future(new ClassifyAddDelTableReply()));
 102         when(api.classifyAddDelSession(any())).thenReturn(future(new ClassifyAddDelSessionReply()));
 103
 104         when(writeContext.readAfter(any())).thenReturn(Optional.of(
 105             new org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.access.control.list.rev160708.access.lists.AclBuilder()
 106                 .setAccessListEntries(
 107                     new AccessListEntriesBuilder().setAce(Arrays.asList(ace(permit()), ace(permit()), ace(deny())
 108                     )).build()
 109                 ).build()
 110
 111         ));
 112         when(api.inputAclSetInterface(any())).thenReturn(future(new InputAclSetInterfaceReply()));
 113
 114         customizer.writeCurrentAttributes(IID, acl, writeContext);
 115
 116         final InOrder inOrder = Mockito.inOrder(api);
 117         inOrder.verify(api).classifyAddDelTable(argThat(actionOnMissEquals(DENY))); // default action
 118         inOrder.verify(api).classifyAddDelTable(any());
 119         inOrder.verify(api).classifyAddDelSession(argThat(actionOnHitEquals(DENY))); // last deny ACE
 120         inOrder.verify(api).classifyAddDelTable(any());
 121         inOrder.verify(api).classifyAddDelSession(argThat(actionOnHitEquals(PERMIT)));
 122         inOrder.verify(api).classifyAddDelTable(any());
 123         inOrder.verify(api).classifyAddDelSession(argThat(actionOnHitEquals(PERMIT)));
 124         inOrder.verify(api).inputAclSetInterface(inputAclSetInterfaceWriteRequest()); // assignment
 125     }
 126
 127     private Matcher<ClassifyAddDelTable> actionOnMissEquals(final int action) {
 128         return new BaseMatcher<ClassifyAddDelTable>() {
 129             public Object item;
 130
 131             @Override
 132             public void describeTo(final Description description) {
 133                 description.appendText("Expected ClassifyAddDelTable[missNextIndex=" + action + "] but was " + item);
 134             }
 135
 136             @Override
 137             public boolean matches(final Object item) {
 138                 this.item = item;
 139                 if (item instanceof ClassifyAddDelTable) {
 140                     return ((ClassifyAddDelTable) item).missNextIndex == action;
 141                 }
 142                 return false;
 143             }
 144         };
 145     }
 146
 147     private Matcher<ClassifyAddDelSession> actionOnHitEquals(final int action) {
 148         return new BaseMatcher<ClassifyAddDelSession>() {
 149             public Object item;
 150
 151             @Override
 152             public void describeTo(final Description description) {
 153                 description.appendText("Expected ClassifyAddDelSession[hitNextIndex=" + action + "] but was " + item);
 154             }
 155
 156             @Override
 157             public boolean matches(final Object item) {
 158                 this.item = item;
 159                 if (item instanceof ClassifyAddDelSession) {
 160                     return ((ClassifyAddDelSession) item).hitNextIndex == action;
 161                 }
 162                 return false;
 163             }
 164         };
 165     }
 166
 167     private Deny deny() {
 168         return new DenyBuilder().build();
 169     }
 170
 171     private Permit permit() {
 172         return new PermitBuilder().build();
 173     }
 174
 175     private static Ace ace(final PacketHandling action) {
 176         return new AceBuilder()
 177             .setMatches(new MatchesBuilder().setAceType(
 178                 new AceIpBuilder()
 179                     .setAceIpVersion(new AceIpv6Builder().build())
 180                     .setProtocol((short) 1)
 181                     .build()
 182             ).build())
 183             .setActions(new ActionsBuilder().setPacketHandling(action).build())
 184             .build();
 185     }
 186
 187     @Test
 188     public void testDelete() throws WriteFailedException {
 189         when(api.classifyTableByInterface(any())).thenReturn(future(classifyTableByInterfaceReply()));
 190         when(api.inputAclSetInterface(any())).thenReturn(future(new InputAclSetInterfaceReply()));
 191         when(api.classifyAddDelTable(any())).thenReturn(future(new ClassifyAddDelTableReply()));
 192
 193         customizer.deleteCurrentAttributes(IID, acl, writeContext);
 194
 195         final ClassifyTableByInterface expectedRequest = new ClassifyTableByInterface();
 196         expectedRequest.swIfIndex = IF_INDEX;
 197         verify(api).classifyTableByInterface(expectedRequest);
 198         verify(api).inputAclSetInterface(inputAclSetInterfaceDeleteRequest());
 199         verify(api).classifyAddDelTable(classifyAddDelTable(1));
 200         verify(api).classifyAddDelTable(classifyAddDelTable(2));
 201         verify(api).classifyAddDelTable(classifyAddDelTable(3));
 202     }
 203
 204     private static InputAclSetInterface inputAclSetInterfaceDeleteRequest() {
 205         final InputAclSetInterface request = new InputAclSetInterface();
 206         request.l2TableIndex = 1;
 207         request.ip4TableIndex = 2;
 208         request.ip6TableIndex = 3;
 209         return request;
 210     }
 211
 212     private static ClassifyAddDelTable classifyAddDelTable(final int tableIndex) {
 213         final ClassifyAddDelTable reply = new ClassifyAddDelTable();
 214         reply.tableIndex = tableIndex;
 215         return reply;
 216     }
 217
 218     private static ClassifyTableByInterfaceReply classifyTableByInterfaceReply() {
 219         final ClassifyTableByInterfaceReply reply = new ClassifyTableByInterfaceReply();
 220         reply.l2TableId = 1;
 221         reply.ip4TableId = 2;
 222         reply.ip6TableId = 3;
 223         return reply;
 224     }
 225
 226     private static InputAclSetInterface inputAclSetInterfaceWriteRequest() {
 227         final InputAclSetInterface request = new InputAclSetInterface();
 228         request.swIfIndex = IF_INDEX;
 229         request.isAdd = 1;
 230         request.l2TableIndex = -1;
 231         request.ip4TableIndex = -1;
 232         request.ip6TableIndex = 0;
 233         return request;
 234     }
 235 }