com.facebook.buck.jvm.java

Class JavaTestX

java.lang.Object

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

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

com.facebook.buck.jvm.java.JavaTestX

All Implemented Interfaces:

BuildEngineAction, AllowsNonAnnotatedFields, ExportDependencies, HasDeclaredAndExtraDeps, HasRuntimeDeps, HasSupplementaryOutputs, BuildRule, HasNameAndType, ExternalTestRunnerRule, TestRule, TestXRule, Comparable<BuildRule>

Direct Known Subclasses:

RobolectricTestX

public class JavaTestX
extends AbstractBuildRuleWithDeclaredAndExtraDeps
implements TestXRule, HasRuntimeDeps, ExternalTestRunnerRule, ExportDependencies

The new Java Test rule that uses the test protocol to run.

It cannot be run via buck's internal runners

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.TestXRule

TEST_BINARY_OUTPUT

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

NOOP_REPORTING_CALLBACK

Constructor Summary

Constructors

Constructor and Description
JavaTestX(BuildTarget buildTarget, ProjectFilesystem projectFilesystem, BuildRuleParams params, JavaBinary compiledTestsBinary, JavaLibrary compiledTestsLibrary, Set<String> labels, Set<String> contacts, CoercedTestRunnerSpec specs, List<Arg> vmArg)

Method Summary

Modifier and Type	Method and Description
com.google.common.collect.ImmutableList<Step>	getBuildSteps(BuildContext buildContext, BuildableContext buildableContext)
com.google.common.collect.ImmutableSet<String>	getContacts()
SortedSet<BuildRule>	getExportedDeps()
SortedSet<BuildRule>	getExportedProvidedDeps()
protected com.google.common.collect.ImmutableList<String>	getJvmArgs(SourcePathResolverAdapter sourcePathResolverAdapter)
com.google.common.collect.ImmutableSet<String>	getLabels()
Path	getPathToTestOutputDirectory()
protected com.google.common.collect.ImmutableSet<Path>	getRuntimeClasspath(BuildContext buildContext)
java.util.stream.Stream<BuildTarget>	getRuntimeDeps(BuildRuleResolver buildRuleResolver)
SourcePath	getSourcePathToOutput()
SourcePath	getSourcePathToSupplementaryOutput(String name) Returns a SourcePath to a named supplementary output, or null if it does not exist.
CoercedTestRunnerSpec	getSpecs()

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.TestXRule

getExternalTestRunnerSpec, interpretTestResults, onPreTest, runTests, runTestSeparately, shouldNotBeCalled, supportsStreamingTests

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

JavaTestX

public JavaTestX(BuildTarget buildTarget,
                 ProjectFilesystem projectFilesystem,
                 BuildRuleParams params,
                 JavaBinary compiledTestsBinary,
                 JavaLibrary compiledTestsLibrary,
                 Set<String> labels,
                 Set<String> contacts,
                 CoercedTestRunnerSpec specs,
                 List<Arg> vmArg)

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.

getPathToTestOutputDirectory

public Path getPathToTestOutputDirectory()

Specified by:

getPathToTestOutputDirectory in interface TestRule

Returns:

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

getBuildSteps

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

Specified by:

getBuildSteps in interface BuildRule

getExportedDeps

public SortedSet<BuildRule> getExportedDeps()

Specified by:

getExportedDeps in interface ExportDependencies

getExportedProvidedDeps

public SortedSet<BuildRule> getExportedProvidedDeps()

Specified by:

getExportedProvidedDeps in interface ExportDependencies

getSourcePathToOutput

@Nullable
public SourcePath getSourcePathToOutput()

Specified by:

getSourcePathToOutput in interface BuildRule

getRuntimeDeps

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

Specified by:

getRuntimeDeps in interface HasRuntimeDeps

getRuntimeClasspath

protected com.google.common.collect.ImmutableSet<Path> getRuntimeClasspath(BuildContext buildContext)

Returns:

a set of paths to the files which must be passed as the classpath to the java process when this test is executed

getJvmArgs

protected com.google.common.collect.ImmutableList<String> getJvmArgs(SourcePathResolverAdapter sourcePathResolverAdapter)

Returns:

a list of JVM args that should be passed to JVM to run the command properly

getSpecs

public CoercedTestRunnerSpec getSpecs()

Specified by:

getSpecs in interface TestXRule

Returns:

the specs from the test protocol defined in BUCK files

getSourcePathToSupplementaryOutput

@Nullable
public 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

Specified by:

getSourcePathToSupplementaryOutput in interface TestXRule