Class BugCheckerRefactoringTestHelper

java.lang.Object

com.google.errorprone.BugCheckerRefactoringTestHelper

@CheckReturnValue
public class BugCheckerRefactoringTestHelper
extends Object

Compare a file transformed as suggested by BugChecker to an expected source.

Inputs are a BugChecker instance, input file and expected file.

Author:

kurs@google.com (Jan Kurs)

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	BugCheckerRefactoringTestHelper.ExpectOutput	To assert the proper .addInput().addOutput() chain.
static interface	BugCheckerRefactoringTestHelper.FixChooser	For checks that provide multiple possible fixes, chooses the one that will be applied for the test.
static enum	BugCheckerRefactoringTestHelper.FixChoosers	Predefined FixChoosers for selecting a fix by its position in the list
static enum	BugCheckerRefactoringTestHelper.TestMode	Test mode for matching refactored source against expected source.

Method Summary

Modifier and Type	Method	Description
BugCheckerRefactoringTestHelper.ExpectOutput	addInput(String inputFilename)	Deprecated. prefer addInputLines(String, String...).
BugCheckerRefactoringTestHelper.ExpectOutput	addInputLines(String path, String... input)
BugCheckerRefactoringTestHelper	addModules(String... modules)
BugCheckerRefactoringTestHelper	allowBreakingChanges()	If set, fixes that produce output that doesn't compile are allowed.
void	doTest()
void	doTest(BugCheckerRefactoringTestHelper.TestMode testMode)
static BugCheckerRefactoringTestHelper	newInstance(BugChecker refactoringBugChecker, Class<?> clazz)	Deprecated. prefer newInstance(Class, Class)
static BugCheckerRefactoringTestHelper	newInstance(ScannerSupplier scannerSupplier, Class<?> clazz)	Returns a new CompilationTestHelper.
static BugCheckerRefactoringTestHelper	newInstance(Class<? extends BugChecker> checkerClass, Class<?> clazz)
BugCheckerRefactoringTestHelper	setArgs(com.google.common.collect.ImmutableList<String> args)
BugCheckerRefactoringTestHelper	setArgs(String... args)
BugCheckerRefactoringTestHelper	setFixChooser(BugCheckerRefactoringTestHelper.FixChooser chooser)
BugCheckerRefactoringTestHelper	setImportOrder(String importOrder)

Methods inherited from class Object

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

Method Details

newInstance

@Deprecated
public static BugCheckerRefactoringTestHelper newInstance(BugChecker refactoringBugChecker,
 Class<?> clazz)

Deprecated.

prefer newInstance(Class, Class)

newInstance

public static BugCheckerRefactoringTestHelper newInstance(ScannerSupplier scannerSupplier,
 Class<?> clazz)

Returns a new CompilationTestHelper.

Parameters:

scannerSupplier - the ScannerSupplier to test

clazz - the class to use to locate file resources

newInstance

public static BugCheckerRefactoringTestHelper newInstance(Class<? extends BugChecker> checkerClass,
 Class<?> clazz)

addInput

@Deprecated
public BugCheckerRefactoringTestHelper.ExpectOutput addInput(String inputFilename)

Deprecated.

prefer addInputLines(String, String...). Declaring tests in the same file using text blocks is more readable, as it encourages writing small, focussed tests.

Adds an input file.

addInputLines

public BugCheckerRefactoringTestHelper.ExpectOutput addInputLines(String path,
 String... input)

setFixChooser

@CanIgnoreReturnValue
public BugCheckerRefactoringTestHelper setFixChooser(BugCheckerRefactoringTestHelper.FixChooser chooser)

addModules

@CanIgnoreReturnValue
public BugCheckerRefactoringTestHelper addModules(String... modules)

setArgs

@CanIgnoreReturnValue
public BugCheckerRefactoringTestHelper setArgs(com.google.common.collect.ImmutableList<String> args)

setArgs

@CanIgnoreReturnValue
public BugCheckerRefactoringTestHelper setArgs(String... args)

allowBreakingChanges

@CanIgnoreReturnValue
public BugCheckerRefactoringTestHelper allowBreakingChanges()

If set, fixes that produce output that doesn't compile are allowed. Off by default.

setImportOrder

@CanIgnoreReturnValue
public BugCheckerRefactoringTestHelper setImportOrder(String importOrder)

doTest

public void doTest()

doTest

public void doTest(BugCheckerRefactoringTestHelper.TestMode testMode)