HONEYCOMB-91: Create read customizer for L2FibEntry

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

5 files changed, 178 insertions, 37 deletions

diff --git a/v3po/v3po2vpp/src/test/java/io/fd/honeycomb/v3po/translate/v3po/test/ContextTestUtils.java b/v3po/v3po2vpp/src/test/java/io/fd/honeycomb/v3po/translate/v3po/test/ContextTestUtils.java
index ce20f0734..5828da850 100644
--- a/v3po/v3po2vpp/src/test/java/io/fd/honeycomb/v3po/translate/v3po/test/ContextTestUtils.java
+++ b/v3po/v3po2vpp/src/test/java/io/fd/honeycomb/v3po/translate/v3po/test/ContextTestUtils.java
@@ -16,10 +16,16 @@
 
 package io.fd.honeycomb.v3po.translate.v3po.test;
 
+import static org.mockito.Mockito.doReturn;
+
 import com.google.common.base.Optional;
+import com.google.common.collect.Lists;
+import io.fd.honeycomb.v3po.translate.MappingContext;
+import java.util.List;
 import org.opendaylight.yang.gen.v1.urn.honeycomb.params.xml.ns.yang.naming.context.rev160513.Contexts;
 import org.opendaylight.yang.gen.v1.urn.honeycomb.params.xml.ns.yang.naming.context.rev160513.contexts.NamingContextKey;
 import org.opendaylight.yang.gen.v1.urn.honeycomb.params.xml.ns.yang.naming.context.rev160513.contexts.naming.context.Mappings;
+import org.opendaylight.yang.gen.v1.urn.honeycomb.params.xml.ns.yang.naming.context.rev160513.contexts.naming.context.MappingsBuilder;
 import org.opendaylight.yang.gen.v1.urn.honeycomb.params.xml.ns.yang.naming.context.rev160513.contexts.naming.context.mappings.Mapping;
 import org.opendaylight.yang.gen.v1.urn.honeycomb.params.xml.ns.yang.naming.context.rev160513.contexts.naming.context.mappings.MappingBuilder;
 import org.opendaylight.yang.gen.v1.urn.honeycomb.params.xml.ns.yang.naming.context.rev160513.contexts.naming.context.mappings.MappingKey;
@@ -37,4 +43,25 @@ public class ContextTestUtils {
                 org.opendaylight.yang.gen.v1.urn.honeycomb.params.xml.ns.yang.naming.context.rev160513.contexts.NamingContext.class,
                 new NamingContextKey(namingContextName)).child(Mappings.class).child(Mapping.class, new MappingKey(name));
     }
+
+    public static void mockMapping(final MappingContext mappingContext, final String name, final int id, final String namingContextName) {
+        final InstanceIdentifier<Mappings> mappingsIid = getMappingIid(name, namingContextName).firstIdentifierOf(Mappings.class);
+
+        final Optional<Mapping> singleMapping = getMapping(name, id);
+        final Optional<Mappings> previousMappings = mappingContext.read(mappingsIid);
+
+        final MappingsBuilder mappingsBuilder;
+        if(previousMappings != null && previousMappings.isPresent()) {
+            mappingsBuilder = new MappingsBuilder(previousMappings.get());
+        } else {
+            mappingsBuilder = new MappingsBuilder();
+            mappingsBuilder.setMapping(Lists.newArrayList());
+        }
+
+        final List<Mapping> mappingList = mappingsBuilder.getMapping();
+        mappingList.add(singleMapping.get());
+        doReturn(Optional.of(mappingsBuilder.setMapping(mappingList).build()))
+                .when(mappingContext).read(mappingsIid);
+        doReturn(singleMapping).when(mappingContext).read(getMappingIid(name, namingContextName));
+    }
 }
diff --git a/v3po/v3po2vpp/src/test/java/io/fd/honeycomb/v3po/translate/v3po/vppstate/BridgeDomainCustomizerTest.java b/v3po/v3po2vpp/src/test/java/io/fd/honeycomb/v3po/translate/v3po/vppstate/BridgeDomainCustomizerTest.java
index 369038687..80403eb58 100644
--- a/v3po/v3po2vpp/src/test/java/io/fd/honeycomb/v3po/translate/v3po/vppstate/BridgeDomainCustomizerTest.java
+++ b/v3po/v3po2vpp/src/test/java/io/fd/honeycomb/v3po/translate/v3po/vppstate/BridgeDomainCustomizerTest.java
@@ -54,6 +54,6 @@ public class BridgeDomainCustomizerTest extends ListReaderCustomizerTest<BridgeD
 
     @Override
     protected RootReaderCustomizer<BridgeDomain, BridgeDomainBuilder> initCustomizer() {
-        return new BridgeDomainCustomizer(api, bdContext, interfacesContext);
+        return new BridgeDomainCustomizer(api, bdContext);
     }
 }
\ No newline at end of file
diff --git a/v3po/v3po2vpp/src/test/java/io/fd/honeycomb/v3po/translate/v3po/vppstate/L2FibEntryCustomizerTest.java b/v3po/v3po2vpp/src/test/java/io/fd/honeycomb/v3po/translate/v3po/vppstate/L2FibEntryCustomizerTest.java
new file mode 100644
index 000000000..4808b6d88
--- /dev/null
+++ b/v3po/v3po2vpp/src/test/java/io/fd/honeycomb/v3po/translate/v3po/vppstate/L2FibEntryCustomizerTest.java
@@ -0,0 +1,139 @@
+/*
+ * 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.v3po.translate.v3po.vppstate;
+
+import static io.fd.honeycomb.v3po.translate.v3po.test.ContextTestUtils.mockMapping;
+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.v3po.translate.spi.read.RootReaderCustomizer;
+import io.fd.honeycomb.v3po.translate.v3po.test.ListReaderCustomizerTest;
+import io.fd.honeycomb.v3po.translate.v3po.util.NamingContext;
+import java.util.Collections;
+import java.util.List;
+import java.util.concurrent.CompletableFuture;
+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.rev150105.L2FibForward;
+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.L2FibTableBuilder;
+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.l2.fib.attributes.l2.fib.table.L2FibEntryBuilder;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev150105.l2.fib.attributes.l2.fib.table.L2FibEntryKey;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev150105.vpp.state.BridgeDomains;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev150105.vpp.state.bridge.domains.BridgeDomain;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev150105.vpp.state.bridge.domains.BridgeDomainKey;
+import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
+import org.openvpp.jvpp.VppInvocationException;
+import org.openvpp.jvpp.dto.L2FibTableDump;
+import org.openvpp.jvpp.dto.L2FibTableEntry;
+import org.openvpp.jvpp.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);
+    }
+
+    @Override
+    public void setUpBefore() {
+        bdContext = new NamingContext("generatedBdName", BD_CTX_NAME);
+        interfacesContext = new NamingContext("generatedIfaceName", IFC_CTX_NAME);
+    }
+
+    @Override
+    protected RootReaderCustomizer<L2FibEntry, L2FibEntryBuilder> initCustomizer() {
+        return new L2FibEntryCustomizer(api, bdContext, interfacesContext);
+    }
+
+    @Test
+    public void testMerge() throws Exception {
+        final L2FibTableBuilder builder = mock(L2FibTableBuilder.class);
+        final List<L2FibEntry> value = Collections.emptyList();
+        getCustomizer().merge(builder, value);
+        verify(builder).setL2FibEntry(value);
+    }
+
+    private static InstanceIdentifier<L2FibEntry> getL2FibEntryId(final String bdName, final PhysAddress address) {
+        return InstanceIdentifier.create(BridgeDomains.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;
+
+        final CompletableFuture<L2FibTableEntryReplyDump> replyFuture = new CompletableFuture<>();
+        replyFuture.complete(reply);
+        when(api.l2FibTableDump(any(L2FibTableDump.class))).thenReturn(replyFuture);
+    }
+
+    @Test
+    public void testRead() throws Exception {
+        final long address_vpp = 0x0000010203040506L;
+        final PhysAddress address = new PhysAddress("01:02:03:04:05:06");
+
+        mockMapping(mappingContext, BD_NAME, BD_ID, BD_CTX_NAME);
+        mockMapping(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");
+        mockMapping(mappingContext, BD_NAME, BD_ID, BD_CTX_NAME);
+
+        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/honeycomb/v3po/translate/v3po/vppstate/VppStateTest.java b/v3po/v3po2vpp/src/test/java/io/fd/honeycomb/v3po/translate/v3po/vppstate/VppStateTest.java
index 4ca89da8f..8b11769d6 100644
--- a/v3po/v3po2vpp/src/test/java/io/fd/honeycomb/v3po/translate/v3po/vppstate/VppStateTest.java
+++ b/v3po/v3po2vpp/src/test/java/io/fd/honeycomb/v3po/translate/v3po/vppstate/VppStateTest.java
@@ -16,8 +16,8 @@
 
 package io.fd.honeycomb.v3po.translate.v3po.vppstate;
 
-import static io.fd.honeycomb.v3po.translate.v3po.test.ContextTestUtils.getMapping;
 import static io.fd.honeycomb.v3po.translate.v3po.test.ContextTestUtils.getMappingIid;
+import static io.fd.honeycomb.v3po.translate.v3po.test.ContextTestUtils.mockMapping;
 import static org.junit.Assert.assertEquals;
 import static org.junit.Assert.assertFalse;
 import static org.junit.Assert.assertTrue;
@@ -30,7 +30,6 @@ import static org.mockito.MockitoAnnotations.initMocks;
 
 import com.google.common.base.Optional;
 import com.google.common.collect.Iterables;
-import com.google.common.collect.Lists;
 import com.google.common.collect.Multimap;
 import io.fd.honeycomb.v3po.translate.MappingContext;
 import io.fd.honeycomb.v3po.translate.ModificationCache;
@@ -47,11 +46,9 @@ import java.util.concurrent.CompletableFuture;
 import java.util.concurrent.CompletionStage;
 import java.util.concurrent.ExecutionException;
 import org.junit.Before;
+import org.junit.Ignore;
 import org.junit.Test;
 import org.mockito.Mock;
-import org.opendaylight.yang.gen.v1.urn.honeycomb.params.xml.ns.yang.naming.context.rev160513.contexts.naming.context.Mappings;
-import org.opendaylight.yang.gen.v1.urn.honeycomb.params.xml.ns.yang.naming.context.rev160513.contexts.naming.context.MappingsBuilder;
-import org.opendaylight.yang.gen.v1.urn.honeycomb.params.xml.ns.yang.naming.context.rev160513.contexts.naming.context.mappings.Mapping;
 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.VppState;
 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev150105.VppStateBuilder;
@@ -101,7 +98,7 @@ public class VppStateTest {
 
         bdContext = new NamingContext("generatedBdName", "bd-test-instance");
         interfaceContext = new NamingContext("generatedIfaceName", "ifc-test-instance");
-        vppStateReader = VppStateTestUtils.getVppStateReader(api, bdContext, interfaceContext);
+        vppStateReader = VppStateTestUtils.getVppStateReader(api, bdContext);
         readerRegistry = new DelegatingReaderRegistry(Collections.<Reader<? extends DataObject>>singletonList(vppStateReader));
     }
 
@@ -208,13 +205,14 @@ public class VppStateTest {
      * L2fib does not have a dedicated reader, relying on auto filtering
      */
     @Test
+    @Ignore("L2 FIB was moved to dedicated customizer. TODO: add infra test that covers such case")
     @SuppressWarnings("unchecked")
     public void testReadL2Fib() throws Exception {
         final BridgeDomainDetails bd = new BridgeDomainDetails();
         bd.bdId = 0;
         final String bdName = "bdn1";
         mockBdMapping(bd, bdName);
-        mockMapping("eth1", 0, "ifc-test-instance");
+        mockMapping(mappingContext, "eth1", 0, "ifc-test-instance");
 
         whenBridgeDomainDumpThenReturn(Collections.singletonList(bd));
         final L2FibTableEntry l2FibEntry = new L2FibTableEntry();
@@ -237,28 +235,7 @@ public class VppStateTest {
     }
 
     private void mockBdMapping(final BridgeDomainDetails bd, final String bdName) {
-        mockMapping(bdName, bd.bdId, "bd-test-instance");
-    }
-
-    private void mockMapping(final String name, final int id, final String namingContextName) {
-        final InstanceIdentifier<Mappings> mappingsIid = getMappingIid(name, namingContextName).firstIdentifierOf(Mappings.class);
-
-        final Optional<Mapping> singleMapping = getMapping(name, id);
-        final Optional<Mappings> previousMappings = mappingContext.read(mappingsIid);
-
-        final MappingsBuilder mappingsBuilder;
-        if(previousMappings != null && previousMappings.isPresent()) {
-            mappingsBuilder = new MappingsBuilder(previousMappings.get());
-        } else {
-            mappingsBuilder = new MappingsBuilder();
-            mappingsBuilder.setMapping(Lists.newArrayList());
-        }
-
-        final List<Mapping> mappingList = mappingsBuilder.getMapping();
-        mappingList.add(singleMapping.get());
-        doReturn(Optional.of(mappingsBuilder.setMapping(mappingList).build()))
-            .when(mappingContext).read(mappingsIid);
-        doReturn(singleMapping).when(mappingContext).read(getMappingIid(name, namingContextName));
+        mockMapping(mappingContext, bdName, bd.bdId, "bd-test-instance");
     }
 
     @Test
@@ -272,7 +249,7 @@ public class VppStateTest {
         VppState readRoot = (VppState) readerRegistry.read(InstanceIdentifier.create(VppState.class), ctx).get();
 
         final CompositeListReader<BridgeDomain, BridgeDomainKey, BridgeDomainBuilder> bridgeDomainReader =
-            VppStateTestUtils.getBridgeDomainReader(api, bdContext, interfaceContext);
+            VppStateTestUtils.getBridgeDomainReader(api, bdContext);
 
         final List<BridgeDomain> read =
             bridgeDomainReader.readList(InstanceIdentifier.create(VppState.class).child(BridgeDomains.class).child(
diff --git a/v3po/v3po2vpp/src/test/java/io/fd/honeycomb/v3po/translate/v3po/vppstate/VppStateTestUtils.java b/v3po/v3po2vpp/src/test/java/io/fd/honeycomb/v3po/translate/v3po/vppstate/VppStateTestUtils.java
index 688f75911..8fd57d679 100644
--- a/v3po/v3po2vpp/src/test/java/io/fd/honeycomb/v3po/translate/v3po/vppstate/VppStateTestUtils.java
+++ b/v3po/v3po2vpp/src/test/java/io/fd/honeycomb/v3po/translate/v3po/vppstate/VppStateTestUtils.java
@@ -47,14 +47,13 @@ final class VppStateTestUtils {
      * Create root VppState reader with all its children wired
      */
     static CompositeRootReader<VppState, VppStateBuilder> getVppStateReader(@Nonnull final FutureJVpp futureJVpp,
-                                                                            @Nonnull final NamingContext bdContext,
-                                                                            @Nonnull final NamingContext interfaceContext) {
+                                                                            @Nonnull final NamingContext bdContext) {
 
         final ChildReader<Version> versionReader = new CompositeChildReader<>(
                 Version.class, new VersionCustomizer(futureJVpp));
 
         final CompositeListReader<BridgeDomain, BridgeDomainKey, BridgeDomainBuilder> bridgeDomainReader =
-                getBridgeDomainReader(futureJVpp, bdContext, interfaceContext);
+                getBridgeDomainReader(futureJVpp, bdContext);
 
         final ChildReader<BridgeDomains> bridgeDomainsReader = new CompositeChildReader<>(
                 BridgeDomains.class,
@@ -73,10 +72,9 @@ final class VppStateTestUtils {
     }
 
     static CompositeListReader<BridgeDomain, BridgeDomainKey, BridgeDomainBuilder> getBridgeDomainReader(
-            final @Nonnull FutureJVpp futureJVpp, @Nonnull final NamingContext bdContext,
-            @Nonnull final NamingContext interfaceContext) {
+            final @Nonnull FutureJVpp futureJVpp, @Nonnull final NamingContext bdContext) {
         return new CompositeListReader<>(
                 BridgeDomain.class,
-                new BridgeDomainCustomizer(futureJVpp, bdContext, interfaceContext));
+                new BridgeDomainCustomizer(futureJVpp, bdContext));
     }
 }