Dynamic test support #62

mk868 · 2024-12-15T17:51:52Z

Related: #59

I'm still not 100% convinced that this is the correct use of UriSource, so I set PR as a draft.
Some links:

junit says about TestSource: "a representation of the source of a test or container used to navigate to its location by IDEs and build tools." - nothing specific, should be fine for us
DynamicTest should be able to provide tags and source information to TestDescriptor junit-team/junit5#1178 - discussion on Cucumber's need to provide additional metadata in dynamic testing, resulted in Add TestSource support to dynamic containers and tests junit-team/junit5#1428

I used a custom scheme xray:// to force not to use FileSource or DirectorySource - we need DefaultUriSource to not lose query data, see UriSource#from(URI) implementation.

Sample test class:

package xyz;

import static org.junit.jupiter.api.DynamicTest.dynamicTest;

import app.getxray.xray.junit.customjunitxml.XrayURI;
import java.util.List;
import org.junit.jupiter.api.DynamicTest;
import org.junit.jupiter.api.TestFactory;

class DynTest {

  @TestFactory
  List<DynamicTest> something() {
    return List.of(
        dynamicTest("test 1",
            XrayURI.builder()
                .key("ABC-100")
                .summary("Summary 1")
                .description("description 1")
                .build(this.getClass()),
            () -> {
              // ...
            }),
        dynamicTest("test 2",
            XrayURI.builder()
                .key("ABC-200")
                .summary("Summary 2")
                .build(this.getClass()),
            () -> {
              // ...
            }),
        dynamicTest("test 3",
            XrayURI.builder()
                .key("ABC-300")
                // should we pass the dynamic test's display name "test 3" as summary to the report?
                .description("description 3")
                .build(this.getClass()),
            () -> {
              // ...
            })
    );
  }

}