testing

@prismatic-io/spectral › "testing"

Index

Classes

• ComponentTestHarness

Interfaces

• InvokeReturn

Type aliases

• TestConfigVarValues
• TestConnectionValue
• ToTestValues

Variables

• defaultConnectionValueEnvironmentVariable

Functions

• connectionValue
• createActionContext
• createConfigVars
• createConnection
• createDataSourceContext
• createHarness
• defaultTriggerPayload
• invoke
• invokeDataSource
• invokeFlow
• invokeTrigger
• loggerMock

Type aliases

TestConfigVarValues

Ƭ TestConfigVarValues: Record‹string, string | TestConnectionValue›

Defined in packages/spectral/src/testing.ts:307

---

TestConnectionValue

Ƭ TestConnectionValue: Pick‹ConnectionValue, "fields" | "context" | "token"›

Defined in packages/spectral/src/testing.ts:302

---

ToTestValues

Ƭ ToTestValues: object

Defined in packages/spectral/src/testing.ts:309

Type declaration:

Variables

Const defaultConnectionValueEnvironmentVariable

• defaultConnectionValueEnvironmentVariable: "PRISMATIC_CONNECTION_VALUE" = "PRISMATIC_CONNECTION_VALUE"

Defined in packages/spectral/src/testing.ts:52

Functions

Const connectionValue

▸ connectionValue(envVarKey: string): ConnectionValue

Defined in packages/spectral/src/testing.ts:55

Parameters:

Name	Type	Default
envVarKey	string	defaultConnectionValueEnvironmentVariable

Returns: ConnectionValue

---

Const createActionContext

▸ createActionContext‹TConfigVars›(context?: Partial‹ActionContext‹TConfigVars››): ActionContext‹TConfigVars›

Defined in packages/spectral/src/testing.ts:83

Type parameters:

▪ TConfigVars: ConfigVarResultCollection

Parameters:

Name	Type
context?	Partial‹ActionContext‹TConfigVars››

Returns: ActionContext‹TConfigVars›

---

Const createConfigVars

▸ createConfigVars‹TConfigVarValues›(values?: TConfigVarValues): ConfigVarResultCollection

Defined in packages/spectral/src/testing.ts:314

Type parameters:

▪ TConfigVarValues: TestConfigVarValues

Parameters:

Name	Type
values?	TConfigVarValues

Returns: ConfigVarResultCollection

---

Const createConnection

▸ createConnection‹T›(__namedParameters: object, values: Record‹string, unknown›, tokenValues?: Record‹string, unknown›): ConnectionValue

Defined in packages/spectral/src/testing.ts:41

Type parameters:

▪ T: ConnectionDefinition

Parameters:

▪ __namedParameters: object

Name	Type
key	string

▪ values: Record‹string, unknown›

▪Optional tokenValues: Record‹string, unknown›

Returns: ConnectionValue

---

Const createDataSourceContext

▸ createDataSourceContext‹TConfigVars›(context?: Partial‹DataSourceContext‹TConfigVars››): DataSourceContext‹TConfigVars›

Defined in packages/spectral/src/testing.ts:132

Type parameters:

▪ TConfigVars: ConfigVarResultCollection

Parameters:

Name	Type
context?	Partial‹DataSourceContext‹TConfigVars››

Returns: DataSourceContext‹TConfigVars›

---

Const createHarness

▸ createHarness‹TComponent›(component: TComponent): ComponentTestHarness‹TComponent›

Defined in packages/spectral/src/testing.ts:495

Type parameters:

▪ TComponent: Component

Parameters:

Name	Type
component	TComponent

Returns: ComponentTestHarness‹TComponent›

---

Const defaultTriggerPayload

▸ defaultTriggerPayload(): TriggerPayload

Defined in packages/spectral/src/testing.ts:192

Returns: TriggerPayload

---

Const invoke

▸ invoke‹TInputs, TConfigVars, TAllowsBranching, TReturn›(__namedParameters: object, params: ActionInputParameters‹TInputs›, context?: Partial‹ActionContext‹TConfigVars››): Promise‹InvokeReturn‹TReturn››

Defined in packages/spectral/src/testing.ts:171

Invokes specified ActionDefinition perform function using supplied params and optional context. Accepts a generic type matching ActionPerformReturn as a convenience to avoid extra casting within test methods. Returns an InvokeResult containing both the action result and a mock logger for asserting logging.

Type parameters:

▪ TInputs: Inputs

▪ TConfigVars: ConfigVarResultCollection

▪ TAllowsBranching: boolean

▪ TReturn: InvokeActionPerformReturn‹TAllowsBranching, unknown›

Parameters:

▪ __namedParameters: object

Name	Type
perform	function

▪ params: ActionInputParameters‹TInputs›

▪Optional context: Partial‹ActionContext‹TConfigVars››

Returns: Promise‹InvokeReturn‹TReturn››

---

Const invokeDataSource

▸ invokeDataSource‹TInputs, TConfigVars, TDataSourceType›(__namedParameters: object, params: ActionInputParameters‹TInputs›, context?: Partial‹DataSourceContext‹TConfigVars››): Promise‹InvokeDataSourceResult‹TDataSourceType››

Defined in packages/spectral/src/testing.ts:287

Invokes specified DataSourceDefinition perform function using supplied params. Accepts a generic type matching DataSourceResult as a convenience to avoid extra casting within test methods. Returns a DataSourceResult.

Type parameters:

▪ TInputs: Inputs

▪ TConfigVars: ConfigVarResultCollection

▪ TDataSourceType: DataSourceType

Parameters:

▪ __namedParameters: object

Name	Type
perform	function

▪ params: ActionInputParameters‹TInputs›

▪Optional context: Partial‹DataSourceContext‹TConfigVars››

Returns: Promise‹InvokeDataSourceResult‹TDataSourceType››

---

Const invokeFlow

▸ invokeFlow‹TConfigPages, TConfigVars, TConfigVarValues›(flow: Flow‹TConfigPages, ComponentSelector‹any››, __namedParameters: object): Promise‹InvokeReturn‹InvokeActionPerformReturn‹false, unknown›››

Defined in packages/spectral/src/testing.ts:341

Invokes specified Flow of a Code Native Integration using supplied params. Runs the Trigger and then the Action function and returns the result of the Action.

Type parameters:

▪ TConfigPages: ConfigPages‹any›

▪ TConfigVars: ConfigVarResultCollection

▪ TConfigVarValues: TestConfigVarValues

Parameters:

▪ flow: Flow‹TConfigPages, ComponentSelector‹any››

▪Default value __namedParameters: object= {}

Name	Type
configVars	undefined | TConfigVarValues
context	undefined | object
payload	undefined | object

Returns: Promise‹InvokeReturn‹InvokeActionPerformReturn‹false, unknown›››

---

Const invokeTrigger

▸ invokeTrigger‹TInputs, TConfigVars, TAllowsBranching, TResult›(__namedParameters: object, context?: Partial‹ActionContext‹TConfigVars››, payload?: TriggerPayload, params?: ActionInputParameters‹TInputs›): Promise‹InvokeReturn‹TResult››

Defined in packages/spectral/src/testing.ts:253

Invokes specified TriggerDefinition perform function using supplied params and optional context. Accepts a generic type matching TriggerResult as a convenience to avoid extra casting within test methods. Returns an InvokeResult containing both the trigger result and a mock logger for asserting logging.

Type parameters:

▪ TInputs: Inputs

▪ TConfigVars: ConfigVarResultCollection

▪ TAllowsBranching: boolean

▪ TResult: InvokeTriggerResult‹TAllowsBranching, TriggerPayload›

Parameters:

▪ __namedParameters: object

Name	Type
perform	function

▪Optional context: Partial‹ActionContext‹TConfigVars››

▪Optional payload: TriggerPayload

▪Optional params: ActionInputParameters‹TInputs›

Returns: Promise‹InvokeReturn‹TResult››

---

Const loggerMock

▸ loggerMock(): ActionLogger

Defined in packages/spectral/src/testing.ts:73

Pre-built mock of ActionLogger. Suitable for asserting logs are created as expected. See https://prismatic.io/docs/custom-components/writing-custom-components/#verifying-correct-logging-in-action-tests for information on testing correct logging behavior in your custom component.

Returns: ActionLogger