Class Test

Hierarchy

Resource
- Test

Implements

Runnable

Constructors

constructor

new Test(name: string, testType?: TestTypes, contextID?: number, options?: TestOptions): Test

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

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>

Inherited from Resource.delete
- Defined in resources/resource.ts:375
Delete the resource in DataTrue

Returns Promise<void>
Promise

deleteStep

deleteStep(index: number): void

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

deleteTagValidation

deleteTagValidation(index: number): void

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

getContextID

getContextID(): undefined | number

Inherited from Resource.getContextID
- Defined in resources/resource.ts:84
Gets the contextID of a resource

Returns undefined | number
contextID of the resource

getContextType

getContextType(): string

Inherited from Resource.getContextType
- Defined in resources/resource.ts:93
Gets the contextType of a resource

Returns string
contextType of the resource

getResourceID

getResourceID(): undefined | number

Inherited from Resource.getResourceID
- Defined in resources/resource.ts:75
Gets the resourceID of a resource

Returns undefined | number
resourceID of the resource

getSteps

getSteps(): readonly Step[]

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

getTagValidations

getTagValidations(): readonly TagValidation[]

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

insertStep

insertStep(step: Step, index?: number): void

- Defined in resources/test.ts:111
Parameters
- step: Step
- index: number = ...
Returns void

insertTagValidation

insertTagValidation(tagValidation: TagValidation, index?: number): void

- Defined in resources/test.ts:115
Parameters
- tagValidation: TagValidation
- index: number = ...
Returns void

progress

progress(): Promise<JobStatus>

Implementation of Runnable.progress
- Defined in resources/test.ts:203
Retrieve the JobStatus for a resource

Returns Promise<JobStatus>
Promise of the JobStatus

report

report(): Promise<TestResultReport>

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

run

run(emailUsers?: number[], variables?: Record<string, string>): Promise<string>

Implementation of Runnable.run
- Defined in resources/test.ts:179
Run the resource in DataTrue

Parameters
- emailUsers: number[] = []
- variables: Record<string, string> = {}
Returns Promise<string>
Promise of the jobID

save

save(): Promise<void>

Inherited from Resource.save
- Defined in resources/resource.ts:178
Save a resource to DataTrue

Returns Promise<void>
Promise

setContextID

setContextID(id: undefined | number): void

Inherited from Resource.setContextID
- Defined in resources/resource.ts:122
Sets the contextID of a resource

Parameters
- id: undefined | number
  
  the contextID to set
Returns void

setOptions

setOptions(options: TestOptions, override?: boolean): void

Overrides Resource.setOptions
- Defined in resources/test.ts:148
Set options from the passed options object

Parameters
- options: TestOptions
- override: boolean = false
Returns void

setResourceID

setResourceID(id: undefined | number): void

Inherited from Resource.setResourceID
- Defined in resources/resource.ts:102
Sets the resourceID of a resource

Parameters
- id: undefined | number
  
  the resourceID to set
Returns void

setVariable

setVariable(name: string, type: VariableTypes, value: string): void

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

toJSON

toJSON(): Promise<Record<string, any>>

Overrides Resource.toJSON
- Defined in resources/test.ts:152
Convert the resource to an Object

Returns Promise<Record<string, any>>
object representation of the resource

toString

toString(): Promise<string>

Inherited from Resource.toString
- Defined in resources/resource.ts:66
Convert the resource to a JSON string

Returns Promise<string>
the resource represented as a JSON string

Static fromID

fromID(id: number): Promise<Test>

Overrides Resource.fromID
- Defined in resources/test.ts:67
Create a resource from a given ID

Parameters
- id: number
Returns Promise<Test>
Promise of the resource

Static fromJSON

fromJSON(obj: Record<string, any>, copy?: boolean): Test

Overrides Resource.fromJSON
- Defined in resources/test.ts:72
Create a resource from an object

Parameters
- obj: Record<string, any>
- copy: boolean = false
Returns Test
new Resource

Generated using TypeDoc