HC2VPP-88: translation layer for af_packet interface management

Includes postman collection with RESTCONF examples.

Change-Id: If6f7ba1e2e7ab37433ebc5215e4731f1193c62a2
Signed-off-by: Marek Gradzki <mgradzki@cisco.com>

3 files changed, 242 insertions, 0 deletions

diff --git a/v3po/v3po2vpp/src/test/java/io/fd/hc2vpp/v3po/interfaces/AfPacketCustomizerTest.java b/v3po/v3po2vpp/src/test/java/io/fd/hc2vpp/v3po/interfaces/AfPacketCustomizerTest.java
new file mode 100644
index 000000000..2834e91bc
--- /dev/null
+++ b/v3po/v3po2vpp/src/test/java/io/fd/hc2vpp/v3po/interfaces/AfPacketCustomizerTest.java
@@ -0,0 +1,112 @@
+/*
+ * Copyright (c) 2018 Cisco and/or its affiliates.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at:
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package io.fd.hc2vpp.v3po.interfaces;
+
+import static org.mockito.ArgumentMatchers.any;
+import static org.mockito.ArgumentMatchers.eq;
+import static org.mockito.Mockito.verify;
+import static org.mockito.Mockito.when;
+
+import io.fd.hc2vpp.common.test.write.WriterCustomizerTest;
+import io.fd.hc2vpp.common.translate.util.Ipv4Translator;
+import io.fd.hc2vpp.common.translate.util.NamingContext;
+import io.fd.honeycomb.translate.write.WriteFailedException;
+import io.fd.vpp.jvpp.core.dto.AfPacketCreate;
+import io.fd.vpp.jvpp.core.dto.AfPacketCreateReply;
+import io.fd.vpp.jvpp.core.dto.AfPacketDelete;
+import io.fd.vpp.jvpp.core.dto.AfPacketDeleteReply;
+import java.nio.charset.StandardCharsets;
+import org.junit.Test;
+import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.Interfaces;
+import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.Interface;
+import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.InterfaceKey;
+import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.PhysAddress;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev170607.VppInterfaceAugmentation;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev170607.interfaces._interface.AfPacket;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev170607.interfaces._interface.AfPacketBuilder;
+import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
+
+public class AfPacketCustomizerTest extends WriterCustomizerTest implements Ipv4Translator {
+
+    private static final String IFC_TEST_INSTANCE = "ifc-test-instance";
+    private static final int IFACE_ID = 1;
+    private static final String IFACE_NAME = "veth1";
+    private static final InstanceIdentifier<AfPacket> ID =
+        InstanceIdentifier.create(Interfaces.class).child(Interface.class, new InterfaceKey(IFACE_NAME))
+            .augmentation(VppInterfaceAugmentation.class).child(AfPacket.class);
+    private AfPacketCustomizer customizer;
+
+    @Override
+    public void setUpTest() throws Exception {
+        InterfaceTypeTestUtils.setupWriteContext(writeContext,
+            org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev170607.AfPacket.class);
+        customizer = new AfPacketCustomizer(api, new NamingContext("generatedInterfaceName", IFC_TEST_INSTANCE));
+
+        final AfPacketCreateReply createReply = new AfPacketCreateReply();
+        createReply.swIfIndex = IFACE_ID;
+        when(api.afPacketCreate(any())).thenReturn(future(createReply));
+        when(api.afPacketDelete(any())).thenReturn(future(new AfPacketDeleteReply()));
+    }
+
+    @Test
+    public void testWriteRandomMac() throws WriteFailedException {
+        final AfPacketCreate expectedCreateRequest = new AfPacketCreate();
+        expectedCreateRequest.hostIfName = IFACE_NAME.getBytes(StandardCharsets.UTF_8);
+        expectedCreateRequest.useRandomHwAddr = 1;
+        expectedCreateRequest.hwAddr = new byte[6];
+
+        customizer.writeCurrentAttributes(ID, afPacket(), writeContext);
+
+        verify(api).afPacketCreate(expectedCreateRequest);
+        verify(mappingContext).put(mappingIid(IFACE_NAME, IFC_TEST_INSTANCE), mapping(IFACE_NAME, IFACE_ID).get());
+    }
+
+    @Test
+    public void testWriteExplicitMac() throws WriteFailedException {
+        final AfPacket afPacket = afPacket("01:02:03:04:05:06");
+
+        final AfPacketCreate expectedCreateRequest = new AfPacketCreate();
+        expectedCreateRequest.hostIfName = IFACE_NAME.getBytes(StandardCharsets.UTF_8);
+        expectedCreateRequest.useRandomHwAddr = 0;
+        expectedCreateRequest.hwAddr = new byte[] {1, 2, 3, 4, 5, 6};
+
+        customizer.writeCurrentAttributes(ID, afPacket, writeContext);
+
+        verify(api).afPacketCreate(expectedCreateRequest);
+        verify(mappingContext).put(mappingIid(IFACE_NAME, IFC_TEST_INSTANCE), mapping(IFACE_NAME, IFACE_ID).get());
+    }
+
+    @Test
+    public void testDelete() throws WriteFailedException {
+        final AfPacket afPacket = afPacket("02:03:04:05:06:07");
+        final AfPacketDelete expectedDeleteRequest = new AfPacketDelete();
+        expectedDeleteRequest.hostIfName = IFACE_NAME.getBytes(StandardCharsets.UTF_8);
+
+        customizer.deleteCurrentAttributes(ID, afPacket, writeContext);
+
+        verify(api).afPacketDelete(expectedDeleteRequest);
+        verify(mappingContext).delete(eq(mappingIid(IFACE_NAME, IFC_TEST_INSTANCE)));
+    }
+
+    private static AfPacket afPacket() {
+        return new AfPacketBuilder().setHostInterfaceName(IFACE_NAME).build();
+    }
+
+    private static AfPacket afPacket(String mac) {
+        return new AfPacketBuilder().setHostInterfaceName(IFACE_NAME).setMac(new PhysAddress(mac)).build();
+    }
+}
diff --git a/v3po/v3po2vpp/src/test/java/io/fd/hc2vpp/v3po/interfacesstate/AfPacketCustomizerTest.java b/v3po/v3po2vpp/src/test/java/io/fd/hc2vpp/v3po/interfacesstate/AfPacketCustomizerTest.java
new file mode 100644
index 000000000..809c4aec2
--- /dev/null
+++ b/v3po/v3po2vpp/src/test/java/io/fd/hc2vpp/v3po/interfacesstate/AfPacketCustomizerTest.java
@@ -0,0 +1,127 @@
+/*
+ * Copyright (c) 2018 Cisco and/or its affiliates.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at:
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package io.fd.hc2vpp.v3po.interfacesstate;
+
+import static io.fd.hc2vpp.v3po.interfacesstate.AfPacketCustomizer.getCfgId;
+import static org.mockito.ArgumentMatchers.any;
+import static org.mockito.Mockito.mock;
+import static org.mockito.Mockito.verify;
+import static org.mockito.Mockito.verifyZeroInteractions;
+import static org.mockito.Mockito.when;
+
+import io.fd.hc2vpp.common.test.read.InitializingReaderCustomizerTest;
+import io.fd.hc2vpp.common.test.util.InterfaceDumpHelper;
+import io.fd.hc2vpp.common.translate.util.NamingContext;
+import io.fd.hc2vpp.v3po.interfacesstate.cache.InterfaceCacheDumpManager;
+import io.fd.honeycomb.translate.read.ReadFailedException;
+import io.fd.honeycomb.translate.spi.read.ReaderCustomizer;
+import io.fd.vpp.jvpp.core.dto.AfPacketDetails;
+import io.fd.vpp.jvpp.core.dto.AfPacketDetailsReplyDump;
+import io.fd.vpp.jvpp.core.dto.SwInterfaceDetails;
+import java.util.Collections;
+import org.junit.Test;
+import org.mockito.Mock;
+import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.InterfacesState;
+import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.state.Interface;
+import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.state.InterfaceKey;
+import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.PhysAddress;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev170607.VppInterfaceStateAugmentation;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev170607.VppInterfaceStateAugmentationBuilder;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev170607.interfaces.state._interface.AfPacket;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev170607.interfaces.state._interface.AfPacketBuilder;
+import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
+
+public class AfPacketCustomizerTest extends InitializingReaderCustomizerTest<AfPacket, AfPacketBuilder>
+    implements InterfaceDumpHelper {
+    private static final String IFC_CTX_NAME = "ifc-test-instance";
+    private static final String IF_NAME = "host-veth1";
+    private static final int IF_INDEX = 1;
+    private static final InstanceIdentifier<AfPacket> IID =
+        InstanceIdentifier.create(InterfacesState.class).child(Interface.class, new InterfaceKey(IF_NAME))
+            .augmentation(VppInterfaceStateAugmentation.class).child(AfPacket.class);
+
+    private NamingContext interfaceContext;
+
+    @Mock
+    private InterfaceCacheDumpManager dumpCacheManager;
+
+    public AfPacketCustomizerTest() {
+        super(AfPacket.class, VppInterfaceStateAugmentationBuilder.class);
+    }
+
+    @Override
+    protected void setUp() throws Exception {
+        interfaceContext = new NamingContext("generatedInterfaceName", IFC_CTX_NAME);
+        defineMapping(mappingContext, IF_NAME, IF_INDEX, IFC_CTX_NAME);
+    }
+
+    @Override
+    protected ReaderCustomizer<AfPacket, AfPacketBuilder> initCustomizer() {
+        return new AfPacketCustomizer(api, interfaceContext, dumpCacheManager);
+    }
+
+    @Test
+    public void testRead() throws ReadFailedException {
+        final AfPacketBuilder builder = mock(AfPacketBuilder.class);
+        when(dumpCacheManager.getInterfaceDetail(IID, ctx, IF_NAME)).thenReturn(ifaceDetails());
+        when(api.afPacketDump(any())).thenReturn(future(afPacketReplyDump()));
+
+        getCustomizer().readCurrentAttributes(IID, builder, ctx);
+
+        verify(builder).setMac(new PhysAddress("01:02:03:04:05:06"));
+    }
+
+    @Test
+    public void testReadFailed() throws ReadFailedException {
+        final AfPacketBuilder builder = mock(AfPacketBuilder.class);
+        when(dumpCacheManager.getInterfaceDetail(IID, ctx, IF_NAME)).thenReturn(null);
+
+        getCustomizer().readCurrentAttributes(IID, builder, ctx);
+
+        verifyZeroInteractions(builder);
+    }
+
+    @Test
+    public void testInit() {
+        final AfPacket operData = new AfPacketBuilder()
+            .setHostInterfaceName(IF_NAME)
+            .setMac(new PhysAddress("11:22:33:44:55:66")).build();
+        final org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev170607.interfaces._interface.AfPacket
+            cfgData =
+            new org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev170607.interfaces._interface.AfPacketBuilder()
+                .setHostInterfaceName(IF_NAME)
+                .setMac(new PhysAddress("11:22:33:44:55:66")).build();
+        invokeInitTest(IID, operData, getCfgId(IID), cfgData);
+    }
+
+    private SwInterfaceDetails ifaceDetails() {
+        final SwInterfaceDetails details = new SwInterfaceDetails();
+        details.swIfIndex = IF_INDEX;
+        details.interfaceName = IF_NAME.getBytes();
+        details.l2Address = new byte[] {1, 2, 3, 4, 5, 6};
+        return details;
+    }
+
+    private AfPacketDetailsReplyDump afPacketReplyDump() {
+        final AfPacketDetailsReplyDump reply = new AfPacketDetailsReplyDump();
+        final AfPacketDetails details0 = new AfPacketDetails();
+        details0.swIfIndex = IF_INDEX;
+        details0.hostIfName = IF_NAME.getBytes();
+        reply.afPacketDetails = Collections.singletonList(details0);
+        return reply;
+    }
+}
\ No newline at end of file
diff --git a/v3po/v3po2vpp/src/test/java/io/fd/hc2vpp/v3po/interfacesstate/InterfaceDataTranslatorTest.java b/v3po/v3po2vpp/src/test/java/io/fd/hc2vpp/v3po/interfacesstate/InterfaceDataTranslatorTest.java
index 5595ebb5a..4125513de 100644
--- a/v3po/v3po2vpp/src/test/java/io/fd/hc2vpp/v3po/interfacesstate/InterfaceDataTranslatorTest.java
+++ b/v3po/v3po2vpp/src/test/java/io/fd/hc2vpp/v3po/interfacesstate/InterfaceDataTranslatorTest.java
@@ -32,6 +32,7 @@ import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.iana._if.type.re
 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.InterfacesState;
 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.state.Interface;
 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.state.InterfaceKey;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev170607.AfPacket;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev170607.Tap;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev170607.VhostUser;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev170607.VxlanGpeTunnel;
@@ -64,6 +65,7 @@ public class InterfaceDataTranslatorTest implements InterfaceDataTranslator {
         assertEquals(VxlanTunnel.class, getInterfaceType("vxlan0"));
         assertEquals(VxlanGpeTunnel.class, getInterfaceType("vxlan_gpe0"));
         assertEquals(VhostUser.class, getInterfaceType("VirtualEthernet0/0/0"));
+        assertEquals(AfPacket.class, getInterfaceType("host-veth0"));
         assertEquals(EthernetCsmacd.class, getInterfaceType("eth0.0"));
         assertEquals(EthernetCsmacd.class, getInterfaceType("local0"));
     }
@@ -74,6 +76,7 @@ public class InterfaceDataTranslatorTest implements InterfaceDataTranslator {
         assertTrue(isInterfaceOfType(VxlanTunnel.class, interfaceDetails("vxlan0")));
         assertTrue(isInterfaceOfType(VxlanGpeTunnel.class, interfaceDetails("vxlan_gpe0")));
         assertTrue(isInterfaceOfType(VhostUser.class, interfaceDetails("VirtualEthernet0/0/0")));
+        assertTrue(isInterfaceOfType(AfPacket.class, interfaceDetails("host-veth0")));
         assertTrue(isInterfaceOfType(EthernetCsmacd.class, interfaceDetails("eth0.0")));
         assertTrue(isInterfaceOfType(EthernetCsmacd.class, interfaceDetails("local0")));
     }