Package datadog.trace.api.civisibility.noop

Class NoOpDDTestModule

java.lang.Object
datadog.trace.api.civisibility.noop.NoOpDDTestModule
All Implemented Interfaces:
DDTestModule
public class NoOpDDTestModule extends Object implements DDTestModule

  • Constructor Details

    • NoOpDDTestModule

      public NoOpDDTestModule()

  • Method Details

    • setTag

      public void setTag(String key, Object value)
      Description copied from interface: DDTestModule
      Adds an arbitrary tag to the module
      Specified by:
      setTag in interface DDTestModule
      Parameters:
      key - The name of the tag
      value - The value of the tag

    • setErrorInfo

      public void setErrorInfo(Throwable error)
      Description copied from interface: DDTestModule
      Marks the module as failed.

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

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

      Specified by:
      setErrorInfo in interface DDTestModule
      Parameters:
      error - Optional exception that caused the module to fail

    • setSkipReason

      public void setSkipReason(String skipReason)
      Description copied from interface: DDTestModule
      Marks the module as skipped.

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

      Specified by:
      setSkipReason in interface DDTestModule
      Parameters:
      skipReason - Optional reason for skipping the module

    • end

      public void end(@Nullable Long endTime)
      Description copied from interface: DDTestModule
      Marks the end of module execution.

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

      The method must be called once for each module instance.

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

      Specified by:
      end in interface DDTestModule
      Parameters:
      endTime - Optional finish time in microseconds. If null is supplied, current time will be assumed

    • testSuiteStart

      public DDTestSuite testSuiteStart(String testSuiteName, @Nullable Class<?> testClass, @Nullable Long startTime, boolean parallelized)
      Description copied from interface: DDTestModule
      Marks the start of a new test suite in the module.
      Specified by:
      testSuiteStart in interface DDTestModule
      Parameters:
      testSuiteName - The name of the suite
      testClass - Optional class that corresponds to the test suite.
      startTime - Optional start time in microseconds. If null is supplied, current time will be assumed
      parallelized - Whether test cases from this suite will be executed concurrently in multiple threads
      Returns:
      Handle to the test suite instance