dev.gradleplugins.grava.testing

Class WellBehavedPluginTester

java.lang.Object

dev.gradleplugins.grava.testing.AbstractTester

dev.gradleplugins.grava.testing.WellBehavedPluginTester

public final class WellBehavedPluginTester
extends AbstractTester

Test Gradle plugin behaviour deemed of a good plugin.

Usage

Standalone test can be achieved with the following:

     new WellBehavedPluginTester().qualifiedPluginId("foo.bar").testWellBehavedPlugin()
 

JUnit 5 @TestFactory can be achieved with the following:

 @TestFactory
 Stream<DynamicTest> checkWellBehavedPlugin() {
     return new WellBehavedPluginTester()
                .qualifiedPluginId("foo.bar")
                .stream()
                .map(TestCaseUtils::toJUnit5DynamicTest);
 }
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	WellBehavedPluginTester.SupportedTarget

Constructor Summary

Constructors

Constructor and Description
WellBehavedPluginTester()

Method Summary

Modifier and Type	Method and Description
protected void	collectTesters(java.util.List<TestCase> testCases)
WellBehavedPluginTester	doesNotWellBehaveWhenAppliedToUnsupportedTarget() Mark the plugin under test as misbehaving when applied to unsupported target.
<T extends org.gradle.api.Plugin<?>> WellBehavedPluginTester	pluginClass(java.lang.Class<T> pluginType)
WellBehavedPluginTester	qualifiedPluginId(java.lang.String qualifiedPluginId)
WellBehavedPluginTester	supportedTarget(WellBehavedPluginTester.SupportedTarget... targets)
void	testWellBehavedPlugin() Executes all well behaved plugin tests.

Methods inherited from class dev.gradleplugins.grava.testing.AbstractTester

executeAllTestCases, getTesters, stream

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

WellBehavedPluginTester

public WellBehavedPluginTester()

Method Detail

qualifiedPluginId

public WellBehavedPluginTester qualifiedPluginId(java.lang.String qualifiedPluginId)

pluginClass

public <T extends org.gradle.api.Plugin<?>> WellBehavedPluginTester pluginClass(java.lang.Class<T> pluginType)

supportedTarget

public WellBehavedPluginTester supportedTarget(WellBehavedPluginTester.SupportedTarget... targets)

doesNotWellBehaveWhenAppliedToUnsupportedTarget

public WellBehavedPluginTester doesNotWellBehaveWhenAppliedToUnsupportedTarget()

Mark the plugin under test as misbehaving when applied to unsupported target. By default, when a plugin is applied to an unsupported target, i.e. Project plugin applied to Settings, a class cast exception will be thrown. This behavior is not very informative to the user. A well behaved plugin will show an informative error message to the user on the correct usage.

Returns:

this tester

collectTesters

protected void collectTesters(java.util.List<TestCase> testCases)

Specified by:

collectTesters in class AbstractTester

testWellBehavedPlugin

public void testWellBehavedPlugin()

Executes all well behaved plugin tests. Use this method for opinionated test framework testing. Use AbstractTester.stream() to convert the test case into your target test framework.