sample project that demonstrates how you can test your custom build with a JUnit5 test

[abendt]

Context

While learning how to use the Kotlin DSL for Gradle I found the samples to be immensely helpful. However I missed a sample that demonstrated how to unit-test your custom logic in buildSrc with. I think other users also could benefit from some this sample.

#1087

Note: this is a continuation of #1302

Contributor Checklist

• [x ] Base the PR against the develop branch
• [x ] Make sure that all commits are signed off to indicate that you agree to the terms of Developer Certificate of Origin.
• Provide integration tests to verify changes from a user perspective
• Provide unit tests to verify logic
• Ensure that tests pass locally: ./gradlew check --parallel

[JLLeitschuh]

This might be more aproprate:

tasks.withType<Test>().configureEach {
    useJunitPlatform()
}

It might also be good to demonstrate configuring Junit 5 as well.

For example:

tasks.withType<Test>().configureEach {
    useJunitPlatform {
        filter {
            // Add an example of configuring some filter here.
        }
    }
}

[abendt]

it seems that filter is not JUnit 5 specific and belongs to Test. If i understand it correctly this should be equivalent:

tasks.withType<Test>().configureEach {
    filter {
        // Add an example of configuring some filter here.
     }
}

I'd suggest to use tags instead, to demonstrate a Junit5 specific configuration:

tasks.withType<Test>().configureEach {
    useJUnitPlatform {
        includeTags("fooTag")
    }
}

[JLLeitschuh]

You are 100% correct. Good catch.

[abendt]

ok, i have changed it

[JLLeitschuh]

LGTM!

[henrik242]

LGTM. Any reason why this hasn't been merged?

[alexvas]

The example is great! My only question is: why should I google is out as a PR instead of one of official Kotlin DSL samples?