HONEYCOMB-116: utility for stubbing jvpp methods

- introduces FutureProducer (inspired by https://gerrit.fd.io/r/#/c/2650/)
- updates unit tests for v3po and lisp

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

3 files changed, 67 insertions, 2 deletions

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 4648676bf..4c6810925 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
@@ -22,6 +22,7 @@ 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 io.fd.honeycomb.vpp.test.util.FutureProducer;
 import org.junit.Before;
 import org.junit.Test;
 import org.mockito.Mock;
@@ -38,7 +39,7 @@ 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>> {
+public abstract class ReaderCustomizerTest<D extends DataObject, B extends Builder<D>> implements FutureProducer {
 
     @Mock
     protected FutureJVppCore api;
diff --git a/vpp-common/vpp-translate-test/src/main/java/io/fd/honeycomb/vpp/test/util/FutureProducer.java b/vpp-common/vpp-translate-test/src/main/java/io/fd/honeycomb/vpp/test/util/FutureProducer.java
new file mode 100644
index 000000000..6a81549f2
--- /dev/null
+++ b/vpp-common/vpp-translate-test/src/main/java/io/fd/honeycomb/vpp/test/util/FutureProducer.java
@@ -0,0 +1,63 @@
+/*
+ * 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 java.util.concurrent.CompletableFuture;
+import javax.annotation.Nonnull;
+import org.openvpp.jvpp.VppCallbackException;
+import org.openvpp.jvpp.core.future.FutureJVppCore;
+
+/**
+ * <p>VPP translation test helper, that produces instances of {@link CompletableFuture} with desired results.</p>
+ * <p>Useful when stubbing {@link FutureJVppCore} methods: <br>{@code when(api.showVersion(any())).thenReturn(future(new
+ * ShowVersionReply()));}</p>
+ */
+public interface FutureProducer {
+
+    /**
+     * Returns {@link CompletableFuture} with desired result.
+     *
+     * @param result returned when {@link CompletableFuture#get()} is invoked
+     * @param <T>    the result type of returned future
+     */
+    default <T> CompletableFuture<T> future(@Nonnull final T result) {
+        final CompletableFuture<T> future = new CompletableFuture<>();
+        future.complete(result);
+        return future;
+    }
+
+    /**
+     * Returns {@link CompletableFuture} with provided {@link Exception} as a result.
+     *
+     * @param exception to be thrown when {@link CompletableFuture#get()} is invoked
+     * @param <T>       the result type of returned future
+     */
+    default <T> CompletableFuture<T> failedFuture(@Nonnull final Exception exception) {
+        final CompletableFuture<T> future = new CompletableFuture<>();
+        future.completeExceptionally(exception);
+        return future;
+    }
+
+    /**
+     * Returns {@link CompletableFuture} with VppCallbackException(retval = -1) as a cause.
+     *
+     * @param <T> the result type of returned future
+     */
+    default <T> CompletableFuture<T> failedFuture() {
+        return failedFuture(new VppCallbackException("test-call", 1 /* ctxId */, -1 /* retval */));
+    }
+}
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 0e1d00a9c..e09d7b617 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
@@ -20,6 +20,7 @@ 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 io.fd.honeycomb.vpp.test.util.FutureProducer;
 import org.junit.Before;
 import org.mockito.Mock;
 import org.mockito.Mockito;
@@ -29,7 +30,7 @@ import org.openvpp.jvpp.core.future.FutureJVppCore;
 /**
  * Generic test for classes implementing {@link WriterCustomizer} interface.
  */
-public abstract class WriterCustomizerTest {
+public abstract class WriterCustomizerTest implements FutureProducer {
 
     @Mock
     protected FutureJVppCore api;