datadog.trace.api.civisibility

Interface DDTest

All Known Implementing Classes:

NoOpDDTest

public interface DDTest

This interface represent an individual test case. Typically, a test case corresponds to a method that contains the test logic.

Method Summary

Modifier and Type	Method and Description
void	end(Long endTime) Marks the end of test execution.
void	setErrorInfo(Throwable error) Marks the test as failed.
void	setSkipReason(String skipReason) Marks the test as skipped.
void	setTag(String key, Object value) Adds an arbitrary tag to the test

Method Detail

setTag

void setTag(String key,
            Object value)

Adds an arbitrary tag to the test

Parameters:

key - The name of the tag

value - The value of the tag

setErrorInfo

void setErrorInfo(@Nullable
                  Throwable error)

Marks the test as failed.

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

Parameters:

error - Optional exception that caused the test to fail

setSkipReason

void setSkipReason(@Nullable
                   String skipReason)

Marks the test as skipped.

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

Parameters:

skipReason - Optional reason for skipping the test

end

void end(@Nullable
         Long endTime)

Marks the end of test execution.

Unless either setErrorInfo(Throwable) or setSkipReason(String) were invoked prior to calling this method, the test is assumed to have finished successfully.

The method must be called once for each test instance.

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

Parameters:

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