com.dkfqs.tools.javatest

Class AbstractJUnitTest

java.lang.Object

com.dkfqs.tools.javatest.AbstractJUnitTest

public class AbstractJUnitTest
extends java.lang.Object

An abstract class useful for running JUnit tests on Measuring Agents. This class supports also to report additional measured data to the 'All Purpose Interface'.

Constructor Summary

Constructors

Constructor and Description
AbstractJUnitTest()

Method Summary

Modifier and Type	Method and Description
void	addAverageDeltaAndCurrentValue(long statisticId, long sumValuesDelta, long numValuesDelta, long currentValue, long currentValueTimestamp) All Purpose Interface: Add delta values to the average and set the current value for a 'average-and-current-value' statistic.
void	addCounterLong(long statisticId, long value) All Purpose Interface: Increment the counter of a declared 'cumulative-counter-long' statistic.
void	addEfficiencyRatioDelta(long statisticId, long efficiencyDeltaValue, long inefficiencyDeltaValue) All Purpose Interface: Add efficiency ratio delta values to a 'efficiency-ratio-percent' statistic.
void	addError(long statisticId, java.lang.String errorSubject, java.lang.String errorSeverity, java.lang.String errorType, java.util.List<java.lang.String> errorLogLines, java.util.List<java.lang.String> errorContextLines) All Purpose Interface: Add an error to the test result.
void	addError(long statisticId, java.lang.String errorSubject, java.lang.String errorSeverity, java.lang.String errorType, java.lang.String errorLog, java.lang.String errorContext) All Purpose Interface: Add an error to the test result.
void	addSampleError(long statisticId, java.lang.String errorSubject, java.lang.String errorSeverity, java.lang.String errorType, java.util.List<java.lang.String> errorLogLines, java.util.List<java.lang.String> errorContextLines) All Purpose Interface: Add an error to a declared statistic (for sample-event-time-chart statistics only, when measuring of a data sample did fail).
void	addSampleError(long statisticId, java.lang.String errorSubject, java.lang.String errorSeverity, java.lang.String errorType, java.lang.String errorLog, java.lang.String errorContext) All Purpose Interface: Add an error to a declared statistic (for sample-event-time-chart statistics only, when measuring of a data sample did fail).
void	addSampleLong(long statisticId, long value) All Purpose Interface: Add a measured long value to a statistic.
int	addTestResultAnnotationExecEvent(java.lang.String eventText) All Purpose Interface: Add an execution annotation event to the test result.
void	addThroughputDelta(long statisticId, double deltaValue) All Purpose Interface: Add a measured delta value to a throughput statistic.
void	closeAllPurposeInterface() Close the All Purpose Interface.
void	declareStatistic(long statisticId, java.lang.String statisticType, java.lang.String statisticTitle, java.lang.String statisticSubtitle, java.lang.String yAxisTitle, java.lang.String unitText, int sortPosition, boolean addToSummaryStatistic, java.lang.String backgroundColor) All Purpose Interface: Declare a new statistic.
static java.io.File	getArgDataOutputDirectory() Get the data output directory.
static java.lang.String	getUserInputField(java.lang.String variableName, java.lang.String defaultValue) Get the value of a user input field.
static int	getUserNumber() Get the simulated user number.
static boolean	isArgDebugExecution() Get if debug test execution is enabled.
static boolean	isArgDebugMeasuring() Get if debug data measuring is enabled.
void	openAllPurposeInterface() Open the All Purpose Interface for a specific simulated user.
void	registerSampleStart(long statisticId) All Purpose Interface: Register that the measuring of a long value sample has started

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractJUnitTest

public AbstractJUnitTest()

Method Detail

isArgDebugExecution

public static boolean isArgDebugExecution()

Get if debug test execution is enabled.

Returns:

true if debug test execution is enabled

isArgDebugMeasuring

public static boolean isArgDebugMeasuring()

Get if debug data measuring is enabled.

Returns:

true if debug data measuring is enabled

getArgDataOutputDirectory

public static java.io.File getArgDataOutputDirectory()

Get the data output directory.

Returns:

the data output directory, or null if no such information is available

getUserNumber

public static int getUserNumber()

Get the simulated user number.

Returns:

the simulated user number, or -1 if no such information is available

getUserInputField

public static java.lang.String getUserInputField(java.lang.String variableName,
                                                 java.lang.String defaultValue)

Get the value of a user input field.

Parameters:

variableName - the variable name of the user input field

defaultValue - the default value

Returns:

the value of a user input field, or the default value if the user input field is undefined

openAllPurposeInterface

public void openAllPurposeInterface()

Open the All Purpose Interface for a specific simulated user.

See Also:

getUserNumber(), closeAllPurposeInterface()

closeAllPurposeInterface

public void closeAllPurposeInterface()

Close the All Purpose Interface.

See Also:

openAllPurposeInterface()

declareStatistic

public void declareStatistic(long statisticId,
                             java.lang.String statisticType,
                             java.lang.String statisticTitle,
                             java.lang.String statisticSubtitle,
                             java.lang.String yAxisTitle,
                             java.lang.String unitText,
                             int sortPosition,
                             boolean addToSummaryStatistic,
                             java.lang.String backgroundColor)

All Purpose Interface: Declare a new statistic.

Parameters:

statisticId - the unique ID of the statistic

statisticType - the type of the statistic

statisticTitle - the title shown in the UI

statisticSubtitle - the subtitle shown in the UI, or an empty string = not shown in the UI

yAxisTitle - the Y-axis title of the diagram shown in the UI, or an empty string = not shown in the UI

unitText - the text for the measured unit shown in the UI, or an empty string = not shown in the UI

sortPosition - the UI sort position (sorting order: from small to large positions)

addToSummaryStatistic - if true = add the number of passed/failed/pending samples to the summary statistic

backgroundColor - the background color either as #hex-triplet or as bootstrap class, or an empty string = no special background color

See Also:

AbstractJavaTest.STATISTIC_TYPE_SAMPLE_EVENT_TIME_CHART, AbstractJavaTest.STATISTIC_TYPE_THROUGHPUT_TIME_CHART, AbstractJavaTest.STATISTIC_TYPE_CUMULATIVE_COUNTER_LONG, AbstractJavaTest.STATISTIC_TYPE_EFFICIENCY_RATIO_PERCENT, AbstractJavaTest.STATISTIC_TYPE_AVERAGE_AND_CURRENT_VALUE

registerSampleStart

public void registerSampleStart(long statisticId)

All Purpose Interface: Register that the measuring of a long value sample has started

Parameters:

statisticId - the unique ID of the statistic

See Also:

addSampleLong(long, long), addSampleError(long, String, String, String, String, String), AbstractJavaTest.STATISTIC_TYPE_SAMPLE_EVENT_TIME_CHART

addSampleLong

public void addSampleLong(long statisticId,
                          long value)

All Purpose Interface: Add a measured long value to a statistic.

Parameters:

statisticId - the unique ID of the statistic

value - the measured long value

See Also:

registerSampleStart(long), AbstractJavaTest.STATISTIC_TYPE_SAMPLE_EVENT_TIME_CHART

addSampleError

public void addSampleError(long statisticId,
                           java.lang.String errorSubject,
                           java.lang.String errorSeverity,
                           java.lang.String errorType,
                           java.lang.String errorLog,
                           java.lang.String errorContext)

All Purpose Interface: Add an error to a declared statistic (for sample-event-time-chart statistics only, when measuring of a data sample did fail).

Parameters:

statisticId - the unique ID of the statistic

errorSubject - the subject of the error. Note that multiple errors which contains the same subject can be grouped.

errorSeverity - the error severity

errorType - the (optional) type of the error which reflects why the error did occur. Note that multiple errors which contains the same error type can be grouped.

errorLog - the (optional) error log

errorContext - the (optional) error context that describes the circumstances under which the error occurred. It's recommended to pass a JSON object as string.

See Also:

AbstractJavaTest.ERROR_SEVERITY_WARNING, AbstractJavaTest.ERROR_SEVERITY_ERROR, AbstractJavaTest.ERROR_SEVERITY_FATAL, AbstractJavaTest.registerSampleStart(long), AbstractJavaTest.STATISTIC_TYPE_SAMPLE_EVENT_TIME_CHART

addSampleError

public void addSampleError(long statisticId,
                           java.lang.String errorSubject,
                           java.lang.String errorSeverity,
                           java.lang.String errorType,
                           java.util.List<java.lang.String> errorLogLines,
                           java.util.List<java.lang.String> errorContextLines)

All Purpose Interface: Add an error to a declared statistic (for sample-event-time-chart statistics only, when measuring of a data sample did fail).

Parameters:

statisticId - the unique ID of the statistic

errorSubject - the subject of the error. Note that multiple errors which contains the same subject can be grouped.

errorSeverity - the error severity

errorType - the (optional) type of the error which reflects why the error did occur. Note that multiple errors which contains the same error type can be grouped.

errorLogLines - the lines of the error log, or an empty list if no such data are available

errorContextLines - the lines of the error context, or an empty list if no such data are available

See Also:

AbstractJavaTest.ERROR_SEVERITY_WARNING, AbstractJavaTest.ERROR_SEVERITY_ERROR, AbstractJavaTest.ERROR_SEVERITY_FATAL, registerSampleStart(long), AbstractJavaTest.STATISTIC_TYPE_SAMPLE_EVENT_TIME_CHART

addThroughputDelta

public void addThroughputDelta(long statisticId,
                               double deltaValue)

All Purpose Interface: Add a measured delta value to a throughput statistic.

Parameters:

statisticId - the unique ID of the statistic

deltaValue - the measured delta value

See Also:

AbstractJavaTest.STATISTIC_TYPE_THROUGHPUT_TIME_CHART

addCounterLong

public void addCounterLong(long statisticId,
                           long value)

All Purpose Interface: Increment the counter of a declared 'cumulative-counter-long' statistic.

Parameters:

statisticId - the unique ID of the statistic

value - the value by which the counter is incremented

See Also:

AbstractJavaTest.STATISTIC_TYPE_CUMULATIVE_COUNTER_LONG

addEfficiencyRatioDelta

public void addEfficiencyRatioDelta(long statisticId,
                                    long efficiencyDeltaValue,
                                    long inefficiencyDeltaValue)

All Purpose Interface: Add efficiency ratio delta values to a 'efficiency-ratio-percent' statistic.

Parameters:

statisticId - the unique ID of the statistic

efficiencyDeltaValue - the efficiency delta value to add

inefficiencyDeltaValue - the inefficiency delta value to add

See Also:

AbstractJavaTest.STATISTIC_TYPE_EFFICIENCY_RATIO_PERCENT

addAverageDeltaAndCurrentValue

public void addAverageDeltaAndCurrentValue(long statisticId,
                                           long sumValuesDelta,
                                           long numValuesDelta,
                                           long currentValue,
                                           long currentValueTimestamp)

All Purpose Interface: Add delta values to the average and set the current value for a 'average-and-current-value' statistic.

Parameters:

statisticId - the unique ID of the statistic

sumValuesDelta - the sum of delta values to add to the average

numValuesDelta - the number of delta values to add to the average

currentValue - the current value, or -1 if no such data is available

currentValueTimestamp - the Unix-like timestamp of the current value, or -1 if no such data is available

See Also:

AbstractJavaTest.STATISTIC_TYPE_AVERAGE_AND_CURRENT_VALUE

addError

public void addError(long statisticId,
                     java.lang.String errorSubject,
                     java.lang.String errorSeverity,
                     java.lang.String errorType,
                     java.lang.String errorLog,
                     java.lang.String errorContext)

All Purpose Interface: Add an error to the test result. Note: do not call this method for sample-event-time-chart statistics, call instead in such a case addSampleError.

Parameters:

statisticId - the unique ID of the statistic, or -1 if this error is not bound to any statistic

errorSubject - the subject of the error. Note that multiple errors which contains the same subject can be grouped.

errorSeverity - the error severity

errorType - the (optional) type of the error which reflects why the error did occur. Note that multiple errors which contains the same error type can be grouped.

errorLog - the (optional) error log

errorContext - the (optional) error context that describes the circumstances under which the error occurred. It's recommended to pass a JSON object as string.

See Also:

AbstractJavaTest.ERROR_SEVERITY_WARNING, AbstractJavaTest.ERROR_SEVERITY_ERROR, AbstractJavaTest.ERROR_SEVERITY_FATAL, AbstractJavaTest.addError(long, String, String, String, String, String)

addError

public void addError(long statisticId,
                     java.lang.String errorSubject,
                     java.lang.String errorSeverity,
                     java.lang.String errorType,
                     java.util.List<java.lang.String> errorLogLines,
                     java.util.List<java.lang.String> errorContextLines)

All Purpose Interface: Add an error to the test result. Note: do not call this method for sample-event-time-chart statistics, call instead in such a case addSampleError.

Parameters:

statisticId - the unique ID of the statistic, or -1 if this error is not bound to any statistic

errorSubject - the subject of the error. Note that multiple errors which contains the same subject can be grouped.

errorSeverity - the error severity

errorType - the (optional) type of the error which reflects why the error did occur. Note that multiple errors which contains the same error type can be grouped.

errorLogLines - the lines of the error log, or an empty list if no such data are available

errorContextLines - the lines of the error context, or an empty list if no such data are available

See Also:

AbstractJavaTest.ERROR_SEVERITY_WARNING, AbstractJavaTest.ERROR_SEVERITY_ERROR, AbstractJavaTest.ERROR_SEVERITY_FATAL, AbstractJavaTest.addSampleError(long, String, String, String, List, List)

addTestResultAnnotationExecEvent

public int addTestResultAnnotationExecEvent(java.lang.String eventText)

All Purpose Interface: Add an execution annotation event to the test result. Note that a maximum number of 999999 events can added.

Parameters:

eventText - the event text

Returns:

the event id, or 0 if the event is ignored because too many events have already added to the test result