org.checkerframework.framework.test

Class CheckerFrameworkPerDirectoryTest

java.lang.Object

org.checkerframework.framework.test.CheckerFrameworkPerDirectoryTest

Direct Known Subclasses:

CheckerFrameworkWPIPerDirectoryTest

public abstract class CheckerFrameworkPerDirectoryTest
extends Object

Compiles all test files in a test directory together. Use CheckerFrameworkPerFileTest to compile each test file in a test directory individually. A CheckerFrameworkPerDirectoryTest is faster than an equivalent CheckerFrameworkPerFileTest, but can only test that processor errors or warnings are issued.

To create a CheckerFrameworkPerDirectoryTest, create a new class that extends this class. The new class must do the following:

1. Declare a constructor taking 1 parameter of type java.util.List<java.io.File>. This is a list of the files that will be compiled.
2. Declare the following method:

    @Parameters public static String [] getTestDirs()

   getTestDir must return an array of directories that exist in the test folder. 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.

 public class MyTest extends CheckerFrameworkPerDirectoryTest {
   /**  @param testFiles the files containing test code, which will be type-checked * /
   public MyTest(List <File > testFiles) {
     super(testFiles, MyChecker.class, "", "Anomsgtext");
   }
   @Parameters
   public static String [] getTestDirs() {
     return new String[]{"all-systems"};
   }
 }
 

Field Summary

Fields

Modifier and Type	Field and Description
protected List<String>	checkerNames The binary names of the checkers to run.
protected List<String>	checkerOptions Extra options to pass to javac when running the checker.
protected List<String>	classpathExtra Extra entries for the classpath.
protected String	testDir The path, relative to currentDir/test to the directory containing test inputs.
protected List<File>	testFiles The files containing test code, which will be type-checked.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	CheckerFrameworkPerDirectoryTest(List<File> testFiles, Class<? extends AbstractProcessor> checker, String testDir, List<String> classpathExtra, String... checkerOptions) Creates a new checker test.
protected	CheckerFrameworkPerDirectoryTest(List<File> testFiles, Class<? extends AbstractProcessor> checker, String testDir, String... checkerOptions) Creates a new checker test.
protected	CheckerFrameworkPerDirectoryTest(List<File> testFiles, List<String> checkerNames, String testDir, List<String> classpathExtra, String... checkerOptions) Creates a new checker test.

Method Summary

Modifier and Type	Method and Description
TypecheckResult	adjustTypecheckResult(TypecheckResult testResult) This method is called before issuing assertions about a TypecheckResult.
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 files 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

testFiles

protected final List<File> testFiles

The files containing test code, which will be type-checked.

checkerNames

protected final List<String> checkerNames

The binary names of the checkers to run.

testDir

protected final String testDir

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.

classpathExtra

protected final List<String> classpathExtra

Extra entries for the classpath.

Constructor Detail

CheckerFrameworkPerDirectoryTest

protected CheckerFrameworkPerDirectoryTest(List<File> testFiles,
                                           Class<? extends AbstractProcessor> checker,
                                           String testDir,
                                           String... checkerOptions)

Creates a new checker test.

TestConfigurationBuilder.getDefaultConfigurationBuilder(String, File, String, Iterable, Iterable, List, boolean) adds additional checker options.

Parameters:

testFiles - the files containing test code, which will be type-checked

checker - the class for the checker to use

testDir - the path to the directory of test inputs

checkerOptions - options to pass to the compiler when running tests

CheckerFrameworkPerDirectoryTest

protected CheckerFrameworkPerDirectoryTest(List<File> testFiles,
                                           Class<? extends AbstractProcessor> checker,
                                           String testDir,
                                           List<String> classpathExtra,
                                           String... checkerOptions)

Creates a new checker test.

TestConfigurationBuilder.getDefaultConfigurationBuilder(String, File, String, Iterable, Iterable, List, boolean) adds additional checker options.

Parameters:

testFiles - the files containing test code, which will be type-checked

checker - the class for the checker to use

testDir - the path to the directory of test inputs

classpathExtra - extra entries for the classpath, relative to a directory such as checker-framework/checker

checkerOptions - options to pass to the compiler when running tests

CheckerFrameworkPerDirectoryTest

protected CheckerFrameworkPerDirectoryTest(List<File> testFiles,
                                           List<String> checkerNames,
                                           String testDir,
                                           List<String> classpathExtra,
                                           String... checkerOptions)

Creates a new checker test.

TestConfigurationBuilder.getDefaultConfigurationBuilder(String, File, String, Iterable, Iterable, List, boolean) adds additional checker options.

Parameters:

testFiles - the files containing test code, which will be type-checked

checkerNames - the binary names of the checkers to run

testDir - the path to the directory of test inputs

classpathExtra - extra entries for the classpath, relative to a directory such as checker-framework/checker

checkerOptions - options to pass to the compiler when running tests

Method Detail

run

public void run()

adjustTypecheckResult

public TypecheckResult adjustTypecheckResult(TypecheckResult testResult)

This method is called before issuing assertions about a TypecheckResult. Subclasses can override it to customize behavior.

Parameters:

testResult - a test result to possibly change

Returns:

a TypecheckResult to use instead, which may be the unmodified argument

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 files passed to the test. Those files are available in field testFiles.

If you want to specify the same command-line option for all tests of a particular checker, then pass it to the CheckerFrameworkPerDirectoryTest(java.util.List<java.io.File>, java.util.List<java.lang.String>, java.lang.String, java.util.List<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