org.netbeans.modules.java.hints.test.api

Class HintTest

java.lang.Object

org.netbeans.modules.java.hints.test.api.HintTest

public class HintTest
extends Object

A support class for writing a test for a Java Hint. A test verifying that correct warnings are produced should look like:

 HintTest.create()
         .input("<input Java source code>")
         .run(<class containg the hint>)
         .assertWarnings("<required warning(s)>");
 

Note: when verifying that no warnings are produced in a particular situation, do not pass any warnings to the assertWarnings method. A test verifying that a hint's transformation is correct:

 HintTest.create()
         .input("<input Java source code>")
         .run(<class containg the hint>)
         .findWarning("<a warning produce by the hint>")
         .applyFix() //fill apply the only fix in the given ErrorDescription
         .assertCompilable()
         .assertOutput("<output Java source code>");
 

All the tests run under the test branding, which allows to specify test values for bundle keys for warning and fix in Bundle_test.properties, to isolate the test from changes in the production Bundle.properties.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	HintTest.AppliedFix A wrapper over result after applying a fix.
class	HintTest.HintOutput Encapsulated the output of the hint.
class	HintTest.HintWarning A wrapper over a single warning.

Method Summary

Modifier and Type	Method and Description
HintTest	classpath(URL... entries) Use the specified URLs as compile classpath while parsing the Java input.
static HintTest	create() Bootstraps the test framework.
HintTest	input(String code) Create a test file.
HintTest	input(String code, boolean compilable) Create a test file.
HintTest	input(String fileName, String code) Create a test file.
HintTest	input(String fileName, String code, boolean compilable) Create a test file.
HintTest	options(String... options) Sets additional command line options for all Java files used in this test.
HintTest	preference(String preferencesKey, boolean value) Sets a preference that will be visible to the hint.
HintTest	preference(String preferencesKey, int value) Sets a preference that will be visible to the hint.
HintTest	preference(String preferencesKey, String value) Sets a preference that will be visible to the hint.
HintTest.HintOutput	run(Class<?> hint) Runs the given hint(s) on the first file written by a input method.
HintTest.HintOutput	run(Class<?> hint, String hintCode) Runs the given hint(s) on the first file written by a input method.
HintTest	setCaretMarker(char c) A character to use as a marker of a caret in the input code.
HintTest	sourceLevel(int sourceLevel) Sets a source level for all Java files used in this test.
HintTest	sourceLevel(String sourceLevel) Sets a source level for all Java files used in this test.

Methods inherited from class java.lang.Object

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

Method Detail

create

public static HintTest create()
                       throws Exception

Bootstraps the test framework.

Returns:

the test framework - call more methods on it to set-up a test, then call run method and assert results.

Throws:

Exception

setCaretMarker

public HintTest setCaretMarker(char c)

A character to use as a marker of a caret in the input code. The caret position during the run method will be set to the position of this character in the first input file.

Parameters:

c - a caret marker

Returns:

itself

classpath

public HintTest classpath(URL... entries)

Use the specified URLs as compile classpath while parsing the Java input. The URLs need to be "folder" URLs, ready to be passed to ClassPathSupport.createClassPath(java.net.URL[]).

Parameters:

entries - that should become roots of the compile classpath

Returns:

itself

See Also:

FileUtil.urlForArchiveOrDir(java.io.File), FileUtil.getArchiveRoot(java.net.URL)

input

public HintTest input(String code)
               throws Exception

Create a test file. Equivalent to calling input("test/Test.java", code, true).

Parameters:

code - the content of the newly created test file

Returns:

itself

Throws:

Exception

input

public HintTest input(String code,
                      boolean compilable)
               throws Exception

Create a test file. Equivalent to calling input("test/Test.java", code, compilable).

Parameters:

code - the content of the newly created test file

compilable - if true, it will be verified that the file does not contain compilation errors before the hint is run on it

Returns:

itself

Throws:

Exception

input

public HintTest input(String fileName,
                      String code)
               throws Exception

Create a test file. Equivalent to calling input(fileName, code, true).

Parameters:

fileName - a relative file name of the newly created file from a (automatically created) source root

code - the content of the newly created test file

Returns:

itself

Throws:

Exception

input

public HintTest input(String fileName,
                      String code,
                      boolean compilable)
               throws Exception

Create a test file. Any number of files can be created for one test, but the hint will be run only on the first one.

Parameters:

fileName - a relative file name of the newly created file from a (automatically created) source root

code - the content of the newly created test file

compilable - if true, it will be verified that the file does not contain compilation errors before the hint is run on it

Returns:

itself

Throws:

Exception

sourceLevel

public HintTest sourceLevel(int sourceLevel)

Sets a source level for all Java files used in this test.

Parameters:

sourceLevel - the source level to use while parsing Java files

Returns:

itself

sourceLevel

public HintTest sourceLevel(String sourceLevel)

Sets a source level for all Java files used in this test.

Parameters:

sourceLevel - the source level to use while parsing Java files

Returns:

itself

options

public HintTest options(String... options)

Sets additional command line options for all Java files used in this test.

Parameters:

options - the additional command line options to use while parsing Java files

Returns:

itself

Since:

1.23

preference

public HintTest preference(String preferencesKey,
                           String value)

Sets a preference that will be visible to the hint.

Parameters:

preferencesKey - a key for the preferences

value - the value to set

Returns:

itself

preference

public HintTest preference(String preferencesKey,
                           int value)

Sets a preference that will be visible to the hint.

Parameters:

preferencesKey - a key for the preferences

value - the value to set

Returns:

itself

preference

public HintTest preference(String preferencesKey,
                           boolean value)

Sets a preference that will be visible to the hint.

Parameters:

preferencesKey - a key for the preferences

value - the value to set

Returns:

itself

run

public HintTest.HintOutput run(Class<?> hint)
                        throws Exception

Runs the given hint(s) on the first file written by a input method.

Parameters:

hint - all hints in this class will be run on the file

Returns:

a wrapper over the hint output that allows verifying results of the hint

Throws:

Exception

run

public HintTest.HintOutput run(Class<?> hint,
                               String hintCode)
                        throws Exception

Runs the given hint(s) on the first file written by a input method. Runs only hints with the specified hintCode. Null hintCode includes all hints from the class

Parameters:

hint - all hints in this class will be run on the file

hintCode - if not null, only hints with the same id will be run

Returns:

a wrapper over the hint output that allows verifying results of the hint

Throws:

Exception