[jira] [Commented] (FLINK-26845) Document testing guidelines

["Salva (Jira)" <ji...@apache.org>]

    [ https://issues.apache.org/jira/browse/FLINK-26845?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17513845#comment-17513845 ] 

Salva commented on FLINK-26845:
-------------------------------

Are there any short-term plans for addressing this issue [~sjwiesman] [~trohrmann]? A first step would be to give some general guidelines based on the current state of the project (i.e., without requiring adding new testing-specific features/utilities). The documentation/examples should cover the following:

- How to do simple unit tests of your functions? In particular, do the different language sdks already provide mocks for the context? This is probably the only thing statefun-specific unless I'm missing something.

- How to do e2e of your entire functions mesh? There might not be anything statefun-specific here though, in that case the docs could simply point that out (and optionally point readers to an example).

> Document testing guidelines
> ---------------------------
>
>                 Key: FLINK-26845
>                 URL: https://issues.apache.org/jira/browse/FLINK-26845
>             Project: Flink
>          Issue Type: Improvement
>          Components: Stateful Functions
>            Reporter: Salva
>            Priority: Minor
>
> As of now, there seems to be not much guidance on how to approach testing. Although it's true [~sjwiesman] that 
> {quote}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.
> {quote}
> 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
> {quote}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…|https://t.co/WGjyMA510b]. However, it is not well documented.
> {quote}
> Once the overall guidelines are in place for different testing strategies, tests could be added to the examples in the {_}[playground|https://github.com/apache/flink-statefun-playground]{_}.
> {_}Note{_}: Issue originally reported in Twitter: [https://twitter.com/salvalcantara/status/1505834101026267136?s=20&t=Go2IHP6iP4ZmIyVLmIeD3g]



--
This message was sent by Atlassian Jira
(v8.20.1#820001)