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 (598 forks)batch import
1 - triagedhelp wantedt:docst:testing

Repository metrics

Stars
 (1,311 stars)
PR merge metrics
 (Avg merge 1d 10h) (2 merged PRs in 30d)

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

Research direction
Examine the Alpakka Kafka testing documentation referenced in the issue (https://doc.akka.io/docs/alpakka kafka/current/testing.html#testing from java code) and adapt the approach for Akka HTTP. Write documentation similar to that example but for Akka HTTP testkits, focusing on JUnit 5 integration. Include code examples for both Java and Scala. The documentation should be placed in the appropriate section of the Akka HTTP test documentation.
Tech stack
scalajava
Domain
documentationbackend
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
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.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
None
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90