akka/akka-core

Document or fix PF methods in classic Java testkit

Open

#27,562 opened on Aug 26, 2019

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Scala (13,277 stars) (3,547 forks)batch import
help wantedt:javat:testing

Description

Looks as though quite a few of the methods in akka.testkit.javadsl.TestKit was just copy-pasted over from the Scala testkit, they take total functions but the docs talk about partial functions, they should either be updated to have docs that show how to use them or if they are not possible to use at all from Java (I'm unsure) they should be changed so that they can be used from Java or removed.

The methods are:

  • expectMsgPF
  • fishForSpecificMessage
  • receiveWhile

Additionally these should have the docs updated to not talk about partial functions:

  • ignoreMsg
  • fishForMessage

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.
3
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
JavaAkka TestKitScala (to compare)
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
45
Research direction
Examine the methods expectMsgPF, fishForSpecificMessage, receiveWhile, ignoreMsg, fishForMessage in akka.testkit.javadsl.TestKit. Compare with the Scala version in akka.testkit.TestKit to understand the partial function usage. Update Java docs to remove references to partial functions or fix the methods to work correctly. Ensure the changes are consistent with the Scala API but usable from Java.
Document or fix PF methods in classic Java testkit · akka/akka-core#27562 | Good First Issue