Cleanup and document FindLeaderReply

[controller.git] / opendaylight / md-sal / sal-distributed-datastore / src / test / java / org / opendaylight / controller / cluster / datastore / ShardTestKit.java

diff --git a/opendaylight/md-sal/sal-distributed-datastore/src/test/java/org/opendaylight/controller/cluster/datastore/ShardTestKit.java b/opendaylight/md-sal/sal-distributed-datastore/src/test/java/org/opendaylight/controller/cluster/datastore/ShardTestKit.java
index 9a0e8f9e18416d104f059e316577d377e5c718f2..0ac21d8cd2f9ac88c924db31580ad6c306d7950a 100644 (file)
--- a/opendaylight/md-sal/sal-distributed-datastore/src/test/java/org/opendaylight/controller/cluster/datastore/ShardTestKit.java
+++ b/opendaylight/md-sal/sal-distributed-datastore/src/test/java/org/opendaylight/controller/cluster/datastore/ShardTestKit.java
@@ -7,27 +7,33 @@
  */
 package org.opendaylight.controller.cluster.datastore;
 
+import akka.actor.ActorRef;
+import akka.actor.ActorSystem;
+import akka.pattern.Patterns;
+import akka.testkit.JavaTestKit;
+import akka.util.Timeout;
+import com.google.common.util.concurrent.Uninterruptibles;
+import java.util.Optional;
 import java.util.concurrent.TimeUnit;
+import java.util.concurrent.TimeoutException;
 import org.junit.Assert;
 import org.opendaylight.controller.cluster.raft.client.messages.FindLeader;
 import org.opendaylight.controller.cluster.raft.client.messages.FindLeaderReply;
-import com.google.common.util.concurrent.Uninterruptibles;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
 import scala.concurrent.Await;
 import scala.concurrent.Future;
 import scala.concurrent.duration.Duration;
-import akka.actor.ActorRef;
-import akka.actor.ActorSystem;
-import akka.pattern.Patterns;
-import akka.testkit.JavaTestKit;
-import akka.util.Timeout;
+import scala.concurrent.duration.FiniteDuration;
 
-class ShardTestKit extends JavaTestKit {
+public class ShardTestKit extends JavaTestKit {
+    private static final Logger LOG = LoggerFactory.getLogger(ShardTestKit.class);
 
-    ShardTestKit(ActorSystem actorSystem) {
+    public ShardTestKit(ActorSystem actorSystem) {
         super(actorSystem);
     }
 
-    protected void waitForLogMessage(final Class logLevel, ActorRef subject, String logMessage){
+    public void waitForLogMessage(final Class<?> logLevel, ActorRef subject, String logMessage){
         // Wait for a specific log message to show up
         final boolean result =
             new JavaTestKit.EventFilter<Boolean>(logLevel
@@ -44,21 +50,56 @@ class ShardTestKit extends JavaTestKit {
 
     }
 
-    protected void waitUntilLeader(ActorRef shard) {
+    public static String waitUntilLeader(ActorRef shard) {
+        FiniteDuration duration = Duration.create(100, TimeUnit.MILLISECONDS);
         for(int i = 0; i < 20 * 5; i++) {
-            Future<Object> future = Patterns.ask(shard, new FindLeader(), new Timeout(5, TimeUnit.SECONDS));
+            Future<Object> future = Patterns.ask(shard, FindLeader.INSTANCE, new Timeout(duration));
             try {
-                FindLeaderReply resp = (FindLeaderReply)Await.result(future, Duration.create(5, TimeUnit.SECONDS));
-                if(resp.getLeaderActor() != null) {
-                    return;
+                final Optional<String> maybeLeader = ((FindLeaderReply)Await.result(future, duration)).getLeaderActor();
+                if (maybeLeader.isPresent()) {
+                    return maybeLeader.get();
                 }
-            } catch (Exception e) {
-                e.printStackTrace();
+            } catch(TimeoutException e) {
+                LOG.trace("FindLeader timed out", e);
+            } catch(Exception e) {
+                LOG.error("FindLeader failed", e);
             }
 
             Uninterruptibles.sleepUninterruptibly(50, TimeUnit.MILLISECONDS);
         }
 
         Assert.fail("Leader not found for shard " + shard.path());
+        return null;
+    }
+
+    public void waitUntilNoLeader(ActorRef shard) {
+        FiniteDuration duration = Duration.create(100, TimeUnit.MILLISECONDS);
+        Object lastResponse = null;
+        for(int i = 0; i < 20 * 5; i++) {
+            Future<Object> future = Patterns.ask(shard, FindLeader.INSTANCE, new Timeout(duration));
+            try {
+                final Optional<String> maybeLeader = ((FindLeaderReply)Await.result(future, duration)).getLeaderActor();
+                if (!maybeLeader.isPresent()) {
+                    return;
+                }
+
+                lastResponse = maybeLeader.get();
+            } catch(TimeoutException e) {
+                lastResponse = e;
+            } catch(Exception e) {
+                LOG.error("FindLeader failed", e);
+                lastResponse = e;
+            }
+
+            Uninterruptibles.sleepUninterruptibly(50, TimeUnit.MILLISECONDS);
+        }
+
+        if(lastResponse instanceof Throwable) {
+            throw (AssertionError)new AssertionError(
+                    String.format("Unexpected error occurred from FindLeader for shard %s", shard.path())).
+                            initCause((Throwable)lastResponse);
+        }
+
+        Assert.fail(String.format("Unexpected leader %s found for shard %s", lastResponse, shard.path()));
     }
 }
\ No newline at end of file