Skip to content

BH.oM.Test.Results.TestResult

Class structure

Implemented interfaces and base types

The TestResult is inheriting from the following base type(s) and implements the following interfaces:

Properties

Defining properties

The following properties are defined on the class

Name Type Description Quantity
Description string Describes the focus of the test that this Test Result answers. This is typically for CI processes but should be human readable for ease of use. -
Status TestStatus States whether the test was a success or not. Defaults to Error to ensure any defaults are investigated appropriately. -
Information List<ITestInformation> Information generated during the test. -
Message string A human readable message explaining why this Test Result has turned out the way it has, with potential solutions or links to associated wiki pages. -
UTCTime DateTime Provides the UTC time of when the Test Result was executed. -
ID string Machine readable identifier for the Test Result. -

Code and Schema

C# implementation

C#
public class TestResult : BH.oM.Test.ITestInformation, BH.oM.Base.IObject

Assembly: Test_oM.dll

The C# class definition is available on github:

All history and changes of the class can be found by inspection the history.

JSON Schema implementation

The object is defined as a JSON schema. You can validate a JSON instance against this schema by reference. To do this, use the schema reference below in a validator like this one.

JSON Schema
{
 "$ref" : "https://raw.githubusercontent.com/BHoM/BHoM_JSONSchema/develop/Test_oM/Results/TestResult.json"
}

The JSON Schema is available on github here: