HONEYCOMB-116: base classes for testing customizers

- adds base class for testing writers
- moves base classes to vpp-translate-test,
  subproject of vpp-common

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

5 files changed, 254 insertions, 0 deletions

diff --git a/vpp-common/pom.xml b/vpp-common/pom.xml
index a3b38fce3..f46a182cd 100644
--- a/vpp-common/pom.xml
+++ b/vpp-common/pom.xml
@@ -37,6 +37,7 @@
     <module>naming-context-impl</module>
     <module>minimal-distribution</module>
     <module>vpp-impl-parent</module>
+    <module>vpp-translate-test</module>
   </modules>
   <!-- DO NOT install or deploy the repo root pom as it's only needed to initiate a build -->
   <build>
diff --git a/vpp-common/vpp-translate-test/pom.xml b/vpp-common/vpp-translate-test/pom.xml
new file mode 100644
index 000000000..a80d90bd1
--- /dev/null
+++ b/vpp-common/vpp-translate-test/pom.xml
@@ -0,0 +1,55 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!-- vi: set et smarttab sw=4 tabstop=4: -->
+<!--
+ 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.
+-->
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+
+    <parent>
+        <groupId>io.fd.honeycomb.vpp</groupId>
+        <artifactId>vpp-impl-parent</artifactId>
+        <version>1.16.12-SNAPSHOT</version>
+        <relativePath>../../vpp-common/vpp-impl-parent</relativePath>
+    </parent>
+
+    <modelVersion>4.0.0</modelVersion>
+    <groupId>io.fd.honeycomb.vpp</groupId>
+    <artifactId>vpp-translate-test</artifactId>
+    <version>1.16.12-SNAPSHOT</version>
+    <packaging>bundle</packaging>
+
+    <dependencies>
+        <dependency>
+            <groupId>io.fd.honeycomb</groupId>
+            <artifactId>translate-spi</artifactId>
+            <version>${project.version}</version>
+        </dependency>
+        <dependency>
+            <groupId>io.fd.vpp</groupId>
+            <artifactId>jvpp-core</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>org.mockito</groupId>
+            <artifactId>mockito-all</artifactId>
+            <version>1.9.5</version>
+            <scope>compile</scope>
+        </dependency>
+        <dependency>
+            <groupId>junit</groupId>
+            <artifactId>junit</artifactId>
+            <version>4.12</version>
+            <scope>compile</scope>
+        </dependency>
+    </dependencies>
+</project>
diff --git a/vpp-common/vpp-translate-test/src/main/java/io/fd/honeycomb/vpp/test/read/ListReaderCustomizerTest.java b/vpp-common/vpp-translate-test/src/main/java/io/fd/honeycomb/vpp/test/read/ListReaderCustomizerTest.java
new file mode 100644
index 000000000..0509ef9e5
--- /dev/null
+++ b/vpp-common/vpp-translate-test/src/main/java/io/fd/honeycomb/vpp/test/read/ListReaderCustomizerTest.java
@@ -0,0 +1,52 @@
+/*
+ * 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.read;
+
+import static org.junit.Assert.assertNotNull;
+
+import io.fd.honeycomb.translate.spi.read.ListReaderCustomizer;
+import org.junit.Test;
+import org.opendaylight.yangtools.concepts.Builder;
+import org.opendaylight.yangtools.yang.binding.DataObject;
+import org.opendaylight.yangtools.yang.binding.Identifiable;
+import org.opendaylight.yangtools.yang.binding.Identifier;
+import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
+
+/**
+ * Generic test for classes implementing {@link ListReaderCustomizer} interface.
+ *
+ * @param <D> Specific DataObject derived type (Identifiable), that is handled by this customizer
+ * @param <K> Specific Identifier for handled type (D)
+ * @param <B> Specific Builder for handled type (D)
+ */
+public abstract class ListReaderCustomizerTest<D extends DataObject & Identifiable<K>, K extends Identifier<D>, B extends Builder<D>> extends
+    ReaderCustomizerTest<D, B> {
+
+    protected ListReaderCustomizerTest(Class<D> dataObjectClass) {
+        super(dataObjectClass);
+    }
+
+    @Override
+    protected ListReaderCustomizer<D, K, B> getCustomizer() {
+        return ListReaderCustomizer.class.cast(super.getCustomizer());
+    }
+
+    @Test
+    public void testGetBuilder() throws Exception {
+        assertNotNull(getCustomizer().getBuilder(InstanceIdentifier.create(dataObjectClass)));
+    }
+}
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
new file mode 100644
index 000000000..4648676bf
--- /dev/null
+++ b/vpp-common/vpp-translate-test/src/main/java/io/fd/honeycomb/vpp/test/read/ReaderCustomizerTest.java
@@ -0,0 +1,86 @@
+/*
+ * 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.read;
+
+import static org.junit.Assert.assertNotNull;
+
+import io.fd.honeycomb.translate.MappingContext;
+import io.fd.honeycomb.translate.ModificationCache;
+import io.fd.honeycomb.translate.read.ReadContext;
+import io.fd.honeycomb.translate.spi.read.ReaderCustomizer;
+import org.junit.Before;
+import org.junit.Test;
+import org.mockito.Mock;
+import org.mockito.Mockito;
+import org.mockito.MockitoAnnotations;
+import org.opendaylight.yangtools.concepts.Builder;
+import org.opendaylight.yangtools.yang.binding.DataObject;
+import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
+import org.openvpp.jvpp.core.future.FutureJVppCore;
+
+/**
+ * Generic test for classes implementing {@link ReaderCustomizer} interface.
+ *
+ * @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>> {
+
+    @Mock
+    protected FutureJVppCore api;
+    @Mock
+    protected ReadContext ctx;
+    @Mock
+    protected MappingContext mappingContext;
+
+    protected ModificationCache cache;
+    protected final Class<D> dataObjectClass;
+    private ReaderCustomizer<D, B> customizer;
+
+    protected ReaderCustomizerTest(Class<D> dataObjectClass) {
+        this.dataObjectClass = dataObjectClass;
+    }
+
+    @Before
+    public void setUpParent() throws Exception {
+        MockitoAnnotations.initMocks(this);
+        cache = new ModificationCache();
+        Mockito.doReturn(cache).when(ctx).getModificationCache();
+        Mockito.doReturn(mappingContext).when(ctx).getMappingContext();
+        setUp();
+        customizer = initCustomizer();
+    }
+
+    /**
+     * Optional setup for subclasses. Invoked before customizer is initialized.
+     */
+    protected void setUp() throws Exception {
+    }
+
+    protected abstract ReaderCustomizer<D, B> initCustomizer();
+
+    protected ReaderCustomizer<D, B> getCustomizer() {
+        return customizer;
+    }
+
+    @Test
+    public void testGetBuilder() throws Exception {
+        assertNotNull(customizer.getBuilder(InstanceIdentifier.create(dataObjectClass)));
+    }
+
+    // TODO HONEYCOMB-116: create generic testMerge()
+}
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
new file mode 100644
index 000000000..0e1d00a9c
--- /dev/null
+++ b/vpp-common/vpp-translate-test/src/main/java/io/fd/honeycomb/vpp/test/write/WriterCustomizerTest.java
@@ -0,0 +1,60 @@
+/*
+ * 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.write;
+
+import io.fd.honeycomb.translate.MappingContext;
+import io.fd.honeycomb.translate.ModificationCache;
+import io.fd.honeycomb.translate.spi.write.WriterCustomizer;
+import io.fd.honeycomb.translate.write.WriteContext;
+import org.junit.Before;
+import org.mockito.Mock;
+import org.mockito.Mockito;
+import org.mockito.MockitoAnnotations;
+import org.openvpp.jvpp.core.future.FutureJVppCore;
+
+/**
+ * Generic test for classes implementing {@link WriterCustomizer} interface.
+ */
+public abstract class WriterCustomizerTest {
+
+    @Mock
+    protected FutureJVppCore api;
+    @Mock
+    protected WriteContext writeContext;
+    @Mock
+    protected MappingContext mappingContext;
+
+    protected ModificationCache cache;
+
+    protected WriterCustomizerTest() {
+    }
+
+    @Before
+    public void setUpParent() throws Exception {
+        MockitoAnnotations.initMocks(this);
+        cache = new ModificationCache();
+        Mockito.doReturn(cache).when(writeContext).getModificationCache();
+        Mockito.doReturn(mappingContext).when(writeContext).getMappingContext();
+        setUp();
+    }
+
+    /**
+     * Optional setup for subclasses. Invoked after parent initialization.
+     */
+    protected void setUp() throws Exception {
+    }
+}