Lightbend Activator

Akka Multi-Node Testing Sample with Scala

Akka Multi-Node Testing Sample with Scala

Akka Team
September 30, 2016
akka testing scala sample

Sample containing sbt build settings and test classes for illustrating multi-node testing with Akka and Scala

How to get "Akka Multi-Node Testing Sample with Scala" on your computer

There are several ways to get this template.

Option 1: Choose akka-sample-multi-node-scala in the Lightbend Activator UI.

Already have Lightbend Activator (get it here)? Launch the UI then search for akka-sample-multi-node-scala in the list of templates.

Option 2: Download the akka-sample-multi-node-scala project as a zip archive

If you haven't installed Activator, you can get the code by downloading the template bundle for akka-sample-multi-node-scala.

  1. Download the Template Bundle for "Akka Multi-Node Testing Sample with Scala"
  2. Extract the downloaded zip file to your system
  3. The bundle includes a small bootstrap script that can start Activator. To start Lightbend Activator's UI:

    In your File Explorer, navigate into the directory that the template was extracted to, right-click on the file named "activator.bat", then select "Open", and if prompted with a warning, click to continue:

    Or from a command line:

     C:\Users\typesafe\akka-sample-multi-node-scala> activator ui 
    This will start Lightbend Activator and open this template in your browser.

Option 3: Create a akka-sample-multi-node-scala project from the command line

If you have Lightbend Activator, use its command line mode to create a new project from this template. Type activator new PROJECTNAME akka-sample-multi-node-scala on the command line.

Option 4: View the template source

The creator of this template maintains it at

Option 5: Preview the tutorial below

We've included the text of this template's tutorial below, but it may work better if you view it inside Activator on your computer. Activator tutorials are often designed to be interactive.

Preview the tutorial

This sample contains sbt build settings and test classes for illustrating multi-node testing with Akka.

Please refer to the full documentation of multi-node testing and the closely related multi-jvm testing for details. There is also an section on cluster testing.

sbt setup

Open project/plugins.sbt

It adds the sbt-multi-jvm plugin to the build.

Open build.sbt

It includes the MultiJvm settings that are needed to run multi-jvm tests.


Open MultiNodeSample.scala

Note that MultiJvm test sources are located in src/multi-jvm/... and the test classes must end with MultiJvm followed by the node name, typically Node1, Node2, Node3...

To hook up the MultiNodeSpec with with ScalaTest you need something like: STMultiNodeSpec.scala

To see the test in action, open the Test tab and click Start to run the MultiNodeSample. This corresponds to sbt test.

In case you have many tests in the project it can be convenient to run a single test from the sbt prompt:

> multi-jvm:testOnly sample.multinode.MultiNodeSampleSpec

The same test can be run on multiple machines as described in the multi-node testing documentation.