Raise test coverage of nsh plugin to 80%. HONEYCOMB-198

Change-Id: Ia1ebc0330544d63c66b6462a33563b86358ace6c
Signed-off-by: Hongjun Ni <hongjun.ni@intel.com>

5 files changed, 224 insertions, 2 deletions

diff --git a/nsh/impl/pom.xml b/nsh/impl/pom.xml
index 81138cd3d..8cd0dabbb 100644
--- a/nsh/impl/pom.xml
+++ b/nsh/impl/pom.xml
@@ -55,6 +55,16 @@
       <artifactId>guice-multibindings</artifactId>
       <version>${guice.version}</version>
     </dependency>
+    <dependency>
+        <groupId>com.google.inject.extensions</groupId>
+        <artifactId>guice-testlib</artifactId>
+        <scope>test</scope>
+    </dependency>
+    <dependency>
+        <groupId>org.hamcrest</groupId>
+        <artifactId>hamcrest-all</artifactId>
+        <scope>test</scope>
+    </dependency>
 
     <dependency>
       <groupId>io.fd.honeycomb</groupId>
diff --git a/nsh/impl/src/main/java/io/fd/honeycomb/vppnsh/impl/VppNshModule.java b/nsh/impl/src/main/java/io/fd/honeycomb/vppnsh/impl/VppNshModule.java
index 94399a5fa..cd21e0e76 100755
--- a/nsh/impl/src/main/java/io/fd/honeycomb/vppnsh/impl/VppNshModule.java
+++ b/nsh/impl/src/main/java/io/fd/honeycomb/vppnsh/impl/VppNshModule.java
@@ -16,10 +16,12 @@
 
 package io.fd.honeycomb.vppnsh.impl;
 
+import com.google.common.annotations.VisibleForTesting;
 import com.google.inject.AbstractModule;
 import com.google.inject.Singleton;
 import com.google.inject.multibindings.Multibinder;
 import com.google.inject.name.Names;
+import com.google.inject.Provider;
 import io.fd.honeycomb.data.init.DataTreeInitializer;
 import io.fd.honeycomb.translate.read.ReaderFactory;
 import io.fd.honeycomb.translate.vpp.util.NamingContext;
@@ -29,6 +31,7 @@ import io.fd.honeycomb.vppnsh.impl.init.VppNshInitializer;
 import io.fd.honeycomb.vppnsh.impl.oper.VppNshReaderFactory;
 import io.fd.honeycomb.vppnsh.impl.util.JVppNshProvider;
 import io.fd.vpp.jvpp.nsh.future.FutureJVppNsh;
+import io.fd.vpp.jvpp.nsh.future.FutureJVppNshFacade;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
@@ -38,6 +41,15 @@ import org.slf4j.LoggerFactory;
 public final class VppNshModule extends AbstractModule {
 
     private static final Logger LOG = LoggerFactory.getLogger(VppNshModule.class);
+    private final Class<? extends Provider<FutureJVppNshFacade>> jvppNshProviderClass;
+
+    public VppNshModule() {
+        this(JVppNshProvider.class);
+    }
+    @VisibleForTesting
+    VppNshModule(Class<? extends Provider<FutureJVppNshFacade>> jvppNshProvider) {
+        this.jvppNshProviderClass = jvppNshProvider;
+    }
 
     @Override
     protected void configure() {
@@ -53,7 +65,7 @@ public final class VppNshModule extends AbstractModule {
             .toInstance(new NamingContext("nsh-map-", "nsh-map-context"));
 
         // Bind to Plugin's JVPP.
-        bind(FutureJVppNsh.class).toProvider(JVppNshProvider.class).in(Singleton.class);
+        bind(FutureJVppNsh.class).toProvider(jvppNshProviderClass).in(Singleton.class);
 
         // Below are classes picked up by HC framework
         Multibinder.newSetBinder(binder(), WriterFactory.class).addBinding().to(VppNshWriterFactory.class);
diff --git a/nsh/impl/src/main/java/io/fd/honeycomb/vppnsh/impl/util/JVppNshProvider.java b/nsh/impl/src/main/java/io/fd/honeycomb/vppnsh/impl/util/JVppNshProvider.java
index 04b3ed928..56f73dedf 100755
--- a/nsh/impl/src/main/java/io/fd/honeycomb/vppnsh/impl/util/JVppNshProvider.java
+++ b/nsh/impl/src/main/java/io/fd/honeycomb/vppnsh/impl/util/JVppNshProvider.java
@@ -17,6 +17,7 @@
 package io.fd.honeycomb.vppnsh.impl.util;
 
 import com.google.inject.Inject;
+import com.google.inject.Provider;
 import io.fd.honeycomb.infra.distro.ProviderTrait;
 import java.io.IOException;
 import io.fd.vpp.jvpp.JVppRegistry;
@@ -30,7 +31,7 @@ import org.slf4j.LoggerFactory;
  * Provides future API for jvpp-nsh plugin. Must be a singleton due to shutdown hook usage.
  * Registers shutdown hook to free plugin's resources on shutdown.
  */
-public final class JVppNshProvider extends ProviderTrait<FutureJVppNsh> {
+public final class JVppNshProvider extends ProviderTrait<FutureJVppNshFacade> {
 
     private static final Logger LOG = LoggerFactory.getLogger(JVppNshProvider.class);
 
diff --git a/nsh/impl/src/test/java/io/fd/honeycomb/vppnsh/impl/VppNshModuleTest.java b/nsh/impl/src/test/java/io/fd/honeycomb/vppnsh/impl/VppNshModuleTest.java
new file mode 100644
index 000000000..a07f1c8c9
--- /dev/null
+++ b/nsh/impl/src/test/java/io/fd/honeycomb/vppnsh/impl/VppNshModuleTest.java
@@ -0,0 +1,128 @@
+/*
+ * Copyright (c) 2016 Intel 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.vppnsh.impl;
+
+import static org.hamcrest.CoreMatchers.is;
+import static org.hamcrest.CoreMatchers.not;
+import static org.hamcrest.Matchers.empty;
+import static org.junit.Assert.assertNotNull;
+import static org.junit.Assert.assertThat;
+import static org.mockito.Mockito.mock;
+import static org.mockito.MockitoAnnotations.initMocks;
+
+import com.google.inject.Guice;
+import com.google.inject.Inject;
+import com.google.inject.Provider;
+import com.google.inject.multibindings.Multibinder;
+import com.google.inject.name.Named;
+import com.google.inject.testing.fieldbinder.Bind;
+import com.google.inject.testing.fieldbinder.BoundFieldModule;
+import io.fd.honeycomb.translate.read.ReaderFactory;
+import io.fd.honeycomb.translate.util.read.registry.CompositeReaderRegistryBuilder;
+import io.fd.honeycomb.translate.util.write.registry.FlatWriterRegistryBuilder;
+import io.fd.honeycomb.translate.vpp.util.NamingContext;
+import io.fd.honeycomb.translate.write.WriterFactory;
+import java.util.HashSet;
+import java.util.Set;
+import org.junit.Before;
+import org.junit.Test;
+import org.mockito.Mock;
+import org.opendaylight.controller.md.sal.binding.api.DataBroker;
+import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
+
+import io.fd.honeycomb.vppnsh.impl.config.VppNshWriterFactory;
+import io.fd.honeycomb.vppnsh.impl.init.VppNshInitializer;
+import io.fd.honeycomb.vppnsh.impl.oper.VppNshReaderFactory;
+import io.fd.honeycomb.vppnsh.impl.util.JVppNshProvider;
+import io.fd.vpp.jvpp.nsh.future.FutureJVppNsh;
+import io.fd.vpp.jvpp.nsh.future.FutureJVppNshFacade;
+import io.fd.vpp.jvpp.JVppRegistry;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.vpp.nsh.rev160624.VppNshState;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.vpp.nsh.rev160624.VppNshStateBuilder;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.vpp.nsh.rev160624.vpp.nsh.state.NshEntries;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.vpp.nsh.rev160624.vpp.nsh.state.NshEntriesBuilder;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.vpp.nsh.rev160624.vpp.nsh.state.nsh.entries.NshEntry;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.vpp.nsh.rev160624.vpp.nsh.state.NshMaps;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.vpp.nsh.rev160624.vpp.nsh.state.NshMapsBuilder;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.vpp.nsh.rev160624.vpp.nsh.state.nsh.maps.NshMap;
+
+
+public class VppNshModuleTest {
+
+    @Named("honeycomb-context")
+    @Bind
+    @Mock
+    private DataBroker honeycombContext;
+
+    @Named("honeycomb-initializer")
+    @Bind
+    @Mock
+    private DataBroker honeycombInitializer;
+
+    @Named("interface-context")
+    @Bind
+    private NamingContext interfaceContext;
+
+    @Bind
+    @Mock
+    private JVppRegistry registry;
+
+    @Inject
+    private Set<ReaderFactory> readerFactories = new HashSet<>();
+
+    @Inject
+    private Set<WriterFactory> writerFactories = new HashSet<>();
+
+    @Before
+    public void setUp() throws Exception {
+
+        initMocks(this);
+
+        interfaceContext = new NamingContext("interface-", "interface-context");
+
+        Guice.createInjector(new VppNshModule(MockJVppNshProvider.class), BoundFieldModule.of(this)).injectMembers(this);
+    }
+
+    @Test
+    public void testReaderFactories() throws Exception {
+        assertThat(readerFactories, is(not(empty())));
+
+        // Test registration process (all dependencies present, topological order of readers does exist, etc.)
+        final CompositeReaderRegistryBuilder registryBuilder = new CompositeReaderRegistryBuilder();
+        readerFactories.forEach(factory -> factory.init(registryBuilder));
+        assertNotNull(registryBuilder.build());
+    }
+
+    @Test
+    public void testWriterFactories() throws Exception {
+        assertThat(writerFactories, is(not(empty())));
+
+        // Test registration process (all dependencies present, topological order of writers does exist, etc.)
+        final FlatWriterRegistryBuilder registryBuilder = new FlatWriterRegistryBuilder();
+        writerFactories.forEach(factory -> factory.init(registryBuilder));
+        assertNotNull(registryBuilder.build());
+    }
+
+    private static final class MockJVppNshProvider implements Provider<FutureJVppNshFacade> {
+
+        @Override
+        public FutureJVppNshFacade get() {
+            return mock(FutureJVppNshFacade.class);
+        }
+    }
+}
+
diff --git a/nsh/impl/src/test/java/io/fd/honeycomb/vppnsh/impl/init/VppNshInitializerTest.java b/nsh/impl/src/test/java/io/fd/honeycomb/vppnsh/impl/init/VppNshInitializerTest.java
new file mode 100644
index 000000000..18b799cc5
--- /dev/null
+++ b/nsh/impl/src/test/java/io/fd/honeycomb/vppnsh/impl/init/VppNshInitializerTest.java
@@ -0,0 +1,71 @@
+/*
+ * Copyright (c) 2016 Intel 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.vppnsh.impl.init;
+
+import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.assertNotNull;
+import static org.mockito.Mockito.mock;
+
+import com.google.common.collect.Lists;
+import java.util.stream.Collectors;
+
+import org.junit.Test;
+import org.opendaylight.controller.md.sal.binding.api.DataBroker;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.vpp.nsh.rev160624.VppNsh;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.vpp.nsh.rev160624.VppNshBuilder;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.vpp.nsh.rev160624.VppNshState;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.vpp.nsh.rev160624.VppNshStateBuilder;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.vpp.nsh.rev160624.vpp.nsh.state.NshEntries;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.vpp.nsh.rev160624.vpp.nsh.state.NshEntriesBuilder;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.vpp.nsh.rev160624.vpp.nsh.state.nsh.entries.NshEntry;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.vpp.nsh.rev160624.vpp.nsh.state.nsh.entries.NshEntryBuilder;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.vpp.nsh.rev160624.vpp.nsh.state.NshMaps;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.vpp.nsh.rev160624.vpp.nsh.state.NshMapsBuilder;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.vpp.nsh.rev160624.vpp.nsh.state.nsh.maps.NshMap;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.vpp.nsh.rev160624.vpp.nsh.state.nsh.maps.NshMapBuilder;
+
+
+public class VppNshInitializerTest {
+    @Test
+    public void convert() throws Exception {
+
+        final VppNshInitializer initializer = new VppNshInitializer(mock(DataBroker.class));
+
+
+        /* mock VppNsh operational data */
+        final VppNshStateBuilder stateBuilder = new VppNshStateBuilder();
+
+        NshEntriesBuilder nshEntriesBuilder = new NshEntriesBuilder()
+                .setNshEntry(Lists.newArrayList());
+        stateBuilder.setNshEntries(nshEntriesBuilder.build());
+
+        NshMapsBuilder nshMapsBuilder = new NshMapsBuilder()
+                .setNshMap(Lists.newArrayList());
+        stateBuilder.setNshMaps(nshMapsBuilder.build());
+
+        final VppNshState state = stateBuilder.build();
+
+        /* Convert operational data to config data */
+        final VppNsh config = initializer.convert(state);
+
+        /* vefify the config data */
+        assertNotNull(config);
+        assertNotNull(config.getNshEntries());
+        assertNotNull(config.getNshMaps());
+    }
+
+}