com.facebook.buck.cxx

Class CxxTest

java.lang.Object

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

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

com.facebook.buck.cxx.CxxTest

All Implemented Interfaces:

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

public abstract class CxxTest
extends AbstractBuildRuleWithDeclaredAndExtraDeps
implements TestRule, HasRuntimeDeps, BinaryBuildRule, ExternalTestRunnerRule

A no-op BuildRule which houses the logic to run and form the results for C/C++ tests.

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

Constructor and Description

CxxTest(BuildTarget buildTarget, ProjectFilesystem projectFilesystem, BuildRuleParams params, BuildRule binary, Tool executable, com.google.common.collect.ImmutableMap<String,Arg> env, com.google.common.collect.ImmutableList<Arg> args, com.google.common.collect.ImmutableSortedSet<? extends SourcePath> resources, com.google.common.collect.ImmutableSet<SourcePath> additionalCoverageTargets, java.util.function.Function<SourcePathRuleFinder,com.google.common.collect.ImmutableSortedSet<BuildRule>> additionalDepsSupplier, com.google.common.collect.ImmutableSet<String> labels, com.google.common.collect.ImmutableSet<String> contacts, boolean runTestSeparately, Optional<Long> testRuleTimeoutMs, com.facebook.buck.cxx.CxxTestType cxxTestType)

Method Summary

Modifier and Type	Method and Description
protected com.google.common.collect.ImmutableSet<SourcePath>	getAdditionalCoverageTargets()
protected com.google.common.collect.ImmutableList<Arg>	getArgs()
com.google.common.collect.ImmutableList<Step>	getBuildSteps(BuildContext context, BuildableContext buildableContext)
com.google.common.collect.ImmutableSet<String>	getContacts()
protected com.google.common.collect.ImmutableMap<String,String>	getEnv(SourcePathResolverAdapter pathResolver)
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()
protected Path	getPathToTestExitCode()
protected Path	getPathToTestOutput()
Path	getPathToTestOutputDirectory()
protected Path	getPathToTestResults()
java.util.stream.Stream<BuildTarget>	getRuntimeDeps(BuildRuleResolver buildRuleResolver)
protected abstract com.google.common.collect.ImmutableList<String>	getShellCommand(SourcePathResolverAdapter pathResolver, Path output)
SourcePath	getSourcePathToOutput()
Callable<TestResults>	interpretTestResults(ExecutionContext executionContext, SourcePathResolverAdapter pathResolver, boolean isUsingTestSelectors)
protected abstract com.google.common.collect.ImmutableList<TestResultSummary>	parseResults(Path exitCode, Path output, Path results)
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.AbstractBuildRuleWithDeclaredAndExtraDeps

deprecatedGetExtraDeps, getBuildDeps, getDeclaredDeps, getTargetGraphOnlyDeps

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

equals, getBuildTarget, getDependencies, getProjectFilesystem, getSourcePathOutputs, getType, hasBuildSteps, hashCode, injectFields, isCacheable, 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, getBuildTarget, getFullyQualifiedName, getProjectFilesystem, 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

CxxTest

public CxxTest(BuildTarget buildTarget,
               ProjectFilesystem projectFilesystem,
               BuildRuleParams params,
               BuildRule binary,
               Tool executable,
               com.google.common.collect.ImmutableMap<String,Arg> env,
               com.google.common.collect.ImmutableList<Arg> args,
               com.google.common.collect.ImmutableSortedSet<? extends SourcePath> resources,
               com.google.common.collect.ImmutableSet<SourcePath> additionalCoverageTargets,
               java.util.function.Function<SourcePathRuleFinder,com.google.common.collect.ImmutableSortedSet<BuildRule>> additionalDepsSupplier,
               com.google.common.collect.ImmutableSet<String> labels,
               com.google.common.collect.ImmutableSet<String> contacts,
               boolean runTestSeparately,
               Optional<Long> testRuleTimeoutMs,
               com.facebook.buck.cxx.CxxTestType cxxTestType)

Method Detail

getSourcePathToOutput

public SourcePath getSourcePathToOutput()

Specified by:

getSourcePathToOutput in interface BuildRule

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

getBuildSteps

public final com.google.common.collect.ImmutableList<Step> getBuildSteps(BuildContext context,
                                                                         BuildableContext buildableContext)

Specified by:

getBuildSteps in interface BuildRule

getPathToTestExitCode

protected Path getPathToTestExitCode()

Returns:

the path to which the test exit code output is written.

getPathToTestOutput

protected Path getPathToTestOutput()

Returns:

the path to which the test commands output is written.

getPathToTestResults

protected Path getPathToTestResults()

Returns:

the path to which the framework-specific test results are written.

getShellCommand

protected abstract com.google.common.collect.ImmutableList<String> getShellCommand(SourcePathResolverAdapter pathResolver,
                                                                                   Path output)

Returns:

the shell command used to run the 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

parseResults

protected abstract com.google.common.collect.ImmutableList<TestResultSummary> parseResults(Path exitCode,
                                                                                           Path output,
                                                                                           Path results)
                                                                                    throws Exception

Throws:

Exception

interpretTestResults

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

Specified by:

interpretTestResults in interface TestRule

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.

getAdditionalCoverageTargets

protected com.google.common.collect.ImmutableSet<SourcePath> getAdditionalCoverageTargets()

getPathToTestOutputDirectory

public Path getPathToTestOutputDirectory()

Specified by:

getPathToTestOutputDirectory in interface TestRule

Returns:

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

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.

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.

getRuntimeDeps

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

Specified by:

getRuntimeDeps in interface HasRuntimeDeps

getExternalTestRunnerSpec

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

Specified by:

getExternalTestRunnerSpec in interface ExternalTestRunnerRule

getEnv

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

getArgs

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