TestModel <TSnapshot, TEvent, TInput>

Creates a test model that represents an abstract model of a system under test (SUT).

The test model is used to generate test paths, which are used to verify that states in the model are reachable in the SUT.

Index

Constructors

• constructor

Properties

• defaultTraversalOptions
• logic
• options

Methods

• getAdjacencyList
• getAllStates
• getDefaultOptions
• getPaths
• getPathsFromEvents
• getShortestPaths
• getShortestPathsFrom
• getSimplePaths
• getSimplePathsFrom
• resolveOptions
• testPath
• testPathSync
• testState
• testStateSync
• testTransition
• testTransitionSync

Constructors

constructor

• new TestModel<TSnapshot, TEvent, TInput>(logic: ActorLogic<TSnapshot, TEvent, TInput, AnyActorSystem>, options?: Partial<TestModelOptions<TSnapshot, TEvent>>): TestModel<TSnapshot, TEvent, TInput>

• Type parameters

  • TSnapshot: Snapshot<unknown>
  • TEvent: EventObject
  • TInput

  Parameters

  • logic: ActorLogic<TSnapshot, TEvent, TInput, AnyActorSystem>

  • optionaloptions: Partial<TestModelOptions<TSnapshot, TEvent>>

  Returns TestModel<TSnapshot, TEvent, TInput>

Properties

publicoptionaldefaultTraversalOptions

defaultTraversalOptions?: TraversalOptions<TSnapshot, TEvent>

publiclogic

logic: ActorLogic<TSnapshot, TEvent, TInput, AnyActorSystem>

publicoptions

options: TestModelOptions<TSnapshot, TEvent>

Methods

publicgetAdjacencyList

• getAdjacencyList(): { event: TEvent; nextState: TSnapshot; state: TSnapshot }[]

• An array of adjacencies, which are objects that represent each state with the nextState given the event.

  ---

  Returns { event: TEvent; nextState: TSnapshot; state: TSnapshot }[]

publicgetAllStates

• getAllStates(): TSnapshot[]

• Returns TSnapshot[]

publicgetDefaultOptions

• getDefaultOptions(): TestModelOptions<TSnapshot, TEvent>

• Returns TestModelOptions<TSnapshot, TEvent>

publicgetPaths

• getPaths(pathGenerator: PathGenerator<TSnapshot, TEvent, TInput>, options?: Partial<TraversalOptions<TSnapshot, TEvent>>): TestPath<TSnapshot, TEvent>[]

• Parameters

  • pathGenerator: PathGenerator<TSnapshot, TEvent, TInput>

  • optionaloptions: Partial<TraversalOptions<TSnapshot, TEvent>>

  Returns TestPath<TSnapshot, TEvent>[]

publicgetPathsFromEvents

• getPathsFromEvents(events: TEvent[], options?: TraversalOptions<TSnapshot, TEvent>): TestPath<TSnapshot, TEvent>[]

• Parameters

  • events: TEvent[]

  • optionaloptions: TraversalOptions<TSnapshot, TEvent>

  Returns TestPath<TSnapshot, TEvent>[]

publicgetShortestPaths

• getShortestPaths(options?: Partial<TraversalOptions<TSnapshot, TEvent>>): TestPath<TSnapshot, TEvent>[]

• Parameters

  • optionaloptions: Partial<TraversalOptions<TSnapshot, TEvent>>

  Returns TestPath<TSnapshot, TEvent>[]

publicgetShortestPathsFrom

• getShortestPathsFrom(paths: TestPath<TSnapshot, TEvent>[], options?: Partial<TraversalOptions<TSnapshot, any>>): TestPath<TSnapshot, TEvent>[]

• Parameters

  • paths: TestPath<TSnapshot, TEvent>[]

  • optionaloptions: Partial<TraversalOptions<TSnapshot, any>>

  Returns TestPath<TSnapshot, TEvent>[]

publicgetSimplePaths

• getSimplePaths(options?: Partial<TraversalOptions<TSnapshot, TEvent>>): TestPath<TSnapshot, TEvent>[]

• Parameters

  • optionaloptions: Partial<TraversalOptions<TSnapshot, TEvent>>

  Returns TestPath<TSnapshot, TEvent>[]

publicgetSimplePathsFrom

• getSimplePathsFrom(paths: TestPath<TSnapshot, TEvent>[], options?: Partial<TraversalOptions<TSnapshot, any>>): TestPath<TSnapshot, TEvent>[]

• Parameters

  • paths: TestPath<TSnapshot, TEvent>[]

  • optionaloptions: Partial<TraversalOptions<TSnapshot, any>>

  Returns TestPath<TSnapshot, TEvent>[]

publicresolveOptions

• resolveOptions(options?: Partial<TestModelOptions<TSnapshot, TEvent>>): TestModelOptions<TSnapshot, TEvent>

• Parameters

  • optionaloptions: Partial<TestModelOptions<TSnapshot, TEvent>>

  Returns TestModelOptions<TSnapshot, TEvent>

publictestPath

• testPath(path: StatePath<TSnapshot, TEvent>, params: TestParam<TSnapshot, TEvent>, options?: Partial<TestModelOptions<TSnapshot, TEvent>>): Promise<TestPathResult>

• Parameters

  • path: StatePath<TSnapshot, TEvent>

  • params: TestParam<TSnapshot, TEvent>

  • optionaloptions: Partial<TestModelOptions<TSnapshot, TEvent>>

  Returns Promise<TestPathResult>

publictestPathSync

• testPathSync(path: StatePath<TSnapshot, TEvent>, params: TestParam<TSnapshot, TEvent>, options?: Partial<TestModelOptions<TSnapshot, TEvent>>): TestPathResult

• Parameters

  • path: StatePath<TSnapshot, TEvent>

  • params: TestParam<TSnapshot, TEvent>

  • optionaloptions: Partial<TestModelOptions<TSnapshot, TEvent>>

  Returns TestPathResult

publictestState

• testState(params: TestParam<TSnapshot, TEvent>, state: TSnapshot, options?: Partial<TestModelOptions<TSnapshot, TEvent>>): Promise<void>

• Parameters

  • params: TestParam<TSnapshot, TEvent>

  • state: TSnapshot

  • optionaloptions: Partial<TestModelOptions<TSnapshot, TEvent>>

  Returns Promise<void>

publictestStateSync

• testStateSync(params: TestParam<TSnapshot, TEvent>, state: TSnapshot, options?: Partial<TestModelOptions<TSnapshot, TEvent>>): void

• Parameters

  • params: TestParam<TSnapshot, TEvent>

  • state: TSnapshot

  • optionaloptions: Partial<TestModelOptions<TSnapshot, TEvent>>

  Returns void

publictestTransition

• testTransition(params: TestParam<TSnapshot, TEvent>, step: Step<TSnapshot, TEvent>): Promise<void>

• Parameters

  • params: TestParam<TSnapshot, TEvent>

  • step: Step<TSnapshot, TEvent>

  Returns Promise<void>

publictestTransitionSync

• testTransitionSync(params: TestParam<TSnapshot, TEvent>, step: Step<TSnapshot, TEvent>): void

• Parameters

  • params: TestParam<TSnapshot, TEvent>

  • step: Step<TSnapshot, TEvent>

  Returns void