org.mdiutil.junit

Class JUnitCategoryWrapper

java.lang.Object

org.mdiutil.junit.JUnitCategoryWrapper

public class JUnitCategoryWrapper
extends Object

A wrapper which wrap around Unit Test categories. This class will parse the JUnit tests resource file which define the categories which will be allowed to run, and will return the Set of test categories allowed to run. The file used to condigure the categories is the categories.properties file at the root of the Unit tests.

File structure

The categories.properties file is a properties file with (key, value) pairs:

• The key is the category name
• The value is true or false: true indicates that the tests of the specified category should run, false that they should not run

Note that if no values are defined, all Unit tests will be run.

strictMode

If the "strictMode" value is true, only tests which belong to all true categories will be executed. For example:

 strictMode=true
 editor=true
 server=true
 client=
 

Only Unit Tests annotated by both "editor" and "server" will run.

showSkippedClasses

If the "showSkippedClasses" value is true, tests which are not executed will be shown as ignored. For example:

 showSkippedClasses=true
 editor=true
 server=
 client=
 

Examples

 editor=
 server=
 client=
 

All Unit Tests will run.

 editor=true
 server=false
 client=false
 

Only "editor" Unit Tests will run.

 editor=true
 server=true
 client=
 

Only "editor" or "server" Unit Tests will run.

 editor=
 server=
 client=false
 

All Unit Tests except "client" Unit tests will run.

 strictMode=true
 editor=true
 server=true
 client=
 

Only Unit Tests annotated by both "editor" and "server" will run.

Discovering the categories file

The properties file which contains the categories must be in the following package: org.mdiutils.junit.resources and its name must be categories.properties.

Field Summary

Fields

Modifier and Type	Field and Description
static List<org.junit.runners.model.FrameworkMethod>	EMPTY_LIST
static String	ENV_CATEGORIES The name of the categories environment variable.

Method Summary

Modifier and Type	Method and Description
Set<String>	getCategories()
Set<String>	getExcludedCategories()
static JUnitCategoryWrapper	getInstance() Return the JUnit tests categories which will be allowed to run.
boolean	isShowingSkippedClasses()
boolean	isStrict()

Methods inherited from class java.lang.Object

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

Field Detail

ENV_CATEGORIES

public static final String ENV_CATEGORIES

The name of the categories environment variable.

See Also:

Constant Field Values

EMPTY_LIST

public static final List<org.junit.runners.model.FrameworkMethod> EMPTY_LIST

Method Detail

isShowingSkippedClasses

public boolean isShowingSkippedClasses()

isStrict

public boolean isStrict()

getCategories

public Set<String> getCategories()

getExcludedCategories

public Set<String> getExcludedCategories()

getInstance

public static JUnitCategoryWrapper getInstance()

Return the JUnit tests categories which will be allowed to run.

Returns:

the JUnit tests categories which will be allowed to run