HONEYCOMB-125: write support for ARP termination table

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

3 files changed, 348 insertions, 10 deletions

diff --git a/v3po/v3po2vpp/src/main/java/io/fd/honeycomb/translate/v3po/vpp/ArpTerminationTableEntryCustomizer.java b/v3po/v3po2vpp/src/main/java/io/fd/honeycomb/translate/v3po/vpp/ArpTerminationTableEntryCustomizer.java
new file mode 100644
index 000000000..d59c2bfa2
--- /dev/null
+++ b/v3po/v3po2vpp/src/main/java/io/fd/honeycomb/translate/v3po/vpp/ArpTerminationTableEntryCustomizer.java
@@ -0,0 +1,131 @@
+/*
+ * Copyright (c) 2016 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.honeycomb.translate.v3po.vpp;
+
+import static io.fd.honeycomb.translate.v3po.util.TranslateUtils.booleanToByte;
+
+import com.google.common.base.Preconditions;
+import io.fd.honeycomb.translate.spi.write.ListWriterCustomizer;
+import io.fd.honeycomb.translate.v3po.util.FutureJVppCustomizer;
+import io.fd.honeycomb.translate.v3po.util.NamingContext;
+import io.fd.honeycomb.translate.v3po.util.TranslateUtils;
+import io.fd.honeycomb.translate.v3po.util.WriteTimeoutException;
+import io.fd.honeycomb.translate.write.WriteContext;
+import io.fd.honeycomb.translate.write.WriteFailedException;
+import java.util.concurrent.CompletionStage;
+import javax.annotation.Nonnull;
+import org.apache.commons.lang3.builder.ReflectionToStringBuilder;
+import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress;
+import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4AddressNoZone;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev150105.bridge.domain.attributes.arp.termination.table.ArpTerminationTableEntry;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev150105.bridge.domain.attributes.arp.termination.table.ArpTerminationTableEntryKey;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev150105.vpp.bridge.domains.BridgeDomain;
+import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
+import org.openvpp.jvpp.VppBaseCallException;
+import org.openvpp.jvpp.dto.BdIpMacAddDel;
+import org.openvpp.jvpp.dto.BdIpMacAddDelReply;
+import org.openvpp.jvpp.future.FutureJVpp;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+/**
+ * Writer Customizer responsible for ARP termination table management.<br> Sends {@code bd_ip_mac_add_del} message to
+ * VPP.<br> Equivalent of invoking {@code vppctl set bridge-domain arp term} command.
+ */
+public class ArpTerminationTableEntryCustomizer extends FutureJVppCustomizer
+    implements ListWriterCustomizer<ArpTerminationTableEntry, ArpTerminationTableEntryKey> {
+
+    private static final Logger LOG = LoggerFactory.getLogger(ArpTerminationTableEntryCustomizer.class);
+
+    private final NamingContext bdContext;
+
+    public ArpTerminationTableEntryCustomizer(@Nonnull final FutureJVpp futureJvpp,
+                                              @Nonnull final NamingContext bdContext) {
+        super(futureJvpp);
+        this.bdContext = Preconditions.checkNotNull(bdContext, "bdContext should not be null");
+    }
+
+    @Override
+    public void writeCurrentAttributes(@Nonnull final InstanceIdentifier<ArpTerminationTableEntry> id,
+                                       @Nonnull final ArpTerminationTableEntry dataAfter,
+                                       @Nonnull final WriteContext writeContext)
+        throws WriteFailedException {
+        try {
+            LOG.debug("Creating ARP termination table entry: {} {}", id, dataAfter);
+            bdIpMacAddDel(id, dataAfter, writeContext, true);
+            LOG.debug("L2 ARP termination table entry created successfully: {} {}", id, dataAfter);
+        } catch (VppBaseCallException e) {
+            LOG.warn("Failed to create ARP termination table entry: {} {}", id, dataAfter);
+            throw new WriteFailedException.CreateFailedException(id, dataAfter, e);
+        }
+    }
+
+    @Override
+    public void updateCurrentAttributes(@Nonnull final InstanceIdentifier<ArpTerminationTableEntry> id,
+                                        @Nonnull final ArpTerminationTableEntry dataBefore,
+                                        @Nonnull final ArpTerminationTableEntry dataAfter,
+                                        @Nonnull final WriteContext writeContext) throws WriteFailedException {
+        throw new UnsupportedOperationException(
+            "ARP termination table entry update is not supported. It has to be deleted and then created.");
+    }
+
+    @Override
+    public void deleteCurrentAttributes(@Nonnull final InstanceIdentifier<ArpTerminationTableEntry> id,
+                                        @Nonnull final ArpTerminationTableEntry dataBefore,
+                                        @Nonnull final WriteContext writeContext)
+        throws WriteFailedException {
+        try {
+            LOG.debug("Deleting ARP termination table entry entry: {} {}", id, dataBefore);
+            bdIpMacAddDel(id, dataBefore, writeContext, false);
+            LOG.debug("ARP termination table entry deleted successfully: {} {}", id, dataBefore);
+        } catch (VppBaseCallException e) {
+            LOG.warn("Failed to delete ARP termination table entry: {} {}", id, dataBefore);
+            throw new WriteFailedException.DeleteFailedException(id, e);
+        }
+    }
+
+    private void bdIpMacAddDel(@Nonnull final InstanceIdentifier<ArpTerminationTableEntry> id,
+                               @Nonnull final ArpTerminationTableEntry entry,
+                               final WriteContext writeContext, boolean isAdd)
+        throws VppBaseCallException, WriteTimeoutException {
+        final String bdName = id.firstKeyOf(BridgeDomain.class).getName();
+        final int bdId = bdContext.getIndex(bdName, writeContext.getMappingContext());
+
+        final BdIpMacAddDel request = createRequest(entry, bdId, isAdd);
+        LOG.debug("Sending l2FibAddDel request: {}", ReflectionToStringBuilder.toString(request));
+        final CompletionStage<BdIpMacAddDelReply> replyCompletionStage =
+            getFutureJVpp().bdIpMacAddDel(request);
+
+        TranslateUtils.getReplyForWrite(replyCompletionStage.toCompletableFuture(), id);
+    }
+
+    private BdIpMacAddDel createRequest(final ArpTerminationTableEntry entry, final int bdId, boolean isAdd) {
+        final BdIpMacAddDel request = new BdIpMacAddDel();
+        request.bdId = bdId;
+        request.isAdd = booleanToByte(isAdd);
+        request.macAddress = TranslateUtils.parseMac(entry.getPhysAddress().getValue());
+
+        final IpAddress ipAddress = entry.getIpAddress();
+        if (ipAddress.getIpv6Address() != null) {
+            // FIXME: vpp does not support ipv6 in arp-termination table (based on analysis of l2_bd.c)
+            throw new UnsupportedOperationException("IPv6 address for ARP termination table is not supported yet");
+        }
+
+        request.ipAddress = TranslateUtils.ipv4AddressNoZoneToArray(new Ipv4AddressNoZone(ipAddress.getIpv4Address()));
+        return request;
+    }
+}
diff --git a/v3po/v3po2vpp/src/main/java/org/opendaylight/yang/gen/v1/urn/honeycomb/params/xml/ns/yang/v3po2vpp/rev160406/VppHoneycombWriterModule.java b/v3po/v3po2vpp/src/main/java/org/opendaylight/yang/gen/v1/urn/honeycomb/params/xml/ns/yang/v3po2vpp/rev160406/VppHoneycombWriterModule.java
index 625258b90..2cdf24ce6 100644
--- a/v3po/v3po2vpp/src/main/java/org/opendaylight/yang/gen/v1/urn/honeycomb/params/xml/ns/yang/v3po2vpp/rev160406/VppHoneycombWriterModule.java
+++ b/v3po/v3po2vpp/src/main/java/org/opendaylight/yang/gen/v1/urn/honeycomb/params/xml/ns/yang/v3po2vpp/rev160406/VppHoneycombWriterModule.java
@@ -3,11 +3,14 @@ package org.opendaylight.yang.gen.v1.urn.honeycomb.params.xml.ns.yang.v3po2vpp.r
 import com.google.common.collect.Sets;
 import io.fd.honeycomb.translate.impl.write.GenericListWriter;
 import io.fd.honeycomb.translate.v3po.util.NamingContext;
+import io.fd.honeycomb.translate.v3po.vpp.ArpTerminationTableEntryCustomizer;
 import io.fd.honeycomb.translate.v3po.vpp.BridgeDomainCustomizer;
 import io.fd.honeycomb.translate.v3po.vpp.L2FibEntryCustomizer;
-import io.fd.honeycomb.translate.write.registry.ModifiableWriterRegistryBuilder;
 import io.fd.honeycomb.translate.write.WriterFactory;
+import io.fd.honeycomb.translate.write.registry.ModifiableWriterRegistryBuilder;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev150105.Vpp;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev150105.bridge.domain.attributes.ArpTerminationTable;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev150105.bridge.domain.attributes.arp.termination.table.ArpTerminationTableEntry;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev150105.l2.fib.attributes.L2FibTable;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev150105.l2.fib.attributes.l2.fib.table.L2FibEntry;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev150105.vpp.BridgeDomains;
@@ -37,9 +40,9 @@ public class VppHoneycombWriterModule extends
     @Override
     public java.lang.AutoCloseable createInstance() {
         return new VppHoneycombWriterFactory(
-                getVppJvppWriterDependency(),
-                getBridgeDomainContextVppDependency(),
-                getInterfaceContextVppDependency());
+            getVppJvppWriterDependency(),
+            getBridgeDomainContextVppDependency(),
+            getInterfaceContextVppDependency());
     }
 
     private static final class VppHoneycombWriterFactory implements WriterFactory, AutoCloseable {
@@ -62,17 +65,24 @@ public class VppHoneycombWriterModule extends
             //  BridgeDomains has no handlers
             //   BridgeDomain =
             final InstanceIdentifier<BridgeDomain> bdId =
-                    InstanceIdentifier.create(Vpp.class).child(BridgeDomains.class).child(BridgeDomain.class);
+                InstanceIdentifier.create(Vpp.class).child(BridgeDomains.class).child(BridgeDomain.class);
             registry.add(new GenericListWriter<>(bdId, new BridgeDomainCustomizer(jvpp, bdContext)));
             //    L2FibTable has no handlers
             //     L2FibEntry(handled after BridgeDomain and L2 of ifc and subifc) =
             final InstanceIdentifier<L2FibEntry> l2FibEntryId = bdId.child(L2FibTable.class).child(L2FibEntry.class);
             registry.addAfter(
-                    new GenericListWriter<>(l2FibEntryId, new L2FibEntryCustomizer(jvpp, bdContext, ifcContext)),
-                    Sets.newHashSet(
-                            bdId,
-                            InterfacesHoneycombWriterModule.L2_ID,
-                            SubinterfaceAugmentationWriterFactory.L2_ID));
+                new GenericListWriter<>(l2FibEntryId, new L2FibEntryCustomizer(jvpp, bdContext, ifcContext)),
+                Sets.newHashSet(
+                    bdId,
+                    InterfacesHoneycombWriterModule.L2_ID,
+                    SubinterfaceAugmentationWriterFactory.L2_ID));
+            //    ArpTerminationTable has no handlers
+            //     ArpTerminationTableEntry(handled after BridgeDomain) =
+            final InstanceIdentifier<ArpTerminationTableEntry> arpEntryId =
+                bdId.child(ArpTerminationTable.class).child(ArpTerminationTableEntry.class);
+            registry.addAfter(
+                new GenericListWriter<>(arpEntryId, new ArpTerminationTableEntryCustomizer(jvpp, bdContext)),
+                bdId);
         }
     }
 }
diff --git a/v3po/v3po2vpp/src/test/java/io/fd/honeycomb/translate/v3po/vpp/ArpTerminationTableEntryCustomizerTest.java b/v3po/v3po2vpp/src/test/java/io/fd/honeycomb/translate/v3po/vpp/ArpTerminationTableEntryCustomizerTest.java
new file mode 100644
index 000000000..24fb70be7
--- /dev/null
+++ b/v3po/v3po2vpp/src/test/java/io/fd/honeycomb/translate/v3po/vpp/ArpTerminationTableEntryCustomizerTest.java
@@ -0,0 +1,197 @@
+/*
+ * Copyright (c) 2016 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.honeycomb.translate.v3po.vpp;
+
+import static org.junit.Assert.assertArrayEquals;
+import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.assertTrue;
+import static org.junit.Assert.fail;
+import static org.mockito.Matchers.any;
+import static org.mockito.Mockito.doReturn;
+import static org.mockito.Mockito.mock;
+import static org.mockito.Mockito.verify;
+import static org.mockito.MockitoAnnotations.initMocks;
+
+import io.fd.honeycomb.translate.MappingContext;
+import io.fd.honeycomb.translate.v3po.test.ContextTestUtils;
+import io.fd.honeycomb.translate.v3po.test.TestHelperUtils;
+import io.fd.honeycomb.translate.v3po.util.NamingContext;
+import io.fd.honeycomb.translate.write.WriteContext;
+import io.fd.honeycomb.translate.write.WriteFailedException;
+import java.util.concurrent.CompletableFuture;
+import org.junit.Before;
+import org.junit.Test;
+import org.mockito.ArgumentCaptor;
+import org.mockito.Mock;
+import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress;
+import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4AddressNoZone;
+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.rev150105.bridge.domain.attributes.ArpTerminationTable;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev150105.bridge.domain.attributes.arp.termination.table.ArpTerminationTableEntry;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev150105.bridge.domain.attributes.arp.termination.table.ArpTerminationTableEntryBuilder;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev150105.bridge.domain.attributes.arp.termination.table.ArpTerminationTableEntryKey;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev150105.vpp.BridgeDomains;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev150105.vpp.bridge.domains.BridgeDomain;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev150105.vpp.bridge.domains.BridgeDomainKey;
+import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
+import org.openvpp.jvpp.VppBaseCallException;
+import org.openvpp.jvpp.VppInvocationException;
+import org.openvpp.jvpp.dto.BdIpMacAddDel;
+import org.openvpp.jvpp.dto.BdIpMacAddDelReply;
+import org.openvpp.jvpp.future.FutureJVpp;
+
+public class ArpTerminationTableEntryCustomizerTest {
+    private static final String BD_CTX_NAME = "bd-test-instance";
+    private static final String IFC_CTX_NAME = "ifc-test-instance";
+
+    private static final String BD_NAME = "testBD0";
+    private static final int BD_ID = 111;
+    private static final String IFACE_NAME = "eth0";
+    private static final int IFACE_ID = 123;
+
+    @Mock
+    private FutureJVpp api;
+    @Mock
+    private WriteContext writeContext;
+    @Mock
+    private MappingContext mappingContext;
+
+    private NamingContext bdContext;
+
+    private ArpTerminationTableEntryCustomizer customizer;
+    private byte[] ipAddressRaw;
+    private byte[] physAddressRaw;
+    private PhysAddress physAddress;
+    private IpAddress ipAddress;
+    private ArpTerminationTableEntry entry;
+    private InstanceIdentifier<ArpTerminationTableEntry> id;
+
+    @Before
+    public void setUp() throws Exception {
+        initMocks(this);
+        doReturn(mappingContext).when(writeContext).getMappingContext();
+        bdContext = new NamingContext("generatedBdName", BD_CTX_NAME);
+
+        customizer = new ArpTerminationTableEntryCustomizer(api, bdContext);
+
+        ipAddressRaw = new byte[] {1, 2, 3, 4};
+        physAddressRaw = new byte[] {1, 2, 3, 4, 5, 6};
+        physAddress = new PhysAddress("01:02:03:04:05:06");
+
+        ipAddress = new IpAddress(Ipv4AddressNoZone.getDefaultInstance("1.2.3.4"));
+        entry = generateArpEntry(ipAddress, physAddress);
+        id = getArpEntryId(ipAddress, physAddress);
+
+        ContextTestUtils.mockMapping(mappingContext, BD_NAME, BD_ID, BD_CTX_NAME);
+        ContextTestUtils.mockMapping(mappingContext, IFACE_NAME, IFACE_ID, IFC_CTX_NAME);
+    }
+
+    private static InstanceIdentifier<ArpTerminationTableEntry> getArpEntryId(final IpAddress ipAddress,
+                                                                              final PhysAddress physAddress) {
+        return InstanceIdentifier.create(BridgeDomains.class).child(BridgeDomain.class, new BridgeDomainKey(BD_NAME))
+            .child(ArpTerminationTable.class)
+            .child(ArpTerminationTableEntry.class, new ArpTerminationTableEntryKey(ipAddress, physAddress));
+    }
+
+    private void whenBdIpMacAddDelThenSuccess() {
+        final CompletableFuture<BdIpMacAddDelReply> replyFuture = new CompletableFuture<>();
+        final BdIpMacAddDelReply reply = new BdIpMacAddDelReply();
+        replyFuture.complete(reply);
+        doReturn(replyFuture).when(api).bdIpMacAddDel(any(BdIpMacAddDel.class));
+    }
+
+    private void whenBdIpMacAddDelThenFailure() {
+        doReturn(TestHelperUtils.<BdIpMacAddDelReply>createFutureException()).when(api)
+            .bdIpMacAddDel(any(BdIpMacAddDel.class));
+    }
+
+    private BdIpMacAddDel generateBdIpMacAddDelRequest(final byte[] ipAddress, final byte[] macAddress,
+                                                       final byte isAdd) {
+        final BdIpMacAddDel request = new BdIpMacAddDel();
+        request.ipAddress = ipAddress;
+        request.macAddress = macAddress;
+        request.bdId = BD_ID;
+        request.isAdd = isAdd;
+        return request;
+    }
+
+    private ArpTerminationTableEntry generateArpEntry(final IpAddress ipAddress, final PhysAddress physAddress) {
+        final ArpTerminationTableEntryBuilder entry = new ArpTerminationTableEntryBuilder();
+        entry.setKey(new ArpTerminationTableEntryKey(ipAddress, physAddress));
+        entry.setPhysAddress(physAddress);
+        entry.setIpAddress(ipAddress);
+        return entry.build();
+    }
+
+    private void verifyBdIpMacAddDelWasInvoked(final BdIpMacAddDel expected) throws
+        VppInvocationException {
+        ArgumentCaptor<BdIpMacAddDel> argumentCaptor = ArgumentCaptor.forClass(BdIpMacAddDel.class);
+        verify(api).bdIpMacAddDel(argumentCaptor.capture());
+        final BdIpMacAddDel actual = argumentCaptor.getValue();
+        assertArrayEquals(expected.macAddress, actual.macAddress);
+        assertArrayEquals(expected.ipAddress, actual.ipAddress);
+        assertEquals(expected.bdId, actual.bdId);
+        assertEquals(expected.isAdd, actual.isAdd);
+    }
+
+    @Test
+    public void testCreate() throws Exception {
+        whenBdIpMacAddDelThenSuccess();
+        customizer.writeCurrentAttributes(id, entry, writeContext);
+        verifyBdIpMacAddDelWasInvoked(generateBdIpMacAddDelRequest(ipAddressRaw, physAddressRaw, (byte) 1));
+    }
+
+    @Test
+    public void testCreateFailed() throws Exception {
+        whenBdIpMacAddDelThenFailure();
+        try {
+            customizer.writeCurrentAttributes(id, entry, writeContext);
+        } catch (WriteFailedException.CreateFailedException e) {
+            assertTrue(e.getCause() instanceof VppBaseCallException);
+            verifyBdIpMacAddDelWasInvoked(generateBdIpMacAddDelRequest(ipAddressRaw, physAddressRaw, (byte) 1));
+            return;
+        }
+        fail("WriteFailedException.CreateFailedException was expected");
+    }
+
+    @Test(expected = UnsupportedOperationException.class)
+    public void testUpdate() throws Exception {
+        customizer.updateCurrentAttributes(InstanceIdentifier.create(ArpTerminationTableEntry.class),
+            mock(ArpTerminationTableEntry.class),
+            mock(ArpTerminationTableEntry.class), writeContext);
+    }
+
+    @Test
+    public void testDelete() throws Exception {
+        whenBdIpMacAddDelThenSuccess();
+        customizer.deleteCurrentAttributes(id, entry, writeContext);
+        verifyBdIpMacAddDelWasInvoked(generateBdIpMacAddDelRequest(ipAddressRaw, physAddressRaw, (byte) 0));
+    }
+
+    @Test
+    public void testDeleteFailed() throws Exception {
+        whenBdIpMacAddDelThenFailure();
+        try {
+            customizer.deleteCurrentAttributes(id, entry, writeContext);
+        } catch (WriteFailedException.DeleteFailedException e) {
+            assertTrue(e.getCause() instanceof VppBaseCallException);
+            verifyBdIpMacAddDelWasInvoked(generateBdIpMacAddDelRequest(ipAddressRaw, physAddressRaw, (byte) 0));
+            return;
+        }
+        fail("WriteFailedException.DeleteFailedException was expected");
+    }
+}
\ No newline at end of file