com.avcompris.util.junit

Class JUnitUtils

java.lang.Object

com.avcompris.util.AbstractUtils

com.avcompris.util.junit.JUnitUtils

public abstract class JUnitUtils
extends com.avcompris.util.AbstractUtils

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	JUnitUtils.TestMethodAndClassNames

Constructor Summary

Constructors

Constructor and Description
JUnitUtils()

Method Summary

Modifier and Type	Method and Description
static File	createTmpFileFromCommentsAroundThisMethod() load a plain text fragment from comments in or just below the current test method.
static File	createTmpFileFromCommentsAroundThisMethod(int index) load a plain text fragment from comments in or just below the current test method.
static File	createTmpFileFromCommentsAroundThisMethod(String thisMethodName)
static File	createTmpFileFromCommentsAroundThisMethod(String thisMethodName, int index)
static JUnitUtils.TestMethodAndClassNames	getCurrentTestMethodAndClassNames() find the name of the test method (annotated with @Test) currently executing, or null
static String	getCurrentTestMethodName() find the name of the test method (annotated with @Test) currently executing, or null
static File	newTmpFileNamedAfterCurrentTest(String extension) create a File object in the "target" directory with name of current test class and method.

Methods inherited from class java.lang.Object

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

Constructor Detail

JUnitUtils

public JUnitUtils()

Method Detail

getCurrentTestMethodAndClassNames

public static JUnitUtils.TestMethodAndClassNames getCurrentTestMethodAndClassNames()

find the name of the test method (annotated with @Test) currently executing, or null

getCurrentTestMethodName

@Nullable
public static String getCurrentTestMethodName()

find the name of the test method (annotated with @Test) currently executing, or null

createTmpFileFromCommentsAroundThisMethod

public static File createTmpFileFromCommentsAroundThisMethod()
                                                      throws IOException

load a plain text fragment from comments in or just below the current test method. This is useful for instance to display in the cleanest way the XML document or YAML stream to parse and the API usage in the same Java file. Note: Groovy would just not have this issue.

TODO: externalize this method, use AST in it.

Throws:

IOException

createTmpFileFromCommentsAroundThisMethod

public static File createTmpFileFromCommentsAroundThisMethod(int index)
                                                      throws IOException

load a plain text fragment from comments in or just below the current test method. This is useful for instance to display in the cleanest way the XML document or YAML stream to parse and the API usage in the same Java file. Note: Groovy would just not have this issue.

TODO: externalize this method, use AST in it.

Parameters:

index - (start at 0) the index of the comments to extract within the method.

Throws:

IOException

See Also:

createTmpFileFromCommentsAroundThisMethod()

createTmpFileFromCommentsAroundThisMethod

public static File createTmpFileFromCommentsAroundThisMethod(@Nullable
                                                             String thisMethodName)
                                                      throws IOException

Parameters:

thisMethodName - the name of the test method in which, or around which, search for text content in Java comments. If this parameter is null, rely on the JUnit test method currently executing.

Throws:

IOException

See Also:

createTmpFileFromCommentsAroundThisMethod()

createTmpFileFromCommentsAroundThisMethod

public static File createTmpFileFromCommentsAroundThisMethod(@Nullable
                                                             String thisMethodName,
                                                             int index)
                                                      throws IOException

Parameters:

thisMethodName - the name of the test method in which, or around which, search for text content in Java comments. If this parameter is null, rely on the JUnit test method currently executing.

index - (start at 0) the index of the comments to extract within the method.

Throws:

IOException

See Also:

createTmpFileFromCommentsAroundThisMethod()

newTmpFileNamedAfterCurrentTest

public static File newTmpFileNamedAfterCurrentTest(String extension)

create a File object in the "target" directory with name of current test class and method.