com.facebook.buck.core.test.rule

Interface TestRule

All Superinterfaces:

AllowsNonAnnotatedFields, BuildEngineAction, BuildRule, Comparable<BuildRule>, HasNameAndType

All Known Subinterfaces:

ExternalTestRunnerRule, TestXRule

All Known Implementing Classes:

AndroidInstrumentationTest, AppleTest, AppleTestX, CxxTest, DTest, GoTest, GoTestX, JavaTest, JavaTestX, PythonTest, PythonTestX, RobolectricTest, RobolectricTestX, RuleAnalysisLegacyTestBuildRuleView, RustTest, ShTest

public interface TestRule
extends BuildRule

A BuildRule that is designed to run tests.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	TestRule.TestReportingCallback Callbacks to invoke during the test run to report information about test cases and/or tests.

Field Summary

Fields

Modifier and Type	Field and Description
static TestRule.TestReportingCallback	NOOP_REPORTING_CALLBACK Implementation of TestRule.TestReportingCallback which does nothing.

Method Summary

Modifier and Type	Method and Description
com.google.common.collect.ImmutableSet<String>	getContacts()
com.google.common.collect.ImmutableSet<String>	getLabels()
Path	getPathToTestOutputDirectory()
Callable<TestResults>	interpretTestResults(ExecutionContext executionContext, SourcePathResolverAdapter pathResolver, boolean isUsingTestSelectors)
com.google.common.collect.ImmutableList<Step>	runTests(ExecutionContext executionContext, TestRunningOptions options, BuildContext buildContext, TestRule.TestReportingCallback testReportingCallback) Returns the commands required to run the tests.
boolean	runTestSeparately()
boolean	supportsStreamingTests()

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

NOOP_REPORTING_CALLBACK

static final TestRule.TestReportingCallback NOOP_REPORTING_CALLBACK

Implementation of TestRule.TestReportingCallback which does nothing.

Method Detail

runTests

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

Returns the commands required to run the tests.

Note: This method may be run without BuildEngine.build(com.facebook.buck.core.build.engine.BuildEngineBuildContext, ExecutionContext, BuildRule) having been run. This happens if the user has built [and ran] the test previously and then re-runs it using the --debug flag.

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

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

getLabels

com.google.common.collect.ImmutableSet<String> getLabels()

Returns:

The set of labels for this build rule.

getContacts

com.google.common.collect.ImmutableSet<String> getContacts()

Returns:

The set of email addresses to act as contact points for this test.

getPathToTestOutputDirectory

Path getPathToTestOutputDirectory()

Returns:

The relative path to the output directory of the test rule.

runTestSeparately

boolean runTestSeparately()

Returns:

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

supportsStreamingTests

boolean supportsStreamingTests()

Returns:

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