datadog.trace.api.civisibility.noop

Class NoOpDDTestSession

java.lang.Object

datadog.trace.api.civisibility.noop.NoOpDDTestSession

All Implemented Interfaces:

DDTestSession

public class NoOpDDTestSession
extends Object
implements DDTestSession

Field Summary

Fields

Modifier and Type	Field and Description
static DDTestSession	INSTANCE

Constructor Summary

Constructors

Constructor and Description
NoOpDDTestSession()

Method Summary

Modifier and Type	Method and Description
void	end(Long endTime) Marks the end of tests execution.
void	setErrorInfo(Throwable error) Marks the session as failed.
void	setSkipReason(String skipReason) Marks the entire execution as skipped.
void	setTag(String key, Object value) Adds an arbitrary tag to the session
DDTestModule	testModuleStart(String moduleName, Long startTime) Marks the start of a new module.

Methods inherited from class java.lang.Object

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

Field Detail

INSTANCE

public static final DDTestSession INSTANCE

Constructor Detail

NoOpDDTestSession

public NoOpDDTestSession()

Method Detail

setTag

public void setTag(String key,
                   Object value)

Description copied from interface: DDTestSession

Adds an arbitrary tag to the session

Specified by:

setTag in interface DDTestSession

Parameters:

key - The name of the tag

value - The value of the tag

setErrorInfo

public void setErrorInfo(Throwable error)

Description copied from interface: DDTestSession

Marks the session as failed.

This method should be used to signal a failure that is not related to a specific module or a test suite, but rather to the tests execution as a whole (e.g. a failure in a setup/teardown logic that is executed once for the entire project). If an individual module in the project fails, there is no need to explicitly signal it to the session object: the status of the session will reflect individual module failures automatically.

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

Specified by:

setErrorInfo in interface DDTestSession

Parameters:

error - Optional exception that caused the execution to fail

setSkipReason

public void setSkipReason(String skipReason)

Description copied from interface: DDTestSession

Marks the entire execution as skipped.

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

Specified by:

setSkipReason in interface DDTestSession

Parameters:

skipReason - Optional reason for skipping execution

end

public void end(@Nullable
                Long endTime)

Description copied from interface: DDTestSession

Marks the end of tests execution.

Unless either DDTestSession.setErrorInfo(Throwable) or DDTestSession.setSkipReason(String) were invoked prior to calling this method, the status of the execution will be calculated based on the statuses of individual modules that were run in scope of the session.

The method must be called once for each session instance.

The call does not have to be made in the same thread where the session was started.

Specified by:

end in interface DDTestSession

Parameters:

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

testModuleStart

public DDTestModule testModuleStart(String moduleName,
                                    @Nullable
                                    Long startTime)

Description copied from interface: DDTestSession

Marks the start of a new module.

Specified by:

testModuleStart in interface DDTestSession

Parameters:

moduleName - The name of the module

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

Returns:

Handle to the module instance