Interface IActiveTest

Namespace

Acuit.Pinpoint.Workflows.Testing

Assembly

Acuit.Pinpoint.Workflows.Testing.dll

An active test.

public interface IActiveTest

Extension Methods

IActiveTestExtensions.GetElapsedTime(IActiveTest, ITimeService)

IActiveTestExtensions.SetDataItem(IActiveTest, CustomTestDataItem)

IActiveTestExtensions.SetDataItem(IActiveTest, string, object)

IActiveTestExtensions.SetDataItem(IActiveTest, string, object, CustomTestDataStatus)

IActiveTestExtensions.SetDataItem(IActiveTest, string, object, CustomTestDataStatus, string)

Remarks

This is a service that RecordTest provides for other activities can use to access the active test.

Properties

DataItems

Gets the list of data items.

IList<CustomTestDataItem> DataItems { get; }

Property Value

IList<CustomTestDataItem>

Remarks

This data will be saved with the test result as they exist when CompleteTest(bool, string, string) is called.

EndDateTime

Gets the date/time that the test ended, or null if it has not yet ended.

DateTimeOffset? EndDateTime { get; }

Property Value

DateTimeOffset?

Remarks

Note that the test type saved in the unit record should be close to this, but not exactly the same, as this is the date/time from the local workstation clock when the test was ended via the test workflow, while the unit record test type is assigned from the Acuit Pinpoint Server clock when it adds the test result to the unit record.

Log

Gets the test log.

ITestLog Log { get; }

Property Value

ITestLog

Remarks

The test log is for reference only (e.g., for display on the screen). It is not saved with the test result when CompleteTest(bool, string, string) is called.

StartDateTime

Gets the date/time that the test was started.

DateTimeOffset StartDateTime { get; }

Property Value

DateTimeOffset

TestTypeName

Gets the test type name.

string TestTypeName { get; }

Property Value

string

Methods

CompleteTest(bool, string, string)

Completes the test, saving the test result with the unit record.

void CompleteTest(bool passed, string reason, string notes)

Parameters

passed bool

true if the test passed, or false if the test false.

reason string

An optional reason for the test failure.

notes string

Optional notes.

Remarks

If this test is not associated with a particular unit (which is the case for manual tests), this will do nothing.

This is automatically called by the RecordTest activity. Other activities should normally not call this directly.

Exceptions

InvalidOperationException

The test has already been completed.

Exception

The test result could not be saved for the unit (e.g., a Acuit Pinpoint Server communication error occurred, or Acuit Pinpoint Server returned a fault).