com.facebook.buck.features.python

Class PythonTestDescription

java.lang.Object

com.facebook.buck.features.python.PythonTestDescription

All Implemented Interfaces:

ImplicitDepsInferringDescription<com.facebook.buck.features.python.PythonTestDescription.AbstractPythonTestDescriptionArg>, BaseDescription<PythonTestDescriptionArg>, Description<PythonTestDescriptionArg>, DescriptionWithTargetGraph<PythonTestDescriptionArg>, VersionRoot<PythonTestDescriptionArg>

public class PythonTestDescription
extends Object
implements DescriptionWithTargetGraph<PythonTestDescriptionArg>, ImplicitDepsInferringDescription<com.facebook.buck.features.python.PythonTestDescription.AbstractPythonTestDescriptionArg>, VersionRoot<PythonTestDescriptionArg>

Field Summary

Fields

Modifier and Type	Field and Description
static Flavor	BINARY_FLAVOR

Constructor Summary

Constructors

Constructor and Description
PythonTestDescription(ToolchainProvider toolchainProvider, PythonBinaryDescription binaryDescription, PythonBuckConfig pythonBuckConfig, CxxBuckConfig cxxBuckConfig)

Method Summary

Modifier and Type	Method and Description
BuildRule	createBuildRule(BuildRuleCreationContextWithTargetGraph context, BuildTarget buildTarget, BuildRuleParams params, PythonTestDescriptionArg args) Create a BuildRule for the given BuildRuleParams.
void	findDepsForTargetFromConstructorArgs(BuildTarget buildTarget, CellNameResolver cellRoots, com.facebook.buck.features.python.PythonTestDescription.AbstractPythonTestDescriptionArg constructorArg, com.google.common.collect.ImmutableCollection.Builder<BuildTarget> extraDepsBuilder, com.google.common.collect.ImmutableCollection.Builder<BuildTarget> targetGraphOnlyDepsBuilder)
Class<PythonTestDescriptionArg>	getConstructorArgType() The type of the constructor argument that is used by this description to create a rule
protected static Path	getTestMainPath(SourcePathResolverAdapter resolver, Optional<PythonTestRunner> testRunner)
protected static Path	getTestModulesListName()
protected static Path	getTestModulesListPath(BuildTarget buildTarget, ProjectFilesystem filesystem)
boolean	producesCacheableSubgraph() Whether or not the build rule subgraph produced by this Description is safe to cache in IncrementalActionGraphGenerator for incremental action graph generation.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.facebook.buck.versions.VersionRoot

isVersionRoot

Methods inherited from interface com.facebook.buck.core.description.BaseDescription

getConfigurationDeps

Field Detail

BINARY_FLAVOR

public static final Flavor BINARY_FLAVOR

Constructor Detail

PythonTestDescription

public PythonTestDescription(ToolchainProvider toolchainProvider,
                             PythonBinaryDescription binaryDescription,
                             PythonBuckConfig pythonBuckConfig,
                             CxxBuckConfig cxxBuckConfig)

Method Detail

getConstructorArgType

public Class<PythonTestDescriptionArg> getConstructorArgType()

Description copied from interface: BaseDescription

The type of the constructor argument that is used by this description to create a rule

Specified by:

getConstructorArgType in interface BaseDescription<PythonTestDescriptionArg>

getTestMainPath

protected static Path getTestMainPath(SourcePathResolverAdapter resolver,
                                      Optional<PythonTestRunner> testRunner)

getTestModulesListName

protected static Path getTestModulesListName()

getTestModulesListPath

protected static Path getTestModulesListPath(BuildTarget buildTarget,
                                             ProjectFilesystem filesystem)

createBuildRule

public BuildRule createBuildRule(BuildRuleCreationContextWithTargetGraph context,
                                 BuildTarget buildTarget,
                                 BuildRuleParams params,
                                 PythonTestDescriptionArg args)

Description copied from interface: DescriptionWithTargetGraph

Create a BuildRule for the given BuildRuleParams. Note that the BuildTarget referred to in the params contains the Flavor to create.

Specified by:

createBuildRule in interface DescriptionWithTargetGraph<PythonTestDescriptionArg>

args - A constructor argument, of type as returned by BaseDescription.getConstructorArgType().

Returns:

The BuildRule that describes the default flavour of the rule being described.

findDepsForTargetFromConstructorArgs

public void findDepsForTargetFromConstructorArgs(BuildTarget buildTarget,
                                                 CellNameResolver cellRoots,
                                                 com.facebook.buck.features.python.PythonTestDescription.AbstractPythonTestDescriptionArg constructorArg,
                                                 com.google.common.collect.ImmutableCollection.Builder<BuildTarget> extraDepsBuilder,
                                                 com.google.common.collect.ImmutableCollection.Builder<BuildTarget> targetGraphOnlyDepsBuilder)

Specified by:

findDepsForTargetFromConstructorArgs in interface ImplicitDepsInferringDescription<com.facebook.buck.features.python.PythonTestDescription.AbstractPythonTestDescriptionArg>

producesCacheableSubgraph

public boolean producesCacheableSubgraph()

Description copied from interface: DescriptionWithTargetGraph

Whether or not the build rule subgraph produced by this Description is safe to cache in IncrementalActionGraphGenerator for incremental action graph generation.

Specified by:

producesCacheableSubgraph in interface Description<PythonTestDescriptionArg>

Specified by:

producesCacheableSubgraph in interface DescriptionWithTargetGraph<PythonTestDescriptionArg>