com.facebook.buck.android

Class AndroidInstrumentationTest

java.lang.Object

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

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

com.facebook.buck.android.AndroidInstrumentationTest

All Implemented Interfaces:

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

public class AndroidInstrumentationTest
extends AbstractBuildRuleWithDeclaredAndExtraDeps
implements ExternalTestRunnerRule, HasRuntimeDeps, TestRule

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	AndroidInstrumentationTest(BuildTarget buildTarget, ProjectFilesystem projectFilesystem, AndroidPlatformTarget androidPlatformTarget, BuildRuleParams params, HasInstallableApk apk, Set<String> labels, Set<String> contacts, Tool javaRuntimeLauncher, Optional<Long> testRuleTimeoutMs, PackagedResource ddmlibJar, PackagedResource kxml2Jar, PackagedResource guavaJar, PackagedResource toolsCommonJar)

Method Summary

Modifier and Type	Method and Description
HasInstallableApk	getApk()
com.google.common.collect.ImmutableList<Step>	getBuildSteps(BuildContext context, BuildableContext buildableContext)
com.google.common.collect.ImmutableSet<String>	getContacts()
ExternalTestSpec	getExternalTestRunnerSpec(ExecutionContext executionContext, TestRunningOptions testRunningOptions, BuildContext buildContext)
com.google.common.collect.ImmutableSet<String>	getLabels()
Path	getPathToTestOutputDirectory()
protected static com.google.common.collect.ImmutableList<Path>	getRequiredPaths(HasInstallableApk apkInstance, Optional<Path> instrumentationApkPath, Optional<Path> apkUnderTestPath)
java.util.stream.Stream<BuildTarget>	getRuntimeDeps(BuildRuleResolver buildRuleResolver)
SourcePath	getSourcePathToOutput()
Callable<TestResults>	interpretTestResults(ExecutionContext context, SourcePathResolverAdapter pathResolver, boolean isUsingTestSelectors)
void	onPreTest(BuildContext buildContext) Called in order to perform setup for external tests.
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.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

AndroidInstrumentationTest

protected AndroidInstrumentationTest(BuildTarget buildTarget,
                                     ProjectFilesystem projectFilesystem,
                                     AndroidPlatformTarget androidPlatformTarget,
                                     BuildRuleParams params,
                                     HasInstallableApk apk,
                                     Set<String> labels,
                                     Set<String> contacts,
                                     Tool javaRuntimeLauncher,
                                     Optional<Long> testRuleTimeoutMs,
                                     PackagedResource ddmlibJar,
                                     PackagedResource kxml2Jar,
                                     PackagedResource guavaJar,
                                     PackagedResource toolsCommonJar)

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.

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.

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

getSourcePathToOutput

public SourcePath getSourcePathToOutput()

Specified by:

getSourcePathToOutput in interface BuildRule

getBuildSteps

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

Specified by:

getBuildSteps in interface BuildRule

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.

onPreTest

public void onPreTest(BuildContext buildContext)

Called in order to perform setup for external tests. We use this opportunity to lay down a symlink tree for the exopackage directory.

Specified by:

onPreTest in interface ExternalTestRunnerRule

getExternalTestRunnerSpec

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

Specified by:

getExternalTestRunnerSpec in interface ExternalTestRunnerRule

getRequiredPaths

protected static com.google.common.collect.ImmutableList<Path> getRequiredPaths(HasInstallableApk apkInstance,
                                                                                Optional<Path> instrumentationApkPath,
                                                                                Optional<Path> apkUnderTestPath)

Returns:

a list of paths which must be materialized on disk before an external testrunner can execute the test.

getRuntimeDeps

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

Specified by:

getRuntimeDeps in interface HasRuntimeDeps

getApk

public HasInstallableApk getApk()

Returns:

the test apk