datadog.trace.api.civisibility

Interface DDTestSuite

All Known Implementing Classes:

NoOpDDTestSuite

public interface DDTestSuite

This interface represents a test suite, i.e. a set of related test cases. Typically, a test suite corresponds to a class that contains a number of test method

Method Summary

Modifier and Type	Method and Description
void	end(Long endTime) Marks the end of suite execution.
void	setErrorInfo(Throwable error) Marks the suite as failed.
void	setSkipReason(String skipReason) Marks the suite as skipped.
void	setTag(String key, Object value) Adds an arbitrary tag to the suite
DDTest	testStart(String testName, Method testMethod, Long startTime) Marks the start of a new test case in the suite.

Method Detail

setTag

void setTag(String key,
            Object value)

Adds an arbitrary tag to the suite

Parameters:

key - The name of the tag

value - The value of the tag

setErrorInfo

void setErrorInfo(Throwable error)

Marks the suite as failed.

This method should be used to signal a failure that is not related to a specific test case, but rather to the suite as a whole (e.g. a failure in a setup/teardown method whose scope is entire suite). If an individual test case in the suite fails, there is no need to explicitly signal it to the suite object: the status of the suite will reflect individual test case failures automatically.

This does not imply the end of suite execution, so end(Long) method has to be invoked at some point after this one.

Parameters:

error - Optional exception that caused the suite to fail

setSkipReason

void setSkipReason(String skipReason)

Marks the suite as skipped.

This does not imply the end of suite execution, so end(Long) method has to be invoked at some point after this one.

Parameters:

skipReason - Optional reason for skipping the suite

end

void end(@Nullable
         Long endTime)

Marks the end of suite execution.

Unless either setErrorInfo(Throwable) or setSkipReason(String) were invoked prior to calling this method, the status of the suite will be calculated based on the statuses of individual test cases that were executed in scope of the suite.

The method must be called once for each suite instance.

The call has to be made in the same thread where the suite was started.

Parameters:

endTime - Optional finish time in microseconds. If null is supplied, current time will be assumed

testStart

DDTest testStart(String testName,
                 @Nullable
                 Method testMethod,
                 @Nullable
                 Long startTime)

Marks the start of a new test case in the suite.

Parameters:

testName - The name of the test case

testMethod - Optional method that corresponds to the test case

startTime - Optional start time in microseconds. If null is supplied, current time will be assumed

Returns:

Handle to the test case instance