Uploaded image for project: 'Flink'
  1. Flink
  2. FLINK-26845

Document testing guidelines

    XMLWordPrintableJSON

Details

    • Improvement
    • Status: Open
    • Minor
    • Resolution: Unresolved
    • None
    • None
    • Stateful Functions
    • None

    Description

      As of now, there seems to be not much guidance on how to approach testing. Although it's true sjwiesman that 

      Unlike other flink apis, the sdk doesn’t pull in the runtime so testing should really look like any other code. There isn’t much statefun specific.

      I think that at the very least testing should be mentioned as part of the docs, even if it is only to stress the above fact. Indeed, as reported by trohrmann, there seems that there are already some test utilities in place but they are not well-documented, plus some potential ideas on how to improve on that front

      Testing tools is definitely one area where we want to improve significantly. Also the documentation for how to do things needs to be updated. There are some testing utils that you can already use today: https://github.com/apache/flink-statefun/blob/master/statefun-sdk-java/src/main/java/org/apache/flink/statefun/sdk/java/testing/TestContext.java…. However, it is not well documented.

      Once the overall guidelines are in place for different testing strategies, tests could be added to the examples in the playground.

      Note: Issue originally reported in Twitter: https://twitter.com/salvalcantara/status/1505834101026267136?s=20&t=Go2IHP6iP4ZmIyVLmIeD3g

      Attachments

        Activity

          People

            Unassigned Unassigned
            Alcántara Salva
            Votes:
            0 Vote for this issue
            Watchers:
            3 Start watching this issue

            Dates

              Created:
              Updated: