com.xebialabs.xlt.plugin.api.testrun

Interface TestRunsRepository

public interface TestRunsRepository

TestRunsRepository is the entry point for test run information. Test runs are organized around lists of events. An event denoting a single fact in a test run: import started, import finished, functional result, etc.

NOTE: When searching for multi-value information, such as the Event.HIERARCHY field, the order in which those values are ordered has no significance. For now, we assume test suites do not have names that can be mixed, such as [ "xebialabs", "com", "TestSuite" ], [ "com", "xebialabs", "TestSuite" ], [ "com", "xebialabs", "intermediate", "TestSuite" ]. When performing a query on [ "com", "xebialabs", "TestSuite" ], all three fields will be considered a hit.

Method Summary

Modifier and Type	Method and Description
java.util.List<Event>	getEventsBetween(long startTime, long endTime, java.util.Map<java.lang.String,java.lang.Object> propertyFilter)
java.util.List<Event>	getEventsForTestRun(TestRun testRun, java.util.Map<java.lang.String,java.lang.Object> propertyFilter)
java.util.List<TestRun>	getLaterTestRuns(TestRun testRun, int max) Get at most max TestRuns after 'testRun'.
Event	getLatestEventOfType(java.lang.String testSpecificationName, java.lang.String eventType, long startTime, long endTime) Find the most recent event within the given time span of a particular type.
TestRun	getLatestTestRun(java.lang.String testSpecificationName, long startTime)
TestRun	getLatestTestRun(java.lang.String testSpecificationName, long startTime, long endTime)
java.util.List<TestRun>	getPreviousTestRuns(TestRun testRun, int max) Get at most max TestRuns before 'testRun'.
java.util.List<Event>	getResultEventsThatChangedFromLastRun(TestRun testRun) Deprecated.
TestRun	getTestRun(java.lang.String testRunId)
java.util.List<TestRun>	getTestRuns(java.util.Map<java.lang.String,java.lang.Object> eventParameters, long startTime, long endTime) Obtain all test runs within the given time span, based on a specific set of event parameters.
java.util.List<TestRun>	getTestRunsBetween(java.lang.String testSpecificationName, long startTime, long endTime) Obtain all test runs within the given time span.
boolean	hasTestRuns(java.lang.String testSpecificationName) Returns true if the test specification has at least one complete test run.
void	refreshIndex() Calls the index on Elastic Search to ensure data consistency.

Method Detail

getTestRun

TestRun getTestRun(java.lang.String testRunId)

getLatestTestRun

TestRun getLatestTestRun(java.lang.String testSpecificationName,
                         long startTime,
                         long endTime)

getLatestTestRun

TestRun getLatestTestRun(java.lang.String testSpecificationName,
                         long startTime)

getPreviousTestRuns

java.util.List<TestRun> getPreviousTestRuns(TestRun testRun,
                                            int max)

Get at most max TestRuns before 'testRun'.

Parameters:

testRun - a test run

max - the maximum number of test runs to retrieve.

Returns:

the test runs in descending order by tested at time.

getLaterTestRuns

java.util.List<TestRun> getLaterTestRuns(TestRun testRun,
                                         int max)

Get at most max TestRuns after 'testRun'. Keep max as small as possible to reduce performance overhead.

Parameters:

testRun - a test run

max - maximum number of runs to return.

Returns:

the test runs in ascending order by tested at time.

getTestRunsBetween

java.util.List<TestRun> getTestRunsBetween(java.lang.String testSpecificationName,
                                           long startTime,
                                           long endTime)

Obtain all test runs within the given time span.

Parameters:

testSpecificationName - name (identifier) of the test specification to look for

startTime - start of the time interval to query for results

endTime - end of the time interval to query for results

Returns:

the test runs. The results are ordered in chronological order (oldest first).

hasTestRuns

boolean hasTestRuns(java.lang.String testSpecificationName)

Returns true if the test specification has at least one complete test run.

Parameters:

testSpecificationName - name (identifier) of the test specification to look for.

Returns:

true if the test specification has at least one complete test run.

Since:

1.4.0

getTestRuns

java.util.List<TestRun> getTestRuns(java.util.Map<java.lang.String,java.lang.Object> eventParameters,
                                    long startTime,
                                    long endTime)

Obtain all test runs within the given time span, based on a specific set of event parameters.

Parameters:

eventParameters - parameters on 'importStarted' or 'executionStarted' events that should match

startTime - start of the time interval to query for results

endTime - end of the time interval to query for results

Returns:

A list of test runs. The results are ordered in chronological order (oldest first)

getLatestEventOfType

Event getLatestEventOfType(java.lang.String testSpecificationName,
                           java.lang.String eventType,
                           long startTime,
                           long endTime)

Find the most recent event within the given time span of a particular type.

Parameters:

testSpecificationName - name (identifier) of the test specification to look for

eventType - type of event. E.g. 'importStarted', 'functionalResult'.

startTime - start of the time interval to query for results

endTime - end of the time interval to query for results

Returns:

the event or null if no event can be found

getEventsBetween

java.util.List<Event> getEventsBetween(long startTime,
                                       long endTime,
                                       java.util.Map<java.lang.String,java.lang.Object> propertyFilter)

Parameters:

startTime - start of the time interval to query for results

endTime - end of the time interval to query for results

propertyFilter - A map { field: value }. Note that multi-value fields (such as lists) are handled as described in the note above.

Returns:

a list of events, ordered in chronological order (oldest first)

getEventsForTestRun

java.util.List<Event> getEventsForTestRun(TestRun testRun,
                                          java.util.Map<java.lang.String,java.lang.Object> propertyFilter)

Parameters:

testRun - The test run whose events should be queried for

propertyFilter - A map { field: value }. Note that multi-value fields (such as lists) are handled as described in the note above.

Returns:

a list of events, ordered in chronological order (oldest first)

getResultEventsThatChangedFromLastRun

@Deprecated
java.util.List<Event> getResultEventsThatChangedFromLastRun(TestRun testRun)

Deprecated.

A list of functional events that changed state with their previous test run. This function is only applicable for functional test runs.

Returns:

a list of events, ordered in chronological order (oldest first)

refreshIndex

void refreshIndex()

Calls the index on Elastic Search to ensure data consistency.

This API is *not* for public use.