ccf1f83b3572d76e261a6aed1a30603353f7a519
[hc2vpp.git] /
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.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.Mock;
44 import org.mockito.Mockito;
45 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.access.control.list.rev160708.AclBase;
46 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.access.control.list.rev160708.EthAcl;
47 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.access.control.list.rev160708.access.lists.acl.AccessListEntriesBuilder;
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;
49 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.access.control.list.rev160708.access.lists.acl.access.list.entries.AceBuilder;
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.ActionsBuilder;
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.MatchesBuilder;
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.PacketHandling;
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.Deny;
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.DenyBuilder;
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.Permit;
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.actions.packet.handling.PermitBuilder;
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.AceIpBuilder;
58 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;
59 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.Interfaces;
60 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.Interface;
61 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.InterfaceKey;
62 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev161214.VppInterfaceAugmentation;
63 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev161214.interfaces._interface.IetfAcl;
64 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev161214.interfaces._interface.ietf.acl.Ingress;
65 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev161214.interfaces._interface.ietf.acl.IngressBuilder;
66 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;
67 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.vpp.acl.rev161214.ietf.acl.base.attributes.AccessListsBuilder;
68 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.vpp.acl.rev161214.ietf.acl.base.attributes.access.lists.AclBuilder;
69 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
70
71 public class IetfAclCustomizerTest extends WriterCustomizerTest {
72
73     private static final String IFC_TEST_INSTANCE = "ifc-test-instance";
74     private static final String IF_NAME = "local0";
75     private static final int IF_INDEX = 1;
76     private static final InstanceIdentifier<Ingress> IID =
77         InstanceIdentifier.create(Interfaces.class).child(Interface.class, new InterfaceKey(IF_NAME)).augmentation(
78             VppInterfaceAugmentation.class).child(IetfAcl.class).child(Ingress.class);
79     private static final String ACL_NAME = "acl1";
80     private static final Class<? extends AclBase> ACL_TYPE = EthAcl.class;
81
82     @Mock
83     private AclTableContextManager aclCtx;
84
85     private IetfAclCustomizer customizer;
86     private Ingress acl;
87     private int DENY = 0;
88     private int PERMIT = -1;
89
90     @Override
91     protected void setUp() {
92         customizer = new IetfAclCustomizer(new IngressIetfAclWriter(api, aclCtx), new NamingContext("prefix", IFC_TEST_INSTANCE));
93         defineMapping(mappingContext, IF_NAME, IF_INDEX, IFC_TEST_INSTANCE);
94         acl = new IngressBuilder().setAccessLists(
95             new AccessListsBuilder().setAcl(
96                 Collections.singletonList(new AclBuilder()
97                     .setName(ACL_NAME)
98                     .setType(ACL_TYPE)
99                     .build())
100             ).build()
101         ).build();
102     }
103
104     @Test
105     public void testWrite() throws WriteFailedException {
106         when(api.classifyAddDelTable(any())).thenReturn(future(new ClassifyAddDelTableReply()));
107         when(api.classifyAddDelSession(any())).thenReturn(future(new ClassifyAddDelSessionReply()));
108
109         when(writeContext.readAfter(any())).thenReturn(Optional.of(
110             new org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.access.control.list.rev160708.access.lists.AclBuilder()
111                 .setAccessListEntries(
112                     new AccessListEntriesBuilder().setAce(Arrays.asList(ace(permit()), ace(permit()), ace(deny())
113                     )).build()
114                 ).build()
115
116         ));
117         when(api.inputAclSetInterface(any())).thenReturn(future(new InputAclSetInterfaceReply()));
118
119         customizer.writeCurrentAttributes(IID, acl, writeContext);
120
121         final InOrder inOrder = Mockito.inOrder(api);
122         inOrder.verify(api).classifyAddDelTable(argThat(actionOnMissEquals(DENY))); // default action
123         inOrder.verify(api).classifyAddDelTable(any());
124         inOrder.verify(api).classifyAddDelSession(argThat(actionOnHitEquals(DENY))); // last deny ACE
125         inOrder.verify(api).classifyAddDelTable(any());
126         inOrder.verify(api).classifyAddDelSession(argThat(actionOnHitEquals(PERMIT)));
127         inOrder.verify(api).classifyAddDelTable(any());
128         inOrder.verify(api).classifyAddDelSession(argThat(actionOnHitEquals(PERMIT)));
129         inOrder.verify(api).inputAclSetInterface(inputAclSetInterfaceWriteRequest()); // assignment
130     }
131
132     private Matcher<ClassifyAddDelTable> actionOnMissEquals(final int action) {
133         return new BaseMatcher<ClassifyAddDelTable>() {
134             public Object item;
135
136             @Override
137             public void describeTo(final Description description) {
138                 description.appendText("Expected ClassifyAddDelTable[missNextIndex=" + action + "] but was " + item);
139             }
140
141             @Override
142             public boolean matches(final Object item) {
143                 this.item = item;
144                 if (item instanceof ClassifyAddDelTable) {
145                     return ((ClassifyAddDelTable) item).missNextIndex == action;
146                 }
147                 return false;
148             }
149         };
150     }
151
152     private Matcher<ClassifyAddDelSession> actionOnHitEquals(final int action) {
153         return new BaseMatcher<ClassifyAddDelSession>() {
154             public Object item;
155
156             @Override
157             public void describeTo(final Description description) {
158                 description.appendText("Expected ClassifyAddDelSession[hitNextIndex=" + action + "] but was " + item);
159             }
160
161             @Override
162             public boolean matches(final Object item) {
163                 this.item = item;
164                 if (item instanceof ClassifyAddDelSession) {
165                     return ((ClassifyAddDelSession) item).hitNextIndex == action;
166                 }
167                 return false;
168             }
169         };
170     }
171
172     private Deny deny() {
173         return new DenyBuilder().build();
174     }
175
176     private Permit permit() {
177         return new PermitBuilder().build();
178     }
179
180     private static Ace ace(final PacketHandling action) {
181         return new AceBuilder()
182             .setMatches(new MatchesBuilder().setAceType(
183                 new AceIpBuilder()
184                     .setAceIpVersion(new AceIpv6Builder().build())
185                     .setProtocol((short) 1)
186                     .build()
187             ).build())
188             .setActions(new ActionsBuilder().setPacketHandling(action).build())
189             .build();
190     }
191
192     @Test
193     public void testDelete() throws WriteFailedException {
194         when(api.inputAclSetInterface(any())).thenReturn(future(new InputAclSetInterfaceReply()));
195         when(api.classifyAddDelTable(any())).thenReturn(future(new ClassifyAddDelTableReply()));
196         when(aclCtx.getEntry(IF_INDEX, mappingContext)).thenReturn(Optional.of(
197             new MappingEntryBuilder()
198                 .setIndex(IF_INDEX)
199                 .setL2TableId(1)
200                 .setIp4TableId(2)
201                 .setIp6TableId(3)
202                 .build()));
203
204         customizer.deleteCurrentAttributes(IID, acl, writeContext);
205
206         final ClassifyTableByInterface expectedRequest = new ClassifyTableByInterface();
207         expectedRequest.swIfIndex = IF_INDEX;
208         verify(api).inputAclSetInterface(inputAclSetInterfaceDeleteRequest());
209         verify(api).classifyAddDelTable(classifyAddDelTable(1));
210         verify(api).classifyAddDelTable(classifyAddDelTable(2));
211         verify(api).classifyAddDelTable(classifyAddDelTable(3));
212     }
213
214     private static InputAclSetInterface inputAclSetInterfaceDeleteRequest() {
215         final InputAclSetInterface request = new InputAclSetInterface();
216         request.swIfIndex = IF_INDEX;
217         request.l2TableIndex = 1;
218         request.ip4TableIndex = 2;
219         request.ip6TableIndex = 3;
220         return request;
221     }
222
223     private static ClassifyAddDelTable classifyAddDelTable(final int tableIndex) {
224         final ClassifyAddDelTable reply = new ClassifyAddDelTable();
225         reply.tableIndex = tableIndex;
226         return reply;
227     }
228
229     private static InputAclSetInterface inputAclSetInterfaceWriteRequest() {
230         final InputAclSetInterface request = new InputAclSetInterface();
231         request.swIfIndex = IF_INDEX;
232         request.isAdd = 1;
233         request.l2TableIndex = -1;
234         request.ip4TableIndex = -1;
235         request.ip6TableIndex = 0;
236         return request;
237     }
238 }