ProtocTestCompilePythonMojo

java.lang.Object
- org.apache.maven.plugin.AbstractMojo
- - org.xolstice.maven.plugin.protobuf.AbstractProtocMojo
  - - org.xolstice.maven.plugin.protobuf.AbstractProtocTestCompileMojo
    - - org.xolstice.maven.plugin.protobuf.ProtocTestCompilePythonMojo

All Implemented Interfaces:

org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo
```
@Mojo(name="test-compile-python",
      defaultPhase=GENERATE_TEST_SOURCES,
      requiresDependencyResolution=TEST,
      threadSafe=true)
public final class ProtocTestCompilePythonMojo
extends AbstractProtocTestCompileMojo
```
This mojo executes the protoc compiler for generating test python sources from protocol buffer definitions. It also searches dependency artifacts in the test scope for .proto files and includes them in the proto_path so that they can be referenced. Finally, it adds the .proto files to the project as test resources so that they can be included in the test-jar artifact.

Since:

0.3.3

Field Summary

Fields
Modifier and Type Field Description

private java.io.File outputDirectory
This is the directory into which the .py test sources will be created.
- Fields inherited from class org.xolstice.maven.plugin.protobuf.AbstractProtocTestCompileMojo
  descriptorSetClassifier
- Fields inherited from class org.xolstice.maven.plugin.protobuf.AbstractProtocMojo
  attachDescriptorSet, attachProtoSources, buildContext, descriptorSetFileName, includeDependenciesInDescriptorSet, includeSourceInfoInDescriptorSet, project, projectHelper, session, toolchainManager, useArgumentFile, writeDescriptorSet
- Fields inherited from interface org.apache.maven.plugin.Mojo
  ROLE

Constructor Summary

Constructors
Constructor Description

ProtocTestCompilePythonMojo()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`protected void`	`addProtocBuilderParameters(Protoc.Builder protocBuilder)`	Adds mojo-specific parameters to the protoc builder.
`protected java.io.File`	`getOutputDirectory()`	Returns the output directory for generated sources.

Methods inherited from class org.xolstice.maven.plugin.protobuf.AbstractProtocTestCompileMojo
doAttachGeneratedFiles, doAttachProtoSources, getDependencyArtifacts, getDescriptorSetOutputDirectory, getProtoSourceRoot

Methods inherited from class org.xolstice.maven.plugin.protobuf.AbstractProtocMojo
checkFilesUpToDate, checkParameters, createDependencyArtifact, createDependencyArtifact, createProtocPlugins, detectJavaHome, doAttachFiles, execute, findGeneratedFilesInDirectory, findProtoFilesInDirectories, findProtoFilesInDirectory, getDependencyArtifactFiles, getExcludes, getIncludes, hasDelta, lastModified, makeProtoPathFromJars, resolveBinaryArtifact, skipMojo, toHexString, truncatePath

Methods inherited from class org.apache.maven.plugin.AbstractMojo
getLog, getPluginContext, setLog, setPluginContext

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - outputDirectory
```
@Parameter(required=true,
           property="pythonTestOutputDirectory",
           defaultValue="${project.build.directory}/generated-test-sources/protobuf/python")
private java.io.File outputDirectory
```
    This is the directory into which the .py test sources will be created.
- Constructor Detail
  - ProtocTestCompilePythonMojo
```
public ProtocTestCompilePythonMojo()
```
- Method Detail
  - addProtocBuilderParameters
```
protected void addProtocBuilderParameters(Protoc.Builder protocBuilder)
```
    Description copied from class: AbstractProtocMojo
    
    Adds mojo-specific parameters to the protoc builder.
    
    Overrides:
    
    addProtocBuilderParameters in class AbstractProtocMojo
    
    Parameters:
    
    protocBuilder - the builder to be modified.
  - getOutputDirectory
```
protected java.io.File getOutputDirectory()
```
    Description copied from class: AbstractProtocMojo
    
    Returns the output directory for generated sources. Depends on build phase so must be defined in concrete implementation.
    
    Specified by:
    
    getOutputDirectory in class AbstractProtocMojo
    
    Returns:
    
    output directory for generated sources.