akka/akka-core

Add docs for using testkits with Junit 5

Open

#27,155 opened on Jun 17, 2019

View on GitHub
 (7 comments) (3 reactions) (0 assignees)Scala (13,277 stars) (3,547 forks)batch import
1 - triagedhelp wantedt:docst:testing

Description

It seems using JUnit 5 with the test kits should be doable without any changes to the testkit. The Alpakka team has added an example to the Alpakka Kafka docs here https://doc.akka.io/docs/alpakka-kafka/current/testing.html#testing-from-java-code

Would be good if we could provide such samples as well for akka-testkit, akka-actor-typed-testkit and the akka-stream-testkit.

Contributor guide

Tech stack
java
Domain
testingdocumentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
basic knowledge of JUnit 5familiarity with Akka testkits
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85
Research direction
Review the Alpakka Kafka documentation example at https://doc.akka.io/docs/alpakka kafka/current/testing.html#testing from java code for reference. Then replicate similar documentation for akka testkit, akka actor typed testkit, and akka stream testkit. Look at the existing documentation structure in the akka core repository to determine where to add the new content.
Add docs for using testkits with Junit 5 · akka/akka-core#27155 | Good First Issue