Testing

Dependencies

To use the CSW Testkit, you must add the following dependency in your project:

sbt

libraryDependencies += "com.github.tmtsoftware.csw" %% "csw-testkit" % "3.0.1"

Introduction

CSW comes with a dedicated csw-testkit module for supporting tests. This module includes following multiple individual testkits:

• LocationTestKit : starts and stops the Location Server
• ConfigTestKit : starts and stops the Config Server
• EventTestKit : starts and stops the Event Service (Note : This uses embedded-redis to start redis sentinel and master)
• AlarmTestKit : starts and stops the Alarm Service (Note : This uses embedded-redis to start redis sentinel and master)
• FrameworkTestKit : in most of the cases, you will end up using this testkit. FrameworkTestKit is created by composing all the above mentioned testkits. Hence it supports starting and stopping all provided CSW services.

TestKits

When you really want granular level access to testkits, then only you would want to use LocationTestKit|ConfigTestKit|EventTestKit|AlarmTestKit|FrameworkTestKit directly. You can create instance of FrameworkTestKit as shown below:

Scala

// create instance of framework testkit
private val frameworkTestKit = FrameworkTestKit()

// starts Config Server and Event Service
override protected def beforeAll(): Unit = frameworkTestKit.start(ConfigServer, EventServer)

// stops all services started by this testkit
override protected def afterAll(): Unit = frameworkTestKit.shutdown()

Java

private static FrameworkTestKit frameworkTestKit = FrameworkTestKit.create();

@BeforeClass
public static void beforeAll() {
    frameworkTestKit.start(JCSWService.ConfigServer, JCSWService.EventServer);
}

@AfterClass
public static void afterAll() {
    frameworkTestKit.shutdown();
}

Spawning components

FrameworkTestKit provides an easy way to spawn components in Container or Standalone mode. Use the spawnContainer method provided by FrameworkTestKit to start components in container mode andspawnStandalone method to start a component in standalone mode.

The example below shows how to spawn container or component in standalone mode using the Framework testkit.

Scala

// starting container from container config using testkit
frameworkTestKit.spawnContainer(ConfigFactory.load("SampleContainer.conf"))

// starting standalone component from config using testkit
// val componentRef: ActorRef[ComponentMessage] =
//   frameworkTestKit.spawnStandaloneComponent(ConfigFactory.load("SampleHcdStandalone.conf"))

Java

// starting container from container config using testkit
frameworkTestKit.spawnContainer(ConfigFactory.load("JSampleContainer.conf"));

// starting standalone component from config using testkit
// ActorRef<ComponentMessage> componentRef =
//      frameworkTestKit.spawnStandaloneComponent(ConfigFactory.load("SampleHcdStandalone.conf"));

Full source at GitHub

• Scala
• Java

Test framework integration

ScalaTest

If you are using ScalaTest, then you can extend csw.testkit.scaladsl.ScalaTestFrameworkTestKit to have the Framework testkit automatically start the provided services before running tests and shut them down when the tests are complete. This is done in beforeAll and afterAll from the BeforeAndAfterAll trait. If you override that method you should call super.beforeAll to start services and super.afterAll to shutdown the test kit.

JUnit

If you are using JUnit then you can use csw.testkit.javadsl.FrameworkTestKitJunitResource to have the framework test kit automatically start the provided services before running tests and shut them down when the tests are complete.

Supported CSW Services by FrameworkTestKit

ScalaTestFrameworkTestKit and FrameworkTestKitJunitResource both support starting one or more of the following services.

• CSWService.LocationServer | JCSWService.LocationServer
• CSWService.ConfigServer | JCSWService.ConfigServer
• CSWService.EventServer | JCSWService.EventServer
• CSWService.AlarmServer | JCSWService.AlarmServer

The example below shows the usage of ScalaTestFrameworkTestKit and FrameworkTestKitJunitResource and how you can start the above mentioned services as per your need.

Scala

import com.typesafe.config.ConfigFactory
import csw.testkit.scaladsl.CSWService.{AlarmServer, EventServer}
import csw.testkit.scaladsl.ScalaTestFrameworkTestKit
import org.scalatest.funsuite.AnyFunSuiteLike

class ScalaTestIntegrationExampleTest extends ScalaTestFrameworkTestKit(AlarmServer, EventServer) with AnyFunSuiteLike {

  test("test spawning component in standalone mode") {
    spawnStandalone(ConfigFactory.load("SampleHcdStandalone.conf"))

    // .. assertions etc.

  }

}

Java

import com.typesafe.config.ConfigFactory;
import csw.testkit.javadsl.FrameworkTestKitJunitResource;
import csw.testkit.javadsl.JCSWService;
import org.junit.ClassRule;
import org.junit.Test;
import org.scalatestplus.junit.JUnitSuite;

import java.util.Arrays;

public class JUnitIntegrationExampleTest extends JUnitSuite {

    @ClassRule
    public static final FrameworkTestKitJunitResource testKit =
            new FrameworkTestKitJunitResource(Arrays.asList(JCSWService.AlarmServer, JCSWService.EventServer));

    @Test
    public void testSpawningComponentInStandaloneMode() {
        testKit.spawnStandalone(ConfigFactory.load("JSampleHcdStandalone.conf"));

         // ... assertions etc.
    }
}

Unit Tests

The goal of unit testing is to break your application into the smallest testable units and test them individually, isolating a specific piece of functionality and ensuring it is working correctly. It is always a good idea to write more unit test cases and relatively fewer component and integration tests. If you want to get an idea of how many tests you should have in different types of testing phases (Unit/Component/Integration), refer to this blog

Unit testing simple Scala/Java classes or objects is straightforward. You can mock external dependencies using Mockito. Refer to the Mockito section for more details.

The following links provide guides for testing applications using different modules of Akka:

• Akka Untyped Actors
• Akka Typed Actors
• Akka Streams

Multi-JVM Tests

Testing asynchronous distributed systems requires special tooling/framework support. Sbt has a plugin called sbt-multi-jvm which helps to test systems across multiple JVMs or machines. This is especially useful for integration testing where multiple systems communicate with each other.

You can find more details on multi-JVM tests here.

You can also refer to some examples in CSW for writing your own multi-JVM tests. For example: CommandServiceTest.scala

In case you want to run your multi-JVM tests across machines, refer to this multi-node testing guide here.

Mockito

Mocks are used so that unit tests can be written independent of dependencies.
CSW uses Mockito for writing unit tests. ScalaTest comes with the MockitoSugar trait which provides some basic syntax sugar for Mockito.

For example: ContainerBehaviorTest.scala