com.facebook.buck.core.test.rule

Class ExternalTestRunnerTestSpec

java.lang.Object

com.facebook.buck.core.test.rule.ExternalTestRunnerTestSpec

All Implemented Interfaces:

ExternalTestSpec, com.fasterxml.jackson.databind.JsonSerializable

public abstract class ExternalTestRunnerTestSpec
extends Object
implements ExternalTestSpec

A JSON-serializable structure that gets passed to external test runners.

NOTE: We're relying on the fact we're using POJOs here and that all the sub-types are JSON-serializable already. Be careful that we don't break serialization when adding item here.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ExternalTestRunnerTestSpec.Builder

Nested classes/interfaces inherited from interface com.fasterxml.jackson.databind.JsonSerializable

com.fasterxml.jackson.databind.JsonSerializable.Base

Constructor Summary

Constructors

Constructor and Description
ExternalTestRunnerTestSpec()

Method Summary

Modifier and Type	Method and Description
static ExternalTestRunnerTestSpec.Builder	builder()
abstract com.google.common.collect.ImmutableSet<Path>	getAdditionalCoverageTargets()
abstract com.google.common.collect.ImmutableList<String>	getCommand()
abstract com.google.common.collect.ImmutableList<String>	getContacts()
abstract Path	getCwd()
abstract com.google.common.collect.ImmutableMap<String,String>	getEnv()
abstract com.google.common.collect.ImmutableList<String>	getLabels()
abstract com.google.common.collect.ImmutableList<Pair<Float,com.google.common.collect.ImmutableSet<Path>>>	getNeededCoverage()
abstract com.google.common.collect.ImmutableSet<Path>	getRequiredPaths()
abstract BuildTarget	getTarget()
abstract String	getType()
void	serialize(com.fasterxml.jackson.core.JsonGenerator jsonGenerator, com.fasterxml.jackson.databind.SerializerProvider serializerProvider)
void	serializeWithType(com.fasterxml.jackson.core.JsonGenerator jsonGenerator, com.fasterxml.jackson.databind.SerializerProvider serializerProvider, com.fasterxml.jackson.databind.jsontype.TypeSerializer typeSerializer)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ExternalTestRunnerTestSpec

public ExternalTestRunnerTestSpec()

Method Detail

getTarget

public abstract BuildTarget getTarget()

Returns:

the build target of this rule.

getType

public abstract String getType()

Returns:

a test-specific type string which classifies the test class, so the external runner knows how to parse the output.

getCommand

public abstract com.google.common.collect.ImmutableList<String> getCommand()

Returns:

the command the external test runner must invoke to run the test.

getCwd

public abstract Path getCwd()

Returns:

the directory from which the external runner should invoke the command.

getNeededCoverage

public abstract com.google.common.collect.ImmutableList<Pair<Float,com.google.common.collect.ImmutableSet<Path>>> getNeededCoverage()

Returns:

coverage threshold and list of source path to be passed the test command for test coverage.

getAdditionalCoverageTargets

public abstract com.google.common.collect.ImmutableSet<Path> getAdditionalCoverageTargets()

Returns:

a list of source path to be passed the test command for calculating additional test coverage.

getEnv

public abstract com.google.common.collect.ImmutableMap<String,String> getEnv()

Returns:

environment variables the external test runner should provide for the test command.

getLabels

public abstract com.google.common.collect.ImmutableList<String> getLabels()

Returns:

test labels.

getContacts

public abstract com.google.common.collect.ImmutableList<String> getContacts()

Returns:

test contacts.

getRequiredPaths

public abstract com.google.common.collect.ImmutableSet<Path> getRequiredPaths()

Returns:

the set of files and directories (may include symlinks or symlink-trees) which *must* be materialized in order to run this test. This is used by external test runners that wish to distribute tests to other machines. Some examples of what my contained include: java_tests: runtime classpath, android_instrumentation_test: test_apk and apk_under_test paths, python_tests: location of python files if style=inplace

serialize

public void serialize(com.fasterxml.jackson.core.JsonGenerator jsonGenerator,
                      com.fasterxml.jackson.databind.SerializerProvider serializerProvider)
               throws IOException

Specified by:

serialize in interface ExternalTestSpec

Specified by:

serialize in interface com.fasterxml.jackson.databind.JsonSerializable

Throws:

IOException

serializeWithType

public void serializeWithType(com.fasterxml.jackson.core.JsonGenerator jsonGenerator,
                              com.fasterxml.jackson.databind.SerializerProvider serializerProvider,
                              com.fasterxml.jackson.databind.jsontype.TypeSerializer typeSerializer)
                       throws IOException

Specified by:

serializeWithType in interface ExternalTestSpec

Specified by:

serializeWithType in interface com.fasterxml.jackson.databind.JsonSerializable

Throws:

IOException

builder

public static ExternalTestRunnerTestSpec.Builder builder()