GradleExecuter (gradle-fixtures 0.0.52 API)

All Known Implementing Classes:

GradleRunnerExecuter, GradleWrapperExecuter
```
public interface GradleExecuter
```

Method Summary

All Methods Instance Methods Abstract Methods
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.
`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.
`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`	`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 consoleOutput)` 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.

- Method Detail
  - inDirectory
```
GradleExecuter inDirectory(java.io.File directory)
```
    Sets the working directory to use. Defaults to the test's temporary directory.
  - getWorkingDirectory
```
java.io.File getWorkingDirectory()
```
  - withDebuggerAttached
```
GradleExecuter withDebuggerAttached()
```
    Allows to trigger on breakpoints inside the Gradle build when the debugger is attached to the caller.
  - withTasks
```
GradleExecuter withTasks(java.lang.String... tasks)
```
    Sets the task names to execute. Defaults to an empty list.
  - withTasks
```
GradleExecuter withTasks(java.util.List<java.lang.String> tasks)
```
    Sets the task names to execute. Defaults to an empty list.
  - withArguments
```
GradleExecuter withArguments(java.lang.String... args)
```
    Sets the additional command-line arguments to use when executing the build. Defaults to an empty list.
  - withArguments
```
GradleExecuter withArguments(java.util.List<java.lang.String> args)
```
    Sets the additional command-line arguments to use when executing the build. Defaults to an empty list.
    
    Parameters:
    
    args - the new arguments to use, the old ones are discarded
    
    Returns:
    
    a new GradleExecuter instance with the new configuration.
  - withArgument
```
GradleExecuter withArgument(java.lang.String arg)
```
    Adds an additional command-line argument to use when executing the build.
  - withStacktraceDisabled
```
GradleExecuter withStacktraceDisabled()
```
    Executes the builds without adding the "--stacktrace" argument.
  - withBuildCacheEnabled
```
GradleExecuter withBuildCacheEnabled()
```
    Activates the build cache. Defaults to false.
  - withPluginClasspath
```
GradleExecuter withPluginClasspath()
```
    Activates the plugin classpath from the plugins under test.
  - withUserHomeDirectory
```
GradleExecuter withUserHomeDirectory(java.io.File userHomeDirectory)
```
    Sets the user's home dir to use when running the build. Implementations are not 100% accurate.
  - withGradleUserHomeDirectory
```
GradleExecuter withGradleUserHomeDirectory(java.io.File gradleUserHomeDirectory)
```
    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.
  - withEnvironmentVars
```
GradleExecuter withEnvironmentVars(java.util.Map<java.lang.String,?> environment)
```
    Sets the environment variables to use when executing the build. Defaults to the environment of this process.
  - usingSettingsFile
```
GradleExecuter usingSettingsFile(java.io.File settingsFile)
```
    Uses the given settings file by adding "--settings-file" argument.
  - usingBuildScript
```
GradleExecuter usingBuildScript(java.io.File buildScript)
```
    Uses the given build script by adding "--build-file" argument.
  - usingInitScript
```
GradleExecuter usingInitScript(java.io.File initScript)
```
    Uses the given init script by adding "--init-script" argument.
  - usingProjectDirectory
```
GradleExecuter usingProjectDirectory(java.io.File projectDirectory)
```
    Uses the given project directory by adding the "--project-dir" argument.
  - getTestDirectory
```
TestFile getTestDirectory()
```
    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.
  - run
```
ExecutionResult run()
```
    Executes the requested build, asserting that the build succeeds. Resets the configuration of this executor.
    
    Returns:
    
    The result.
  - runWithFailure
```
ExecutionFailure runWithFailure()
```
    Executes the requested build, asserting that the build fails. Resets the configuration of this executer.
    
    Returns:
    
    The result.
  - beforeExecute
```
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.
  - afterExecute
```
GradleExecuter afterExecute(java.util.function.Consumer<? super GradleExecuter> action)
```
    Adds an action to be called immediately after execution.
  - withConsole
```
GradleExecuter withConsole(ConsoleOutput consoleOutput)
```
    Executes the build with "--console=rich, auto, verbose" argument.
  - requireOwnGradleUserHomeDirectory
```
GradleExecuter requireOwnGradleUserHomeDirectory()
```
    Configures a unique gradle user home dir for the test. The gradle user home dir used will be underneath the getTestDirectory() directory.
    Note: does not affect the daemon base dir.

Interface GradleExecuter

Method Summary

Method Detail

inDirectory

getWorkingDirectory

withDebuggerAttached

withTasks

withTasks

withArguments

withArguments

withArgument

withStacktraceDisabled

withBuildCacheEnabled

withPluginClasspath

withUserHomeDirectory

withGradleUserHomeDirectory

withEnvironmentVars

usingSettingsFile

usingBuildScript

usingInitScript

usingProjectDirectory

getTestDirectory

run

runWithFailure

beforeExecute

afterExecute

withConsole

requireOwnGradleUserHomeDirectory