Skip to main content

Akka Concepts - Testing Actor Systems

Remember that actors interact only using message passing. In order to check actors behavior you can do it through the messages sent to them and back from them.  So how do you test actors? You send them messages :)
To test actors that communicate only with messages, you need to send it a message and get reply back and check it.
akka has a TestProbe
val p = TestProbe(); // record incoming messages in queue so you can assert and verify them.
Creating actor system for tests:
implicit val system = ActorSystem("TestSys")
val toggle = system.actorOf(Props[Toggle]) // this is the actor we are going to test.
val p = TestProbe() // this is the test client actor which will record the messages.

p.send(toggle, "How are you") // probe --> tested actor: how are you?
p.exepectMsg("happy") // assert result is happy.
To have the probe actor created for you:
new TestKit(ActorSystem("TestSys")) with ImplicitSender { // we are in probe actor.
  val toggle = system.actorOf(Props[Toggle])
  toggle ! "how are you?" // we are already in probe actor.
managing external dependencies
Some of your actors might need to access database what do you do it?
  1. Dependency Injection
  2. Just Override - Add overridable factory methods
class DBManager extends Actor {
  def props: Props = Props[DBWorker] // Override this method when you want a fakeDB!
  def receive = {
    // Do not use context.actorOf(Props[DBWorker]) instead use the factory method see below:
    val dbworker = context.actorOf(props, "dbworker") // So we can override the def!
In our case we have used def props and we refer to it when creating the actor.
How to probe messages sent to parent?
The parent is the Guardian actor if the system created it for us.
So we need a StepParent which forwards all messages to probe.
class StepParent(child: Props, probe: ActorRef) extends Actor {
  contex.actorOf(child, "child")
  def receive = {
    case msg => probe.tell(msg, sender) // forward all messages to probe!
In a similar way we can create FosterParent actor which listens to all messages in both directions from child to parent and vice versa.
Define your test class
class GetterSpec extends TestKit(ActorSystem("GetterSpec")) with ImplicitSender ...
A test case snippet:
system.actorOf(Props(new StepParent(fakeDBWorker, testActor), "name")) // testActor is given by framework it's the probe.
expectMsg(IDidMyWorkMsg) // we expect a message IDidMyWorkMsg
So in general you send messages to your actors and you use expectMsg to check the messages they send back.
BOOK: the best book I have found for working with akka actors, it's surprisingly much better than all others, as it drives you through of a flow of building an app, making mistakes and the continuously improving the design of your app.  The book is: "Mastering Akka"


Popular posts from this blog

Dev OnCall Patterns

Introduction Being On-Call is not easy. So does writing software. Being On-Call is not just a magic solution, anyone who has been On-Call can tell you that, it's a stressful, you could be woken up at the middle of the night, and be undress stress, there are way's to mitigate that. White having software developers as On-Calls has its benefits, in order to preserve the benefits you should take special measurements in order to mitigate the stress and lack of sleep missing work-life balance that comes along with it. Many software developers can tell you that even if they were not being contacted the thought of being available 24/7 had its toll on them. But on the contrary a software developer who is an On-Call's gains many insights into troubleshooting, responsibility and deeper understanding of the code that he and his peers wrote. Being an On-Call all has become a natural part of software development. Please note I do not call software development software engineering b

Recursion Trees Primer

Recursion trees. Controlling the fundamentals stands at the cornerstone of controlling a topic.  In our case in order to be a good developer its not enough or even not at all important to control the latest Java/JavaScript/big data technology but what's really important is the basics.  And the basics in computer science are maths, stats, algorithms and computer structure. Steve wosniak the co-founder of apple said the same, what gave him his relative advantage was his deep understanding of programming and computer structure, this is what gave him the ability to create computer's which are less costly than the competitors (not that there were many) and by the way there were 3 founders to apple company one responsible for the technical side, one for the product and sales (Steve Jobs) and the third responsible for the company structure and growth, each of the three extremely important, it was not only the two Steve's but that's a topic for another episode. And with t

Building Secure and Reliable Systems

A recent book was published this year by Google about site reliability and security engineering, I would like to provide you a brief overview of it and incorporate my own analysis and thoughts about this subject while saving you some time from reading, at least part of it. Take a few of your customers and ask them, what are the top 5 features on my product that you like.  The answer that you are likely to get is, I really like how polished the UI is, or the daily report I get by mail is just fantastic, or since I started using your product I was able to save one hour a day my productivity got up and the share /chat button on document that you added recently is doing a great job. Your customers are very unlikely to answer the question of what top 5 features of my product do you like with I really like its security or I really like that we lost no chat messages since I started using it.  No real customer will even think of it, moreover, assuming you did a very good job, they won&#