Class Test

Base class for all DataTrue resource types

Hierarchy

Resource
- Test

Implements

Runnable

Constructors

constructor

new Test(name: string, testType?: TestTypes, contextID?: number, options?: TestOptions): Test
Parameters
- name: string
- testType: TestTypes = TestTypes.SIMULATION
- Optional contextID: number
- options: TestOptions = {}
Returns Test
Overrides Resource.constructor
- Defined in resources/test.ts:57

Properties

`Readonly` contextType

contextType: string = "suite"

`Optional` jobID

jobID?: string

name

name: string

options

options: TestOptions = ...

testType

testType: TestTypes = TestTypes.SIMULATION

`Static` `Readonly` childTypes

childTypes: readonly string[] = ...

`Static` `Readonly` resourceType

resourceType: string = "test"

`Static` `Readonly` resourceTypeRun

resourceTypeRun: string = "TestScenario"

Methods

delete

delete(): Promise<void>
Delete the resource in DataTrue

Returns
Promise

Returns Promise<void>
Inherited from Resource.delete
- Defined in resources/resource.ts:375

deleteStep

deleteStep(index: number): void
Parameters
- index: number
Returns void
- Defined in resources/test.ts:122

deleteTagValidation

deleteTagValidation(index: number): void
Parameters
- index: number
Returns void
- Defined in resources/test.ts:126

getContextID

getContextID(): undefined | number
Gets the contextID of a resource

Returns
contextID of the resource

Returns undefined | number
Inherited from Resource.getContextID
- Defined in resources/resource.ts:84

getContextType

getContextType(): string
Gets the contextType of a resource

Returns
contextType of the resource

Returns string
Inherited from Resource.getContextType
- Defined in resources/resource.ts:93

getResourceID

getResourceID(): undefined | number
Gets the resourceID of a resource

Returns
resourceID of the resource

Returns undefined | number
Inherited from Resource.getResourceID
- Defined in resources/resource.ts:75

getSteps

getSteps(): readonly Step[]
Returns readonly Step[]
- Defined in resources/test.ts:130

getTagValidations

getTagValidations(): readonly TagValidation[]
Returns readonly TagValidation[]
- Defined in resources/test.ts:134

insertStep

insertStep(step: Step, index?: number): void
Parameters
- step: Step
- index: number = ...
Returns void
- Defined in resources/test.ts:111

insertTagValidation

insertTagValidation(tagValidation: TagValidation, index?: number): void
Parameters
- tagValidation: TagValidation
- index: number = ...
Returns void
- Defined in resources/test.ts:115

progress

progress(): Promise<JobStatus>
Retrieve the JobStatus for a resource

Returns
Promise of the JobStatus

Returns Promise<JobStatus>
Implementation of Runnable.progress
- Defined in resources/test.ts:203

report

report(): Promise<TestResultReport>
Returns Promise<TestResultReport>
- Defined in resources/test.ts:210

run

run(emailUsers?: number[], variables?: Record<string, string>): Promise<string>
Run the resource in DataTrue

Returns
Promise of the jobID
Parameters
- emailUsers: number[] = []
  
  an array of user IDs to whom the test results should be sent
- variables: Record<string, string> = {}
  
  variables to set for the test run
Returns Promise<string>
Implementation of Runnable.run
- Defined in resources/test.ts:179

save

save(): Promise<void>
Save a resource to DataTrue

Returns
Promise

Returns Promise<void>
Inherited from Resource.save
- Defined in resources/resource.ts:178

setContextID

setContextID(id: undefined | number): void
Sets the contextID of a resource
Parameters
- id: undefined | number
  
  the contextID to set
Returns void
Inherited from Resource.setContextID
- Defined in resources/resource.ts:122

setOptions

setOptions(options: TestOptions, override?: boolean): void
Set options from the passed options object
Parameters
- options: TestOptions
  
  the object to set options from
- override: boolean = false
  
  whether to override the options object
Returns void
Overrides Resource.setOptions
- Defined in resources/test.ts:148

setResourceID

setResourceID(id: undefined | number): void
Sets the resourceID of a resource
Parameters
- id: undefined | number
  
  the resourceID to set
Returns void
Inherited from Resource.setResourceID
- Defined in resources/resource.ts:102

setVariable

setVariable(name: string, type: VariableTypes, value: string): void
Parameters
- name: string
- type: VariableTypes
- value: string
Returns void
- Defined in resources/test.ts:138

toJSON

toJSON(): Promise<Record<string, any>>
Convert the resource to an Object

Returns
object representation of the resource

Returns Promise<Record<string, any>>
Overrides Resource.toJSON
- Defined in resources/test.ts:152

toString

toString(): Promise<string>
Convert the resource to a JSON string

Returns
the resource represented as a JSON string

Returns Promise<string>
Inherited from Resource.toString
- Defined in resources/resource.ts:66

`Static` fromID

fromID(id: number): Promise<Test>
Create a resource from a given ID

Returns
Promise of the resource
Parameters
- id: number
  
  the ID of the resource
Returns Promise<Test>
Overrides Resource.fromID
- Defined in resources/test.ts:67

`Static` fromJSON

fromJSON(obj: Record<string, any>, copy?: boolean): Test
Create a resource from an object

Returns
new Resource
Parameters
- obj: Record<string, any>
  
  object to create resource from
- copy: boolean = false
  
  whether to create a copy of the resource or not (removes resource IDs)
Returns Test
Overrides Resource.fromJSON
- Defined in resources/test.ts:72

Generated using TypeDoc