HC2VPP-106 - jvpp timeout configuration

Allows dynamic configuration of jvpp timeout

Change-Id: Iab113ec33f1efd8d150f0e525ef548a64ebf1a0b
Signed-off-by: Jan Srnicek <jsrnicek@cisco.com>

7 files changed, 90 insertions, 10 deletions

diff --git a/vpp-common/vpp-common-integration/src/main/java/io/fd/hc2vpp/common/integration/JVppTimeoutProvider.java b/vpp-common/vpp-common-integration/src/main/java/io/fd/hc2vpp/common/integration/JVppTimeoutProvider.java
new file mode 100644
index 000000000..ce260326d
--- /dev/null
+++ b/vpp-common/vpp-common-integration/src/main/java/io/fd/hc2vpp/common/integration/JVppTimeoutProvider.java
@@ -0,0 +1,37 @@
+/*
+ * Copyright (c) 2017 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.hc2vpp.common.integration;
+
+import com.google.inject.Inject;
+import com.google.inject.Provider;
+import io.fd.hc2vpp.common.translate.util.JvppReplyConsumer;
+
+class JVppTimeoutProvider implements Provider<JVppTimeoutProvider.JVppTimeoutInit> {
+
+    @Inject
+    private VppConfigAttributes configAttributes;
+
+    @Override
+    public JVppTimeoutInit get() {
+        JvppReplyConsumer.JvppReplyTimeoutHolder.setupTimeout(configAttributes.jvppRequestTimeout);
+        return new JVppTimeoutInit() {
+        };
+    }
+
+    interface JVppTimeoutInit {
+    }
+}
diff --git a/vpp-common/vpp-common-integration/src/main/java/io/fd/hc2vpp/common/integration/VppCommonModule.java b/vpp-common/vpp-common-integration/src/main/java/io/fd/hc2vpp/common/integration/VppCommonModule.java
index c7a1cc9f5..4da2d9a13 100644
--- a/vpp-common/vpp-common-integration/src/main/java/io/fd/hc2vpp/common/integration/VppCommonModule.java
+++ b/vpp-common/vpp-common-integration/src/main/java/io/fd/hc2vpp/common/integration/VppCommonModule.java
@@ -35,6 +35,7 @@ public final class VppCommonModule extends AbstractModule {
         bind(VppStatusListener.class).toInstance(new VppStatusListener());
         bind(JVppRegistry.class).toProvider(JVppRegistryProvider.class).in(Singleton.class);
         bind(FutureJVppCore.class).toProvider(JVppCoreProvider.class).in(Singleton.class);
+        bind(JVppTimeoutProvider.JVppTimeoutInit.class).toProvider(JVppTimeoutProvider.class).asEagerSingleton();
 
         // Naming contexts reader exposing context storage over REST/HONEYCOMB_NETCONF
         final Multibinder<ReaderFactory> readerBinder = Multibinder.newSetBinder(binder(), ReaderFactory.class);
diff --git a/vpp-common/vpp-common-integration/src/main/java/io/fd/hc2vpp/common/integration/VppConfigAttributes.java b/vpp-common/vpp-common-integration/src/main/java/io/fd/hc2vpp/common/integration/VppConfigAttributes.java
index 7ac53e63b..9c351cb7c 100644
--- a/vpp-common/vpp-common-integration/src/main/java/io/fd/hc2vpp/common/integration/VppConfigAttributes.java
+++ b/vpp-common/vpp-common-integration/src/main/java/io/fd/hc2vpp/common/integration/VppConfigAttributes.java
@@ -25,4 +25,7 @@ public class VppConfigAttributes {
 
     @InjectConfig("jvpp-connection-name")
     public String jvppConnectionName;
+
+    @InjectConfig("jvpp-request-timeout")
+    public int jvppRequestTimeout;
 }
diff --git a/vpp-common/vpp-common-integration/src/main/resources/honeycomb-minimal-resources/config/jvpp.json b/vpp-common/vpp-common-integration/src/main/resources/honeycomb-minimal-resources/config/jvpp.json
index 1d411872e..efd1cd66e 100644
--- a/vpp-common/vpp-common-integration/src/main/resources/honeycomb-minimal-resources/config/jvpp.json
+++ b/vpp-common/vpp-common-integration/src/main/resources/honeycomb-minimal-resources/config/jvpp.json
@@ -1,3 +1,4 @@
 {
-  "jvpp-connection-name": "honeycomb"
+  "jvpp-connection-name": "honeycomb",
+  "jvpp-request-timeout":5
 }
\ No newline at end of file
diff --git a/vpp-common/vpp-common-integration/src/test/java/io/fd/hc2vpp/common/integration/VppCommonModuleTest.java b/vpp-common/vpp-common-integration/src/test/java/io/fd/hc2vpp/common/integration/VppCommonModuleTest.java
index b63601de5..540145beb 100644
--- a/vpp-common/vpp-common-integration/src/test/java/io/fd/hc2vpp/common/integration/VppCommonModuleTest.java
+++ b/vpp-common/vpp-common-integration/src/test/java/io/fd/hc2vpp/common/integration/VppCommonModuleTest.java
@@ -19,6 +19,7 @@ package io.fd.hc2vpp.common.integration;
 import static org.hamcrest.CoreMatchers.is;
 import static org.hamcrest.CoreMatchers.not;
 import static org.hamcrest.Matchers.empty;
+import static org.junit.Assert.assertEquals;
 import static org.junit.Assert.assertThat;
 import static org.mockito.MockitoAnnotations.initMocks;
 
@@ -27,9 +28,11 @@ import com.google.inject.Inject;
 import com.google.inject.name.Named;
 import com.google.inject.testing.fieldbinder.Bind;
 import com.google.inject.testing.fieldbinder.BoundFieldModule;
+import io.fd.hc2vpp.common.translate.util.JvppReplyConsumer;
 import io.fd.honeycomb.translate.read.ReaderFactory;
 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;
@@ -49,5 +52,14 @@ public class VppCommonModuleTest {
         initMocks(this);
         Guice.createInjector(new VppCommonModule(), BoundFieldModule.of(this)).injectMembers(this);
         assertThat(readerFactories, is(not(empty())));
+        assertEquals(15, JvppReplyConsumer.JvppReplyTimeoutHolder.getTimeout());
+    }
+
+    public void testConfigureJVppTimeoutIgnoreOnRetry() {
+        initMocks(this);
+        Guice.createInjector(new VppCommonModule(), BoundFieldModule.of(this)).injectMembers(this);
+        JvppReplyConsumer.JvppReplyTimeoutHolder.setupTimeout(1);
+        // reconfiguration is ignored
+        assertEquals(15, JvppReplyConsumer.JvppReplyTimeoutHolder.getTimeout());
     }
 }
\ No newline at end of file
diff --git a/vpp-common/vpp-common-integration/src/test/resources/jvpp.json b/vpp-common/vpp-common-integration/src/test/resources/jvpp.json
index 1d411872e..4bdaced82 100644
--- a/vpp-common/vpp-common-integration/src/test/resources/jvpp.json
+++ b/vpp-common/vpp-common-integration/src/test/resources/jvpp.json
@@ -1,3 +1,4 @@
 {
-  "jvpp-connection-name": "honeycomb"
+  "jvpp-connection-name": "honeycomb",
+  "jvpp-request-timeout":15
 }
\ No newline at end of file
diff --git a/vpp-common/vpp-translate-utils/src/main/java/io/fd/hc2vpp/common/translate/util/JvppReplyConsumer.java b/vpp-common/vpp-translate-utils/src/main/java/io/fd/hc2vpp/common/translate/util/JvppReplyConsumer.java
index d55446c82..2a8345445 100644
--- a/vpp-common/vpp-translate-utils/src/main/java/io/fd/hc2vpp/common/translate/util/JvppReplyConsumer.java
+++ b/vpp-common/vpp-translate-utils/src/main/java/io/fd/hc2vpp/common/translate/util/JvppReplyConsumer.java
@@ -20,6 +20,7 @@ import io.fd.honeycomb.translate.read.ReadFailedException;
 import io.fd.honeycomb.translate.write.WriteFailedException;
 import io.fd.vpp.jvpp.VppBaseCallException;
 import io.fd.vpp.jvpp.dto.JVppReply;
+import java.util.Optional;
 import org.opendaylight.yangtools.yang.binding.DataObject;
 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
 
@@ -29,16 +30,17 @@ import java.util.concurrent.ExecutionException;
 import java.util.concurrent.Future;
 import java.util.concurrent.TimeUnit;
 import java.util.concurrent.TimeoutException;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
 
 import static com.google.common.base.Preconditions.checkArgument;
+import static com.google.common.base.Preconditions.checkState;
 
 /**
  * Trait providing logic for consuming reply's to jvpp api calls
  */
 public interface JvppReplyConsumer {
 
-    int DEFAULT_TIMEOUT_IN_SECONDS = 5;
-
     JvppReplyConsumer INSTANCE = new JvppReplyConsumer() {
     };
 
@@ -50,7 +52,8 @@ public interface JvppReplyConsumer {
     default <REP extends JVppReply<?>> REP getReplyForWrite(@Nonnull Future<REP> future,
                                                             @Nonnull final InstanceIdentifier<?> replyType)
             throws WriteFailedException {
-        return getReplyForWrite(future, replyType, DEFAULT_TIMEOUT_IN_SECONDS);
+
+        return getReplyForWrite(future, replyType, JvppReplyTimeoutHolder.getTimeout());
     }
 
     /**
@@ -79,7 +82,7 @@ public interface JvppReplyConsumer {
                                                              @Nonnull final InstanceIdentifier<?> replyType,
                                                              @Nonnull final DataObject data)
             throws WriteFailedException {
-        return getReplyForCreate(future, replyType, data, DEFAULT_TIMEOUT_IN_SECONDS);
+        return getReplyForCreate(future, replyType, data, JvppReplyTimeoutHolder.getTimeout());
     }
 
     /**
@@ -107,7 +110,7 @@ public interface JvppReplyConsumer {
                                                              @Nonnull final DataObject dataBefore,
                                                              @Nonnull final DataObject dataAfter)
             throws WriteFailedException {
-        return getReplyForUpdate(future, replyType, dataBefore, dataAfter, DEFAULT_TIMEOUT_IN_SECONDS);
+        return getReplyForUpdate(future, replyType, dataBefore, dataAfter, JvppReplyTimeoutHolder.getTimeout());
     }
 
     /**
@@ -134,7 +137,7 @@ public interface JvppReplyConsumer {
     default <REP extends JVppReply<?>> REP getReplyForDelete(@Nonnull Future<REP> future,
                                                              @Nonnull final InstanceIdentifier<?> replyType)
             throws WriteFailedException {
-        return getReplyForDelete(future, replyType, DEFAULT_TIMEOUT_IN_SECONDS);
+        return getReplyForDelete(future, replyType, JvppReplyTimeoutHolder.getTimeout());
     }
 
     /**
@@ -156,7 +159,7 @@ public interface JvppReplyConsumer {
     default <REP extends JVppReply<?>> REP getReplyForRead(@Nonnull Future<REP> future,
                                                            @Nonnull final InstanceIdentifier<?> replyType)
             throws ReadFailedException {
-        return getReplyForRead(future, replyType, DEFAULT_TIMEOUT_IN_SECONDS);
+        return getReplyForRead(future, replyType, JvppReplyTimeoutHolder.getTimeout());
     }
 
     default <REP extends JVppReply<?>> REP getReplyForRead(@Nonnull Future<REP> future,
@@ -174,7 +177,7 @@ public interface JvppReplyConsumer {
 
     default <REP extends JVppReply<?>> REP getReply(@Nonnull Future<REP> future)
             throws TimeoutException, VppBaseCallException {
-        return getReply(future, DEFAULT_TIMEOUT_IN_SECONDS);
+        return getReply(future, JvppReplyTimeoutHolder.getTimeout());
     }
 
     default <REP extends JVppReply<?>> REP getReply(@Nonnull Future<REP> future,
@@ -195,4 +198,26 @@ public interface JvppReplyConsumer {
             throw new IllegalStateException(e);
         }
     }
+
+    /**
+     * Wrapper for reply timeout
+     */
+    class JvppReplyTimeoutHolder {
+        private static final Logger LOG = LoggerFactory.getLogger(JvppReplyTimeoutHolder.class);
+        private static Optional<Integer> timeout = Optional.empty();
+
+        public static void setupTimeout(@Nonnegative final int jvppTimeout) {
+            if (timeout.isPresent()) {
+                // do not fail on reconfigure, to not disturb restarts
+                LOG.warn("JVpp timeout already configured");
+                return;
+            }
+            timeout = Optional.of(jvppTimeout);
+            LOG.info("Jvpp reply timeout configured to {} seconds", timeout.get());
+        }
+
+        public static int getTimeout() {
+            return timeout.orElse(5);
+        }
+    }
 }