dev.gradleplugins.test.fixtures.gradle.executer

Class OutputScrapingExecutionResult

java.lang.Object

dev.gradleplugins.test.fixtures.gradle.executer.OutputScrapingExecutionResult

All Implemented Interfaces:

ExecutionResult

Direct Known Subclasses:

OutputScrapingExecutionFailure

public class OutputScrapingExecutionResult
extends java.lang.Object
implements ExecutionResult

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	OutputScrapingExecutionResult(LogContent output, LogContent error, boolean includeBuildSrc)

Method Summary

Modifier and Type	Method and Description
ExecutionResult	assertContentContains(java.lang.String actualText, java.lang.String expectedOutput, java.lang.String label)
ExecutionResult	assertHasErrorOutput(java.lang.String expectedOutput)
ExecutionResult	assertHasPostBuildOutput(java.lang.String expectedOutput) Assert that the given message appears after the build result message.
ExecutionResult	assertNotOutput(java.lang.String expectedOutput) Asserts that this result does not include the given log message anywhere in the build output.
ExecutionResult	assertOutputContains(java.lang.String expectedOutput) Asserts that this result includes the given non-error log message.
ExecutionResult	assertOutputEquals(java.lang.String expectedOutput, boolean ignoreExtraLines, boolean ignoreLineOrder)
ExecutionResult	assertTaskExecuted(java.lang.String taskPath)
ExecutionResult	assertTaskNotExecuted(java.lang.String taskPath) Asserts that the given task has not been executed.
ExecutionResult	assertTaskNotSkipped(java.lang.String taskPath) Asserts that the given task has not been skipped.
ExecutionResult	assertTaskOrder(java.lang.Object... taskPaths)
ExecutionResult	assertTasksExecuted(java.lang.Object... taskPaths) Asserts that exactly the given set of tasks have been executed in any order.
ExecutionResult	assertTasksExecutedAndNotSkipped(java.lang.Object... taskPaths) Asserts that exactly the given set of tasks have been executed in any order and none of the tasks were skipped.
ExecutionResult	assertTasksExecutedInOrder(java.lang.Object... taskPaths)
ExecutionResult	assertTaskSkipped(java.lang.String taskPath) Asserts the given task has been skipped.
ExecutionResult	assertTasksNotSkipped(java.lang.Object... taskPaths) Asserts that exactly the given set of tasks have not been skipped.
ExecutionResult	assertTasksSkipped(java.lang.Object... taskPaths) Asserts that exactly the given set of tasks have been skipped.
protected void	failureOnUnexpectedOutput(java.lang.String message)
static java.util.List<java.lang.String>	flattenTaskPaths(java.lang.Object[] taskPaths)
static OutputScrapingExecutionResult	from(java.lang.String output, java.lang.String error) Creates a result from the output of a single Gradle invocation.
java.lang.String	getError()
java.util.List<java.lang.String>	getExecutedTasks()
java.lang.String	getFormattedOutput()
GroupedOutputFixture	getGroupedOutput() Returns a fixture that parses the output and forms them into the expected groups
ExecutionResult	getIgnoreBuildSrc()
LogContent	getMainContent() The main content with debug prefix and ANSI characters removed.
java.lang.String	getNormalizedOutput()
java.lang.String	getOutput() Stdout of the Gradle execution, normalized to use new-line char as line separator.
java.lang.String	getOutputLineThatContains(java.lang.String text)
java.lang.String	getPlainTextOutput() Stdout of the Gradle execution, with ANSI characters interpreted and text attributes discarded.
java.util.Set<java.lang.String>	getSkippedTasks()
boolean	hasErrorOutput(java.lang.String expectedOutput)
static java.lang.String	normalize(LogContent output)

Methods inherited from class java.lang.Object

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

Constructor Detail

OutputScrapingExecutionResult

protected OutputScrapingExecutionResult(LogContent output,
                                        LogContent error,
                                        boolean includeBuildSrc)

Parameters:

output - The build stdout content.

error - The build stderr content. Must have normalized line endings.

Method Detail

flattenTaskPaths

public static java.util.List<java.lang.String> flattenTaskPaths(java.lang.Object[] taskPaths)

from

public static OutputScrapingExecutionResult from(java.lang.String output,
                                                 java.lang.String error)

Creates a result from the output of a single Gradle invocation.

Parameters:

output - The raw build stdout chars.

error - The raw build stderr chars.

Returns:

A OutputScrapingExecutionResult for a successful build, or a OutputScrapingExecutionFailure for a failed build.

getIgnoreBuildSrc

public ExecutionResult getIgnoreBuildSrc()

getOutput

public java.lang.String getOutput()

Description copied from interface: ExecutionResult

Stdout of the Gradle execution, normalized to use new-line char as line separator.

You should avoid using this method as it couples the tests to a particular layout for the console. Instead use the more descriptive assertion methods on this class.

Specified by:

getOutput in interface ExecutionResult

getMainContent

public LogContent getMainContent()

The main content with debug prefix and ANSI characters removed.

getNormalizedOutput

public java.lang.String getNormalizedOutput()

getFormattedOutput

public java.lang.String getFormattedOutput()

getPlainTextOutput

public java.lang.String getPlainTextOutput()

Description copied from interface: ExecutionResult

Stdout of the Gradle execution, with ANSI characters interpreted and text attributes discarded.

Specified by:

getPlainTextOutput in interface ExecutionResult

getGroupedOutput

public GroupedOutputFixture getGroupedOutput()

Description copied from interface: ExecutionResult

Returns a fixture that parses the output and forms them into the expected groups

Specified by:

getGroupedOutput in interface ExecutionResult

normalize

public static java.lang.String normalize(LogContent output)

assertOutputEquals

public ExecutionResult assertOutputEquals(java.lang.String expectedOutput,
                                          boolean ignoreExtraLines,
                                          boolean ignoreLineOrder)

assertHasPostBuildOutput

public ExecutionResult assertHasPostBuildOutput(java.lang.String expectedOutput)

Description copied from interface: ExecutionResult

Assert that the given message appears after the build result message.

Specified by:

assertHasPostBuildOutput in interface ExecutionResult

Parameters:

expectedOutput - The expected log message, with line endings normalized to a newline character.

assertNotOutput

public ExecutionResult assertNotOutput(java.lang.String expectedOutput)

Description copied from interface: ExecutionResult

Asserts that this result does not include the given log message anywhere in the build output.

Specified by:

assertNotOutput in interface ExecutionResult

Parameters:

expectedOutput - The expected log message, with line endings normalized to a newline character.

assertContentContains

public ExecutionResult assertContentContains(java.lang.String actualText,
                                             java.lang.String expectedOutput,
                                             java.lang.String label)

assertOutputContains

public ExecutionResult assertOutputContains(java.lang.String expectedOutput)

Description copied from interface: ExecutionResult

Asserts that this result includes the given non-error log message. Does not consider any text in or following the build result message (use ExecutionResult.assertHasPostBuildOutput(String) instead).

Specified by:

assertOutputContains in interface ExecutionResult

Parameters:

expectedOutput - The expected log message, with line endings normalized to a newline character.

hasErrorOutput

public boolean hasErrorOutput(java.lang.String expectedOutput)

assertHasErrorOutput

public ExecutionResult assertHasErrorOutput(java.lang.String expectedOutput)

getError

public java.lang.String getError()

getOutputLineThatContains

public java.lang.String getOutputLineThatContains(java.lang.String text)

getExecutedTasks

public java.util.List<java.lang.String> getExecutedTasks()

assertTasksExecutedInOrder

public ExecutionResult assertTasksExecutedInOrder(java.lang.Object... taskPaths)

assertTasksExecuted

public ExecutionResult assertTasksExecuted(java.lang.Object... taskPaths)

Description copied from interface: ExecutionResult

Asserts that exactly the given set of tasks have been executed in any order.

Specified by:

assertTasksExecuted in interface ExecutionResult

assertTasksExecutedAndNotSkipped

public ExecutionResult assertTasksExecutedAndNotSkipped(java.lang.Object... taskPaths)

Description copied from interface: ExecutionResult

Asserts that exactly the given set of tasks have been executed in any order and none of the tasks were skipped.

Specified by:

assertTasksExecutedAndNotSkipped in interface ExecutionResult

assertTaskExecuted

public ExecutionResult assertTaskExecuted(java.lang.String taskPath)

assertTaskNotExecuted

public ExecutionResult assertTaskNotExecuted(java.lang.String taskPath)

Description copied from interface: ExecutionResult

Asserts that the given task has not been executed.

Specified by:

assertTaskNotExecuted in interface ExecutionResult

assertTaskOrder

public ExecutionResult assertTaskOrder(java.lang.Object... taskPaths)

getSkippedTasks

public java.util.Set<java.lang.String> getSkippedTasks()

assertTasksSkipped

public ExecutionResult assertTasksSkipped(java.lang.Object... taskPaths)

Description copied from interface: ExecutionResult

Asserts that exactly the given set of tasks have been skipped.

Specified by:

assertTasksSkipped in interface ExecutionResult

assertTaskSkipped

public ExecutionResult assertTaskSkipped(java.lang.String taskPath)

Description copied from interface: ExecutionResult

Asserts the given task has been skipped.

Specified by:

assertTaskSkipped in interface ExecutionResult

assertTasksNotSkipped

public ExecutionResult assertTasksNotSkipped(java.lang.Object... taskPaths)

Description copied from interface: ExecutionResult

Asserts that exactly the given set of tasks have not been skipped.

Specified by:

assertTasksNotSkipped in interface ExecutionResult

assertTaskNotSkipped

public ExecutionResult assertTaskNotSkipped(java.lang.String taskPath)

Description copied from interface: ExecutionResult

Asserts that the given task has not been skipped.

Specified by:

assertTaskNotSkipped in interface ExecutionResult

failureOnUnexpectedOutput

protected void failureOnUnexpectedOutput(java.lang.String message)