/*
* Copyright (c) 2014 Cisco Systems, Inc. and others. All rights reserved.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License v1.0 which accompanies this distribution,
* and is available at http://www.eclipse.org/legal/epl-v10.html
*/
package org.opendaylight.controller.cluster.raft;
/*
* Copyright (c) 2014 Cisco Systems, Inc. and others. All rights reserved.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License v1.0 which accompanies this distribution,
* and is available at http://www.eclipse.org/legal/epl-v10.html
*/
import akka.actor.Actor;
import akka.actor.ActorIdentity;
import akka.actor.ActorRef;
import akka.actor.ActorSelection;
import akka.actor.ActorSystem;
import akka.actor.Identify;
import akka.actor.PoisonPill;
import akka.actor.Props;
import akka.pattern.Patterns;
import akka.testkit.JavaTestKit;
import akka.testkit.TestActorRef;
import akka.util.Timeout;
import com.google.common.base.Stopwatch;
import com.google.common.util.concurrent.Uninterruptibles;
import java.util.LinkedList;
import java.util.List;
import java.util.concurrent.TimeUnit;
import org.junit.Assert;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import scala.concurrent.Await;
import scala.concurrent.Future;
/**
* TestActorFactory provides methods to create both normal and test actors and to kill them when the factory is closed
* The ideal usage for TestActorFactory is with try with resources.
*
*/
public class TestActorFactory implements AutoCloseable {
private static final Logger LOG = LoggerFactory.getLogger(TestActorFactory.class);
private final ActorSystem system;
List createdActors = new LinkedList<>();
private static int actorCount = 1;
public TestActorFactory(ActorSystem system) {
this.system = system;
}
/**
* Create a normal actor with an auto-generated name.
*
* @param props the actor Props
* @return the ActorRef
*/
public ActorRef createActor(Props props) {
ActorRef actorRef = system.actorOf(props);
return addActor(actorRef, true);
}
/**
* Create a normal actor with the passed in name.
*
* @param props the actor Props
* @param actorId name of actor
* @return the ActorRef
*/
public ActorRef createActor(Props props, String actorId) {
ActorRef actorRef = system.actorOf(props, actorId);
return addActor(actorRef, true);
}
/**
* Create a normal actor with the passed in name w/o verifying that the actor is ready.
*
* @param props the actor Props
* @param actorId name of actor
* @return the ActorRef
*/
public ActorRef createActorNoVerify(Props props, String actorId) {
ActorRef actorRef = system.actorOf(props, actorId);
return addActor(actorRef, false);
}
/**
* Create a test actor with the passed in name.
*
* @param props the actor Props
* @param actorId name of actor
* @param the actor type
* @return the ActorRef
*/
@SuppressWarnings("unchecked")
public TestActorRef createTestActor(Props props, String actorId) {
TestActorRef actorRef = TestActorRef.create(system, props, actorId);
return (TestActorRef) addActor(actorRef, true);
}
/**
* Create a test actor with an auto-generated name.
*
* @param props the actor Props
* @param the actor type
* @return the TestActorRef
*/
@SuppressWarnings("unchecked")
public TestActorRef createTestActor(Props props) {
TestActorRef actorRef = TestActorRef.create(system, props);
return (TestActorRef) addActor(actorRef, true);
}
private ActorRef addActor(T actorRef, boolean verify) {
createdActors.add(actorRef);
if (verify) {
verifyActorReady(actorRef);
}
return actorRef;
}
@SuppressWarnings("checkstyle:IllegalCatch")
private void verifyActorReady(ActorRef actorRef) {
// Sometimes we see messages go to dead letters soon after creation - it seems the actor isn't quite
// in a state yet to receive messages or isn't actually created yet. This seems to happen with
// actorSelection so, to alleviate it, we use an actorSelection and send an Identify message with
// retries to ensure it's ready.
Timeout timeout = new Timeout(100, TimeUnit.MILLISECONDS);
Throwable lastError = null;
Stopwatch sw = Stopwatch.createStarted();
while (sw.elapsed(TimeUnit.SECONDS) <= 10) {
try {
ActorSelection actorSelection = system.actorSelection(actorRef.path().toString());
Future