2 * Copyright (c) 2014 Cisco Systems, Inc. and others. All rights reserved.
4 * This program and the accompanying materials are made available under the
5 * terms of the Eclipse Public License v1.0 which accompanies this distribution,
6 * and is available at http://www.eclipse.org/legal/epl-v10.html
9 package org.opendaylight.controller.cluster.raft;
12 * Copyright (c) 2014 Cisco Systems, Inc. and others. All rights reserved.
14 * This program and the accompanying materials are made available under the
15 * terms of the Eclipse Public License v1.0 which accompanies this distribution,
16 * and is available at http://www.eclipse.org/legal/epl-v10.html
19 import akka.actor.Actor;
20 import akka.actor.ActorIdentity;
21 import akka.actor.ActorRef;
22 import akka.actor.ActorSelection;
23 import akka.actor.ActorSystem;
24 import akka.actor.Identify;
25 import akka.actor.PoisonPill;
26 import akka.actor.Props;
27 import akka.pattern.Patterns;
28 import akka.testkit.JavaTestKit;
29 import akka.testkit.TestActorRef;
30 import akka.util.Timeout;
31 import com.google.common.base.Stopwatch;
32 import com.google.common.util.concurrent.Uninterruptibles;
33 import java.util.LinkedList;
34 import java.util.List;
35 import java.util.concurrent.TimeUnit;
36 import org.junit.Assert;
37 import org.slf4j.Logger;
38 import org.slf4j.LoggerFactory;
39 import scala.concurrent.Await;
40 import scala.concurrent.Future;
43 * TestActorFactory provides methods to create both normal and test actors and to kill them when the factory is closed
44 * The ideal usage for TestActorFactory is with try with resources, <br/>
47 * try (TestActorFactory factory = new TestActorFactory(getSystem())){
48 * factory.createActor(props);
49 * factory.createTestActor(props);
50 * factory.generateActorId("leader-");
54 public class TestActorFactory implements AutoCloseable {
55 private final ActorSystem system;
56 List<ActorRef> createdActors = new LinkedList<>();
57 Logger LOG = LoggerFactory.getLogger(getClass());
58 private static int actorCount = 1;
60 public TestActorFactory(ActorSystem system){
65 * Create a normal actor with an auto-generated name
70 public ActorRef createActor(Props props){
71 ActorRef actorRef = system.actorOf(props);
72 return addActor(actorRef);
76 * Create a normal actor with the passed in name
78 * @param actorId name of actor
81 public ActorRef createActor(Props props, String actorId){
82 ActorRef actorRef = system.actorOf(props, actorId);
83 return addActor(actorRef);
87 * Create a test actor with the passed in name
93 @SuppressWarnings("unchecked")
94 public <T extends Actor> TestActorRef<T> createTestActor(Props props, String actorId){
95 TestActorRef<T> actorRef = TestActorRef.create(system, props, actorId);
96 return (TestActorRef<T>) addActor(actorRef);
99 private <T extends ActorRef> ActorRef addActor(T actorRef) {
100 createdActors.add(actorRef);
101 verifyActorReady(actorRef);
105 private void verifyActorReady(ActorRef actorRef) {
106 // Sometimes we see messages go to dead letters soon after creation - it seems the actor isn't quite
107 // in a state yet to receive messages or isn't actually created yet. This seems to happen with
108 // actorSelection so, to alleviate it, we use an actorSelection and send an Identify message with
109 // retries to ensure it's ready.
111 Timeout timeout = new Timeout(100, TimeUnit.MILLISECONDS);
112 Throwable lastError = null;
113 Stopwatch sw = Stopwatch.createStarted();
114 while(sw.elapsed(TimeUnit.SECONDS) <= 10) {
116 ActorSelection actorSelection = system.actorSelection(actorRef.path().toString());
117 Future<Object> future = Patterns.ask(actorSelection, new Identify(""), timeout);
118 ActorIdentity reply = (ActorIdentity)Await.result(future, timeout.duration());
119 Assert.assertNotNull("Identify returned null", reply.getRef());
121 } catch (Exception | AssertionError e) {
122 Uninterruptibles.sleepUninterruptibly(100, TimeUnit.MILLISECONDS);
127 throw new RuntimeException(lastError);
131 * Create a test actor with an auto-generated name
136 @SuppressWarnings("unchecked")
137 public <T extends Actor> TestActorRef<T> createTestActor(Props props){
138 TestActorRef<T> actorRef = TestActorRef.create(system, props);
139 return (TestActorRef<T>) addActor(actorRef);
143 * Generate a friendly but unique actor id/name
147 public String generateActorId(String prefix){
148 return prefix + actorCount++;
151 public void killActor(ActorRef actor, JavaTestKit kit) {
152 killActor(actor, kit, true);
155 public String createTestActorPath(String actorId){
156 return "akka://test/user/" + actorId;
159 private void killActor(ActorRef actor, JavaTestKit kit, boolean remove) {
160 LOG.info("Killing actor {}", actor);
162 actor.tell(PoisonPill.getInstance(), ActorRef.noSender());
163 kit.expectTerminated(JavaTestKit.duration("5 seconds"), actor);
166 createdActors.remove(actor);
171 public void close() {
172 JavaTestKit kit = new JavaTestKit(system);
173 for(ActorRef actor : createdActors) {
174 killActor(actor, kit, false);