com.facebook.buck.jvm.java

Class JavaTest

java.lang.Object

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

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

com.facebook.buck.jvm.java.JavaTest

All Implemented Interfaces:

BuildEngineAction, AllowsNonAnnotatedFields, ExportDependencies, HasDeclaredAndExtraDeps, HasPostBuildSteps, HasRuntimeDeps, BuildRule, HasNameAndType, ExternalTestRunnerRule, TestRule, HasClasspathEntries, Comparable<BuildRule>

Direct Known Subclasses:

RobolectricTest

public class JavaTest
extends AbstractBuildRuleWithDeclaredAndExtraDeps
implements TestRule, HasClasspathEntries, HasRuntimeDeps, HasPostBuildSteps, ExternalTestRunnerRule, ExportDependencies

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	JavaTest.AdditionalClasspathEntriesProvider

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

TestRule.TestReportingCallback

Field Summary

Fields

Modifier and Type	Field and Description
static Flavor	COMPILED_TESTS_LIBRARY_FLAVOR

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

NOOP_REPORTING_CALLBACK

Constructor Summary

Constructors

Constructor and Description

JavaTest(BuildTarget buildTarget, ProjectFilesystem projectFilesystem, BuildRuleParams params, JavaLibrary compiledTestsLibrary, Optional<JavaTest.AdditionalClasspathEntriesProvider> additionalClasspathEntriesProvider, Set<String> labels, Set<String> contacts, TestType testType, String targetLevel, Tool javaRuntimeLauncher, List<Arg> vmArgs, Map<String,String> nativeLibsEnvironment, Optional<Long> testRuleTimeoutMs, Optional<Long> testCaseTimeoutMs, com.google.common.collect.ImmutableMap<String,Arg> env, boolean runTestSeparately, ForkMode forkMode, Optional<Level> stdOutLogLevel, Optional<Level> stdErrLogLevel, Optional<SourcePath> unbundledResourcesRoot)

Method Summary

Modifier and Type	Method and Description
protected void	addPreTestSteps(BuildContext buildContext, com.google.common.collect.ImmutableList.Builder<Step> stepsBuilder)
ForkMode	forkMode()
protected com.google.common.collect.ImmutableSet<Path>	getBootClasspathEntries()
com.google.common.collect.ImmutableList<Step>	getBuildSteps(BuildContext context, BuildableContext buildableContext)
JavaLibrary	getCompiledTestsLibrary() Returns the underlying java library containing the compiled tests.
com.google.common.collect.ImmutableSet<String>	getContacts()
SortedSet<BuildRule>	getExportedDeps()
SortedSet<BuildRule>	getExportedProvidedDeps()
ExternalTestSpec	getExternalTestRunnerSpec(ExecutionContext executionContext, TestRunningOptions options, BuildContext buildContext)
com.google.common.collect.ImmutableSet<SourcePath>	getImmediateClasspaths() Returns the classpaths for only this rule, not its deps.
com.google.common.collect.ImmutableSet<String>	getLabels()
com.google.common.collect.ImmutableSet<SourcePath>	getOutputClasspaths()
Path	getPathToTestOutputDirectory()
com.google.common.collect.ImmutableList<Step>	getPostBuildSteps(BuildContext buildContext)
protected com.google.common.collect.ImmutableSet<Path>	getRuntimeClasspath(BuildContext buildContext)
java.util.stream.Stream<BuildTarget>	getRuntimeDeps(BuildRuleResolver buildRuleResolver)
SourcePath	getSourcePathToOutput()
com.google.common.collect.ImmutableSet<JavaLibrary>	getTransitiveClasspathDeps()
com.google.common.collect.ImmutableSet<SourcePath>	getTransitiveClasspaths()
Callable<TestResults>	interpretTestResults(ExecutionContext context, SourcePathResolverAdapter pathResolver, boolean isUsingTestSelectors)
protected void	onAmendVmArgs(com.google.common.collect.ImmutableList.Builder<String> vmArgsBuilder, SourcePathResolverAdapter pathResolver, Optional<TargetDevice> targetDevice) Override this method if you need to amend vm args.
void	onPreTest(BuildContext buildContext)
com.google.common.collect.ImmutableList<Step>	runTests(ExecutionContext executionContext, TestRunningOptions options, BuildContext buildContext, TestRule.TestReportingCallback testReportingCallback) Runs the tests specified by the "srcs" of this class.
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.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

Field Detail

COMPILED_TESTS_LIBRARY_FLAVOR

public static final Flavor COMPILED_TESTS_LIBRARY_FLAVOR

Constructor Detail

JavaTest

public JavaTest(BuildTarget buildTarget,
                ProjectFilesystem projectFilesystem,
                BuildRuleParams params,
                JavaLibrary compiledTestsLibrary,
                Optional<JavaTest.AdditionalClasspathEntriesProvider> additionalClasspathEntriesProvider,
                Set<String> labels,
                Set<String> contacts,
                TestType testType,
                String targetLevel,
                Tool javaRuntimeLauncher,
                List<Arg> vmArgs,
                Map<String,String> nativeLibsEnvironment,
                Optional<Long> testRuleTimeoutMs,
                Optional<Long> testCaseTimeoutMs,
                com.google.common.collect.ImmutableMap<String,Arg> env,
                boolean runTestSeparately,
                ForkMode forkMode,
                Optional<Level> stdOutLogLevel,
                Optional<Level> stdErrLogLevel,
                Optional<SourcePath> unbundledResourcesRoot)

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.

getBootClasspathEntries

protected com.google.common.collect.ImmutableSet<Path> getBootClasspathEntries()

getCompiledTestsLibrary

public JavaLibrary getCompiledTestsLibrary()

Returns the underlying java library containing the compiled tests.

addPreTestSteps

protected void addPreTestSteps(BuildContext buildContext,
                               com.google.common.collect.ImmutableList.Builder<Step> stepsBuilder)

runTests

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

Runs the tests specified by the "srcs" of this class. If this rule transitively depends on other java_test() rules, then they will be run separately.

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

onAmendVmArgs

protected void onAmendVmArgs(com.google.common.collect.ImmutableList.Builder<String> vmArgsBuilder,
                             SourcePathResolverAdapter pathResolver,
                             Optional<TargetDevice> targetDevice)

Override this method if you need to amend vm args. Subclasses are required to call super.onAmendVmArgs(...).

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

getBuildSteps

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

Specified by:

getBuildSteps in interface BuildRule

getSourcePathToOutput

@Nullable
public SourcePath getSourcePathToOutput()

Specified by:

getSourcePathToOutput in interface BuildRule

getTransitiveClasspaths

public com.google.common.collect.ImmutableSet<SourcePath> getTransitiveClasspaths()

Specified by:

getTransitiveClasspaths in interface HasClasspathEntries

Returns:

Classpath entries for this rule and its dependencies. e.g. If the rule represents a java library, then these entries will be passed to javac's -classpath flag in order to build a jar associated with this rule.

getTransitiveClasspathDeps

public com.google.common.collect.ImmutableSet<JavaLibrary> getTransitiveClasspathDeps()

Specified by:

getTransitiveClasspathDeps in interface HasClasspathEntries

Returns:

A set of rules contributing classpath entries for this rule and its dependencies.

getImmediateClasspaths

public com.google.common.collect.ImmutableSet<SourcePath> getImmediateClasspaths()

Description copied from interface: HasClasspathEntries

Returns the classpaths for only this rule, not its deps.

Used to generate the value of HasClasspathEntries.getTransitiveClasspaths().

Specified by:

getImmediateClasspaths in interface HasClasspathEntries

getOutputClasspaths

public com.google.common.collect.ImmutableSet<SourcePath> getOutputClasspaths()

Specified by:

getOutputClasspaths in interface HasClasspathEntries

Returns:

Classpath entries that this rule will contribute when it is used as a dependency. e.g. If the rule represents a java library, then these entries must be passed to javac's -classpath flag in order to compile rules that depend on this rule. This is a superset of getImmediateClasspaths which also contains the classpath entries of any exported deps.

getExportedDeps

public SortedSet<BuildRule> getExportedDeps()

Specified by:

getExportedDeps in interface ExportDependencies

getExportedProvidedDeps

public SortedSet<BuildRule> getExportedProvidedDeps()

Specified by:

getExportedProvidedDeps in interface ExportDependencies

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.

forkMode

public ForkMode forkMode()

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.

getExternalTestRunnerSpec

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

Specified by:

getExternalTestRunnerSpec in interface ExternalTestRunnerRule

onPreTest

public void onPreTest(BuildContext buildContext)
               throws IOException

Specified by:

onPreTest in interface ExternalTestRunnerRule

Throws:

IOException

getPostBuildSteps

public com.google.common.collect.ImmutableList<Step> getPostBuildSteps(BuildContext buildContext)

Specified by:

getPostBuildSteps in interface HasPostBuildSteps

Returns:

a list of Steps that run after the build regardless of whether this build rule actually ran or hit in the cache.

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