org.checkerframework.framework.test

Class TestUtilities

java.lang.Object

org.checkerframework.framework.test.TestUtilities

public class TestUtilities
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	isAtLeast8Jvm
static boolean	isJSR308Compiler

Constructor Summary

Constructors

Constructor and Description
TestUtilities()

Method Summary

Modifier and Type	Method and Description
static void	assertResultsAreValid(TypecheckResult testResult) TODO: REDO COMMENT Compares the result of the compiler against an array of Strings.
static java.util.List<java.io.File>	deeplyEnclosedJavaTestFiles(java.io.File directory) Returns all the java files that are descendants of the given directory
static java.util.Set<java.lang.String>	diagnosticsToStrings(java.lang.Iterable<javax.tools.Diagnostic<? extends javax.tools.JavaFileObject>> actualDiagnostics, boolean usingAnomsgtxt)
static java.lang.String	diagnosticToString(javax.tools.Diagnostic<? extends javax.tools.JavaFileObject> diagnostic, boolean usingAnomsgtxt)
static void	ensureDirectoryExists(java.io.File path)
static java.io.File	findComparisonFile(java.io.File testFile)
static java.util.List<java.lang.Object[]>	findFilesInParent(java.io.File parent, java.lang.String... fileNames)
static java.util.List<java.util.List<java.io.File>>	findJavaFilesPerDirectory(java.io.File parent, java.lang.String... dirNames) Returns a list where each item is a list of Java files, excluding any skip tests, for each directory given by dirName and also a list for any subdirectory.
static java.util.List<java.io.File>	findNestedJavaTestFiles(java.lang.String... dirNames)
static java.util.List<java.io.File>	findRelativeNestedJavaFiles(java.io.File parent, java.lang.String... dirNames)
static java.util.List<java.io.File>	findRelativeNestedJavaFiles(java.lang.String parent, java.lang.String... dirNames)
static java.util.List<java.io.File>	getJavaFilesAsArgumentList(java.io.File... dirs) Traverses the directories listed looking for java test files
static boolean	getShouldEmitDebugInfo()
static java.io.File	getTestFile(java.lang.String fileRelativeToTestsDir)
static boolean	isJavaFile(java.io.File file)
static boolean	isJavaTestFile(java.io.File file)
static java.util.List<java.lang.String>	optionMapToList(java.util.Map<java.lang.String,java.lang.String> options)
static java.lang.String	summarizeSourceFiles(java.util.List<java.io.File> javaFiles)
static boolean	testBooleanProperty(java.lang.String propName)
static boolean	testBooleanProperty(java.lang.String propName, boolean defaultValue)
static void	writeDiagnostics(java.io.File file, java.io.File testFile, java.util.List<java.lang.String> expected, java.util.List<java.lang.String> actual, java.util.List<java.lang.String> unexpected, java.util.List<java.lang.String> missing, boolean usingNoMsgText, boolean testFailed)
static void	writeJavacArguments(java.io.File file, java.lang.Iterable<? extends javax.tools.JavaFileObject> files, java.lang.Iterable<java.lang.String> options, java.lang.Iterable<java.lang.String> processors)
static void	writeLines(java.io.File file, java.lang.Iterable<?> lines)
static void	writeTestConfiguration(java.io.File file, TestConfiguration config)

Methods inherited from class java.lang.Object

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

Field Detail

isJSR308Compiler

public static final boolean isJSR308Compiler

isAtLeast8Jvm

public static final boolean isAtLeast8Jvm

Constructor Detail

TestUtilities

public TestUtilities()

Method Detail

findNestedJavaTestFiles

public static java.util.List<java.io.File> findNestedJavaTestFiles(java.lang.String... dirNames)

findRelativeNestedJavaFiles

public static java.util.List<java.io.File> findRelativeNestedJavaFiles(java.lang.String parent,
                                                                       java.lang.String... dirNames)

findRelativeNestedJavaFiles

public static java.util.List<java.io.File> findRelativeNestedJavaFiles(java.io.File parent,
                                                                       java.lang.String... dirNames)

findJavaFilesPerDirectory

public static java.util.List<java.util.List<java.io.File>> findJavaFilesPerDirectory(java.io.File parent,
                                                                                     java.lang.String... dirNames)

Returns a list where each item is a list of Java files, excluding any skip tests, for each directory given by dirName and also a list for any subdirectory.

Parameters:

parent - parent directory of the dirNames directories

dirNames - names of directories to search

Returns:

list where each item is a list of Java test files grouped by directory

findFilesInParent

public static java.util.List<java.lang.Object[]> findFilesInParent(java.io.File parent,
                                                                   java.lang.String... fileNames)

getJavaFilesAsArgumentList

public static java.util.List<java.io.File> getJavaFilesAsArgumentList(java.io.File... dirs)

Traverses the directories listed looking for java test files

deeplyEnclosedJavaTestFiles

public static java.util.List<java.io.File> deeplyEnclosedJavaTestFiles(java.io.File directory)

Returns all the java files that are descendants of the given directory

isJavaFile

public static boolean isJavaFile(java.io.File file)

isJavaTestFile

public static boolean isJavaTestFile(java.io.File file)

diagnosticToString

public static java.lang.String diagnosticToString(javax.tools.Diagnostic<? extends javax.tools.JavaFileObject> diagnostic,
                                                  boolean usingAnomsgtxt)

diagnosticsToStrings

public static java.util.Set<java.lang.String> diagnosticsToStrings(java.lang.Iterable<javax.tools.Diagnostic<? extends javax.tools.JavaFileObject>> actualDiagnostics,
                                                                   boolean usingAnomsgtxt)

summarizeSourceFiles

public static java.lang.String summarizeSourceFiles(java.util.List<java.io.File> javaFiles)

getTestFile

public static java.io.File getTestFile(java.lang.String fileRelativeToTestsDir)

findComparisonFile

public static java.io.File findComparisonFile(java.io.File testFile)

optionMapToList

public static java.util.List<java.lang.String> optionMapToList(java.util.Map<java.lang.String,java.lang.String> options)

writeLines

public static void writeLines(java.io.File file,
                              java.lang.Iterable<?> lines)

writeDiagnostics

public static void writeDiagnostics(java.io.File file,
                                    java.io.File testFile,
                                    java.util.List<java.lang.String> expected,
                                    java.util.List<java.lang.String> actual,
                                    java.util.List<java.lang.String> unexpected,
                                    java.util.List<java.lang.String> missing,
                                    boolean usingNoMsgText,
                                    boolean testFailed)

writeTestConfiguration

public static void writeTestConfiguration(java.io.File file,
                                          TestConfiguration config)

writeJavacArguments

public static void writeJavacArguments(java.io.File file,
                                       java.lang.Iterable<? extends javax.tools.JavaFileObject> files,
                                       java.lang.Iterable<java.lang.String> options,
                                       java.lang.Iterable<java.lang.String> processors)

assertResultsAreValid

public static void assertResultsAreValid(TypecheckResult testResult)

TODO: REDO COMMENT Compares the result of the compiler against an array of Strings.

In a checker, we treat a more specific error message as subsumed by a general one. For example, "new.array.type.invalid" is subsumed by "type.invalid". This is not the case in the test framework; the exact error key is expected.

ensureDirectoryExists

public static void ensureDirectoryExists(java.io.File path)

testBooleanProperty

public static boolean testBooleanProperty(java.lang.String propName)

testBooleanProperty

public static boolean testBooleanProperty(java.lang.String propName,
                                          boolean defaultValue)

getShouldEmitDebugInfo

public static boolean getShouldEmitDebugInfo()