PURISTA

Appearance

PURISTA API

PURISTA API / @purista/core / getCommandContextMock

Function: getCommandContextMock() ​

getCommandContextMock<MessagePayloadType, MessageParamsType, FunctionPayloadType, FunctionParamsType, Resources, Invokes, EmitList>(input): object

Defined in: mocks/getCommandContext.mock.ts:17

A function that returns a mock object for command function context

Type Parameters ​

MessagePayloadType ​

MessagePayloadType

MessageParamsType ​

MessageParamsType

FunctionPayloadType ​

FunctionPayloadType

FunctionParamsType ​

FunctionParamsType

Resources ​

Resources extends Record<string, unknown>

Invokes ​

Invokes extends InvokeList

EmitList ​

EmitList extends Record<string, Schema>

Parameters ​

input ​

emitList ​

FromEmitToOtherType<EmitList, Schema>

invokes ​

FromInvokeToOtherType<Invokes, { outputSchema?: Schema; parameterSchema?: Schema; payloadSchema?: Schema; }>

message? ​

{ parameter: MessageParamsType; payload: MessagePayloadType; }

message.parameter ​

MessageParamsType

message.payload ​

MessagePayloadType

parameter ​

FunctionParamsType

payload ​

FunctionPayloadType

resources? ​

Partial<Resources>

sandbox? ​

SinonSandbox

Returns ​

object

mock ​

mock: object

mock.configs ​

configs: object

the config store

mock.configs.getConfig ​

getConfig: ConfigGetterFunction

get a config value from the config store

mock.configs.removeConfig ​

removeConfig: ConfigDeleteFunction

delete a config value from the config store

mock.configs.setConfig ​

setConfig: ConfigSetterFunction

set a config value in the config store

mock.emit ​

emit: EmitCustomMessageFunction<EmitList>

emit a custom message

mock.logger ​

logger: Logger

the logger instance

mock.message ​

message: Readonly<Command<MessagePayloadType, MessageParamsType>>

the original message

mock.resources ​

resources: Resources

Provides resources defined in service builder and set via config during service creation

mock.secrets ​

secrets: object

the secret store

mock.secrets.getSecret ​

getSecret: SecretGetterFunction

get a secret from the secret store

mock.secrets.removeSecret ​

removeSecret: SecretDeleteFunction

delete a secret from the secret store

mock.secrets.setSecret ​

setSecret: SecretSetterFunction

set a secret in the secret store

mock.service ​

service: Invokes

Invokes a command and returns the result. It is recommended to validate the result against a schema which only contains the data you actually need.

Example ​
typescript
// define your invocation in command builder
.canInvoke('ServiceA', '1', 'test', responseOutputSchema, payloadSchema, parameterSchema)
.setCommandFunction(async function (context, payload, _parameter) {
   const inputPayload = { my: 'input' }
   const inputParameter = { search: 'for_me' }
   const result = await context.service.ServiceA[1].test(inputPayload,inputParameter)
})

mock.startActiveSpan() ​

startActiveSpan: <F>(name, opts, context, fn) => Promise<F>

wrap given function in an opentelemetry active span

Type Parameters ​
F ​

F

Parameters ​
name ​

string

opts ​

SpanOptions

context ​

Context | undefined

fn ​

(span) => Promise<F>

Returns ​

Promise<F>

mock.states ​

states: object

the state store

mock.states.getState ​

getState: StateGetterFunction

get a state value from the state store

mock.states.removeState ​

removeState: StateDeleteFunction

delete a state value from the state store

mock.states.setState ​

setState: StateSetterFunction

set a state value in the state store

mock.wrapInSpan() ​

wrapInSpan: <F>(name, opts, fn, context?) => Promise<F>

wrap given function in an opentelemetry span

Type Parameters ​
F ​

F

Parameters ​
name ​

string

opts ​

SpanOptions

fn ​

(span) => Promise<F>

context? ​

Context

Returns ​

Promise<F>

stubs ​

stubs: object

stubs.emit ​

emit: FromEmitToOtherType<EmitList, SinonStub<any[], any>> = eventList

stubs.getConfig ​

getConfig: SinonStub<any[], any>

stubs.getSecret ​

getSecret: SinonStub<any[], any>

stubs.getState ​

getState: SinonStub<any[], any>

stubs.invoke ​

invoke: SinonStub<any[], any>

stubs.logger ​

logger: object = logger.stubs

stubs.logger.debug ​

debug: SinonStub<any[], any>

stubs.logger.error ​

error: SinonStub<any[], any>

stubs.logger.fatal ​

fatal: SinonStub<any[], any>

stubs.logger.info ​

info: SinonStub<any[], any>

stubs.logger.trace ​

trace: SinonStub<any[], any>

stubs.logger.warn ​

warn: SinonStub<any[], any>

stubs.removeConfig ​

removeConfig: SinonStub<any[], any>

stubs.removeSecret ​

removeSecret: SinonStub<any[], any>

stubs.removeState ​

removeState: SinonStub<any[], any>

stubs.resources ​

resources: Partial<Resources>

stubs.service ​

service: FromInvokeToOtherType<Invokes, SinonStub<any[], any>>

stubs.setConfig ​

setConfig: SinonStub<any[], any>

stubs.setSecret ​

setSecret: SinonStub<any[], any>

stubs.setState ​

setState: SinonStub<any[], any>

stubs.startActiveSpan ​

startActiveSpan: SinonStub<any[], any>

stubs.wrapInSpan ​

wrapInSpan: SinonStub<any[], any>