Fix FindBugs warnings in sal-akk-raft
[controller.git] / opendaylight / md-sal / sal-akka-raft / src / test / java / org / opendaylight / controller / cluster / raft / utils / MessageCollectorActor.java
index c5acb1f2a401dfc6935bc30deb1ba993048cfb91..68d6b619cd43bc6aa2d1ce582e32b2eb0bb03d4e 100644 (file)
@@ -9,29 +9,42 @@
 package org.opendaylight.controller.cluster.raft.utils;
 
 import akka.actor.ActorRef;
+import akka.actor.Props;
 import akka.actor.UntypedActor;
 import akka.pattern.Patterns;
 import akka.util.Timeout;
+import com.google.common.base.Predicate;
+import com.google.common.base.Predicates;
+import com.google.common.base.Throwables;
+import com.google.common.collect.Iterables;
 import com.google.common.collect.Lists;
 import com.google.common.util.concurrent.Uninterruptibles;
 import java.util.ArrayList;
+import java.util.Collections;
 import java.util.List;
 import java.util.concurrent.TimeUnit;
+import java.util.concurrent.TimeoutException;
+import org.junit.Assert;
 import scala.concurrent.Await;
 import scala.concurrent.Future;
 import scala.concurrent.duration.Duration;
 import scala.concurrent.duration.FiniteDuration;
 
-
 public class MessageCollectorActor extends UntypedActor {
+    private static final String ARE_YOU_READY = "ARE_YOU_READY";
+    public static final String GET_ALL_MESSAGES = "messages";
+    private static final String CLEAR_MESSAGES = "clear-messages";
+
     private final List<Object> messages = new ArrayList<>();
 
     @Override public void onReceive(Object message) throws Exception {
-        if(message instanceof String){
-            if("get-all-messages".equals(message)){
-                getSender().tell(new ArrayList(messages), getSelf());
-            }
-        } else {
+        if (ARE_YOU_READY.equals(message)) {
+            getSender().tell("yes", getSelf());
+        } else if (GET_ALL_MESSAGES.equals(message)) {
+            getSender().tell(new ArrayList<>(messages), getSelf());
+        } else if (CLEAR_MESSAGES.equals(message)) {
+            clear();
+        } else if (message != null) {
             messages.add(message);
         }
     }
@@ -40,52 +53,185 @@ public class MessageCollectorActor extends UntypedActor {
         messages.clear();
     }
 
-    public static List<Object> getAllMessages(ActorRef actor) throws Exception {
+    @SuppressWarnings("unchecked")
+    private static List<Object> getAllMessages(ActorRef actor) throws Exception {
         FiniteDuration operationDuration = Duration.create(5, TimeUnit.SECONDS);
         Timeout operationTimeout = new Timeout(operationDuration);
-        Future<Object> future = Patterns.ask(actor, "get-all-messages", operationTimeout);
+        Future<Object> future = Patterns.ask(actor, GET_ALL_MESSAGES, operationTimeout);
 
-        try {
-            return (List<Object>) Await.result(future, operationDuration);
-        } catch (Exception e) {
-            throw e;
-        }
+        return (List<Object>) Await.result(future, operationDuration);
+    }
+
+    public static void clearMessages(ActorRef actor) {
+        actor.tell(CLEAR_MESSAGES, ActorRef.noSender());
     }
 
     /**
-     * Get the first message that matches the specified class
-     * @param actor
-     * @param clazz
-     * @return
+     * Get the first message that matches the specified class.
+     *
+     * @param actor the MessageCollectorActor reference
+     * @param clazz the class to match
+     * @return the first matching message
      */
     public static <T> T getFirstMatching(ActorRef actor, Class<T> clazz) throws Exception {
-        for(int i = 0; i < 50; i++) {
-            List<Object> allMessages = getAllMessages(actor);
+        List<Object> allMessages = getAllMessages(actor);
 
-            for(Object message : allMessages){
-                if(message.getClass().equals(clazz)){
-                    return (T) message;
+        for (Object message : allMessages) {
+            if (message.getClass().equals(clazz)) {
+                return clazz.cast(message);
+            }
+        }
+
+        return null;
+    }
+
+    @SuppressWarnings("checkstyle:IllegalCatch")
+    public static <T> List<T> expectMatching(ActorRef actor, Class<T> clazz, int count) {
+        return expectMatching(actor, clazz, count, msg -> true);
+    }
+
+    @SuppressWarnings("checkstyle:IllegalCatch")
+    public static <T> List<T> expectMatching(ActorRef actor, Class<T> clazz, int count,
+            Predicate<T> matcher) {
+        int timeout = 5000;
+        Exception lastEx = null;
+        List<T> messages = Collections.emptyList();
+        for (int i = 0; i < timeout / 50; i++) {
+            try {
+                messages = getAllMatching(actor, clazz);
+                Iterables.removeIf(messages, Predicates.not(matcher));
+                if (messages.size() >= count) {
+                    return messages;
                 }
+
+                lastEx = null;
+            } catch (Exception e)  {
+                lastEx = e;
             }
 
-            Uninterruptibles.sleepUninterruptibly(100, TimeUnit.MILLISECONDS);
+            Uninterruptibles.sleepUninterruptibly(50, TimeUnit.MILLISECONDS);
         }
 
-        return null;
+        throw new AssertionError(String.format("Expected %d messages of type %s. Actual received was %d: %s", count,
+                clazz, messages.size(), messages), lastEx);
+    }
+
+    public static <T> T expectFirstMatching(ActorRef actor, Class<T> clazz) {
+        return expectFirstMatching(actor, clazz, 5000);
+    }
+
+    @SuppressWarnings("checkstyle:IllegalCatch")
+    public static <T> T expectFirstMatching(ActorRef actor, Class<T> clazz, long timeout) {
+        Exception lastEx = null;
+        int count = (int) (timeout / 50);
+        for (int i = 0; i < count; i++) {
+            try {
+                T message = getFirstMatching(actor, clazz);
+                if (message != null) {
+                    return message;
+                }
+
+                lastEx = null;
+            } catch (Exception e) {
+                lastEx = e;
+            }
+
+            Uninterruptibles.sleepUninterruptibly(50, TimeUnit.MILLISECONDS);
+        }
+
+        throw new AssertionError("Did not receive message of type " + clazz, lastEx);
     }
 
-    public static List<Object> getAllMatching(ActorRef actor, Class<?> clazz) throws Exception {
+    @SuppressWarnings("checkstyle:IllegalCatch")
+    public static <T> T expectFirstMatching(ActorRef actor, Class<T> clazz, Predicate<T> matcher) {
+        int timeout = 5000;
+        Exception lastEx = null;
+        T lastMessage = null;
+        for (int i = 0; i < timeout / 50; i++) {
+            try {
+                List<T> messages = getAllMatching(actor, clazz);
+                for (T msg : messages) {
+                    if (matcher.apply(msg)) {
+                        return msg;
+                    }
+
+                    lastMessage = msg;
+                }
+
+                lastEx = null;
+            } catch (Exception e) {
+                lastEx = e;
+            }
+
+            Uninterruptibles.sleepUninterruptibly(50, TimeUnit.MILLISECONDS);
+        }
+
+        throw new AssertionError(String.format("Expected specific message of type %s. Last message received was: %s",
+                clazz, lastMessage), lastEx);
+    }
+
+    public static <T> void assertNoneMatching(ActorRef actor, Class<T> clazz) {
+        assertNoneMatching(actor, clazz, 5000);
+    }
+
+    @SuppressWarnings("checkstyle:IllegalCatch")
+    public static <T> void assertNoneMatching(ActorRef actor, Class<T> clazz, long timeout) {
+        Exception lastEx = null;
+        int count = (int) (timeout / 50);
+        for (int i = 0; i < count; i++) {
+            try {
+                T message = getFirstMatching(actor, clazz);
+                if (message != null) {
+                    Assert.fail("Unexpected message received" +  message.toString());
+                    return;
+                }
+
+                lastEx = null;
+            } catch (Exception e) {
+                lastEx = e;
+            }
+
+            Uninterruptibles.sleepUninterruptibly(50, TimeUnit.MILLISECONDS);
+        }
+
+        if (lastEx != null) {
+            Throwables.propagate(lastEx);
+        }
+
+        return;
+    }
+
+
+    public static <T> List<T> getAllMatching(ActorRef actor, Class<T> clazz) throws Exception {
         List<Object> allMessages = getAllMessages(actor);
 
-        List<Object> output = Lists.newArrayList();
+        List<T> output = Lists.newArrayList();
 
-        for(Object message : allMessages){
-            if(message.getClass().equals(clazz)){
-                output.add(message);
+        for (Object message : allMessages) {
+            if (message.getClass().equals(clazz)) {
+                output.add(clazz.cast(message));
             }
         }
 
         return output;
     }
 
+    public static void waitUntilReady(ActorRef actor) throws Exception {
+        long timeout = 500;
+        FiniteDuration duration = Duration.create(timeout, TimeUnit.MILLISECONDS);
+        for (int i = 0; i < 10; i++) {
+            try {
+                Await.ready(Patterns.ask(actor, ARE_YOU_READY, timeout), duration);
+                return;
+            } catch (TimeoutException e) {
+                // will fall through below
+            }
+        }
+
+        throw new TimeoutException("Actor not ready in time.");
+    }
+
+    public static Props props() {
+        return Props.create(MessageCollectorActor.class);
+    }
 }