org.realityforge.proton.qa

Class AbstractProcessorTest

java.lang.Object

org.realityforge.proton.qa.AbstractProcessorTest

public abstract class AbstractProcessorTest
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
AbstractProcessorTest()

Method Summary

Modifier and Type	Method and Description
protected javax.annotation.processing.Processor[]	additionalProcessors()
protected void	assertCompilationSuccessful(com.google.testing.compile.Compilation compilation) Verify the supplied Compilation was successful.
protected void	assertCompilationUnsuccessful(com.google.testing.compile.Compilation compilation) Verify the supplied Compilation was a failure.
protected com.google.testing.compile.CompileTester	assertCompiles(java.util.List<javax.tools.JavaFileObject> inputs)
protected com.google.testing.compile.CompileTester.SuccessfulCompilationClause	assertCompilesWithoutErrors(java.util.List<javax.tools.JavaFileObject> inputs)
protected com.google.testing.compile.CompileTester.SuccessfulCompilationClause	assertCompilesWithoutErrors(java.lang.String classname)
protected com.google.testing.compile.CompileTester.CleanCompilationClause	assertCompilesWithoutWarnings(java.util.List<javax.tools.JavaFileObject> inputs)
protected com.google.testing.compile.CompileTester.CleanCompilationClause	assertCompilesWithoutWarnings(java.lang.String classname)
protected void	assertCompilesWithSingleWarning(java.lang.String classname, java.lang.String messageFragment)
protected void	assertDiagnostic(com.google.testing.compile.Compilation compilation, javax.tools.Diagnostic.Kind kind, java.lang.String message)
protected void	assertDiagnosticPresent(com.google.testing.compile.Compilation compilation, java.lang.String message) Deprecated. Use assertDiagnostic instead.
protected void	assertErrorDiagnostic(com.google.testing.compile.Compilation compilation, java.lang.String message)
protected void	assertFailedCompile(java.lang.String classname, java.lang.String errorMessageFragment)
protected void	assertFailedCompileResource(java.util.List<javax.tools.JavaFileObject> inputs, java.lang.String errorMessageFragment)
protected void	assertFailedCompileResource(java.lang.String inputResource, java.lang.String errorMessageFragment)
protected void	assertSuccessfulCompile(java.util.List<javax.tools.JavaFileObject> inputs, java.util.List<java.lang.String> outputs)
protected void	assertSuccessfulCompile(java.util.List<javax.tools.JavaFileObject> inputs, java.util.List<java.lang.String> outputs, java.util.function.Predicate<javax.tools.JavaFileObject> filter)
protected void	assertSuccessfulCompile(java.lang.String classname, java.lang.String... expectedOutputResources)
protected void	assertWarningDiagnostic(com.google.testing.compile.Compilation compilation, java.lang.String message)
protected com.google.common.collect.ImmutableList<java.io.File>	buildClasspath(java.io.File... paths) Build a classpath including the paths specified as well as the current classpath.
protected com.google.testing.compile.Compiler	compiler()
protected java.lang.String	describeFailureDiagnostics(com.google.testing.compile.Compilation compilation) Returns a description of the why the compilation failed.
protected boolean	emitGeneratedFile(javax.tools.JavaFileObject target)
protected javax.tools.JavaFileObject	fixture(java.lang.String filename)
protected java.nio.file.Path	fixtureDir()
protected java.lang.String	getFixtureKeyPart()
protected abstract java.lang.String	getOptionPrefix()
protected java.util.List<java.lang.String>	getOptions()
protected javax.tools.JavaFileObject	input(java.lang.String dir, java.lang.String classname)
protected java.util.List<javax.tools.JavaFileObject>	inputs(java.lang.String... classnames)
protected javax.annotation.processing.Processor	newSynthesizingProcessor(java.lang.String classname, int targetRound)
protected javax.annotation.processing.Processor	newSynthesizingProcessor(java.lang.String dir, java.lang.String classname, int targetRound)
protected void	outputFile(javax.tools.JavaFileObject fileObject, java.nio.file.Path targetDir) Output the specified JavaFileObject to target direct.
protected boolean	outputFiles()
protected void	outputFiles(java.util.Collection<javax.tools.JavaFileObject> fileObjects, java.nio.file.Path targetDir)
protected void	outputFiles(java.util.Collection<javax.tools.JavaFileObject> fileObjects, java.nio.file.Path targetDir, java.util.function.Predicate<javax.tools.JavaFileObject> filter)
protected void	outputFilesIfEnabled(java.util.List<javax.tools.JavaFileObject> inputs, java.util.function.Predicate<javax.tools.JavaFileObject> filter) Compile the inputs and output files that match filter if outputFiles() returns true.
protected abstract javax.annotation.processing.Processor	processor()
protected java.util.List<javax.annotation.processing.Processor>	processors()
protected java.lang.String	toFilename(java.lang.String dir, java.lang.String classname)
protected java.lang.String	toFilename(java.lang.String dir, java.lang.String classname, java.lang.String prefix, java.lang.String postfix)

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractProcessorTest

public AbstractProcessorTest()

Method Detail

getOptionPrefix

@Nonnull
protected abstract java.lang.String getOptionPrefix()

processor

@Nonnull
protected abstract javax.annotation.processing.Processor processor()

getOptions

@Nonnull
protected java.util.List<java.lang.String> getOptions()

additionalProcessors

@Nonnull
protected javax.annotation.processing.Processor[] additionalProcessors()

getFixtureKeyPart

@Nonnull
protected java.lang.String getFixtureKeyPart()

emitGeneratedFile

protected boolean emitGeneratedFile(@Nonnull
                                    javax.tools.JavaFileObject target)

assertSuccessfulCompile

protected final void assertSuccessfulCompile(@Nonnull
                                             java.lang.String classname,
                                             @Nonnull
                                             java.lang.String... expectedOutputResources)
                                      throws java.lang.Exception

Throws:

java.lang.Exception

assertSuccessfulCompile

protected final void assertSuccessfulCompile(@Nonnull
                                             java.util.List<javax.tools.JavaFileObject> inputs,
                                             @Nonnull
                                             java.util.List<java.lang.String> outputs)
                                      throws java.lang.Exception

Throws:

java.lang.Exception

assertSuccessfulCompile

protected final void assertSuccessfulCompile(@Nonnull
                                             java.util.List<javax.tools.JavaFileObject> inputs,
                                             @Nonnull
                                             java.util.List<java.lang.String> outputs,
                                             @Nonnull
                                             java.util.function.Predicate<javax.tools.JavaFileObject> filter)
                                      throws java.lang.Exception

Throws:

java.lang.Exception

outputFilesIfEnabled

protected final void outputFilesIfEnabled(@Nonnull
                                          java.util.List<javax.tools.JavaFileObject> inputs,
                                          @Nonnull
                                          java.util.function.Predicate<javax.tools.JavaFileObject> filter)
                                   throws java.lang.Exception

Compile the inputs and output files that match filter if outputFiles() returns true. This is primarily used when updating golden files.

Parameters:

inputs - the input files.

filter - the file filter.

Throws:

java.lang.Exception - if an error occurs.

processors

@Nonnull
protected final java.util.List<javax.annotation.processing.Processor> processors()

compiler

@Nonnull
protected final com.google.testing.compile.Compiler compiler()

assertCompilationSuccessful

protected final void assertCompilationSuccessful(@Nonnull
                                                 com.google.testing.compile.Compilation compilation)

Verify the supplied Compilation was successful.

Parameters:

compilation - the compilation to verify.

assertCompilationUnsuccessful

protected final void assertCompilationUnsuccessful(@Nonnull
                                                   com.google.testing.compile.Compilation compilation)

Verify the supplied Compilation was a failure.

Parameters:

compilation - the compilation to verify.

describeFailureDiagnostics

@Nonnull
protected final java.lang.String describeFailureDiagnostics(@Nonnull
                                                                     com.google.testing.compile.Compilation compilation)

Returns a description of the why the compilation failed.

buildClasspath

@Nonnull
protected final com.google.common.collect.ImmutableList<java.io.File> buildClasspath(@Nonnull
                                                                                              java.io.File... paths)

Build a classpath including the paths specified as well as the current classpath. The current classpath is discovered by inspecting the current classloader, assuming it is a URLClassLoader and walking back to the system classloader adding paths as required.

Parameters:

paths - the additional user supplied paths to add to classpath.

Returns:

an list of directories that define the created classpath.

outputFiles

protected final void outputFiles(@Nonnull
                                 java.util.Collection<javax.tools.JavaFileObject> fileObjects,
                                 @Nonnull
                                 java.nio.file.Path targetDir)
                          throws java.io.IOException

Throws:

java.io.IOException

outputFiles

protected final void outputFiles(@Nonnull
                                 java.util.Collection<javax.tools.JavaFileObject> fileObjects,
                                 @Nonnull
                                 java.nio.file.Path targetDir,
                                 @Nonnull
                                 java.util.function.Predicate<javax.tools.JavaFileObject> filter)
                          throws java.io.IOException

Throws:

java.io.IOException

outputFile

protected final void outputFile(@Nonnull
                                javax.tools.JavaFileObject fileObject,
                                @Nonnull
                                java.nio.file.Path targetDir)
                         throws java.io.IOException

Output the specified JavaFileObject to target direct. The path relative to SOURCE_OUTPUT and CLASS_OUTPUT is included when emitting the file.

Parameters:

fileObject - the object to emit.

targetDir - the target directory

Throws:

java.io.IOException - if an error occurs writing the file or creating the directory.

assertCompiles

@Nonnull
protected final com.google.testing.compile.CompileTester assertCompiles(@Nonnull
                                                                                 java.util.List<javax.tools.JavaFileObject> inputs)

assertCompilesWithoutErrors

@Nonnull
protected final com.google.testing.compile.CompileTester.SuccessfulCompilationClause assertCompilesWithoutErrors(@Nonnull
                                                                                                                          java.lang.String classname)

inputs

@Nonnull
protected final java.util.List<javax.tools.JavaFileObject> inputs(@Nonnull
                                                                           java.lang.String... classnames)

input

@Nonnull
protected final javax.tools.JavaFileObject input(@Nonnull
                                                          java.lang.String dir,
                                                          @Nonnull
                                                          java.lang.String classname)

assertCompilesWithoutErrors

@Nonnull
protected final com.google.testing.compile.CompileTester.SuccessfulCompilationClause assertCompilesWithoutErrors(@Nonnull
                                                                                                                          java.util.List<javax.tools.JavaFileObject> inputs)

assertCompilesWithoutWarnings

@Nonnull
protected final com.google.testing.compile.CompileTester.CleanCompilationClause assertCompilesWithoutWarnings(@Nonnull
                                                                                                                       java.lang.String classname)

assertCompilesWithoutWarnings

@Nonnull
protected final com.google.testing.compile.CompileTester.CleanCompilationClause assertCompilesWithoutWarnings(@Nonnull
                                                                                                                       java.util.List<javax.tools.JavaFileObject> inputs)

newSynthesizingProcessor

@Nonnull
protected final javax.annotation.processing.Processor newSynthesizingProcessor(@Nonnull
                                                                                        java.lang.String classname,
                                                                                        int targetRound)
                                                                                 throws java.io.IOException

Throws:

java.io.IOException

newSynthesizingProcessor

@Nonnull
protected final javax.annotation.processing.Processor newSynthesizingProcessor(@Nonnull
                                                                                        java.lang.String dir,
                                                                                        @Nonnull
                                                                                        java.lang.String classname,
                                                                                        int targetRound)
                                                                                 throws java.io.IOException

Throws:

java.io.IOException

assertCompilesWithSingleWarning

protected final void assertCompilesWithSingleWarning(@Nonnull
                                                     java.lang.String classname,
                                                     @Nonnull
                                                     java.lang.String messageFragment)

assertFailedCompile

protected final void assertFailedCompile(@Nonnull
                                         java.lang.String classname,
                                         @Nonnull
                                         java.lang.String errorMessageFragment)

toFilename

@Nonnull
protected final java.lang.String toFilename(@Nonnull
                                                     java.lang.String dir,
                                                     @Nonnull
                                                     java.lang.String classname)

toFilename

@Nonnull
protected final java.lang.String toFilename(@Nonnull
                                                     java.lang.String dir,
                                                     @Nonnull
                                                     java.lang.String classname,
                                                     @Nonnull
                                                     java.lang.String prefix,
                                                     @Nonnull
                                                     java.lang.String postfix)

assertFailedCompileResource

protected final void assertFailedCompileResource(@Nonnull
                                                 java.lang.String inputResource,
                                                 @Nonnull
                                                 java.lang.String errorMessageFragment)

assertFailedCompileResource

protected final void assertFailedCompileResource(@Nonnull
                                                 java.util.List<javax.tools.JavaFileObject> inputs,
                                                 @Nonnull
                                                 java.lang.String errorMessageFragment)

assertDiagnosticPresent

@Deprecated
protected final void assertDiagnosticPresent(@Nonnull
                                                         com.google.testing.compile.Compilation compilation,
                                                         @Nonnull
                                                         java.lang.String message)

Deprecated. Use assertDiagnostic instead.

assertErrorDiagnostic

protected final void assertErrorDiagnostic(@Nonnull
                                           com.google.testing.compile.Compilation compilation,
                                           @Nonnull
                                           java.lang.String message)

assertWarningDiagnostic

protected final void assertWarningDiagnostic(@Nonnull
                                             com.google.testing.compile.Compilation compilation,
                                             @Nonnull
                                             java.lang.String message)

assertDiagnostic

protected final void assertDiagnostic(@Nonnull
                                      com.google.testing.compile.Compilation compilation,
                                      @Nonnull
                                      javax.tools.Diagnostic.Kind kind,
                                      @Nonnull
                                      java.lang.String message)

fixture

@Nonnull
protected final javax.tools.JavaFileObject fixture(@Nonnull
                                                            java.lang.String filename)

fixtureDir

@Nonnull
protected final java.nio.file.Path fixtureDir()

outputFiles

protected final boolean outputFiles()