HC2VPP-7 - Split vpp state/Cli RPC to separate module

Introduces VppManageModule containing
- Vpp state attributes
- CLI RPC support
- Keep-alive

Change-Id: I8907e57132cc9e57840aa3b9607fa131a77f767d
Signed-off-by: Jan Srnicek <jsrnicek@cisco.com>

3 files changed, 389 insertions, 0 deletions

diff --git a/v3po/v3po2vpp/src/test/java/io/fd/hc2vpp/v3po/l2state/BridgeDomainCustomizerTest.java b/v3po/v3po2vpp/src/test/java/io/fd/hc2vpp/v3po/l2state/BridgeDomainCustomizerTest.java
new file mode 100644
index 000000000..98e0cde08
--- /dev/null
+++ b/v3po/v3po2vpp/src/test/java/io/fd/hc2vpp/v3po/l2state/BridgeDomainCustomizerTest.java
@@ -0,0 +1,48 @@
+/*
+ * 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.hc2vpp.v3po.l2state;
+
+import io.fd.hc2vpp.common.test.read.ListReaderCustomizerTest;
+import io.fd.hc2vpp.common.translate.util.NamingContext;
+import io.fd.honeycomb.translate.spi.read.ReaderCustomizer;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev161214.BridgeDomainsStateBuilder;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev161214.bridge.domains.state.BridgeDomain;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev161214.bridge.domains.state.BridgeDomainBuilder;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev161214.bridge.domains.state.BridgeDomainKey;
+
+
+public class BridgeDomainCustomizerTest
+    extends ListReaderCustomizerTest<BridgeDomain, BridgeDomainKey, BridgeDomainBuilder> {
+
+    private NamingContext bdContext;
+    private NamingContext interfacesContext;
+
+    public BridgeDomainCustomizerTest() {
+        super(BridgeDomain.class, BridgeDomainsStateBuilder.class);
+    }
+
+    @Override
+    public void setUp() {
+        bdContext = new NamingContext("generatedBdName", "bd-test-instance");
+        interfacesContext = new NamingContext("generatedIfaceName", "ifc-test-instance");
+    }
+
+    @Override
+    protected ReaderCustomizer<BridgeDomain, BridgeDomainBuilder> initCustomizer() {
+        return new BridgeDomainCustomizer(api, bdContext);
+    }
+}
\ No newline at end of file
diff --git a/v3po/v3po2vpp/src/test/java/io/fd/hc2vpp/v3po/l2state/L2FibEntryCustomizerTest.java b/v3po/v3po2vpp/src/test/java/io/fd/hc2vpp/v3po/l2state/L2FibEntryCustomizerTest.java
new file mode 100644
index 000000000..836653b28
--- /dev/null
+++ b/v3po/v3po2vpp/src/test/java/io/fd/hc2vpp/v3po/l2state/L2FibEntryCustomizerTest.java
@@ -0,0 +1,125 @@
+/*
+ * 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.hc2vpp.v3po.l2state;
+
+import static org.junit.Assert.assertEquals;
+import static org.mockito.Matchers.any;
+import static org.mockito.Mockito.mock;
+import static org.mockito.Mockito.verify;
+import static org.mockito.Mockito.when;
+
+import io.fd.honeycomb.translate.spi.read.ReaderCustomizer;
+import io.fd.hc2vpp.common.translate.util.NamingContext;
+import io.fd.hc2vpp.common.test.read.ListReaderCustomizerTest;
+import java.util.Collections;
+import java.util.List;
+import java.util.concurrent.ExecutionException;
+import org.junit.Test;
+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.rev161214.BridgeDomains;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev161214.BridgeDomainsState;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev161214.L2FibForward;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev161214.bridge.domains.state.BridgeDomain;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev161214.bridge.domains.state.BridgeDomainKey;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev161214.l2.fib.attributes.L2FibTable;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev161214.l2.fib.attributes.L2FibTableBuilder;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev161214.l2.fib.attributes.l2.fib.table.L2FibEntry;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev161214.l2.fib.attributes.l2.fib.table.L2FibEntryBuilder;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev161214.l2.fib.attributes.l2.fib.table.L2FibEntryKey;
+import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
+import io.fd.vpp.jvpp.VppInvocationException;
+import io.fd.vpp.jvpp.core.dto.L2FibTableDump;
+import io.fd.vpp.jvpp.core.dto.L2FibTableEntry;
+import io.fd.vpp.jvpp.core.dto.L2FibTableEntryReplyDump;
+
+public class L2FibEntryCustomizerTest extends ListReaderCustomizerTest<L2FibEntry, L2FibEntryKey, L2FibEntryBuilder> {
+
+    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;
+    private static final String BD_CTX_NAME = "bd-test-instance";
+    private static final String IFC_CTX_NAME = "ifc-test-instance";
+    private NamingContext bdContext;
+    private NamingContext interfacesContext;
+
+    public L2FibEntryCustomizerTest() {
+        super(L2FibEntry.class, L2FibTableBuilder.class);
+    }
+
+    @Override
+    public void setUp() {
+        bdContext = new NamingContext("generatedBdName", BD_CTX_NAME);
+        defineMapping(mappingContext, BD_NAME, BD_ID, BD_CTX_NAME);
+        interfacesContext = new NamingContext("generatedIfaceName", IFC_CTX_NAME);
+    }
+
+    @Override
+    protected ReaderCustomizer<L2FibEntry, L2FibEntryBuilder> initCustomizer() {
+        return new L2FibEntryCustomizer(api, bdContext, interfacesContext);
+    }
+
+    private static InstanceIdentifier<L2FibEntry> getL2FibEntryId(final String bdName, final PhysAddress address) {
+        return InstanceIdentifier.create(BridgeDomainsState.class).child(BridgeDomain.class, new BridgeDomainKey(bdName))
+            .child(L2FibTable.class).child(L2FibEntry.class, new L2FibEntryKey(address));
+    }
+
+    private void whenL2FibTableDumpThenReturn(final List<L2FibTableEntry> l2FibTableEntryList)
+        throws ExecutionException, InterruptedException, VppInvocationException {
+        final L2FibTableEntryReplyDump reply = new L2FibTableEntryReplyDump();
+        reply.l2FibTableEntry = l2FibTableEntryList;
+        when(api.l2FibTableDump(any(L2FibTableDump.class))).thenReturn(future(reply));
+    }
+
+    @Test
+    public void testRead() throws Exception {
+        final long address_vpp = 0x0000010203040506L;
+        final PhysAddress address = new PhysAddress("01:02:03:04:05:06");
+        defineMapping(mappingContext, IFACE_NAME, IFACE_ID, IFC_CTX_NAME);
+
+        whenL2FibTableDumpThenReturn(Collections.singletonList(generateL2FibEntry(address_vpp)));
+
+        final L2FibEntryBuilder builder = mock(L2FibEntryBuilder.class);
+        getCustomizer().readCurrentAttributes(getL2FibEntryId(BD_NAME, address), builder, ctx);
+
+        verify(builder).setAction(L2FibForward.class);
+        verify(builder).setBridgedVirtualInterface(false);
+        verify(builder).setOutgoingInterface(IFACE_NAME);
+        verify(builder).setStaticConfig(false);
+        verify(builder).setPhysAddress(address);
+        verify(builder).setKey(new L2FibEntryKey(address));
+    }
+
+    private L2FibTableEntry generateL2FibEntry(final long mac) {
+        final L2FibTableEntry entry = new L2FibTableEntry();
+        entry.mac = mac;
+        entry.swIfIndex = IFACE_ID;
+        return entry;
+    }
+
+    @Test
+    public void testGetAllIds() throws Exception {
+        final long address_vpp = 0x0000112233445566L;
+        final PhysAddress address = new PhysAddress("11:22:33:44:55:66");
+
+        whenL2FibTableDumpThenReturn(Collections.singletonList(generateL2FibEntry(address_vpp)));
+
+        final List<L2FibEntryKey> ids = getCustomizer().getAllIds(getL2FibEntryId(BD_NAME, address), ctx);
+        assertEquals(1, ids.size());
+        assertEquals(address, ids.get(0).getPhysAddress());
+    }
+}
\ No newline at end of file
diff --git a/v3po/v3po2vpp/src/test/java/io/fd/hc2vpp/v3po/l2state/L2StateTest.java b/v3po/v3po2vpp/src/test/java/io/fd/hc2vpp/v3po/l2state/L2StateTest.java
new file mode 100644
index 000000000..9a0d0e4c8
--- /dev/null
+++ b/v3po/v3po2vpp/src/test/java/io/fd/hc2vpp/v3po/l2state/L2StateTest.java
@@ -0,0 +1,216 @@
+/*
+ * 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.hc2vpp.v3po.l2state;
+
+import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.assertTrue;
+import static org.mockito.Matchers.any;
+import static org.mockito.Mockito.doAnswer;
+import static org.mockito.Mockito.doReturn;
+import static org.mockito.Mockito.when;
+import static org.mockito.MockitoAnnotations.initMocks;
+
+import com.google.common.base.Optional;
+import com.google.common.collect.Iterables;
+import com.google.common.collect.Multimap;
+import io.fd.hc2vpp.common.test.util.FutureProducer;
+import io.fd.hc2vpp.common.test.util.NamingContextHelper;
+import io.fd.hc2vpp.common.translate.util.NamingContext;
+import io.fd.honeycomb.translate.MappingContext;
+import io.fd.honeycomb.translate.ModificationCache;
+import io.fd.honeycomb.translate.impl.read.GenericListReader;
+import io.fd.honeycomb.translate.impl.read.registry.CompositeReaderRegistryBuilder;
+import io.fd.honeycomb.translate.read.ReadContext;
+import io.fd.honeycomb.translate.read.ReadFailedException;
+import io.fd.honeycomb.translate.read.registry.ReaderRegistry;
+import io.fd.vpp.jvpp.core.dto.BridgeDomainDetails;
+import io.fd.vpp.jvpp.core.dto.BridgeDomainDetailsReplyDump;
+import io.fd.vpp.jvpp.core.dto.BridgeDomainDump;
+import io.fd.vpp.jvpp.core.dto.L2FibTableDump;
+import io.fd.vpp.jvpp.core.dto.L2FibTableEntry;
+import io.fd.vpp.jvpp.core.dto.L2FibTableEntryReplyDump;
+import io.fd.vpp.jvpp.core.future.FutureJVppCore;
+import java.util.Arrays;
+import java.util.Collections;
+import java.util.List;
+import javax.annotation.Nonnull;
+import org.junit.Before;
+import org.junit.Test;
+import org.mockito.Mock;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev161214.BridgeDomainsState;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev161214.BridgeDomainsStateBuilder;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev161214.bridge.domains.state.BridgeDomain;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev161214.bridge.domains.state.BridgeDomainBuilder;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev161214.bridge.domains.state.BridgeDomainKey;
+import org.opendaylight.yangtools.yang.binding.DataObject;
+import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
+
+public class L2StateTest implements FutureProducer, NamingContextHelper {
+
+    private static final String BD_CTX_NAME = "bd-test-instance";
+    @Mock
+    private FutureJVppCore api;
+    @Mock
+    private ReadContext ctx;
+    @Mock
+    private MappingContext mappingContext;
+
+    private NamingContext bdContext;
+
+    private ReaderRegistry readerRegistry;
+
+    private static InstanceIdentifier<BridgeDomainsState> bridgeDomainsId;
+
+    /**
+     * Create root VppState reader with all its children wired.
+     */
+    private static ReaderRegistry getVppStateReader(@Nonnull final FutureJVppCore jVpp,
+                                            @Nonnull final NamingContext bdContext) {
+        final CompositeReaderRegistryBuilder registry = new CompositeReaderRegistryBuilder();
+
+        //  BridgeDomains(Structural)
+        bridgeDomainsId = InstanceIdentifier.create(BridgeDomainsState.class);
+        registry.addStructuralReader(bridgeDomainsId, BridgeDomainsStateBuilder.class);
+        //   BridgeDomain
+        registry.add(getBridgeDomainReader(jVpp, bdContext));
+        return registry.build();
+    }
+
+    private static GenericListReader<BridgeDomain, BridgeDomainKey, BridgeDomainBuilder> getBridgeDomainReader(
+        final @Nonnull FutureJVppCore jVpp, final @Nonnull NamingContext bdContext) {
+        final InstanceIdentifier<BridgeDomain> bridgeDomainId = bridgeDomainsId.child(BridgeDomain.class);
+        return new GenericListReader<>(bridgeDomainId, new BridgeDomainCustomizer(jVpp, bdContext));
+    }
+
+    @Before
+    public void setUp() throws Exception {
+        initMocks(this);
+        final ModificationCache cache = new ModificationCache();
+        doReturn(cache).when(ctx).getModificationCache();
+        doReturn(mappingContext).when(ctx).getMappingContext();
+
+        bdContext = new NamingContext("generatedBdName", BD_CTX_NAME);
+        readerRegistry = getVppStateReader(api, bdContext);
+    }
+
+    private void whenL2FibTableDumpThenReturn(final List<L2FibTableEntry> entryList) {
+        final L2FibTableEntryReplyDump reply = new L2FibTableEntryReplyDump();
+        reply.l2FibTableEntry = entryList;
+        when(api.l2FibTableDump(any(L2FibTableDump.class))).thenReturn(future(reply));
+    }
+
+    private void whenBridgeDomainDumpThenReturn(final List<BridgeDomainDetails> bdList) {
+        final BridgeDomainDetailsReplyDump reply = new BridgeDomainDetailsReplyDump();
+        reply.bridgeDomainDetails = bdList;
+
+        doAnswer(invocation -> {
+            BridgeDomainDump request = (BridgeDomainDump) invocation.getArguments()[0];
+            if (request.bdId == -1) {
+                reply.bridgeDomainDetails = bdList;
+            } else {
+                reply.bridgeDomainDetails = Collections.singletonList(bdList.get(request.bdId));
+            }
+            return future(reply);
+        }).when(api).bridgeDomainDump(any(BridgeDomainDump.class));
+    }
+
+    @Test
+    public void testReadAll() throws Exception {
+        final BridgeDomainDetails bridgeDomainDetails = new BridgeDomainDetails();
+        final BridgeDomainDetails bridgeDomainDetails2 = new BridgeDomainDetails();
+        bridgeDomainDetails2.bdId = 1;
+
+        final List<BridgeDomainDetails> bdList = Arrays.asList(bridgeDomainDetails, bridgeDomainDetails2);
+        mockBdMapping(bridgeDomainDetails, "bd1");
+        mockBdMapping(bridgeDomainDetails2, "bd2");
+
+        whenBridgeDomainDumpThenReturn(bdList);
+
+        final Multimap<InstanceIdentifier<? extends DataObject>, ? extends DataObject> dataObjects =
+            readerRegistry.readAll(ctx);
+        assertEquals(dataObjects.size(), 1);
+        final BridgeDomainsState dataObject =
+            (BridgeDomainsState) Iterables.getOnlyElement(dataObjects.get(Iterables.getOnlyElement(dataObjects.keySet())));
+        assertEquals(2, dataObject.getBridgeDomain().size());
+    }
+
+    @Test
+    public void testReadBridgeDomains() throws Exception {
+        final BridgeDomainDetails details = new BridgeDomainDetails();
+        whenBridgeDomainDumpThenReturn(Collections.singletonList(details));
+
+        mockBdMapping(details, "bdn1");
+        BridgeDomainsState readRoot = (BridgeDomainsState) readerRegistry.read(InstanceIdentifier.create(BridgeDomainsState.class), ctx).get();
+
+        Optional<? extends DataObject> read =
+            readerRegistry.read(InstanceIdentifier.create(BridgeDomainsState.class), ctx);
+        assertTrue(read.isPresent());
+        assertEquals(readRoot.getBridgeDomain(), BridgeDomainsState.class.cast(read.get()).getBridgeDomain());
+    }
+
+    private void mockBdMapping(final BridgeDomainDetails bd, final String bdName) {
+        defineMapping(mappingContext, bdName, bd.bdId, BD_CTX_NAME);
+    }
+
+    @Test
+    public void testReadBridgeDomainAll() throws Exception {
+        final BridgeDomainDetails details = new BridgeDomainDetails();
+        whenBridgeDomainDumpThenReturn(Collections.singletonList(details));
+        mockBdMapping(details, "bd2");
+
+        BridgeDomainsState readRoot = (BridgeDomainsState) readerRegistry.read(InstanceIdentifier.create(BridgeDomainsState.class), ctx).get();
+
+        final GenericListReader<BridgeDomain, BridgeDomainKey, BridgeDomainBuilder> bridgeDomainReader =
+            getBridgeDomainReader(api, bdContext);
+
+        final List<BridgeDomain> read =
+            bridgeDomainReader.readList(InstanceIdentifier.create(BridgeDomainsState.class).child(
+                BridgeDomain.class), ctx);
+
+        assertEquals(readRoot.getBridgeDomain(), read);
+    }
+
+    @Test
+    public void testReadBridgeDomain() throws Exception {
+        final BridgeDomainDetails bd = new BridgeDomainDetails();
+        bd.bdId = 0;
+        final String bdName = "bdn1";
+        mockBdMapping(bd, bdName);
+
+        whenBridgeDomainDumpThenReturn(Collections.singletonList(bd));
+
+        BridgeDomainsState readRoot = (BridgeDomainsState) readerRegistry.read(InstanceIdentifier.create(BridgeDomainsState.class), ctx).get();
+
+        final Optional<? extends DataObject> read =
+            readerRegistry.read(InstanceIdentifier.create(BridgeDomainsState.class).child(
+                BridgeDomain.class, new BridgeDomainKey(bdName)), ctx);
+
+        assertTrue(read.isPresent());
+        assertEquals(readRoot.getBridgeDomain().stream().filter(
+            input -> input.getKey().getName().equals(bdName)).findFirst().get(),
+            read.get());
+    }
+
+    @Test(expected = ReadFailedException.class)
+    public void testReadBridgeDomainNotExisting() throws Exception {
+        final String nonExistingBdName = "NOT EXISTING";
+        noMappingDefined(mappingContext, nonExistingBdName, BD_CTX_NAME);
+
+        readerRegistry.read(InstanceIdentifier.create(BridgeDomainsState.class).child(
+            BridgeDomain.class, new BridgeDomainKey(nonExistingBdName)), ctx);
+    }
+}
\ No newline at end of file