org.checkerframework.framework.test

Class CheckerFrameworkTest

java.lang.Object

org.checkerframework.framework.test.CheckerFrameworkTest

public abstract class CheckerFrameworkTest
extends Object

To use this class you must do two things:

1. Create exactly 1 constructor in the subclass with exactly 1 argument of type java.io.File. This File will be the Java file that is compiled and whose output is verified.
2. Create one of the following 2 public static methods with the annotation org.junit.runners.Parameterized.Parameters. The method name and signature must match exactly.
   • @Parameters public static String [] getTestDirs()

     getTestDir must return an array of directories that exist in the test folder, e.g.

       @Parameters
        public static String [] getTestDirs() {
           return new String[]{"all-systems", "flow"};
        }

     The directories can contain more path information (e.g., "myTestDir/moreTests") but note, the test suite will find all of the Java test files that exists below the listed directories. It is unnecessary to list child directories of a directory you have already listed.
   • @Parameters public static List<File> getTestFiles()

     The method returns a List of Java files. There are methods like TestUtilities.findNestedJavaTestFiles(java.lang.String...) to help you construct this List. The TestSuite will then instantiate the subclass once for each file returned by getTestFiles and execute the run method. An example of this method is:

       @Parameters
        public static List<File> getTestFiles() {
          return TestUtilities.findNestedJavaTestFiles("aggregate");
        }

Field Summary

Fields

Modifier and Type	Field and Description
protected String	checkerDir The path, relative to currentDir/test to the directory containing test inputs.
protected String	checkerName The fully-qualified class name of the checker to use for tests.
protected List<String>	checkerOptions Extra options to pass to javac when running the checker.
protected File	testFile

Constructor Summary

Constructors

Constructor and Description
CheckerFrameworkTest(File testFile, Class<? extends AbstractProcessor> checker, String checkerDir, String... checkerOptions) Creates a new checker test.

Method Summary

Modifier and Type	Method and Description
List<String>	customizeOptions(List<String> previousOptions) Override this method if you would like to supply a checker command-line option that depends on the Java file passed to the test.
void	run()

Methods inherited from class java.lang.Object

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

Field Detail

testFile

protected final File testFile

checkerName

protected final String checkerName

The fully-qualified class name of the checker to use for tests.

checkerDir

protected final String checkerDir

The path, relative to currentDir/test to the directory containing test inputs.

checkerOptions

protected final List<String> checkerOptions

Extra options to pass to javac when running the checker.

Constructor Detail

CheckerFrameworkTest

public CheckerFrameworkTest(File testFile,
                            Class<? extends AbstractProcessor> checker,
                            String checkerDir,
                            String... checkerOptions)

Creates a new checker test.

Parameters:

checker - the class for the checker to use

checkerDir - the path to the directory of test inputs

checkerOptions - options to pass to the compiler when running tests

Method Detail

run

public void run()

customizeOptions

public List<String> customizeOptions(List<String> previousOptions)

Override this method if you would like to supply a checker command-line option that depends on the Java file passed to the test. That file name is available in field testFile.

If you want to specify the same command-line option for all tests of a particular checker, then pass it to the CheckerFrameworkTest(java.io.File, java.lang.Class<? extends javax.annotation.processing.AbstractProcessor>, java.lang.String, java.lang.String...) constructor.

Parameters:

previousOptions - The options specified in the constructor of the test previousOptions is unmodifiable

Returns:

A new list of options or the original passed through