dev.gradleplugins.test.fixtures.gradle.executer.internal

Class DefaultGradleDistribution

java.lang.Object

dev.gradleplugins.test.fixtures.gradle.executer.internal.DefaultGradleDistribution

All Implemented Interfaces:

GradleDistribution

Direct Known Subclasses:

CurrentGradleDistribution, DownloadableGradleDistribution

public class DefaultGradleDistribution
extends java.lang.Object
implements GradleDistribution

Constructor Summary

Constructors

Constructor and Description
DefaultGradleDistribution(org.gradle.util.GradleVersion gradleVersion, TestFile gradleHomeDir, TestFile binDistribution)

Method Summary

Modifier and Type	Method and Description
GradleExecuter	executer(TestFile testDirectoryProvider) Creates an executer which will use this distribution.
org.gradle.cache.internal.CacheVersion	getArtifactCacheLayoutVersion() Returns the version of the artifact cache layout
TestFile	getBinDistribution() Returns the binary distribution.
TestFile	getGradleHomeDir() Returns the root directory of the installed distribution
org.gradle.util.GradleVersion	getVersion() Returns the version of this distribution.
boolean	isAddsTaskExecutionExceptionAroundAllTaskFailures() Returns true if this version always adds a task execution exception around all failures, such as input fingerprinting or property validation failures, rather than only around task action failures.
boolean	isDaemonIdleTimeoutConfigurable() Returns true if the configuring daemon idle timeout feature is supported by this distribution.
boolean	isFullySupportsIvyRepository() The 'ivy' repository was introduced in Milestone-3, but early versions didn't work with spaces in the artifact pattern.
protected boolean	isSameOrNewer(java.lang.String otherVersion)
protected boolean	isSameOrOlder(java.lang.String otherVersion)
boolean	isSupportsSpacesInGradleAndJavaOpts() Early versions had bugs that prevented any values having spaces in them in GRADLE_OPTS or JAVA_OPTS.
boolean	isToolingApiDoesNotAddCausesOnTaskCancel() Returns true if this version does not occasionally add additional 'build cancelled' exceptions when tasks are cancelled.
boolean	isToolingApiHasCauseOnCancel() Returns true if this version has a useful cause attached to the exception thrown by the tooling API client on build cancel.
boolean	isToolingApiHasCauseOnForcedCancel() Returns true if this version has a useful cause attached to the exception thrown by the tooling API client when daemon is killed to force cancellation.
boolean	isToolingApiHasCauseOnPhasedActionFail() Returns true if this version retains the original exception as cause on phased action fail.
boolean	isToolingApiLocksBuildActionClasses() Returns true if the tooling API of this distribution incorrectly locks build action implementation classes.
boolean	isToolingApiLoggingInEmbeddedModeSupported() Returns true if the tooling API of this distribution correctly handles logging in embedded mode.
boolean	isToolingApiLogsConfigureSummary() Returns true if this version logs different build outcome messages for tooling API requests that run tasks and to requests that do not run tasks (eg fetch a model).
boolean	isToolingApiLogsFailureOnCancel() Returns true if this version logs a 'build failed' message on build cancellation.
boolean	isToolingApiMergesStderrIntoStdout() Returns true if this version logs errors to stdout instead of stderr.
boolean	isToolingApiRetainsOriginalFailureOnCancel() Returns true if this version retains the original build failure on cancellation (with all context) in the client and build logging, rather than discarding contextual exceptions.
boolean	isToolingApiStdinInEmbeddedModeSupported() Returns true if this version handles the client provided standard input stream when running in embedded mode.
boolean	isToolingApiSupported() Returns true if the tooling API is supported by this distribution.
boolean	isToolingApiTargetJvmSupported(org.gradle.api.JavaVersion javaVersion) Returns true if the tooling API of this distribution supports the given target JVM.
protected boolean	isVersion(java.lang.String otherVersionString)
boolean	isWrapperSupportsGradleUserHomeCommandLineOption() Returns true if the wrapper for this version honours the --gradle-user-home command-line option.
<T> T	selectOutputWithFailureLogging(T stdout, T stderr) Returns the logging output stream that this version logs build failures to when invoked via the tooling API.
java.lang.String	toString()
boolean	worksWith(org.gradle.internal.jvm.Jvm jvm) Returns true if this distribution supports the given JVM.
boolean	worksWith(org.gradle.internal.os.OperatingSystem os) Returns true if this distribution supports the given Operating system.
boolean	wrapperCanExecute(org.gradle.util.GradleVersion version) Returns true if the wrapper from this distribution can execute a build using the specified version.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultGradleDistribution

public DefaultGradleDistribution(org.gradle.util.GradleVersion gradleVersion,
                                 TestFile gradleHomeDir,
                                 TestFile binDistribution)

Method Detail

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getGradleHomeDir

public TestFile getGradleHomeDir()

Description copied from interface: GradleDistribution

Returns the root directory of the installed distribution

Specified by:

getGradleHomeDir in interface GradleDistribution

getBinDistribution

public TestFile getBinDistribution()

Description copied from interface: GradleDistribution

Returns the binary distribution.

Specified by:

getBinDistribution in interface GradleDistribution

getVersion

public org.gradle.util.GradleVersion getVersion()

Description copied from interface: GradleDistribution

Returns the version of this distribution.

Specified by:

getVersion in interface GradleDistribution

executer

public GradleExecuter executer(TestFile testDirectoryProvider)

Description copied from interface: GradleDistribution

Creates an executer which will use this distribution.

Specified by:

executer in interface GradleDistribution

worksWith

public boolean worksWith(org.gradle.internal.jvm.Jvm jvm)

Description copied from interface: GradleDistribution

Returns true if this distribution supports the given JVM.

Specified by:

worksWith in interface GradleDistribution

worksWith

public boolean worksWith(org.gradle.internal.os.OperatingSystem os)

Description copied from interface: GradleDistribution

Returns true if this distribution supports the given Operating system.

Specified by:

worksWith in interface GradleDistribution

isDaemonIdleTimeoutConfigurable

public boolean isDaemonIdleTimeoutConfigurable()

Description copied from interface: GradleDistribution

Returns true if the configuring daemon idle timeout feature is supported by this distribution.

Specified by:

isDaemonIdleTimeoutConfigurable in interface GradleDistribution

isToolingApiSupported

public boolean isToolingApiSupported()

Description copied from interface: GradleDistribution

Returns true if the tooling API is supported by this distribution.

Specified by:

isToolingApiSupported in interface GradleDistribution

isToolingApiTargetJvmSupported

public boolean isToolingApiTargetJvmSupported(org.gradle.api.JavaVersion javaVersion)

Description copied from interface: GradleDistribution

Returns true if the tooling API of this distribution supports the given target JVM.

Specified by:

isToolingApiTargetJvmSupported in interface GradleDistribution

isToolingApiLocksBuildActionClasses

public boolean isToolingApiLocksBuildActionClasses()

Description copied from interface: GradleDistribution

Returns true if the tooling API of this distribution incorrectly locks build action implementation classes.

Specified by:

isToolingApiLocksBuildActionClasses in interface GradleDistribution

isToolingApiLoggingInEmbeddedModeSupported

public boolean isToolingApiLoggingInEmbeddedModeSupported()

Description copied from interface: GradleDistribution

Returns true if the tooling API of this distribution correctly handles logging in embedded mode.

Specified by:

isToolingApiLoggingInEmbeddedModeSupported in interface GradleDistribution

isToolingApiStdinInEmbeddedModeSupported

public boolean isToolingApiStdinInEmbeddedModeSupported()

Description copied from interface: GradleDistribution

Returns true if this version handles the client provided standard input stream when running in embedded mode.

Specified by:

isToolingApiStdinInEmbeddedModeSupported in interface GradleDistribution

getArtifactCacheLayoutVersion

public org.gradle.cache.internal.CacheVersion getArtifactCacheLayoutVersion()

Description copied from interface: GradleDistribution

Returns the version of the artifact cache layout

Specified by:

getArtifactCacheLayoutVersion in interface GradleDistribution

wrapperCanExecute

public boolean wrapperCanExecute(org.gradle.util.GradleVersion version)

Description copied from interface: GradleDistribution

Returns true if the wrapper from this distribution can execute a build using the specified version.

Specified by:

wrapperCanExecute in interface GradleDistribution

isWrapperSupportsGradleUserHomeCommandLineOption

public boolean isWrapperSupportsGradleUserHomeCommandLineOption()

Description copied from interface: GradleDistribution

Returns true if the wrapper for this version honours the --gradle-user-home command-line option.

Specified by:

isWrapperSupportsGradleUserHomeCommandLineOption in interface GradleDistribution

isSupportsSpacesInGradleAndJavaOpts

public boolean isSupportsSpacesInGradleAndJavaOpts()

Description copied from interface: GradleDistribution

Early versions had bugs that prevented any values having spaces in them in GRADLE_OPTS or JAVA_OPTS. See https://issues.gradle.org/browse/GRADLE-1730

Specified by:

isSupportsSpacesInGradleAndJavaOpts in interface GradleDistribution

isFullySupportsIvyRepository

public boolean isFullySupportsIvyRepository()

Description copied from interface: GradleDistribution

The 'ivy' repository was introduced in Milestone-3, but early versions didn't work with spaces in the artifact pattern.

Specified by:

isFullySupportsIvyRepository in interface GradleDistribution

isAddsTaskExecutionExceptionAroundAllTaskFailures

public boolean isAddsTaskExecutionExceptionAroundAllTaskFailures()

Description copied from interface: GradleDistribution

Returns true if this version always adds a task execution exception around all failures, such as input fingerprinting or property validation failures, rather than only around task action failures.

Specified by:

isAddsTaskExecutionExceptionAroundAllTaskFailures in interface GradleDistribution

isToolingApiRetainsOriginalFailureOnCancel

public boolean isToolingApiRetainsOriginalFailureOnCancel()

Description copied from interface: GradleDistribution

Returns true if this version retains the original build failure on cancellation (with all context) in the client and build logging, rather than discarding contextual exceptions.

Specified by:

isToolingApiRetainsOriginalFailureOnCancel in interface GradleDistribution

isToolingApiDoesNotAddCausesOnTaskCancel

public boolean isToolingApiDoesNotAddCausesOnTaskCancel()

Description copied from interface: GradleDistribution

Returns true if this version does not occasionally add additional 'build cancelled' exceptions when tasks are cancelled.

Specified by:

isToolingApiDoesNotAddCausesOnTaskCancel in interface GradleDistribution

isToolingApiHasCauseOnCancel

public boolean isToolingApiHasCauseOnCancel()

Description copied from interface: GradleDistribution

Returns true if this version has a useful cause attached to the exception thrown by the tooling API client on build cancel.

Specified by:

isToolingApiHasCauseOnCancel in interface GradleDistribution

isToolingApiHasCauseOnForcedCancel

public boolean isToolingApiHasCauseOnForcedCancel()

Description copied from interface: GradleDistribution

Returns true if this version has a useful cause attached to the exception thrown by the tooling API client when daemon is killed to force cancellation.

Specified by:

isToolingApiHasCauseOnForcedCancel in interface GradleDistribution

isToolingApiLogsFailureOnCancel

public boolean isToolingApiLogsFailureOnCancel()

Description copied from interface: GradleDistribution

Returns true if this version logs a 'build failed' message on build cancellation.

Specified by:

isToolingApiLogsFailureOnCancel in interface GradleDistribution

isToolingApiHasCauseOnPhasedActionFail

public boolean isToolingApiHasCauseOnPhasedActionFail()

Description copied from interface: GradleDistribution

Returns true if this version retains the original exception as cause on phased action fail.

Specified by:

isToolingApiHasCauseOnPhasedActionFail in interface GradleDistribution

isToolingApiMergesStderrIntoStdout

public boolean isToolingApiMergesStderrIntoStdout()

Description copied from interface: GradleDistribution

Returns true if this version logs errors to stdout instead of stderr.

Specified by:

isToolingApiMergesStderrIntoStdout in interface GradleDistribution

isToolingApiLogsConfigureSummary

public boolean isToolingApiLogsConfigureSummary()

Description copied from interface: GradleDistribution

Returns true if this version logs different build outcome messages for tooling API requests that run tasks and to requests that do not run tasks (eg fetch a model).

Specified by:

isToolingApiLogsConfigureSummary in interface GradleDistribution

selectOutputWithFailureLogging

public <T> T selectOutputWithFailureLogging(T stdout,
                                            T stderr)

Description copied from interface: GradleDistribution

Returns the logging output stream that this version logs build failures to when invoked via the tooling API.

Specified by:

selectOutputWithFailureLogging in interface GradleDistribution

isSameOrNewer

protected boolean isSameOrNewer(java.lang.String otherVersion)

isSameOrOlder

protected boolean isSameOrOlder(java.lang.String otherVersion)

isVersion

protected boolean isVersion(java.lang.String otherVersionString)