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.v3po.interfaces.acl.common.AclTableContextManager;
  26 import io.fd.honeycomb.translate.vpp.util.NamingContext;
  27 import io.fd.honeycomb.translate.write.WriteFailedException;
  28 import io.fd.honeycomb.vpp.test.write.WriterCustomizerTest;
  29 import io.fd.vpp.jvpp.core.dto.ClassifyAddDelSession;
  30 import io.fd.vpp.jvpp.core.dto.ClassifyAddDelSessionReply;
  31 import io.fd.vpp.jvpp.core.dto.ClassifyAddDelTable;
  32 import io.fd.vpp.jvpp.core.dto.ClassifyAddDelTableReply;
  33 import io.fd.vpp.jvpp.core.dto.ClassifyTableByInterface;
  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.junit.Test;
  39 import org.mockito.ArgumentMatcher;
  40 import org.mockito.InOrder;
  41 import org.mockito.Mock;
  42 import org.mockito.Mockito;
  43 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.access.control.list.rev160708.AclBase;
  44 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.access.control.list.rev160708.EthAcl;
  45 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.access.control.list.rev160708.access.lists.acl.AccessListEntriesBuilder;
  46 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.access.control.list.rev160708.access.lists.acl.access.list.entries.Ace;
  47 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.access.control.list.rev160708.access.lists.acl.access.list.entries.AceBuilder;
  48 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;
  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.MatchesBuilder;
  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.actions.PacketHandling;
  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.packet.handling.Deny;
  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.DenyBuilder;
  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.Permit;
  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.PermitBuilder;
  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.matches.ace.type.AceIpBuilder;
  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.ace.ip.ace.ip.version.AceIpv6Builder;
  57 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.Interfaces;
  58 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.Interface;
  59 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.InterfaceKey;
  60 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev161214.VppInterfaceAugmentation;
  61 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev161214.interfaces._interface.IetfAcl;
  62 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev161214.interfaces._interface.ietf.acl.Ingress;
  63 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev161214.interfaces._interface.ietf.acl.IngressBuilder;
  64 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.vpp.acl.context.rev161214.mapping.entry.context.attributes.acl.mapping.entry.context.mapping.table.MappingEntryBuilder;
  65 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.vpp.acl.rev161214.ietf.acl.base.attributes.AccessListsBuilder;
  66 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.vpp.acl.rev161214.ietf.acl.base.attributes.access.lists.AclBuilder;
  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     @Mock
  81     private AclTableContextManager aclCtx;
  82
  83     private IetfAclCustomizer customizer;
  84     private Ingress acl;
  85     private int DENY = 0;
  86     private int PERMIT = -1;
  87
  88     @Override
  89     protected void setUp() {
  90         customizer = new IetfAclCustomizer(new IngressIetfAclWriter(api, aclCtx), new NamingContext("prefix", IFC_TEST_INSTANCE));
  91         defineMapping(mappingContext, IF_NAME, IF_INDEX, IFC_TEST_INSTANCE);
  92         acl = new IngressBuilder().setAccessLists(
  93             new AccessListsBuilder().setAcl(
  94                 Collections.singletonList(new AclBuilder()
  95                     .setName(ACL_NAME)
  96                     .setType(ACL_TYPE)
  97                     .build())
  98             ).build()
  99         ).build();
 100     }
 101
 102     @Test
 103     public void testWrite() throws WriteFailedException {
 104         when(api.classifyAddDelTable(any())).thenReturn(future(new ClassifyAddDelTableReply()));
 105         when(api.classifyAddDelSession(any())).thenReturn(future(new ClassifyAddDelSessionReply()));
 106
 107         when(writeContext.readAfter(any())).thenReturn(Optional.of(
 108             new org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.access.control.list.rev160708.access.lists.AclBuilder()
 109                 .setAccessListEntries(
 110                     new AccessListEntriesBuilder().setAce(Arrays.asList(ace(permit()), ace(permit()), ace(deny())
 111                     )).build()
 112                 ).build()
 113
 114         ));
 115         when(api.inputAclSetInterface(any())).thenReturn(future(new InputAclSetInterfaceReply()));
 116
 117         customizer.writeCurrentAttributes(IID, acl, writeContext);
 118
 119         final InOrder inOrder = Mockito.inOrder(api);
 120         inOrder.verify(api).classifyAddDelTable(argThat(actionOnMissEquals(DENY))); // default action
 121         inOrder.verify(api).classifyAddDelTable(any());
 122         inOrder.verify(api).classifyAddDelSession(argThat(actionOnHitEquals(DENY))); // last deny ACE
 123         inOrder.verify(api).classifyAddDelTable(any());
 124         inOrder.verify(api).classifyAddDelSession(argThat(actionOnHitEquals(PERMIT)));
 125         inOrder.verify(api).classifyAddDelTable(any());
 126         inOrder.verify(api).classifyAddDelSession(argThat(actionOnHitEquals(PERMIT)));
 127         inOrder.verify(api).inputAclSetInterface(inputAclSetInterfaceWriteRequest()); // assignment
 128     }
 129
 130     private ArgumentMatcher<ClassifyAddDelTable> actionOnMissEquals(final int action) {
 131         return table -> table.missNextIndex == action;
 132     }
 133
 134
 135     private ArgumentMatcher<ClassifyAddDelSession> actionOnHitEquals(final int action) {
 136         return session -> session.hitNextIndex == action;
 137     }
 138
 139     private Deny deny() {
 140         return new DenyBuilder().build();
 141     }
 142
 143     private Permit permit() {
 144         return new PermitBuilder().build();
 145     }
 146
 147     private static Ace ace(final PacketHandling action) {
 148         return new AceBuilder()
 149             .setMatches(new MatchesBuilder().setAceType(
 150                 new AceIpBuilder()
 151                     .setAceIpVersion(new AceIpv6Builder().build())
 152                     .setProtocol((short) 1)
 153                     .build()
 154             ).build())
 155             .setActions(new ActionsBuilder().setPacketHandling(action).build())
 156             .build();
 157     }
 158
 159     @Test
 160     public void testDelete() throws WriteFailedException {
 161         when(api.inputAclSetInterface(any())).thenReturn(future(new InputAclSetInterfaceReply()));
 162         when(api.classifyAddDelTable(any())).thenReturn(future(new ClassifyAddDelTableReply()));
 163         when(aclCtx.getEntry(IF_INDEX, mappingContext)).thenReturn(Optional.of(
 164             new MappingEntryBuilder()
 165                 .setIndex(IF_INDEX)
 166                 .setL2TableId(1)
 167                 .setIp4TableId(2)
 168                 .setIp6TableId(3)
 169                 .build()));
 170
 171         customizer.deleteCurrentAttributes(IID, acl, writeContext);
 172
 173         final ClassifyTableByInterface expectedRequest = new ClassifyTableByInterface();
 174         expectedRequest.swIfIndex = IF_INDEX;
 175         verify(api).inputAclSetInterface(inputAclSetInterfaceDeleteRequest());
 176         verify(api).classifyAddDelTable(classifyAddDelTable(1));
 177         verify(api).classifyAddDelTable(classifyAddDelTable(2));
 178         verify(api).classifyAddDelTable(classifyAddDelTable(3));
 179     }
 180
 181     private static InputAclSetInterface inputAclSetInterfaceDeleteRequest() {
 182         final InputAclSetInterface request = new InputAclSetInterface();
 183         request.swIfIndex = IF_INDEX;
 184         request.l2TableIndex = 1;
 185         request.ip4TableIndex = 2;
 186         request.ip6TableIndex = 3;
 187         return request;
 188     }
 189
 190     private static ClassifyAddDelTable classifyAddDelTable(final int tableIndex) {
 191         final ClassifyAddDelTable reply = new ClassifyAddDelTable();
 192         reply.tableIndex = tableIndex;
 193         return reply;
 194     }
 195
 196     private static InputAclSetInterface inputAclSetInterfaceWriteRequest() {
 197         final InputAclSetInterface request = new InputAclSetInterface();
 198         request.swIfIndex = IF_INDEX;
 199         request.isAdd = 1;
 200         request.l2TableIndex = -1;
 201         request.ip4TableIndex = -1;
 202         request.ip6TableIndex = 0;
 203         return request;
 204     }
 205 }