HONEYCOMB-116: utility for stubbing MappingContext methods

- introduces MappingContextHelper (refactored ContextTestUtils)
- updates all v3po and lisp unit tests to use MCH
- updates lisp tests to mock EidMappingContext

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

4 files changed, 131 insertions, 3 deletions

diff --git a/vpp-common/vpp-translate-test/pom.xml b/vpp-common/vpp-translate-test/pom.xml
index bef9a3014..4a28d8c1b 100644
--- a/vpp-common/vpp-translate-test/pom.xml
+++ b/vpp-common/vpp-translate-test/pom.xml
@@ -31,6 +31,11 @@
 
     <dependencies>
         <dependency>
+            <groupId>io.fd.honeycomb.vpp</groupId>
+            <artifactId>naming-context-api</artifactId>
+            <version>${project.version}</version>
+        </dependency>
+        <dependency>
             <groupId>io.fd.honeycomb</groupId>
             <artifactId>translate-spi</artifactId>
             <version>${project.version}</version>
diff --git a/vpp-common/vpp-translate-test/src/main/java/io/fd/honeycomb/vpp/test/read/ReaderCustomizerTest.java b/vpp-common/vpp-translate-test/src/main/java/io/fd/honeycomb/vpp/test/read/ReaderCustomizerTest.java
index 3637ee2c8..c90504264 100644
--- a/vpp-common/vpp-translate-test/src/main/java/io/fd/honeycomb/vpp/test/read/ReaderCustomizerTest.java
+++ b/vpp-common/vpp-translate-test/src/main/java/io/fd/honeycomb/vpp/test/read/ReaderCustomizerTest.java
@@ -25,6 +25,7 @@ import io.fd.honeycomb.translate.spi.read.ReaderCustomizer;
 import io.fd.honeycomb.translate.read.ReadContext;
 import io.fd.honeycomb.translate.spi.read.ReaderCustomizer;
 import io.fd.honeycomb.vpp.test.util.FutureProducer;
+import io.fd.honeycomb.vpp.test.util.NamingContextHelper;
 import org.junit.Before;
 import org.junit.Test;
 import org.mockito.Mock;
@@ -41,7 +42,8 @@ import org.openvpp.jvpp.core.future.FutureJVppCore;
  * @param <D> Specific DataObject derived type (Identifiable), that is handled by this customizer
  * @param <B> Specific Builder for handled type (D)
  */
-public abstract class ReaderCustomizerTest<D extends DataObject, B extends Builder<D>> implements FutureProducer {
+public abstract class ReaderCustomizerTest<D extends DataObject, B extends Builder<D>> implements FutureProducer,
+    NamingContextHelper {
 
     @Mock
     protected FutureJVppCore api;
@@ -52,7 +54,7 @@ public abstract class ReaderCustomizerTest<D extends DataObject, B extends Build
 
     protected ModificationCache cache;
     protected final Class<D> dataObjectClass;
-    private ReaderCustomizer<D, B> customizer;
+    protected ReaderCustomizer<D, B> customizer;
 
     protected ReaderCustomizerTest(Class<D> dataObjectClass) {
         this.dataObjectClass = dataObjectClass;
diff --git a/vpp-common/vpp-translate-test/src/main/java/io/fd/honeycomb/vpp/test/util/NamingContextHelper.java b/vpp-common/vpp-translate-test/src/main/java/io/fd/honeycomb/vpp/test/util/NamingContextHelper.java
new file mode 100644
index 000000000..85f73fe1e
--- /dev/null
+++ b/vpp-common/vpp-translate-test/src/main/java/io/fd/honeycomb/vpp/test/util/NamingContextHelper.java
@@ -0,0 +1,119 @@
+/*
+ * 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.vpp.test.util;
+
+import static org.mockito.Mockito.doReturn;
+
+import com.google.common.base.Optional;
+import com.google.common.collect.Lists;
+import io.fd.honeycomb.translate.MappingContext;
+import java.util.List;
+import javax.annotation.Nonnull;
+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.NamingContext;
+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;
+import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
+import org.opendaylight.yangtools.yang.binding.KeyedInstanceIdentifier;
+
+/**
+ * Utility that helps stubbing {@link io.fd.honeycomb.translate.v3po.util.NamingContext} methods.
+ */
+// TODO(HONEYCOMB-226): the class needs to be refactored or even removed after extracting interface from NamingContext
+public interface NamingContextHelper {
+
+    /**
+     * Creates {@link Mapping} for given data.
+     *
+     * @param name  to be mapped
+     * @param index to be mapped
+     * @return name to index mapping
+     */
+    default Optional<Mapping> mapping(@Nonnull final String name, final int index) {
+        return Optional.of(new MappingBuilder().setName(name).setIndex(index).build());
+    }
+
+    /**
+     * Creates {@link KeyedInstanceIdentifier} for {@link Mapping} in {@link NamingContext}.
+     *
+     * @param name              name of the mapping
+     * @param namingContextName name of the naming context
+     * @return identifier for the mapping
+     */
+    default KeyedInstanceIdentifier<Mapping, MappingKey> mappingIid(@Nonnull final String name,
+                                                                    @Nonnull final String namingContextName) {
+        return InstanceIdentifier.create(Contexts.class).child(NamingContext.class,
+            new NamingContextKey(namingContextName)).child(Mappings.class).child(Mapping.class, new MappingKey(name));
+    }
+
+    /**
+     * Stubs {@link MappingContext#read} to include given mapping in {@link NamingContext}.
+     *
+     * @param mappingContext    mock instance of {@link MappingContext}
+     * @param name              name of the mapping
+     * @param index             index to be mapped
+     * @param namingContextName name of the naming context
+     */
+    default void defineMapping(@Nonnull final MappingContext mappingContext, @Nonnull final String name,
+                               final int index, @Nonnull final String namingContextName) {
+        final KeyedInstanceIdentifier<Mapping, MappingKey> mappingIid = mappingIid(name, namingContextName);
+        final InstanceIdentifier<Mappings> mappingsIid = mappingIid.firstIdentifierOf(Mappings.class);
+
+        final Optional<Mapping> singleMapping = mapping(name, index);
+        final List<Mapping> list = Common.getMappingList(mappingContext, mappingsIid);
+        list.add(singleMapping.get());
+
+        doReturn(Optional.of(new MappingsBuilder().setMapping(list).build())).when(mappingContext).read(mappingsIid);
+        doReturn(singleMapping).when(mappingContext).read(mappingIid);
+    }
+
+    /**
+     * Stubs {@link MappingContext#read} for given {@link NamingContext} to return {@link Optional#absent} for provided
+     * name.
+     *
+     * @param mappingContext    mock instance of {@link MappingContext}
+     * @param name              name of the mapping
+     * @param namingContextName name of the naming context
+     */
+    default void noMappingDefined(@Nonnull final MappingContext mappingContext, @Nonnull final String name,
+                                  @Nonnull final String namingContextName) {
+        final InstanceIdentifier<Mappings> iid = mappingIid(name, namingContextName).firstIdentifierOf(Mappings.class);
+        final List<Mapping> list = Common.getMappingList(mappingContext, iid);
+
+        doReturn(Optional.of(new MappingsBuilder().setMapping(list).build())).when(mappingContext).read(iid);
+        doReturn(Optional.absent()).when(mappingContext).read(mappingIid(name, namingContextName));
+    }
+
+    final class Common {
+        private static List<Mapping> getMappingList(@Nonnull final MappingContext mappingContext,
+                                                    @Nonnull final InstanceIdentifier<Mappings> mappingsIid) {
+            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());
+            }
+            return mappingsBuilder.getMapping();
+        }
+    }
+}
diff --git a/vpp-common/vpp-translate-test/src/main/java/io/fd/honeycomb/vpp/test/write/WriterCustomizerTest.java b/vpp-common/vpp-translate-test/src/main/java/io/fd/honeycomb/vpp/test/write/WriterCustomizerTest.java
index e09d7b617..fe8c8fe42 100644
--- a/vpp-common/vpp-translate-test/src/main/java/io/fd/honeycomb/vpp/test/write/WriterCustomizerTest.java
+++ b/vpp-common/vpp-translate-test/src/main/java/io/fd/honeycomb/vpp/test/write/WriterCustomizerTest.java
@@ -21,6 +21,7 @@ import io.fd.honeycomb.translate.ModificationCache;
 import io.fd.honeycomb.translate.spi.write.WriterCustomizer;
 import io.fd.honeycomb.translate.write.WriteContext;
 import io.fd.honeycomb.vpp.test.util.FutureProducer;
+import io.fd.honeycomb.vpp.test.util.NamingContextHelper;
 import org.junit.Before;
 import org.mockito.Mock;
 import org.mockito.Mockito;
@@ -30,7 +31,8 @@ import org.openvpp.jvpp.core.future.FutureJVppCore;
 /**
  * Generic test for classes implementing {@link WriterCustomizer} interface.
  */
-public abstract class WriterCustomizerTest implements FutureProducer {
+public abstract class WriterCustomizerTest implements FutureProducer,
+    NamingContextHelper {
 
     @Mock
     protected FutureJVppCore api;