Teraslice Test Harness: `Slicer Test Harness Default`
slicer-test-harness.default
A base class for the Slicer and Worker TestHarnesses
Todo
Add support for validating the asset.json?
Hierarchy
default
<SlicerExecutionContext
>↳
default
Table of contents
Constructors
Properties
Accessors
Methods
- createSlices
- getAPI
- getAllSlices
- getOperationAPI
- initialize
- makeContextConfig
- onSliceComplete
- onSliceDispatch
- setClients
- setWorkers
- shutdown
- slicer
Constructors
constructor
• new default(job
, options
): default
Parameters
Name | Type |
---|---|
job | Partial <ValidatedJobConfig > |
options | JobHarnessOptions |
Returns
Overrides
Defined in
teraslice-test-harness/src/slicer-test-harness.ts:40
Properties
context
• Readonly
context: TestContext
Inherited from
Defined in
teraslice-test-harness/src/base-test-harness.ts:22
events
• Readonly
events: EventEmitter
Inherited from
Defined in
teraslice-test-harness/src/base-test-harness.ts:20
executionContext
• Readonly
executionContext: SlicerExecutionContext
Inherited from
Defined in
teraslice-test-harness/src/base-test-harness.ts:21
stats
• Readonly
stats: ExecutionStats
Defined in
teraslice-test-harness/src/slicer-test-harness.ts:27
Accessors
apis
• get
apis(): JobAPIInstances
Returns
JobAPIInstances
Defined in
teraslice-test-harness/src/slicer-test-harness.ts:176
Methods
createSlices
▸ createSlices(): Promise
<(null
| SliceRequest
)[]>
Create Slices, always returns an Array of slices or slice requests. To adjust the number of slicers change the job configuration when constructing this class.
If the slicers are done, you should expect a null value for every slicer
Returns
Promise
<(null
| SliceRequest
)[]>
an array of Slices including the metadata or the just the Slice Request.
Defined in
teraslice-test-harness/src/slicer-test-harness.ts:89
▸ createSlices(options
): Promise
<(null
| SliceRequest
)[]>
Parameters
Name | Type |
---|---|
options | Object |
options.fullResponse | false |
Returns
Promise
<(null
| SliceRequest
)[]>
Defined in
teraslice-test-harness/src/slicer-test-harness.ts:90
▸ createSlices(options
): Promise
<(null
| Slice
)[]>
Parameters
Name | Type |
---|---|
options | Object |
options.fullResponse | true |
Returns
Promise
<(null
| Slice
)[]>
Defined in
teraslice-test-harness/src/slicer-test-harness.ts:91
getAPI
▸ getAPI<T
>(name
): T
Get the reference to a created API that a operation will use. This is different than getOperationAPI which the OperationAPI class instance
Type parameters
Name | Type |
---|---|
T | extends OpAPI = any |
Parameters
Name | Type |
---|---|
name | string |
Returns
T
Defined in
teraslice-test-harness/src/slicer-test-harness.ts:184
getAllSlices
▸ getAllSlices(): Promise
<SliceResults
>
Returns
Promise
<SliceResults
>
Defined in
teraslice-test-harness/src/slicer-test-harness.ts:133
▸ getAllSlices(options
): Promise
<(null
| Slice
)[]>
Parameters
Name | Type |
---|---|
options | Object |
options.fullResponse | false |
Returns
Promise
<(null
| Slice
)[]>
Defined in
teraslice-test-harness/src/slicer-test-harness.ts:134
▸ getAllSlices(options
): Promise
<(null
| SliceRequest
)[]>
Parameters
Name | Type |
---|---|
options | Object |
options.fullResponse | true |
Returns
Promise
<(null
| SliceRequest
)[]>
Defined in
teraslice-test-harness/src/slicer-test-harness.ts:135
getOperationAPI
▸ getOperationAPI<T
>(name
): T
Get the instantiated OperationAPI class instance from the apis. If you are looking for the APIs that created during run time, use getAPI.
Type parameters
Name | Type |
---|---|
T | extends default <APIConfig > = default <APIConfig > |
Parameters
Name | Type |
---|---|
name | string |
Returns
T
Defined in
teraslice-test-harness/src/slicer-test-harness.ts:192
initialize
▸ initialize(recoveryData?
): Promise
<void
>
Initialize the Operations on the ExecutionContext
Parameters
Name | Type | Default value | Description |
---|---|---|---|
recoveryData | SlicerRecoveryData [] | [] | is an array of starting points to recover from |
Returns
Promise
<void
>
Overrides
Defined in
teraslice-test-harness/src/slicer-test-harness.ts:57
makeContextConfig
▸ makeContextConfig(job
, assets?
, cluster_manager_type?
): ExecutionContextConfig
Parameters
Name | Type | Default value |
---|---|---|
job | Partial <ValidatedJobConfig > | undefined |
assets | string [] | undefined |
cluster_manager_type | ClusterManagerType | 'native' |
Returns
ExecutionContextConfig
Inherited from
Defined in
teraslice-test-harness/src/base-test-harness.ts:50
onSliceComplete
▸ onSliceComplete(result
): void
Parameters
Name | Type |
---|---|
result | SliceResult |
Returns
void
Defined in
teraslice-test-harness/src/slicer-test-harness.ts:172
onSliceDispatch
▸ onSliceDispatch(slice
): void
Parameters
Name | Type |
---|---|
slice | Slice |
Returns
void
Defined in
teraslice-test-harness/src/slicer-test-harness.ts:168
setClients
▸ setClients(clients
): void
Parameters
Name | Type |
---|---|
clients | TestClientConfig [] |
Returns
void
Inherited from
Defined in
teraslice-test-harness/src/base-test-harness.ts:46
setWorkers
▸ setWorkers(count
): void
Parameters
Name | Type |
---|---|
count | number |
Returns
void
Defined in
teraslice-test-harness/src/slicer-test-harness.ts:162
shutdown
▸ shutdown(): Promise
<void
>
Shutdown the Operations on the ExecutionContext
Returns
Promise
<void
>
Overrides
Defined in
teraslice-test-harness/src/slicer-test-harness.ts:202
slicer
▸ slicer<T
>(): T
Type parameters
Name | Type |
---|---|
T | extends default <OpConfig > = default <OpConfig > |
Returns
T