teraslice-test-harness / worker-test-harness / default

Class: default

Defined in: teraslice-test-harness/src/worker-test-harness.ts:19

A test harness for testing Operations that run on Workers, mainly Fetchers and Processors.

This is useful for testing Fetcher and Processors together or individually.

Todo

Add support for attaching APIs and Observers

Extends

default<WorkerExecutionContext>

Constructors

Constructor

new default(job, options?): WorkerTestHarness

Defined in: teraslice-test-harness/src/worker-test-harness.ts:20

Parameters

Parameter	Type
`job`	`JobConfigParams`
`options`	`JobHarnessOptions`

Returns

WorkerTestHarness

Overrides

default.constructor

Properties

Property	Modifier	Type	Inherited from	Defined in
`assetPaths`	`readonly`	`string`[]	`default`.`assetPaths`	teraslice-test-harness/src/base-test-harness.ts:24
`clusterType?`	`readonly`	`ClusterManagerType`	`default`.`clusterType`	teraslice-test-harness/src/base-test-harness.ts:25
`context`	`readonly`	`TestContext`	`default`.`context`	teraslice-test-harness/src/base-test-harness.ts:22
`events`	`readonly`	`EventEmitter`	`default`.`events`	teraslice-test-harness/src/base-test-harness.ts:20
`executionContext`	`public`	`WorkerExecutionContext`	`default`.`executionContext`	teraslice-test-harness/src/base-test-harness.ts:21
`job`	`readonly`	`JobConfigParams`	`default`.`job`	teraslice-test-harness/src/base-test-harness.ts:23

Accessors

apis

Get Signature

get apis(): JobAPIInstances

Defined in: teraslice-test-harness/src/worker-test-harness.ts:84

Returns

JobAPIInstances

processors

Get Signature

get processors(): ProcessorCore<OpConfig>[]

Defined in: teraslice-test-harness/src/worker-test-harness.ts:80

Returns

ProcessorCore<OpConfig>[]

Methods

fetcher()

fetcher<T>(): T

Defined in: teraslice-test-harness/src/worker-test-harness.ts:76

Type Parameters

Type Parameter	Default type
`T` extends `FetcherCore`<`OpConfig`>	`FetcherCore`<`OpConfig`>

Returns

T

flush()

Call Signature

flush(): Promise<DataEntity<Record<string, any>, _DataEntityMetadata<Record<string, any>>>[] | undefined>

Defined in: teraslice-test-harness/src/worker-test-harness.ts:179

Shutdown the Operations on the ExecutionContext

Returns

Promise<DataEntity<Record<string, any>, _DataEntityMetadata<Record<string, any>>>[] | undefined>

Call Signature

flush(options): Promise<DataEntity<Record<string, any>, _DataEntityMetadata<Record<string, any>>>[] | undefined>

Defined in: teraslice-test-harness/src/worker-test-harness.ts:180

Shutdown the Operations on the ExecutionContext

Parameters

Parameter	Type
`options`	{ `fullResponse`: `false`; }
`options.fullResponse`	`false`

Returns

Promise<DataEntity<Record<string, any>, _DataEntityMetadata<Record<string, any>>>[] | undefined>

Call Signature

flush(options): Promise<RunSliceResult | undefined>

Defined in: teraslice-test-harness/src/worker-test-harness.ts:181

Shutdown the Operations on the ExecutionContext

Parameters

Parameter	Type
`options`	{ `fullResponse`: `true`; }
`options.fullResponse`	`true`

Returns

Promise<RunSliceResult | undefined>

getAPI()

getAPI<T>(name): T

Defined in: teraslice-test-harness/src/worker-test-harness.ts:92

Get the reference to a created API that a operation will use. This is different than getOperationAPI which the OperationAPI class instance

Type Parameters

Type Parameter	Default type
`T` extends `OpAPI`	`any`

Parameters

Parameter	Type
`name`	`string`

Returns

T

getOperation()

getOperation<T>(findBy): T

Defined in: teraslice-test-harness/src/worker-test-harness.ts:99

Get the instantiated Operation class instance from the operations list

Type Parameters

Type Parameter	Default type
`T` extends `OperationCore`<`OpConfig`>	`OperationCore`<`OpConfig`>

Parameters

Parameter	Type
`findBy`	`string` \| `number`

Returns

T

getOperationAPI()

getOperationAPI<T>(name): T

Defined in: teraslice-test-harness/src/worker-test-harness.ts:107

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

Type Parameter	Default type
`T` extends `APICore`<`APIConfig`>	`APICore`<`APIConfig`>

Parameters

Parameter	Type
`name`	`string`

Returns

T

initialize()

initialize(): Promise<void>

Defined in: teraslice-test-harness/src/worker-test-harness.ts:117

Initialize the Operations on the ExecutionContext

Returns

Promise<void>

Overrides

default.initialize

makeContextConfig()

protected makeContextConfig(job, assets?, cluster_manager_type?): Promise<ExecutionContextConfig>

Defined in: teraslice-test-harness/src/base-test-harness.ts:53

Parameters

Parameter	Type	Default value
`job`	`JobConfigParams`	`undefined`
`assets`	`string`[]	`...`
`cluster_manager_type`	`ClusterManagerType`	`'native'`

Returns

Promise<ExecutionContextConfig>

Inherited from

default.makeContextConfig

runSlice()

Call Signature

runSlice(input): Promise<DataEntity<Record<string, any>, _DataEntityMetadata<Record<string, any>>>[]>

Defined in: teraslice-test-harness/src/worker-test-harness.ts:135

Given a slice run pass it the Fetcher and then subsequent operations. This will also fire lifecycle events which may be triggered any extra APIs.

Parameters

Parameter	Type	Description
`input`	`Slice` \| `SliceRequest`	The input slice, can optionally include all of the slice metadata. Use `newTestSlice()` to create a test slice.

Returns

Promise<DataEntity<Record<string, any>, _DataEntityMetadata<Record<string, any>>>[]>

an Array of DataEntities or a SliceResult

Call Signature

runSlice(input, options): Promise<DataEntity<Record<string, any>, _DataEntityMetadata<Record<string, any>>>[]>

Defined in: teraslice-test-harness/src/worker-test-harness.ts:138

Given a slice run pass it the Fetcher and then subsequent operations. This will also fire lifecycle events which may be triggered any extra APIs.

Parameters

Parameter	Type	Description
`input`	`Slice` \| `SliceRequest`	The input slice, can optionally include all of the slice metadata. Use `newTestSlice()` to create a test slice.
`options`	{ `fullResponse`: `false`; }	an optional object of additional configruation
`options.fullResponse`	`false`	if specified it will return an object with both the slice results and any analytics if specified on the Job.

Returns

Promise<DataEntity<Record<string, any>, _DataEntityMetadata<Record<string, any>>>[]>

an Array of DataEntities or a SliceResult

Call Signature

runSlice(input, options): Promise<RunSliceResult>

Defined in: teraslice-test-harness/src/worker-test-harness.ts:142

Given a slice run pass it the Fetcher and then subsequent operations. This will also fire lifecycle events which may be triggered any extra APIs.

Parameters

Parameter	Type	Description
`input`	`Slice` \| `SliceRequest`	The input slice, can optionally include all of the slice metadata. Use `newTestSlice()` to create a test slice.
`options`	{ `fullResponse`: `true`; }	an optional object of additional configruation
`options.fullResponse`	`true`	if specified it will return an object with both the slice results and any analytics if specified on the Job.

Returns

Promise<RunSliceResult>

an Array of DataEntities or a SliceResult

setClients()

setClients(clients): void

Defined in: teraslice-test-harness/src/base-test-harness.ts:49

Parameters

Parameter	Type
`clients`	`TestClientConfig`[]

Returns

void

Inherited from

default.setClients

shutdown()

shutdown(): Promise<void>

Defined in: teraslice-test-harness/src/base-test-harness.ts:91

Cleanup test code

Returns

Promise<void>

Inherited from

default.shutdown

testFetcher()

static testFetcher(opConfig, apiConfig, options?): WorkerTestHarness

Defined in: teraslice-test-harness/src/worker-test-harness.ts:58

Parameters

Parameter	Type
`opConfig`	`OpConfig`
`apiConfig`	`APIConfig`
`options?`	`JobHarnessOptions`

Returns

WorkerTestHarness

testProcessor()

static testProcessor(opConfig, options?): WorkerTestHarness

Defined in: teraslice-test-harness/src/worker-test-harness.ts:24

Parameters

Parameter	Type
`opConfig`	`OpConfig`
`options?`	`JobHarnessOptions`

Returns

WorkerTestHarness

testSender()

static testSender(opConfig, apiConfig, options?): WorkerTestHarness

Defined in: teraslice-test-harness/src/worker-test-harness.ts:38

Parameters

Parameter	Type
`opConfig`	`OpConfig`
`apiConfig`	`APIConfig`
`options?`	`JobHarnessOptions`

Returns

WorkerTestHarness

Todo​

Extends​

Constructors​

Constructor​

Parameters​

Returns​

Overrides​

Properties​

Accessors​

apis​

Get Signature​

Returns​

processors​

Get Signature​

Returns​

Methods​

fetcher()​

Type Parameters​

Returns​

flush()​

Call Signature​

Returns​

Call Signature​

Parameters​

Returns​

Call Signature​

Parameters​

Returns​

getAPI()​

Type Parameters​

Parameters​

Returns​

getOperation()​

Type Parameters​

Parameters​

Returns​

getOperationAPI()​

Type Parameters​

Parameters​

Returns​

initialize()​

Returns​

Overrides​

makeContextConfig()​

Parameters​

Returns​

Inherited from​

runSlice()​

Call Signature​

Parameters​

Returns​

Call Signature​

Parameters​

Returns​

Call Signature​

Parameters​

Returns​

setClients()​

Parameters​

Returns​

Inherited from​

shutdown()​

Returns​

Inherited from​

testFetcher()​

Parameters​

Returns​

testProcessor()​

Parameters​

Returns​

testSender()​

Parameters​

Returns​

Todo

Extends

Constructors

Constructor

Parameters

Returns

Overrides

Properties

Accessors

apis

Get Signature

Returns

processors

Get Signature

Returns

Methods

fetcher()

Type Parameters

Returns

flush()

Call Signature

Returns

Call Signature

Parameters

Returns

Call Signature

Parameters

Returns

getAPI()

Type Parameters

Parameters

Returns

getOperation()

Type Parameters

Parameters

Returns

getOperationAPI()

Type Parameters

Parameters

Returns

initialize()

Returns

Overrides

makeContextConfig()

Parameters

Returns

Inherited from

runSlice()

Call Signature

Parameters

Returns

Call Signature

Parameters

Returns

Call Signature

Parameters

Returns

setClients()

Parameters

Returns

Inherited from

shutdown()

Returns

Inherited from

testFetcher()

Parameters

Returns

testProcessor()

Parameters

Returns

testSender()

Parameters

Returns