Package org.checkerframework.framework.test

Interface TestConfiguration

All Known Implementing Classes:
ImmutableTestConfiguration
public interface TestConfiguration
A configuration for running CheckerFrameworkTests or running the TypecheckExecutor.

  • Method Details

    • getTestSourceFiles

      List<File> getTestSourceFiles()
      Returns a list of source files a CheckerFrameworkPerDirectoryTest should be run over. These source files will be passed to Javac when the test is run. These are NOT JUnit tests.
      Returns:
      a list of source files a CheckerFrameworkPerDirectoryTest should be run over

    • getDiagnosticFiles

      List<File> getDiagnosticFiles()
      Diagnostic files consist of a set of lines that enumerate expected error/warning diagnostics. The lines are of the form: 
      fileName:lineNumber: diagnostKind: (messageKey)
      e.g., 
      MethodInvocation.java:17: error: (method.invocation)
      If getDiagnosticFiles does NOT return an empty list, then the only diagnostics expected by the TestExecutor will be the ones found in these files. If it does return an empty list, then the only diagnostics expected will be the ones found in comments in the input test files.

      It is preferred that users write the errors in the test files and not in diagnostic files.

      Returns:
      a List of diagnostic files containing the error/warning messages expected to be output when Javac is run on the files returned by getTestSourceFiles. Return an empty list if these messages were specified within the source files.

    • getProcessors

      List<@BinaryName String> getProcessors()
      Returns a list of annotation processors (Checkers) passed to the Javac compiler.
      Returns:
      a list of annotation processors (Checkers) passed to the Javac compiler

    • getOptions

      Map<String,@Nullable String> getOptions()
      Some Javac command line arguments require arguments themselves (e.g. -classpath takes a path) getOptions returns a Map(optionName => optionArgumentIfAny). If an option does not take an argument, pass null as the value.

      E.g., 

      
 Map(
   "-AprintAllQualifiers" => null
    "-classpath" => "myDir1:myDir2"
 )
      Returns:
      a Map representing all command-line options to Javac other than source files and processors

    • getFlatOptions

      List<String> getFlatOptions()
      Returns the map returned by getOptions(), flattened into a list. The entries will be added as followed: List(key1, value1, key2, value2, ..., keyN, valueN). If a value is NULL, then it will not appear in the list.
      Returns:
      the map returned getOptions(), but flattened into a list

    • shouldEmitDebugInfo

      boolean shouldEmitDebugInfo()
      Returns true if the TypecheckExecutor should emit debug information on system out, false otherwise.
      Returns:
      true if the TypecheckExecutor should emit debug information on system out, false otherwise