Package org.tquadrat.foundation.testutil

Class TestBaseClass

java.lang.Object

org.easymock.EasyMockSupport

org.tquadrat.foundation.testutil.TestBaseClass

@API(status=STABLE,
     since="0.0.5")
public abstract class TestBaseClass
extends org.easymock.EasyMockSupport

A base class for JUnit test classes.

Author:

Thomas Thrien (thomas.thrien@tquadrat.org)

Version:

$Id: TestBaseClass.java 1100 2024-02-16 23:33:45Z tquadrat $

Since:

0.0.5

UML Diagram

⁠

UML Diagram for "org.tquadrat.foundation.testutil.TestBaseClass"

⁠

Field Summary

Fields

Modifier and Type	Field	Description
private PrintStream	m_DefaultErrorStream	The default error output stream.
private InputStream	m_DefaultInputStream	The default input stream.
private Locale	m_DefaultLocale	The default Locale.
private PrintStream	m_DefaultOutputStream	The default output stream.
private TimeZone	m_DefaultTimeZone	The default TimeZone.
private ZoneId	m_DefaultZoneId	The default ZoneId.
private Collection<Thread>	m_LiveThreadsBeforeSetup	Threads that are alive before the test is started.
private boolean	m_SkipThreadTest	Flag that controls whether the test regarding additional threads will be performed or not.
private static Properties	m_SystemProperties	The system properties.
static final String	MSG_ExceptionNotThrown	The message for an exception that was not thrown: "Expected Exception \'%s\' was not thrown".
static final String	MSG_ExceptionThrown	The message for an unexpected exception that was thrown: "Unexpected Exception \'%s\' was thrown".
static final String	MSG_WrongExceptionThrown	The message that another than the expected exception was thrown: "Wrong Exception type; caught \'%2$s\' but \'%1$s\' was expected".

Fields inherited from class org.easymock.EasyMockSupport

controls

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	TestBaseClass()	Creates a new TestBaseClass instance.

Method Summary

Modifier and Type	Method	Description
protected static final void	assertThatJDKAssertionAreEnabled()	As the name of the method indicates, it asserts that the JDK assertions are enabled. The method uses TestUtils.isAssertionOn() to check whether JDK assertion is currently activated, meaning that the program was started with the command line flags -ea or -enableassertions. Unfortunately, it is possible to activate assertions for some selected packages only (and org.tquadrat.test may not be amongst these), or org.tquadrat.test is explicitly disabled with -da or -disableassertions (or – most mean!
protected final void	assertThatSystemPropertiesWereNotChanged()	As the name of the method indicates, it asserts that the system properties were not modified.
protected final void	assertThatThereAreNoMoreLiveThreadsThanBeforeSetup()	As the name of the method indicates, it asserts that there are no more living threads than there had been before setup.
protected final PrintStream	getDefaultErrorStream()	Returns the default error stream.
protected final PrintStream	getDefaultOutputStream()	Returns the default output stream.
protected final boolean	hasNetwork()	Checks whether the machine, that runs the current test, has network configured.
protected final void	obtainLiveThreads()	References to all currently running threads will be stored.
protected final void	resetDefaultSettings()	Resets the default settings for Locale, TimeZone, and ZoneId.
protected final void	resetDefaultStreams()	Resets the default streams.
protected final void	resetSkipThreadTest()	Resets the thread test flag.
protected final void	saveDefaultSettings()	Saves the default settings for Locale, TimeZone, and ZoneId.
protected final void	saveDefaultStreams()	Saves the default streams.
final void	skipThreadTest()	Sets the thread test flag to true, disabling that test.
protected static void	storeSystemProperties()	Keep the system properties.
protected final String	translateEscapes(CharSequence input)	Translates the escape sequences in a String.
protected final boolean	validateAsStaticClass(Class<?> candidate)	Validates whether a class is really a static class. A class is static when it has the following characteristics: The class is final. All methods are static. Only the default constructor may exists, this has to be private, and it has to throw an Error on invocation. If a test fails, the result is written to System.out. The method will not check for the &#64;UtilityClass annotation as this has only the retention level SOURCE.

Methods inherited from class org.easymock.EasyMockSupport

createControl, createControl, createMock, createMock, createMock, createMock, createMockBuilder, createNiceControl, createNiceMock, createNiceMock, createStrictControl, createStrictMock, createStrictMock, getMockedClass, injectMocks, isAMock, mock, mock, mock, mock, niceMock, niceMock, partialMockBuilder, replayAll, resetAll, resetAllToDefault, resetAllToNice, resetAllToStrict, strictMock, strictMock, verifyAll, verifyAllRecordings, verifyAllUnexpectedCalls

Methods inherited from class java.lang.Object

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

Field Details

MSG_ExceptionNotThrown

public static final String MSG_ExceptionNotThrown

The message for an exception that was not thrown: "Expected Exception \'%s\' was not thrown".

See Also:

• Constant Field Values

MSG_ExceptionThrown

public static final String MSG_ExceptionThrown

The message for an unexpected exception that was thrown: "Unexpected Exception \'%s\' was thrown".

See Also:

• Constant Field Values

MSG_WrongExceptionThrown

public static final String MSG_WrongExceptionThrown

The message that another than the expected exception was thrown: "Wrong Exception type; caught \'%2$s\' but \'%1$s\' was expected".

See Also:

• Constant Field Values

m_DefaultErrorStream

private PrintStream m_DefaultErrorStream

The default error output stream.

m_DefaultInputStream

private InputStream m_DefaultInputStream

The default input stream.

m_DefaultLocale

private Locale m_DefaultLocale

The default Locale.

m_DefaultOutputStream

private PrintStream m_DefaultOutputStream

The default output stream.

m_DefaultTimeZone

private TimeZone m_DefaultTimeZone

The default TimeZone.

m_DefaultZoneId

private ZoneId m_DefaultZoneId

The default ZoneId.

m_LiveThreadsBeforeSetup

private Collection<Thread> m_LiveThreadsBeforeSetup

Threads that are alive before the test is started.

m_SkipThreadTest

private boolean m_SkipThreadTest

Flag that controls whether the test regarding additional threads will be performed or not.

See Also:

• assertThatThereAreNoMoreLiveThreadsThanBeforeSetup()

m_SystemProperties

private static Properties m_SystemProperties

The system properties.

Constructor Details

TestBaseClass

protected TestBaseClass()

Creates a new TestBaseClass instance.

Method Details

assertThatJDKAssertionAreEnabled

@BeforeAll
protected static final void assertThatJDKAssertionAreEnabled()

As the name of the method indicates, it asserts that the JDK assertions are enabled.

The method uses TestUtils.isAssertionOn() to check whether JDK assertion is currently activated, meaning that the program was started with the command line flags -ea or -enableassertions.

Unfortunately, it is possible to activate assertions for some selected packages only (and org.tquadrat.test may not be amongst these), or org.tquadrat.test is explicitly disabled with -da or -disableassertions (or – most mean! – assertions are only activated for org.tquadrat.test}. Therefore, the outcome of this method will not guarantee for one hundred percent that assertion are always thrown where necessary.

See Also:

• TestUtils.isAssertionOn()

assertThatSystemPropertiesWereNotChanged

@AfterEach
protected final void assertThatSystemPropertiesWereNotChanged()

As the name of the method indicates, it asserts that the system properties were not modified.

assertThatThereAreNoMoreLiveThreadsThanBeforeSetup

@AfterEach
protected final void assertThatThereAreNoMoreLiveThreadsThanBeforeSetup()

As the name of the method indicates, it asserts that there are no more living threads than there had been before setup.

getDefaultErrorStream

protected final PrintStream getDefaultErrorStream()

Returns the default error stream.

Returns:

The default error stream.

getDefaultOutputStream

protected final PrintStream getDefaultOutputStream()

Returns the default output stream.

Returns:

The default output stream.

hasNetwork

protected final boolean hasNetwork()

Checks whether the machine, that runs the current test, has network configured.

Returns:

true if the current machine has a network configured, false otherwise.

obtainLiveThreads

@BeforeEach
protected final void obtainLiveThreads()

References to all currently running threads will be stored.

See Also:

• m_LiveThreadsBeforeSetup
• assertThatThereAreNoMoreLiveThreadsThanBeforeSetup()

resetDefaultSettings

@BeforeEach
protected final void resetDefaultSettings()

Resets the default settings for Locale, TimeZone, and ZoneId.

See Also:

• Locale.setDefault(Locale)
• TimeZone.setDefault(TimeZone)
• ZoneId.systemDefault()

resetDefaultStreams

@AfterEach
protected final void resetDefaultStreams()

Resets the default streams.

resetSkipThreadTest

@BeforeEach
protected final void resetSkipThreadTest()

Resets the thread test flag.

saveDefaultSettings

@BeforeEach
protected final void saveDefaultSettings()

Saves the default settings for Locale, TimeZone, and ZoneId.

See Also:

• Locale.getDefault()
• TimeZone.getDefault()
• ZoneId.systemDefault()

saveDefaultStreams

@BeforeEach
protected final void saveDefaultStreams()

Saves the default streams.

skipThreadTest

public final void skipThreadTest()

Sets the thread test flag to true, disabling that test.

storeSystemProperties

@BeforeAll
protected static void storeSystemProperties()

Keep the system properties.

translateEscapes

protected final String translateEscapes(CharSequence input)

Translates the escape sequences in a String. Refer to String.translateEscapes() for the details.

Use this method to convert the input from CSV files or alike.

Parameters:

input - The input String; can be null.

Returns:

The processed String; will be null if the input was already null.

Since:

0.1.0

validateAsStaticClass

protected final boolean validateAsStaticClass(Class<?> candidate)

Validates whether a class is really a static class.

A class is static when it has the following characteristics:

• The class is final.
• All methods are static.
• Only the default constructor may exists, this has to be private, and it has to throw an Error on invocation.

If a test fails, the result is written to System.out.

The method will not check for the @UtilityClass annotation as this has only the retention level SOURCE.

Parameters:

candidate - The class to inspect.

Returns:

true if the class is in fact static, false otherwise.