com.xebialabs.xlt.plugin.api.testrun

Class Event

java.lang.Object

com.xebialabs.xlt.plugin.api.testrun.Event

All Implemented Interfaces:

java.io.Serializable

public class Event
extends java.lang.Object
implements java.io.Serializable

The event is a container of test result information, either of a single test or an aggregation of multiple test. It is represented as a String to Object map, with a number of mandatory and a number of optional keys. For the invariants that apply to an event, look at the EventValidator.

See Also:

EventValidator, Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CHILD_FINISHED Deprecated.
static java.lang.String	CHILD_RUN_ID Deprecated.
static java.lang.String	CHILD_STARTED Deprecated.
static java.lang.String	CREATED_AT Timestamp when event is created.
static java.lang.String	DURATION Total duration of a test run.
static java.lang.String	EXECUTION_FINISHED Deprecated.
static java.lang.String	EXECUTION_STARTED Deprecated.
static java.lang.String	FIRST_ERROR Optional error message related to a failing test case.
static java.lang.String	HIERARCHY List of names, defining the hierarchy (namespace) levels in a test.
static java.lang.String	ID ID field used internally to track events.
static org.slf4j.Logger	LOG
static java.lang.String	MAX_RESPONSE_TIME_KO Deprecated.
static java.lang.String	MAX_RESPONSE_TIME_OK Deprecated.
static java.lang.String	MAX_RESPONSE_TIME_TOTAL Deprecated.
static java.lang.String	MEAN_RESPONSE_TIME_KO Deprecated.
static java.lang.String	MEAN_RESPONSE_TIME_OK Deprecated.
static java.lang.String	MEAN_RESPONSE_TIME_TOTAL Deprecated.
static java.lang.String	MIN_RESPONSE_TIME_KO Deprecated.
static java.lang.String	MIN_RESPONSE_TIME_OK Deprecated.
static java.lang.String	MIN_RESPONSE_TIME_TOTAL Deprecated.
static java.lang.String	NUMBER_OF_REQUESTS_KO Deprecated.
static java.lang.String	NUMBER_OF_REQUESTS_OK Deprecated.
static java.lang.String	NUMBER_OF_REQUESTS_TOTAL Deprecated.
static java.lang.String	RESULT Result ('PASSED', 'FAILED').
static java.lang.String	RUN_ID UUID to correlate all events associated with one test run.
static java.lang.String	RUN_KEY Unique identifier per test run.
static java.lang.String	SIMULATION_NAME Deprecated.
static java.lang.String	STANDARD_DEVIATION_KO Deprecated.
static java.lang.String	STANDARD_DEVIATION_OK Deprecated.
static java.lang.String	STANDARD_DEVIATION_TOTAL Deprecated.
static java.lang.String	TAGS User tags, added by users.
static java.lang.String	TEST_SPECIFICATION ID of the Test Specification associated with this event (and therefore the test run).
static java.lang.String	TESTED_AT Timestamp of the moment the tests have been executed.
static java.lang.String	TYPE Type of event.
static java.lang.String	TYPE_FUNCTIONAL_RESULT
static java.lang.String	TYPE_IMPORT_FINISHED
static java.lang.String	TYPE_IMPORT_STARTED
static java.lang.String	TYPE_PERFORMANCE_RESULT
static java.lang.String	TYPE_UNKNOWN

Constructor Summary

Constructors

Constructor and Description
Event(Event event, java.util.Map<java.lang.String,java.lang.Object> properties)
Event(java.util.Map<java.lang.String,java.lang.Object> properties) Create a new event based on the supplied map of properties.
Event(java.lang.String type) Create a new blank event with a specified type
Event(java.lang.String type, java.util.Map<java.lang.String,java.lang.Object> properties)

Method Summary

Methods

Modifier and Type	Method and Description
static Event	create(java.lang.String type, java.lang.Object... properties) Creates a new event with type and properties.
static Event	createImportFinishedEvent(int duration) Creates a new import finished event with given duration.
static Event	createImportStartedEvent() Creates a new import started event.
static Event	createImportStartedEvent(long testedAt) Creates a new import started event.
boolean	equals(java.lang.Object o)
<T> T	get(java.lang.String key)
long	getCreatedAt()
int	getDuration() Get the duration in milliseconds.
java.lang.String	getFirstError()
java.util.List<java.lang.String>	getHierarchy()
java.lang.String	getId()
long	getMaxResponseTime()
long	getMaxResponseTimeNotOk()
long	getMaxResponseTimeOk()
long	getMeanResponseTime()
long	getMeanResponseTimeNotOk()
long	getMeanResponseTimeOk()
long	getMinResponseTime()
long	getMinResponseTimeNotOk()
long	getMinResponseTimeOk()
java.util.Map<java.lang.String,java.lang.Object>	getProperties()
<T> T	getRequired(java.lang.String key)
java.lang.String	getResult()
java.lang.String	getRunKey()
java.lang.String	getSimulationName()
double	getStandardDeviation()
double	getStandardDeviationNotOk()
double	getStandardDeviationOk()
java.util.List<java.lang.String>	getTags()
long	getTestedAt()
java.lang.String	getTestRunId()
java.lang.String	getTestSpecificationName() This is the last part of the JCR ID of a test specification.
java.util.Date	getTimestampAsDate()
long	getTotalNumberOfNotOkRequests()
long	getTotalNumberOfOkRequests()
long	getTotalNumberOfRequests()
java.lang.String	getType()
int	hashCode()
boolean	hasProperty(java.lang.String key)
boolean	isFunctionalResult()
boolean	isOfType(java.lang.String type)
boolean	isResult(java.lang.String result)
static java.util.Map<java.lang.String,java.lang.Object>	props(java.util.Map<java.lang.String,java.lang.Object> map, java.lang.Object... keyValues)
static java.util.Map<java.lang.String,java.lang.Object>	props(java.lang.Object... keyValues)
void	remove(java.lang.String key)
Event	setCreatedAt(long timestamp) Sets the create date of this event.
Event	setDuration(int totalDuration)
Event	setFailureReason(java.lang.String message)
Event	setFirstError(java.lang.String firstError)
Event	setMaxResponseTime(long maxResponseTime)
Event	setMaxResponseTimeNotOk(long maxResponseTimeNotOk)
Event	setMaxResponseTimeOk(long maxResponseTimeOk)
Event	setMeanResponseTime(long meanResponseTime)
Event	setMeanResponseTimeNotOk(long meanResponseTimeNotOk)
Event	setMeanResponseTimeOk(long meanResponseTimeOk)
Event	setMinResponseTime(long minResponseTime)
Event	setMinResponseTimeNotOk(long minResponseTimeNotOk)
Event	setMinResponseTimeOk(long minResponseTimeOk)
Event	setResult(java.lang.String result)
Event	setRunKey(java.lang.String runKey)
Event	setSimulationName(java.lang.String simulationName)
Event	setStandardDeviation(double standardDeviation)
Event	setStandardDeviationNotOk(double standardDeviationNotOk)
Event	setStandardDeviationOk(double standardDeviationOk)
Event	setTags(java.util.List<java.lang.String> tags)
Event	setTestedAt(long testedAt)
Event	setTestRunId(java.lang.String testRunId)
Event	setTestSpecificationName(java.lang.String testSpecificationName)
Event	setTotalNumberOfNotOkRequests(long totalNumberOfNotOkRequests)
Event	setTotalNumberOfOkRequests(long totalNumberOfOkRequests)
Event	setTotalNumberOfRequests(long totalNumberOfRequests)
java.lang.String	toString()
Event	update(java.lang.String key, java.lang.Object value)
Event	updateWithProperties(java.util.Map<java.lang.String,java.lang.Object> otherProperties)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

LOG

public static final org.slf4j.Logger LOG

ID

public static final java.lang.String ID

ID field used internally to track events.

See Also:

Constant Field Values

RUN_ID

public static final java.lang.String RUN_ID

UUID to correlate all events associated with one test run.

See Also:

Constant Field Values

CREATED_AT

public static final java.lang.String CREATED_AT

Timestamp when event is created.

See Also:

Constant Field Values

TYPE

public static final java.lang.String TYPE

Type of event.

See Also:

Constant Field Values

TEST_SPECIFICATION

public static final java.lang.String TEST_SPECIFICATION

ID of the Test Specification associated with this event (and therefore the test run).

See Also:

Constant Field Values

TESTED_AT

public static final java.lang.String TESTED_AT

Timestamp of the moment the tests have been executed.

See Also:

Constant Field Values

RUN_KEY

public static final java.lang.String RUN_KEY

Unique identifier per test run. This identifier should be unique in the context of a test specification. Used by test tools to prevent duplicate imports.

Note: This is not the same as the test run ID.

See Also:

Constant Field Values

TAGS

public static final java.lang.String TAGS

User tags, added by users.

See Also:

Constant Field Values

EXECUTION_STARTED

@Deprecated
public static final java.lang.String EXECUTION_STARTED

Deprecated.

Deprecated only use TYPE_IMPORT_STARTED.

See Also:

Constant Field Values

EXECUTION_FINISHED

@Deprecated
public static final java.lang.String EXECUTION_FINISHED

Deprecated.

Deprecated only use TYPE_IMPORT_FINISHED.

See Also:

Constant Field Values

TYPE_IMPORT_STARTED

public static final java.lang.String TYPE_IMPORT_STARTED

See Also:

Constant Field Values

TYPE_IMPORT_FINISHED

public static final java.lang.String TYPE_IMPORT_FINISHED

See Also:

Constant Field Values

TYPE_FUNCTIONAL_RESULT

public static final java.lang.String TYPE_FUNCTIONAL_RESULT

See Also:

Constant Field Values

TYPE_PERFORMANCE_RESULT

public static final java.lang.String TYPE_PERFORMANCE_RESULT

See Also:

Constant Field Values

TYPE_UNKNOWN

public static final java.lang.String TYPE_UNKNOWN

See Also:

Constant Field Values

DURATION

public static final java.lang.String DURATION

Total duration of a test run. Used in 'importFinished' and 'functionalResult' events.

See Also:

Constant Field Values

RESULT

public static final java.lang.String RESULT

Result ('PASSED', 'FAILED'). Used by 'functionalResult' events.

See Also:

Constant Field Values

FIRST_ERROR

public static final java.lang.String FIRST_ERROR

Optional error message related to a failing test case. Used by 'functionalResult' events.

See Also:

Constant Field Values

HIERARCHY

public static final java.lang.String HIERARCHY

List of names, defining the hierarchy (namespace) levels in a test. Used by 'functionalResult' events.

See Also:

Constant Field Values

SIMULATION_NAME

@Deprecated
public static final java.lang.String SIMULATION_NAME

Deprecated.

See Also:

Constant Field Values

NUMBER_OF_REQUESTS_TOTAL

@Deprecated
public static final java.lang.String NUMBER_OF_REQUESTS_TOTAL

Deprecated.

See Also:

Constant Field Values

NUMBER_OF_REQUESTS_OK

@Deprecated
public static final java.lang.String NUMBER_OF_REQUESTS_OK

Deprecated.

See Also:

Constant Field Values

NUMBER_OF_REQUESTS_KO

@Deprecated
public static final java.lang.String NUMBER_OF_REQUESTS_KO

Deprecated.

See Also:

Constant Field Values

MIN_RESPONSE_TIME_TOTAL

@Deprecated
public static final java.lang.String MIN_RESPONSE_TIME_TOTAL

Deprecated.

See Also:

Constant Field Values

MIN_RESPONSE_TIME_OK

@Deprecated
public static final java.lang.String MIN_RESPONSE_TIME_OK

Deprecated.

See Also:

Constant Field Values

MIN_RESPONSE_TIME_KO

@Deprecated
public static final java.lang.String MIN_RESPONSE_TIME_KO

Deprecated.

See Also:

Constant Field Values

MAX_RESPONSE_TIME_TOTAL

@Deprecated
public static final java.lang.String MAX_RESPONSE_TIME_TOTAL

Deprecated.

See Also:

Constant Field Values

MEAN_RESPONSE_TIME_TOTAL

@Deprecated
public static final java.lang.String MEAN_RESPONSE_TIME_TOTAL

Deprecated.

See Also:

Constant Field Values

MAX_RESPONSE_TIME_OK

@Deprecated
public static final java.lang.String MAX_RESPONSE_TIME_OK

Deprecated.

See Also:

Constant Field Values

MAX_RESPONSE_TIME_KO

@Deprecated
public static final java.lang.String MAX_RESPONSE_TIME_KO

Deprecated.

See Also:

Constant Field Values

MEAN_RESPONSE_TIME_OK

@Deprecated
public static final java.lang.String MEAN_RESPONSE_TIME_OK

Deprecated.

See Also:

Constant Field Values

MEAN_RESPONSE_TIME_KO

@Deprecated
public static final java.lang.String MEAN_RESPONSE_TIME_KO

Deprecated.

See Also:

Constant Field Values

STANDARD_DEVIATION_TOTAL

@Deprecated
public static final java.lang.String STANDARD_DEVIATION_TOTAL

Deprecated.

See Also:

Constant Field Values

STANDARD_DEVIATION_OK

@Deprecated
public static final java.lang.String STANDARD_DEVIATION_OK

Deprecated.

See Also:

Constant Field Values

STANDARD_DEVIATION_KO

@Deprecated
public static final java.lang.String STANDARD_DEVIATION_KO

Deprecated.

See Also:

Constant Field Values

CHILD_RUN_ID

@Deprecated
public static final java.lang.String CHILD_RUN_ID

Deprecated.

See Also:

Constant Field Values

CHILD_FINISHED

@Deprecated
public static final java.lang.String CHILD_FINISHED

Deprecated.

See Also:

Constant Field Values

CHILD_STARTED

@Deprecated
public static final java.lang.String CHILD_STARTED

Deprecated.

See Also:

Constant Field Values

Constructor Detail

Event

public Event(java.util.Map<java.lang.String,java.lang.Object> properties)

Create a new event based on the supplied map of properties. If CREATED_AT is not given, the current time will be set.

Parameters:

properties -

Event

public Event(java.lang.String type)

Create a new blank event with a specified type

Parameters:

type - The event type. Should be one of TYPE_IMPORT_STARTED, TYPE_FUNCTIONAL_RESULT, TYPE_PERFORMANCE_RESULT or TYPE_IMPORT_FINISHED.

Event

public Event(java.lang.String type,
     java.util.Map<java.lang.String,java.lang.Object> properties)

Event

public Event(Event event,
     java.util.Map<java.lang.String,java.lang.Object> properties)

Method Detail

getType

public java.lang.String getType()

isOfType

public boolean isOfType(java.lang.String type)

update

public Event update(java.lang.String key,
           java.lang.Object value)

updateWithProperties

public Event updateWithProperties(java.util.Map<java.lang.String,java.lang.Object> otherProperties)

get

public <T> T get(java.lang.String key)

getRequired

public <T> T getRequired(java.lang.String key)

hasProperty

public boolean hasProperty(java.lang.String key)

getProperties

public java.util.Map<java.lang.String,java.lang.Object> getProperties()

props

public static java.util.Map<java.lang.String,java.lang.Object> props(java.util.Map<java.lang.String,java.lang.Object> map,
                                                     java.lang.Object... keyValues)

props

public static java.util.Map<java.lang.String,java.lang.Object> props(java.lang.Object... keyValues)

getId

public java.lang.String getId()

getTestSpecificationName

public java.lang.String getTestSpecificationName()

This is the last part of the JCR ID of a test specification.

setTestSpecificationName

public Event setTestSpecificationName(java.lang.String testSpecificationName)

getTimestampAsDate

public java.util.Date getTimestampAsDate()

getCreatedAt

public long getCreatedAt()

setCreatedAt

public Event setCreatedAt(long timestamp)

Sets the create date of this event. Not to be used by test parsers.

Parameters:

timestamp - number of milliseconds

Returns:

the event

setTestedAt

public Event setTestedAt(long testedAt)

getTestedAt

public long getTestedAt()

setDuration

public Event setDuration(int totalDuration)

getDuration

public int getDuration()

Get the duration in milliseconds.

getResult

public java.lang.String getResult()

setResult

public Event setResult(java.lang.String result)

getFirstError

public java.lang.String getFirstError()

setFirstError

public Event setFirstError(java.lang.String firstError)

getTotalNumberOfRequests

public long getTotalNumberOfRequests()

setTotalNumberOfRequests

public Event setTotalNumberOfRequests(long totalNumberOfRequests)

setTotalNumberOfOkRequests

public Event setTotalNumberOfOkRequests(long totalNumberOfOkRequests)

getTotalNumberOfOkRequests

public long getTotalNumberOfOkRequests()

setTotalNumberOfNotOkRequests

public Event setTotalNumberOfNotOkRequests(long totalNumberOfNotOkRequests)

getTotalNumberOfNotOkRequests

public long getTotalNumberOfNotOkRequests()

setMinResponseTime

public Event setMinResponseTime(long minResponseTime)

getMinResponseTime

public long getMinResponseTime()

setMinResponseTimeOk

public Event setMinResponseTimeOk(long minResponseTimeOk)

getMinResponseTimeOk

public long getMinResponseTimeOk()

setMinResponseTimeNotOk

public Event setMinResponseTimeNotOk(long minResponseTimeNotOk)

getMinResponseTimeNotOk

public long getMinResponseTimeNotOk()

setMaxResponseTime

public Event setMaxResponseTime(long maxResponseTime)

getMaxResponseTime

public long getMaxResponseTime()

setMaxResponseTimeOk

public Event setMaxResponseTimeOk(long maxResponseTimeOk)

getMaxResponseTimeOk

public long getMaxResponseTimeOk()

setMaxResponseTimeNotOk

public Event setMaxResponseTimeNotOk(long maxResponseTimeNotOk)

getMaxResponseTimeNotOk

public long getMaxResponseTimeNotOk()

setMeanResponseTime

public Event setMeanResponseTime(long meanResponseTime)

getMeanResponseTime

public long getMeanResponseTime()

setMeanResponseTimeOk

public Event setMeanResponseTimeOk(long meanResponseTimeOk)

getMeanResponseTimeOk

public long getMeanResponseTimeOk()

setMeanResponseTimeNotOk

public Event setMeanResponseTimeNotOk(long meanResponseTimeNotOk)

getMeanResponseTimeNotOk

public long getMeanResponseTimeNotOk()

getStandardDeviation

public double getStandardDeviation()

setStandardDeviation

public Event setStandardDeviation(double standardDeviation)

getStandardDeviationOk

public double getStandardDeviationOk()

setStandardDeviationOk

public Event setStandardDeviationOk(double standardDeviationOk)

getStandardDeviationNotOk

public double getStandardDeviationNotOk()

setStandardDeviationNotOk

public Event setStandardDeviationNotOk(double standardDeviationNotOk)

setSimulationName

public Event setSimulationName(java.lang.String simulationName)

getSimulationName

public java.lang.String getSimulationName()

setFailureReason

public Event setFailureReason(java.lang.String message)

getTestRunId

public java.lang.String getTestRunId()

setTestRunId

public Event setTestRunId(java.lang.String testRunId)

setRunKey

public Event setRunKey(java.lang.String runKey)

getRunKey

public java.lang.String getRunKey()

setTags

public Event setTags(java.util.List<java.lang.String> tags)

getTags

public java.util.List<java.lang.String> getTags()

create

public static Event create(java.lang.String type,
           java.lang.Object... properties)

Creates a new event with type and properties. Properties should be an array alternating keys with values. The length should always be even, and all even elements should be Strings.

Parameters:

type - The event type. Should be one of TYPE_IMPORT_STARTED, TYPE_FUNCTIONAL_RESULT, TYPE_PERFORMANCE_RESULT or TYPE_IMPORT_FINISHED.

properties - Even number of properties, alternating keys and values.

createImportStartedEvent

public static Event createImportStartedEvent()

Creates a new import started event.

Returns:

An import started event.

createImportStartedEvent

public static Event createImportStartedEvent(long testedAt)

Creates a new import started event.

Parameters:

testedAt - test time in milliseconds since and midnight, January 1, 1970 UTC.

Returns:

An import started event.

createImportFinishedEvent

public static Event createImportFinishedEvent(int duration)

Creates a new import finished event with given duration.

Parameters:

duration - the duration of the test run in milliseconds.

Returns:

An import finished event.

getHierarchy

public java.util.List<java.lang.String> getHierarchy()

remove

public void remove(java.lang.String key)

isFunctionalResult

public boolean isFunctionalResult()

isResult

public boolean isResult(java.lang.String result)

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object