Index (gradle-runner-kit-api 0.0.140 API)

A B C D F G I M O P R T U V W

A

afterExecute(Consumer<GradleExecutionContext>) - Method in interface dev.gradleplugins.runnerkit.GradleRunner: Adds an action to assert the outcome based on the execution context right after the execution.
asRichOutputResult() - Method in interface dev.gradleplugins.runnerkit.BuildResult: Dilutes the build result to match a rich console, output scrapping, build result.

B

beforeExecute(UnaryOperator<GradleRunner>) - Method in interface dev.gradleplugins.runnerkit.GradleRunner: Adds an action to modify the Gradle runner before it is executed.
build() - Method in interface dev.gradleplugins.runnerkit.GradleRunner: Executes a build, expecting it to complete without failure.
buildAndFail() - Method in interface dev.gradleplugins.runnerkit.GradleRunner: Executes a build, expecting it to complete with failure.
BuildFailure - Class in dev.gradleplugins.runnerkit
BuildOutcome - Enum in dev.gradleplugins.runnerkit
BuildResult - Interface in dev.gradleplugins.runnerkit
BuildResult.Failure - Interface in dev.gradleplugins.runnerkit
BuildTask - Interface in dev.gradleplugins.runnerkit: A task that was executed when running a specific build.

C

causedBy(String) - Method in class dev.gradleplugins.runnerkit.BuildFailure
configure(UnaryOperator<GradleRunner>) - Method in interface dev.gradleplugins.runnerkit.GradleRunner: Configures current runner using the specified operator.
create(GradleExecutor) - Static method in interface dev.gradleplugins.runnerkit.GradleRunner

D

describedBy(String) - Static method in class dev.gradleplugins.runnerkit.BuildFailure
dev.gradleplugins.runnerkit - package dev.gradleplugins.runnerkit
dev.gradleplugins.runnerkit.providers - package dev.gradleplugins.runnerkit.providers

F

forwardOutput() - Method in interface dev.gradleplugins.runnerkit.GradleRunner: Forwards the output of executed builds to the System.out stream.
forwardStandardError(Writer) - Method in interface dev.gradleplugins.runnerkit.GradleRunner: Configures the runner to forward standard error output from builds to the given writer.
forwardStandardOutput(Writer) - Method in interface dev.gradleplugins.runnerkit.GradleRunner: Configures the runner to forward standard output from builds to the given writer.
forwardStdError(Writer) - Method in interface dev.gradleplugins.runnerkit.GradleRunner: Provided method for migration convenience from Gradle TestKit.
forwardStdOutput(Writer) - Method in interface dev.gradleplugins.runnerkit.GradleRunner: Provided method for migration convenience from Gradle TestKit.
from(String) - Static method in interface dev.gradleplugins.runnerkit.BuildResult: Creates a build result from a textual output produced by a Gradle build.

G

get() - Method in interface dev.gradleplugins.runnerkit.providers.GradleExecutionProvider
get() - Method in class dev.gradleplugins.runnerkit.TaskPath
getAfterExecute() - Method in interface dev.gradleplugins.runnerkit.GradleExecutionContext
getAllArguments() - Method in interface dev.gradleplugins.runnerkit.GradleExecutionContext
getAllArguments() - Method in interface dev.gradleplugins.runnerkit.GradleRunner: The build arguments.
getArguments() - Method in interface dev.gradleplugins.runnerkit.GradleExecutionContext
getBeforeExecute() - Method in interface dev.gradleplugins.runnerkit.GradleExecutionContext
getBuildCache() - Method in interface dev.gradleplugins.runnerkit.GradleExecutionContext
getBuildResult() - Method in exception dev.gradleplugins.runnerkit.UnexpectedBuildResultException
getBuildScan() - Method in interface dev.gradleplugins.runnerkit.GradleExecutionContext
getBuildScript() - Method in interface dev.gradleplugins.runnerkit.GradleExecutionContext
getCauses() - Method in class dev.gradleplugins.runnerkit.BuildFailure
getCauses() - Method in interface dev.gradleplugins.runnerkit.BuildResult.Failure
getConsoleType() - Method in interface dev.gradleplugins.runnerkit.GradleExecutionContext
getDaemonBaseDirectory() - Method in interface dev.gradleplugins.runnerkit.GradleExecutionContext
getDaemonIdleTimeout() - Method in interface dev.gradleplugins.runnerkit.GradleExecutionContext
getDefaultCharacterEncoding() - Method in interface dev.gradleplugins.runnerkit.GradleExecutionContext
getDefaultLocale() - Method in interface dev.gradleplugins.runnerkit.GradleExecutionContext
getDeprecationChecks() - Method in interface dev.gradleplugins.runnerkit.GradleExecutionContext
getDescription() - Method in class dev.gradleplugins.runnerkit.BuildFailure
getDescription() - Method in interface dev.gradleplugins.runnerkit.BuildResult.Failure
getDistribution() - Method in interface dev.gradleplugins.runnerkit.GradleExecutionContext
getEnvironmentVariables() - Method in interface dev.gradleplugins.runnerkit.GradleExecutionContext
getExecutedTaskPaths() - Method in interface dev.gradleplugins.runnerkit.BuildResult: Returns a list of task paths for all executed tasks (e.g.
getExecutionParameters() - Method in interface dev.gradleplugins.runnerkit.GradleExecutionContext
getExecutorType() - Method in interface dev.gradleplugins.runnerkit.GradleExecutionContext
getFailures() - Method in interface dev.gradleplugins.runnerkit.BuildResult: Returns the failures in this build result, if any.
getGradleUserHomeDirectory() - Method in interface dev.gradleplugins.runnerkit.GradleExecutionContext
getInitScripts() - Method in interface dev.gradleplugins.runnerkit.GradleExecutionContext
getInjectedClasspath() - Method in interface dev.gradleplugins.runnerkit.GradleExecutionContext
getJavaHome() - Method in interface dev.gradleplugins.runnerkit.GradleExecutionContext
getMissingSettingsFilePolicy() - Method in interface dev.gradleplugins.runnerkit.GradleExecutionContext
getOutcome() - Method in interface dev.gradleplugins.runnerkit.BuildTask: The outcome of attempting to execute this task.
getOutput() - Method in interface dev.gradleplugins.runnerkit.BuildResult: The textual output produced during the build.
getOutput() - Method in interface dev.gradleplugins.runnerkit.BuildTask: The plain output of the task during the build.
getOutput() - Method in interface dev.gradleplugins.runnerkit.GradleExecutionResult
getPath() - Method in interface dev.gradleplugins.runnerkit.BuildTask: The unique path of the task.
getPluginClasspath() - Method in interface dev.gradleplugins.runnerkit.GradleRunner: The injected plugin classpath for the build.
getProjectDirectory() - Method in interface dev.gradleplugins.runnerkit.GradleExecutionContext
getProjectPath() - Method in class dev.gradleplugins.runnerkit.TaskPath
getSettingsFile() - Method in interface dev.gradleplugins.runnerkit.GradleExecutionContext
getSkippedTaskPaths() - Method in interface dev.gradleplugins.runnerkit.BuildResult: Returns a list of task paths for all skipped tasks (e.g.
getStacktrace() - Method in interface dev.gradleplugins.runnerkit.GradleExecutionContext
getStandardError() - Method in interface dev.gradleplugins.runnerkit.GradleExecutionContext
getStandardOutput() - Method in interface dev.gradleplugins.runnerkit.GradleExecutionContext
getTaskName() - Method in class dev.gradleplugins.runnerkit.TaskPath
getTasks() - Method in interface dev.gradleplugins.runnerkit.BuildResult: The tasks that were part of the build.
getTasks() - Method in interface dev.gradleplugins.runnerkit.GradleExecutionContext
getUserHomeDirectory() - Method in interface dev.gradleplugins.runnerkit.GradleExecutionContext
getWelcomeMessageRendering() - Method in interface dev.gradleplugins.runnerkit.GradleExecutionContext
getWorkingDirectory() - Method in interface dev.gradleplugins.runnerkit.GradleExecutionContext
getWorkingDirectory() - Method in interface dev.gradleplugins.runnerkit.GradleRunner: The directory that the build will be executed in.
GradleDistribution - Interface in dev.gradleplugins.runnerkit
GradleExecutionContext - Interface in dev.gradleplugins.runnerkit
GradleExecutionContext.BuildCache - Enum in dev.gradleplugins.runnerkit
GradleExecutionContext.BuildScan - Enum in dev.gradleplugins.runnerkit
GradleExecutionContext.ConsoleType - Enum in dev.gradleplugins.runnerkit
GradleExecutionContext.DeprecationChecks - Enum in dev.gradleplugins.runnerkit
GradleExecutionContext.MissingSettingsFilePolicy - Enum in dev.gradleplugins.runnerkit
GradleExecutionContext.Stacktrace - Enum in dev.gradleplugins.runnerkit
GradleExecutionContext.WelcomeMessage - Enum in dev.gradleplugins.runnerkit
GradleExecutionProvider<T> - Interface in dev.gradleplugins.runnerkit.providers
GradleExecutionResult - Interface in dev.gradleplugins.runnerkit
GradleExecutor - Interface in dev.gradleplugins.runnerkit
GradleRunner - Interface in dev.gradleplugins.runnerkit
gradleTestKit() - Static method in interface dev.gradleplugins.runnerkit.GradleExecutor: Creates a Gradle Test Kit executor.
gradleWrapper() - Static method in interface dev.gradleplugins.runnerkit.GradleExecutor: Creates a Gradle Wrapper executor.

I

ignoresMissingSettingsFile() - Method in interface dev.gradleplugins.runnerkit.GradleRunner: Does not create an empty settings file when it's missing before execution.
inDirectory(File) - Method in interface dev.gradleplugins.runnerkit.GradleRunner: Sets the working directory to use.
inDirectory(Path) - Method in interface dev.gradleplugins.runnerkit.GradleRunner: Sets the working directory to use.
inDirectory(Supplier<?>) - Method in interface dev.gradleplugins.runnerkit.GradleRunner: Sets the working directory to use using the supplier.
InvalidPluginMetadataException - Exception in dev.gradleplugins.runnerkit: Thrown when the plugin under test metadata cannot be read.
InvalidPluginMetadataException(String) - Constructor for exception dev.gradleplugins.runnerkit.InvalidPluginMetadataException
InvalidRunnerConfigurationException - Exception in dev.gradleplugins.runnerkit: Thrown when a build cannot be executed due to the runner being in an invalid state.
InvalidRunnerConfigurationException(String) - Constructor for exception dev.gradleplugins.runnerkit.InvalidRunnerConfigurationException
InvalidRunnerConfigurationException(String, RuntimeException) - Constructor for exception dev.gradleplugins.runnerkit.InvalidRunnerConfigurationException
isPresent() - Method in interface dev.gradleplugins.runnerkit.providers.GradleExecutionProvider
isSuccessful() - Method in interface dev.gradleplugins.runnerkit.GradleExecutionResult

M

map(Function<? super T, ? extends U>) - Method in interface dev.gradleplugins.runnerkit.providers.GradleExecutionProvider

O

of(String) - Static method in class dev.gradleplugins.runnerkit.TaskPath
orElse(T) - Method in interface dev.gradleplugins.runnerkit.providers.GradleExecutionProvider
orElseGet(Supplier<T>) - Method in interface dev.gradleplugins.runnerkit.providers.GradleExecutionProvider

P

publishBuildScans() - Method in interface dev.gradleplugins.runnerkit.GradleRunner: Publishes build scans to the public enterprise server for each build ran by this executer.

R

requireOwnGradleUserHomeDirectory() - Method in interface dev.gradleplugins.runnerkit.GradleRunner: Configures a unique Gradle user home directory for the test.
run(GradleExecutionContext) - Method in interface dev.gradleplugins.runnerkit.GradleExecutor

T

task(String) - Method in interface dev.gradleplugins.runnerkit.BuildResult: Returns the result object for a particular task, or null if the given task was not part of the build.
TaskOutcome - Enum in dev.gradleplugins.runnerkit: The outcome of executing a task during a build.
TaskPath - Class in dev.gradleplugins.runnerkit
tasks(TaskOutcome) - Method in interface dev.gradleplugins.runnerkit.BuildResult: The subset of BuildResult.getTasks() that had the given outcome.
toString() - Method in class dev.gradleplugins.runnerkit.TaskPath

U

UnexpectedBuildFailure - Exception in dev.gradleplugins.runnerkit: Thrown when executing a build that was expected to succeed, but failed.
UnexpectedBuildFailure(String, BuildResult) - Constructor for exception dev.gradleplugins.runnerkit.UnexpectedBuildFailure
UnexpectedBuildResultException - Exception in dev.gradleplugins.runnerkit
UnexpectedBuildSuccess - Exception in dev.gradleplugins.runnerkit: Thrown when executing a build that was expected to fail, but succeeded.
UnexpectedBuildSuccess(String, BuildResult) - Constructor for exception dev.gradleplugins.runnerkit.UnexpectedBuildSuccess
usingBuildScript(File) - Method in interface dev.gradleplugins.runnerkit.GradleRunner: Uses the given build script by adding "--build-file" argument.
usingInitScript(File) - Method in interface dev.gradleplugins.runnerkit.GradleRunner: Uses the given init script by adding "--init-script" argument.
usingProjectDirectory(File) - Method in interface dev.gradleplugins.runnerkit.GradleRunner: Uses the given project directory by adding the "--project-dir" argument.
usingSettingsFile(File) - Method in interface dev.gradleplugins.runnerkit.GradleRunner: Uses the given settings file by adding "--settings-file" argument.

V

valueOf(String) - Static method in enum dev.gradleplugins.runnerkit.BuildOutcome: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum dev.gradleplugins.runnerkit.GradleExecutionContext.BuildCache: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum dev.gradleplugins.runnerkit.GradleExecutionContext.BuildScan: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum dev.gradleplugins.runnerkit.GradleExecutionContext.ConsoleType: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum dev.gradleplugins.runnerkit.GradleExecutionContext.DeprecationChecks: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum dev.gradleplugins.runnerkit.GradleExecutionContext.MissingSettingsFilePolicy: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum dev.gradleplugins.runnerkit.GradleExecutionContext.Stacktrace: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum dev.gradleplugins.runnerkit.GradleExecutionContext.WelcomeMessage: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum dev.gradleplugins.runnerkit.TaskOutcome: Returns the enum constant of this type with the specified name.
values() - Static method in enum dev.gradleplugins.runnerkit.BuildOutcome: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum dev.gradleplugins.runnerkit.GradleExecutionContext.BuildCache: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum dev.gradleplugins.runnerkit.GradleExecutionContext.BuildScan: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum dev.gradleplugins.runnerkit.GradleExecutionContext.ConsoleType: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum dev.gradleplugins.runnerkit.GradleExecutionContext.DeprecationChecks: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum dev.gradleplugins.runnerkit.GradleExecutionContext.MissingSettingsFilePolicy: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum dev.gradleplugins.runnerkit.GradleExecutionContext.Stacktrace: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum dev.gradleplugins.runnerkit.GradleExecutionContext.WelcomeMessage: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum dev.gradleplugins.runnerkit.TaskOutcome: Returns an array containing the constants of this enum type, in the order they are declared.

W

withArgument(String) - Method in interface dev.gradleplugins.runnerkit.GradleRunner: Adds an additional command-line argument to use when executing the build.
withArguments(String...) - Method in interface dev.gradleplugins.runnerkit.GradleRunner: Sets the additional command-line arguments to use when executing the build.
withArguments(List<String>) - Method in interface dev.gradleplugins.runnerkit.GradleRunner: Sets the additional command-line arguments to use when executing the build.
withBuildCacheEnabled() - Method in interface dev.gradleplugins.runnerkit.GradleRunner: Activates the build cache.
withDefaultCharacterEncoding(Charset) - Method in interface dev.gradleplugins.runnerkit.GradleRunner: Sets the default character encoding to use.
withDefaultLocale(Locale) - Method in interface dev.gradleplugins.runnerkit.GradleRunner: Sets the default locale to use.
withEnvironment(Map<String, String>) - Method in interface dev.gradleplugins.runnerkit.GradleRunner: Sets the environment variables to use when executing the build.
withEnvironmentVariable(String, String) - Method in interface dev.gradleplugins.runnerkit.GradleRunner: Adds an additional environment variable to use when executing the build.
withEnvironmentVariables(Map<String, ?>) - Method in interface dev.gradleplugins.runnerkit.GradleRunner: Sets the environment variables to use when executing the build.
withEnvironmentVars(Map<String, ?>) - Method in interface dev.gradleplugins.runnerkit.GradleRunner: Deprecated.
withGradleDistribution(URI) - Method in interface dev.gradleplugins.runnerkit.GradleRunner: Configures the runner to execute the build using the distribution of Gradle specified.
withGradleInstallation(File) - Method in interface dev.gradleplugins.runnerkit.GradleRunner: Configures the runner to execute the build using the installation of Gradle specified.
withGradleUserHomeDirectory(File) - Method in interface dev.gradleplugins.runnerkit.GradleRunner: Sets the Gradle user home dir.
withGradleVersion(String) - Method in interface dev.gradleplugins.runnerkit.GradleRunner: Configures the runner to execute the build with the version of Gradle specified.
withNormalizedTaskOutput(Predicate<TaskPath>, UnaryOperator<String>) - Method in interface dev.gradleplugins.runnerkit.BuildResult: Returns a new build result with the task output matching the predicate normalized by the output normalizer.
withoutBuildSrc() - Method in interface dev.gradleplugins.runnerkit.BuildResult: Returns a new build result without the tasks executed from the buildSrc included build.
withoutDeprecationChecks() - Method in interface dev.gradleplugins.runnerkit.GradleRunner: Disable deprecation warning checks.
withPluginClasspath() - Method in interface dev.gradleplugins.runnerkit.GradleRunner: Sets the plugin classpath based on the Gradle plugin development plugin conventions.
withPluginClasspath(Iterable<? extends File>) - Method in interface dev.gradleplugins.runnerkit.GradleRunner: Sets the injected plugin classpath for the build.
withRichConsoleEnabled() - Method in interface dev.gradleplugins.runnerkit.GradleRunner: Forces the rich console output.
withStacktraceDisabled() - Method in interface dev.gradleplugins.runnerkit.GradleRunner: Executes the builds without adding the "--stacktrace" argument.
withTasks(String...) - Method in interface dev.gradleplugins.runnerkit.GradleRunner: Sets the task names to execute.
withTasks(List<String>) - Method in interface dev.gradleplugins.runnerkit.GradleRunner: Sets the task names to execute.
withUserHomeDirectory(File) - Method in interface dev.gradleplugins.runnerkit.GradleRunner: Sets the user's home dir to use when running the build.
withWelcomeMessageEnabled() - Method in interface dev.gradleplugins.runnerkit.GradleRunner: Renders the welcome message users see upon first invocation of a Gradle distribution with a given Gradle user home directory.

A B C D F G I M O P R T U V W