dev.gradleplugins.test.fixtures.gradle.executer

Class GradleRunnerExecuter

java.lang.Object

dev.gradleplugins.test.fixtures.gradle.executer.GradleRunnerExecuter

All Implemented Interfaces:

GradleExecuter

public class GradleRunnerExecuter
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
protected GradleExecuterConfiguration	configuration

Constructor Summary

Constructors

Constructor and Description
GradleRunnerExecuter(TestFile testDirectory)

Method Summary

Modifier and Type	Method and Description
GradleExecuter	afterExecute(java.util.function.Consumer<? super GradleExecuter> action) Adds an action to be called immediately after execution.
GradleExecuter	beforeExecute(java.util.function.Consumer<? super GradleExecuter> action) Adds an action to be called immediately before execution, to allow extra configuration to be injected.
ExecutionResult	doRun()
ExecutionFailure	doRunWithFailure()
protected java.util.List<java.lang.String>	getAllArguments()
TestFile	getTestDirectory() The directory that the executer will use for any test specific storage.
java.io.File	getWorkingDirectory()
GradleExecuter	inDirectory(java.io.File directory) Sets the working directory to use.
protected GradleExecuter	newInstance(GradleExecuterConfiguration configuration)
protected GradleExecuter	newInstance(TestFile testDirectory, GradleExecuterConfiguration configuration)
GradleExecuter	requireOwnGradleUserHomeDirectory() Configures a unique gradle user home dir for the test.
ExecutionResult	run() Executes the requested build, asserting that the build succeeds.
ExecutionFailure	runWithFailure() Executes the requested build, asserting that the build fails.
GradleExecuter	usingBuildScript(java.io.File buildScript) Uses the given build script by adding "--build-file" argument.
GradleExecuter	usingGradleVersion(java.lang.String gradleVersion)
GradleExecuter	usingInitScript(java.io.File initScript) Uses the given init script by adding "--init-script" argument.
GradleExecuter	usingProjectDirectory(java.io.File projectDirectory) Uses the given project directory by adding the "--project-dir" argument.
GradleExecuter	usingSettingsFile(java.io.File settingsFile) Uses the given settings file by adding "--settings-file" argument.
GradleExecuter	withArgument(java.lang.String arg) Adds an additional command-line argument to use when executing the build.
GradleExecuter	withArguments(java.util.List<java.lang.String> args) Sets the additional command-line arguments to use when executing the build.
GradleExecuter	withArguments(java.lang.String... args) Sets the additional command-line arguments to use when executing the build.
GradleExecuter	withBuildCacheEnabled() Activates the build cache.
GradleExecuter	withConsole(ConsoleOutput consoleType) Executes the build with "--console=rich, auto, verbose" argument.
GradleExecuter	withDebuggerAttached() Allows to trigger on breakpoints inside the Gradle build when the debugger is attached to the caller.
GradleExecuter	withEnvironmentVars(java.util.Map<java.lang.String,?> environment) Sets the environment variables to use when executing the build.
GradleExecuter	withGradleUserHomeDirectory(java.io.File gradleUserHomeDirectory) Sets the Gradle user home dir.
GradleExecuter	withPluginClasspath() Activates the plugin classpath from the plugins under test.
GradleExecuter	withStacktraceDisabled() Executes the builds without adding the "--stacktrace" argument.
GradleExecuter	withTasks(java.util.List<java.lang.String> tasks) Sets the task names to execute.
GradleExecuter	withTasks(java.lang.String... tasks) Sets the task names to execute.
GradleExecuter	withUserHomeDirectory(java.io.File userHomeDirectory) Sets the user's home dir to use when running the build.

Methods inherited from class java.lang.Object

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

Field Detail

configuration

protected GradleExecuterConfiguration configuration

Constructor Detail

GradleRunnerExecuter

public GradleRunnerExecuter(TestFile testDirectory)

Method Detail

newInstance

protected GradleExecuter newInstance(TestFile testDirectory,
                                     GradleExecuterConfiguration configuration)

withDebuggerAttached

public GradleExecuter withDebuggerAttached()

Description copied from interface: GradleExecuter

Allows to trigger on breakpoints inside the Gradle build when the debugger is attached to the caller.

withPluginClasspath

public GradleExecuter withPluginClasspath()

Description copied from interface: GradleExecuter

Activates the plugin classpath from the plugins under test.

doRun

public ExecutionResult doRun()

doRunWithFailure

public ExecutionFailure doRunWithFailure()

usingGradleVersion

public GradleExecuter usingGradleVersion(java.lang.String gradleVersion)

newInstance

protected GradleExecuter newInstance(GradleExecuterConfiguration configuration)

getTestDirectory

public TestFile getTestDirectory()

Description copied from interface: GradleExecuter

The directory that the executer will use for any test specific storage. May or may not be the same directory as the build to be run.

Specified by:

getTestDirectory in interface GradleExecuter

getWorkingDirectory

public java.io.File getWorkingDirectory()

Specified by:

getWorkingDirectory in interface GradleExecuter

inDirectory

public GradleExecuter inDirectory(java.io.File directory)

Description copied from interface: GradleExecuter

Sets the working directory to use. Defaults to the test's temporary directory.

Specified by:

inDirectory in interface GradleExecuter

withUserHomeDirectory

public GradleExecuter withUserHomeDirectory(java.io.File userHomeDirectory)

Description copied from interface: GradleExecuter

Sets the user's home dir to use when running the build. Implementations are not 100% accurate.

Specified by:

withUserHomeDirectory in interface GradleExecuter

withGradleUserHomeDirectory

public GradleExecuter withGradleUserHomeDirectory(java.io.File gradleUserHomeDirectory)

Description copied from interface: GradleExecuter

Sets the Gradle user home dir. Setting to null requests that the executer use the real default Gradle user home dir rather than the default used for testing.

Note: does not affect the daemon base dir.

Specified by:

withGradleUserHomeDirectory in interface GradleExecuter

requireOwnGradleUserHomeDirectory

public GradleExecuter requireOwnGradleUserHomeDirectory()

Description copied from interface: GradleExecuter

Configures a unique gradle user home dir for the test. The gradle user home dir used will be underneath the GradleExecuter.getTestDirectory() directory.

Note: does not affect the daemon base dir.

Specified by:

requireOwnGradleUserHomeDirectory in interface GradleExecuter

withStacktraceDisabled

public GradleExecuter withStacktraceDisabled()

Description copied from interface: GradleExecuter

Executes the builds without adding the "--stacktrace" argument.

Specified by:

withStacktraceDisabled in interface GradleExecuter

usingSettingsFile

public GradleExecuter usingSettingsFile(java.io.File settingsFile)

Description copied from interface: GradleExecuter

Uses the given settings file by adding "--settings-file" argument.

Specified by:

usingSettingsFile in interface GradleExecuter

usingBuildScript

public GradleExecuter usingBuildScript(java.io.File buildScript)

Description copied from interface: GradleExecuter

Uses the given build script by adding "--build-file" argument.

Specified by:

usingBuildScript in interface GradleExecuter

usingInitScript

public GradleExecuter usingInitScript(java.io.File initScript)

Description copied from interface: GradleExecuter

Uses the given init script by adding "--init-script" argument.

Specified by:

usingInitScript in interface GradleExecuter

usingProjectDirectory

public GradleExecuter usingProjectDirectory(java.io.File projectDirectory)

Description copied from interface: GradleExecuter

Uses the given project directory by adding the "--project-dir" argument.

Specified by:

usingProjectDirectory in interface GradleExecuter

withBuildCacheEnabled

public GradleExecuter withBuildCacheEnabled()

Description copied from interface: GradleExecuter

Activates the build cache. Defaults to false.

Specified by:

withBuildCacheEnabled in interface GradleExecuter

withArguments

public GradleExecuter withArguments(java.lang.String... args)

Description copied from interface: GradleExecuter

Sets the additional command-line arguments to use when executing the build. Defaults to an empty list.

Specified by:

withArguments in interface GradleExecuter

withArguments

public GradleExecuter withArguments(java.util.List<java.lang.String> args)

Description copied from interface: GradleExecuter

Sets the additional command-line arguments to use when executing the build. Defaults to an empty list.

Specified by:

withArguments in interface GradleExecuter

withArgument

public GradleExecuter withArgument(java.lang.String arg)

Description copied from interface: GradleExecuter

Adds an additional command-line argument to use when executing the build.

Specified by:

withArgument in interface GradleExecuter

withTasks

public GradleExecuter withTasks(java.lang.String... tasks)

Description copied from interface: GradleExecuter

Sets the task names to execute. Defaults to an empty list.

Specified by:

withTasks in interface GradleExecuter

withTasks

public GradleExecuter withTasks(java.util.List<java.lang.String> tasks)

Description copied from interface: GradleExecuter

Sets the task names to execute. Defaults to an empty list.

Specified by:

withTasks in interface GradleExecuter

beforeExecute

public GradleExecuter beforeExecute(java.util.function.Consumer<? super GradleExecuter> action)

Description copied from interface: GradleExecuter

Adds an action to be called immediately before execution, to allow extra configuration to be injected.

Specified by:

beforeExecute in interface GradleExecuter

afterExecute

public GradleExecuter afterExecute(java.util.function.Consumer<? super GradleExecuter> action)

Description copied from interface: GradleExecuter

Adds an action to be called immediately after execution.

Specified by:

afterExecute in interface GradleExecuter

withConsole

public GradleExecuter withConsole(ConsoleOutput consoleType)

Description copied from interface: GradleExecuter

Executes the build with "--console=rich, auto, verbose" argument.

Specified by:

withConsole in interface GradleExecuter

withEnvironmentVars

public GradleExecuter withEnvironmentVars(java.util.Map<java.lang.String,?> environment)

Description copied from interface: GradleExecuter

Sets the environment variables to use when executing the build. Defaults to the environment of this process.

Specified by:

withEnvironmentVars in interface GradleExecuter

run

public ExecutionResult run()

Description copied from interface: GradleExecuter

Executes the requested build, asserting that the build succeeds. Resets the configuration of this executor.

Specified by:

run in interface GradleExecuter

Returns:

The result.

runWithFailure

public ExecutionFailure runWithFailure()

Description copied from interface: GradleExecuter

Executes the requested build, asserting that the build fails. Resets the configuration of this executer.

Specified by:

runWithFailure in interface GradleExecuter

Returns:

The result.

getAllArguments

protected java.util.List<java.lang.String> getAllArguments()