@sakuli/core

Index

Enumerations

LogMode

Classes

Interfaces

Variables

Functions

Type aliases

Argv

Argv: YargsArgv

CommandModule

CommandModule: YargsCommandModule

SakuliInstance

SakuliInstance: SakuliClass

TestActionChangeListener

TestActionChangeListener: TestExecutionContextEntityEventListener<TestActionContext>

TestActionEndListener

TestActionEndListener: TestExecutionContextEntityEventListener<TestActionContext & FinishedMeasurable>

TestCaseChangeListener

TestCaseChangeListener: TestExecutionContextEntityEventListener<TestCaseContext>

TestCaseEndListener

TestCaseEndListener: TestExecutionContextEntityEventListener<TestCaseContext & FinishedMeasurable>

TestContextEntityKind

TestContextEntityKind: TestContextKindSuite | TestContextKindCase | TestContextKindStep | TestContextKindSAction

TestContextEntityState

TestContextEntityState: TestContextEntityStateOk | TestContextEntityStateWarning | TestContextEntityStateCritical | TestContextEntityStateUnknown | TestContextEntityStateError

TestContextEntityStateCritical

TestContextEntityStateCritical: 2

TestContextEntityStateError

TestContextEntityStateError: 4

TestContextEntityStateOk

TestContextEntityStateOk: 0

TestContextEntityStateUnknown

TestContextEntityStateUnknown: 3

TestContextEntityStateWarning

TestContextEntityStateWarning: 1

TestContextKindCase

TestContextKindCase: "case"

TestContextKindSAction

TestContextKindSAction: "action"

TestContextKindStep

TestContextKindStep: "step"

TestContextKindSuite

TestContextKindSuite: "suite"

TestExecutionChangeListener

TestExecutionChangeListener: (state: TestExecutionContext) => void

Type declaration

- (state: TestExecutionContext): void
- Parameters
  - state: TestExecutionContext
  Returns void

TestExecutionContextEventTypes

TestStepChangeListener

TestStepChangeListener: TestExecutionContextEntityEventListener<TestStepContext>

TestStepEndListener

TestStepEndListener: TestExecutionContextEntityEventListener<TestStepContext & FinishedMeasurable>

TestSuiteChangeListener

TestSuiteChangeListener: TestExecutionContextEntityEventListener<TestSuiteContext>

TestSuiteEndListener

TestSuiteEndListener: TestExecutionContextEntityEventListener<TestSuiteContext & FinishedMeasurable>

Variables

END_EXECUTION

END_EXECUTION: "END_EXECUTION" = "END_EXECUTION"

END_TESTACTION

END_TESTACTION: "END_TESTACTION" = "END_TESTACTION"

END_TESTCASE

END_TESTCASE: "END_TESTCASE" = "END_TESTCASE"

END_TESTSTEP

END_TESTSTEP: "END_TESTSTEP" = "END_TESTSTEP"

END_TESTSUITE

END_TESTSUITE: "END_TESTSUITE" = "END_TESTSUITE"

START_EXECUTION

START_EXECUTION: "START_EXECUTION" = "START_EXECUTION"

START_TESTACTION

START_TESTACTION: "START_TESTACTION" = "START_TESTACTION"

START_TESTCASE

START_TESTCASE: "START_TESTCASE" = "START_TESTCASE"

START_TESTSTEP

START_TESTSTEP: "START_TESTSTEP" = "START_TESTSTEP"

START_TESTSUITE

START_TESTSUITE: "START_TESTSUITE" = "START_TESTSUITE"

SakuliBootstrapDefaults

SakuliBootstrapDefaults: { presetProvider: string[] } = ...

Type declaration

presetProvider: string[]

UPDATE_TESTACTION

UPDATE_TESTACTION: "UPDATE_TESTACTION" = "UPDATE_TESTACTION"

UPDATE_TESTCASE

UPDATE_TESTCASE: "UPDATE_TESTCASE" = "UPDATE_TESTCASE"

UPDATE_TESTSTEP

UPDATE_TESTSTEP: "UPDATE_TESTSTEP" = "UPDATE_TESTSTEP"

UPDATE_TESTSUITE

UPDATE_TESTSUITE: "UPDATE_TESTSUITE" = "UPDATE_TESTSUITE"

nodeSignals

nodeSignals: Signals[] = ...

Functions

Sakuli

Sakuli(presetProvider?: SakuliPresetProvider[]): SakuliInstance

- Defined in sakuli.class.ts:25
Parameters
- presetProvider: SakuliPresetProvider[] = []
Returns SakuliInstance

bootstrap

bootstrap(bootstrapOptions: SakuliBootstrapOptions, resolvePresetFn: (presetModuleNames: string[]) => Promise<SakuliPresetProvider[]>): Promise<SakuliClass>

- Defined in bootstrap/bootstrap.function.ts:5
Parameters
- bootstrapOptions: SakuliBootstrapOptions
- resolvePresetFn: (presetModuleNames: string[]) => Promise<SakuliPresetProvider[]>
  - - (presetModuleNames: string[]): Promise<SakuliPresetProvider[]>
    - Parameters
      - presetModuleNames: string[]
      Returns Promise<SakuliPresetProvider[]>
Returns Promise<SakuliClass>

findSakuliPresets

findSakuliPresets(nodeModulesPaths: string[]): string[]

- Defined in bootstrap/find-sakuli-presets.function.ts:6
Parameters
- nodeModulesPaths: string[]
Returns string[]

getDuration

getDuration(m: FinishedMeasurable): number

- Defined in runner/test-execution-context/measureable.interface.ts:26
Parameters
- m: FinishedMeasurable
Returns number

Const getNodeModulesPaths

getNodeModulesPaths(): Promise<string[]>

- Defined in bootstrap/get-node-modules-paths.function.ts:4
Returns Promise<string[]>

getPresetDeclarationFromFile

getPresetDeclarationFromFile(packageJsonPath: string): Promise<string[]>

- Defined in bootstrap/get-preset-declaration-from-file.function.ts:3
Parameters
- packageJsonPath: string
Returns Promise<string[]>

getReadableStateName

getReadableStateName(state: TestContextEntityState): string

- Defined in runner/test-execution-context/test-context-entity-state.class.ts:21
Parameters
- state: TestContextEntityState
Returns string

isExistingDirectory

isExistingDirectory(path: string): boolean

- Defined in bootstrap/is-existing-directory.function.ts:3
Parameters
- path: string
Returns boolean

isFinished

isFinished(m: StartedMeasurable): m is FinishedMeasurable

- Defined in runner/test-execution-context/measureable.interface.ts:22
Parameters
- m: StartedMeasurable
Returns m is FinishedMeasurable

isSakuliExecutionContext

isSakuliExecutionContext(ctx: any): ctx is SakuliExecutionContext

- Defined in runner/test-execution-context/sakuli-execution-context-provider.class.ts:8
Parameters
- ctx: any
Returns ctx is SakuliExecutionContext

isStarted

isStarted(m: Measurable): m is StartedMeasurable

- Defined in runner/test-execution-context/measureable.interface.ts:18
Parameters
- m: Measurable
Returns m is StartedMeasurable

loadBootstrapOptions

loadBootstrapOptions(): Promise<SakuliBootstrapOptions>

- Defined in bootstrap/load-bootstrap-options.function.ts:20
Reads sakuli bootconfiguration from a json file. The configuration is considered under a sakuli wich must implement the {@see SakuliBootstrapOptions} interface.*

Per default it assumes the package.json in the current directory

If no there is neither a readable file nor the corresponding key in the file the function will return an empty default config.

Returns Promise<SakuliBootstrapOptions>

parseLogMode

parseLogMode(logModeString?: null | string): undefined | LogMode

- Defined in log-mode.ts:6
Parameters
- Optional logModeString: null | string
Returns undefined | LogMode

toJson

toJson(e: TestSuiteContext): SakuliContextTestSuiteRaw
toJson(e: TestCaseContext): SakuliContextTestCaseRaw
toJson(e: TestStepContext): SakuliContextTestStepRaw
toJson(e: TestActionContext): SakuliContextTestActionRaw

- Defined in runner/test-execution-context/test-context-entity-to-json.function.ts:41
Parameters
- e: TestSuiteContext
Returns SakuliContextTestSuiteRaw
- Defined in runner/test-execution-context/test-context-entity-to-json.function.ts:42
Parameters
- e: TestCaseContext
Returns SakuliContextTestCaseRaw
- Defined in runner/test-execution-context/test-context-entity-to-json.function.ts:43
Parameters
- e: TestStepContext
Returns SakuliContextTestStepRaw
- Defined in runner/test-execution-context/test-context-entity-to-json.function.ts:44
Parameters
- e: TestActionContext
Returns SakuliContextTestActionRaw

Index

Enumerations

Classes

Interfaces

Type aliases

Variables

Functions

Type aliases

Argv

CommandModule

SakuliInstance

TestActionChangeListener

TestActionEndListener

TestCaseChangeListener

TestCaseEndListener

TestContextEntityKind

TestContextEntityState

TestContextEntityStateCritical

TestContextEntityStateError

TestContextEntityStateOk

TestContextEntityStateUnknown

TestContextEntityStateWarning

TestContextKindCase

TestContextKindSAction

TestContextKindStep

TestContextKindSuite

TestExecutionChangeListener

Type declaration

Parameters

state: TestExecutionContext

Returns void

TestExecutionContextEventTypes

TestStepChangeListener

TestStepEndListener

TestSuiteChangeListener

TestSuiteEndListener

Variables

END_EXECUTION

END_TESTACTION

END_TESTCASE

END_TESTSTEP

END_TESTSUITE

START_EXECUTION

START_TESTACTION

START_TESTCASE

START_TESTSTEP

START_TESTSUITE

SakuliBootstrapDefaults

Type declaration

presetProvider: string[]

UPDATE_TESTACTION

UPDATE_TESTCASE

UPDATE_TESTSTEP

UPDATE_TESTSUITE

nodeSignals

Functions

Sakuli

Parameters

presetProvider: SakuliPresetProvider[] = []

Returns SakuliInstance

bootstrap

Parameters

bootstrapOptions: SakuliBootstrapOptions

resolvePresetFn: (presetModuleNames: string[]) => Promise<SakuliPresetProvider[]>

Parameters

presetModuleNames: string[]

Returns Promise<SakuliPresetProvider[]>

Returns Promise<SakuliClass>

findSakuliPresets

Parameters

nodeModulesPaths: string[]

Returns string[]

getDuration

Parameters

m: FinishedMeasurable

Returns number

Const getNodeModulesPaths

Returns Promise<string[]>

getPresetDeclarationFromFile

Parameters