akka/akka-http

Add docs for using testkits with Junit 5

Open

#2,573 opened on Jun 17, 2019

View on GitHub
 (5 comments) (2 reactions) (0 assignees)Scala (1,311 stars) (598 forks)batch import
1 - triagedhelp wantedt:docst:testing

Description

Sister-ticket of akka/akka#27155

We since previously have a request to migrate to JUnit 5 but since the demand has been so low I'm not sure if we want to do that, however, I think we should show in docs how to use the testkit with JUnit 5

Alpakka Kafka has done this in the docs here https://doc.akka.io/docs/alpakka-kafka/current/testing.html#testing-from-java-code

Contributor guide

Tech stack
javascala
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.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Basic knowledge of Akka HTTP testkitFamiliarity with JUnit 5
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65
Research direction
The issue requests adding documentation for using testkits with JUnit 5, similar to how Alpakka Kafka does it (https://doc.akka.io/docs/alpakka kafka/current/testing.html#testing from java code). The solution involves locating the existing Akka HTTP test documentation (likely in the `docs/src/main/paradox/` directory) and adding a new section or page that demonstrates how to use the testkit with JUnit 5. The sister ticket at akka/akka#27155 may contain additional context. The contributor should also check the existing comments for any prior discussion or suggestions.