com.facebook.buck.core.test.rule

Interface TestXRule

All Superinterfaces:

AllowsNonAnnotatedFields, BuildEngineAction, BuildRule, Comparable<BuildRule>, ExternalTestRunnerRule, HasNameAndType, HasSupplementaryOutputs, TestRule

All Known Implementing Classes:

AppleTestX, GoTestX, JavaTestX, PythonTestX, RobolectricTestX

public interface TestXRule
extends TestRule, ExternalTestRunnerRule, HasSupplementaryOutputs

Marks a rule as implementing the test protocol

Nested Class Summary

Nested classes/interfaces inherited from interface com.facebook.buck.core.test.rule.TestRule

TestRule.TestReportingCallback

Field Summary

Fields

Modifier and Type	Field and Description
static String	TEST_BINARY_OUTPUT The named output for test rules that maps to the location of where Buck materializes the final test binary.

Fields inherited from interface com.facebook.buck.core.test.rule.TestRule

NOOP_REPORTING_CALLBACK

Method Summary

Modifier and Type	Method and Description
default ExternalTestSpec	getExternalTestRunnerSpec(ExecutionContext executionContext, TestRunningOptions testRunningOptions, BuildContext buildContext) This shouldn't be overriden as the default implementation is sufficient.
default SourcePath	getSourcePathToSupplementaryOutput(String name) Returns a SourcePath to a named supplementary output, or null if it does not exist.
CoercedTestRunnerSpec	getSpecs()
default Callable<TestResults>	interpretTestResults(ExecutionContext executionContext, SourcePathResolverAdapter pathResolver, boolean isUsingTestSelectors) Deprecated.
default void	onPreTest(BuildContext buildContext) Deprecated.
default com.google.common.collect.ImmutableList<Step>	runTests(ExecutionContext executionContext, TestRunningOptions options, BuildContext buildContext, TestRule.TestReportingCallback testReportingCallback) Deprecated.
default boolean	runTestSeparately() Deprecated.
default IllegalStateException	shouldNotBeCalled()
default boolean	supportsStreamingTests() Deprecated.

Methods inherited from interface com.facebook.buck.core.test.rule.TestRule

getContacts, getLabels, getPathToTestOutputDirectory

Methods inherited from interface com.facebook.buck.core.rules.BuildRule

compareTo, getBuildDeps, getBuildSteps, getBuildTarget, getFullyQualifiedName, getProjectFilesystem, getSourcePathToOutput, hasBuildSteps, isCacheable, outputFileCanBeCopied, shouldRespectInputSizeLimitForRemoteExecution, toString, updateBuildRuleResolver

Methods inherited from interface com.facebook.buck.core.build.action.BuildEngineAction

getDependencies, getSourcePathOutputs

Methods inherited from interface com.facebook.buck.core.rules.HasNameAndType

getType

Field Detail

TEST_BINARY_OUTPUT

static final String TEST_BINARY_OUTPUT

The named output for test rules that maps to the location of where Buck materializes the final test binary.

See Also:

Constant Field Values

Method Detail

shouldNotBeCalled

default IllegalStateException shouldNotBeCalled()

getSpecs

CoercedTestRunnerSpec getSpecs()

Returns:

the specs from the test protocol defined in BUCK files

runTests

@Deprecated
default com.google.common.collect.ImmutableList<Step> runTests(ExecutionContext executionContext,
                                                                           TestRunningOptions options,
                                                                           BuildContext buildContext,
                                                                           TestRule.TestReportingCallback testReportingCallback)

Deprecated.

tests are no longer ran by Buck, so test protocol rules should not have this.

Specified by:

runTests in interface TestRule

Parameters:

executionContext - Provides context for creating Steps.

options - The runtime testing options.

buildContext - A SourcePathResolverAdapter from the build.

Returns:

the commands required to run the tests

interpretTestResults

@Deprecated
default Callable<TestResults> interpretTestResults(ExecutionContext executionContext,
                                                               SourcePathResolverAdapter pathResolver,
                                                               boolean isUsingTestSelectors)

Deprecated.

tests are no longer ran by Buck, and hence we don't need to interpret the test results

Specified by:

interpretTestResults in interface TestRule

runTestSeparately

@Deprecated
default boolean runTestSeparately()

Deprecated.

tests are not ran by Buck. This attribute should be on the test specs for the test runner to interpret

Specified by:

runTestSeparately in interface TestRule

Returns:

true if the test should run by itself when no other tests are run, false otherwise.

supportsStreamingTests

@Deprecated
default boolean supportsStreamingTests()

Deprecated.

tests are not ran by Buck. This attribute should be on the test specs for the test runner to interpret

Specified by:

supportsStreamingTests in interface TestRule

Returns:

true if calling runTests() on this rule invokes the callbacks in testReportingCallback as the tests run, false otherwise.

getExternalTestRunnerSpec

default ExternalTestSpec getExternalTestRunnerSpec(ExecutionContext executionContext,
                                                   TestRunningOptions testRunningOptions,
                                                   BuildContext buildContext)

This shouldn't be overriden as the default implementation is sufficient. Unfortunately it's not trivial to convert this to an Abstract class and make this final because rules also extend a variety of AbstractBuildRule classes and multiple inheritance is not available in Java.

Specified by:

getExternalTestRunnerSpec in interface ExternalTestRunnerRule

Returns:

the test protocol specs.

onPreTest

@Deprecated
default void onPreTest(BuildContext buildContext)

Deprecated.

since Buck doesn't actually run the test, pre test steps make no sense.

Specified by:

onPreTest in interface ExternalTestRunnerRule

getSourcePathToSupplementaryOutput

@Nullable
default SourcePath getSourcePathToSupplementaryOutput(String name)

Description copied from interface: HasSupplementaryOutputs

Returns a SourcePath to a named supplementary output, or null if it does not exist.

Specified by:

getSourcePathToSupplementaryOutput in interface HasSupplementaryOutputs