com.facebook.buck.shell

Class ShTest

java.lang.Object

com.facebook.buck.core.rules.impl.AbstractBuildRule

com.facebook.buck.core.rules.impl.AbstractBuildRuleWithDeclaredAndExtraDeps

com.facebook.buck.core.rules.impl.NoopBuildRuleWithDeclaredAndExtraDeps

com.facebook.buck.shell.ShTest

All Implemented Interfaces:

BuildEngineAction, AllowsNonAnnotatedFields, HasDeclaredAndExtraDeps, HasRuntimeDeps, BuildRule, HasNameAndType, BinaryBuildRule, ExternalTestRunnerRule, TestRule, Comparable<BuildRule>

public class ShTest
extends NoopBuildRuleWithDeclaredAndExtraDeps
implements TestRule, HasRuntimeDeps, ExternalTestRunnerRule, BinaryBuildRule

Test whose correctness is determined by running a specified shell script. If running the shell script returns a non-zero error code, the test is considered a failure.

Nested Class Summary

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

TestRule.TestReportingCallback

Field Summary

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

NOOP_REPORTING_CALLBACK

Constructor Summary

Constructors

Modifier

Constructor and Description

protected

ShTest(BuildTarget buildTarget, ProjectFilesystem projectFilesystem, BuildRuleParams params, com.google.common.collect.ImmutableList<Arg> args, com.google.common.collect.ImmutableMap<String,Arg> env, com.google.common.collect.ImmutableSortedSet<? extends SourcePath> resources, Optional<Long> testRuleTimeoutMs, boolean runTestSeparately, Set<String> labels, Optional<String> type, com.google.common.collect.ImmutableSet<String> contacts)

Method Summary

Modifier and Type	Method and Description
protected com.google.common.collect.ImmutableList<Arg>	getArgs()
com.google.common.collect.ImmutableSet<String>	getContacts()
protected com.google.common.collect.ImmutableMap<String,Arg>	getEnv()
Tool	getExecutableCommand(OutputLabel outputLabel) Command to execute the output of this rule.
ExternalTestSpec	getExternalTestRunnerSpec(ExecutionContext executionContext, TestRunningOptions testRunningOptions, BuildContext buildContext)
com.google.common.collect.ImmutableSet<String>	getLabels()
Path	getPathToTestOutputDirectory()
java.util.stream.Stream<BuildTarget>	getRuntimeDeps(BuildRuleResolver buildRuleResolver)
Callable<TestResults>	interpretTestResults(ExecutionContext context, 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 class com.facebook.buck.core.rules.impl.NoopBuildRuleWithDeclaredAndExtraDeps

getBuildSteps, getSourcePathToOutput, hasBuildSteps, isCacheable

Methods inherited from class com.facebook.buck.core.rules.impl.AbstractBuildRuleWithDeclaredAndExtraDeps

deprecatedGetExtraDeps, getBuildDeps, getDeclaredDeps, getTargetGraphOnlyDeps

Methods inherited from class com.facebook.buck.core.rules.impl.AbstractBuildRule

equals, getBuildTarget, getDependencies, getProjectFilesystem, getSourcePathOutputs, getType, hashCode, injectFields, toString, updateBuildRuleResolver

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

onPreTest

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

Constructor Detail

ShTest

protected ShTest(BuildTarget buildTarget,
                 ProjectFilesystem projectFilesystem,
                 BuildRuleParams params,
                 com.google.common.collect.ImmutableList<Arg> args,
                 com.google.common.collect.ImmutableMap<String,Arg> env,
                 com.google.common.collect.ImmutableSortedSet<? extends SourcePath> resources,
                 Optional<Long> testRuleTimeoutMs,
                 boolean runTestSeparately,
                 Set<String> labels,
                 Optional<String> type,
                 com.google.common.collect.ImmutableSet<String> contacts)

Method Detail

getLabels

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

Specified by:

getLabels in interface TestRule

Returns:

The set of labels for this build rule.

getContacts

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

Specified by:

getContacts in interface TestRule

Returns:

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

runTests

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

Description copied from interface: TestRule

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.

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

getPathToTestOutputDirectory

public Path getPathToTestOutputDirectory()

Specified by:

getPathToTestOutputDirectory in interface TestRule

Returns:

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

interpretTestResults

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

Specified by:

interpretTestResults in interface TestRule

runTestSeparately

public boolean runTestSeparately()

Specified by:

runTestSeparately in interface TestRule

Returns:

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

getRuntimeDeps

public java.util.stream.Stream<BuildTarget> getRuntimeDeps(BuildRuleResolver buildRuleResolver)

Specified by:

getRuntimeDeps in interface HasRuntimeDeps

supportsStreamingTests

public boolean supportsStreamingTests()

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.

getExecutableCommand

public Tool getExecutableCommand(OutputLabel outputLabel)

Description copied from interface: BinaryBuildRule

Command to execute the output of this rule.

Specified by:

getExecutableCommand in interface BinaryBuildRule

Parameters:

outputLabel - associated with the executable

getExternalTestRunnerSpec

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

Specified by:

getExternalTestRunnerSpec in interface ExternalTestRunnerRule

getArgs

protected com.google.common.collect.ImmutableList<Arg> getArgs()

getEnv

protected com.google.common.collect.ImmutableMap<String,Arg> getEnv()