com.facebook.buck.core.rules.tool

Class RuleAnalysisLegacyTestBuildRuleView

java.lang.Object

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

com.facebook.buck.core.rules.impl.RuleAnalysisLegacyBuildRuleView

com.facebook.buck.core.rules.tool.RuleAnalysisLegacyBinaryBuildRuleView

com.facebook.buck.core.rules.tool.RuleAnalysisLegacyTestBuildRuleView

All Implemented Interfaces:

BuildEngineAction, AllowsNonAnnotatedFields, HasMultipleOutputs, SupportsInputBasedRuleKey, BuildRule, HasNameAndType, BinaryBuildRule, ExternalTestRunnerRule, TestRule, Comparable<BuildRule>

public class RuleAnalysisLegacyTestBuildRuleView
extends RuleAnalysisLegacyBinaryBuildRuleView
implements TestRule, ExternalTestRunnerRule

As RuleAnalysisLegacyBuildRuleView, but also implements TestRule so that this rule can be run by buck test

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
RuleAnalysisLegacyTestBuildRuleView(String type, BuildTarget buildTarget, Optional<Action> action, BuildRuleResolver ruleResolver, ProjectFilesystem projectFilesystem, ProviderInfoCollection providerInfoCollection) Create an instance of RuleAnalysisLegacyTestBuildRuleView

Method Summary

Modifier and Type	Method and Description
com.google.common.collect.ImmutableSet<String>	getContacts()
ExternalTestSpec	getExternalTestRunnerSpec(ExecutionContext executionContext, TestRunningOptions testRunningOptions, BuildContext buildContext)
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 class com.facebook.buck.core.rules.tool.RuleAnalysisLegacyBinaryBuildRuleView

getExecutableCommand

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

getBuildDeps, getBuildSteps, getOutputLabels, getProviderInfos, getSourcePathToOutput, getSourcePathToOutput, getType, isCacheable, updateBuildRuleResolver

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

equals, getBuildTarget, getDependencies, getProjectFilesystem, getSourcePathOutputs, hasBuildSteps, hashCode, injectFields, toString

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

Methods inherited from interface com.facebook.buck.core.rules.attr.SupportsInputBasedRuleKey

inputBasedRuleKeyIsEnabled, isSupported

Constructor Detail

RuleAnalysisLegacyTestBuildRuleView

public RuleAnalysisLegacyTestBuildRuleView(String type,
                                           BuildTarget buildTarget,
                                           Optional<Action> action,
                                           BuildRuleResolver ruleResolver,
                                           ProjectFilesystem projectFilesystem,
                                           ProviderInfoCollection providerInfoCollection)

Create an instance of RuleAnalysisLegacyTestBuildRuleView

Parameters:

type - the type of this BuildRule

buildTarget - the BuildTarget of this analysis rule

action - the action of the result for which we want to provide the BuildRule view

ruleResolver - the current BuildRuleResolver to query dependent rules

projectFilesystem - the filesystem

providerInfoCollection - the providers returned by this build target

Throws:

IllegalStateException - if providerInfoCollection does not contain an instance of both RunInfo and TestInfo

Method Detail

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

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.

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.

getExternalTestRunnerSpec

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

Specified by:

getExternalTestRunnerSpec in interface ExternalTestRunnerRule