Class VariableResolver

Service for resolving test variables through the inheritance hierarchy.

Resolution order (highest to lowest priority):

Run-level values (CLI flags, API params)
Suite-level values (if running in a suite)
Test-level defaults
TestType defaults

Index

Constructors

Methods

getAvailableVariables parseCliValue parseCliVariables parseSuiteConfig parseTestConfig parseTypeSchema resolveVariables validateDataType validateValue

Constructors

constructor

new VariableResolver(): VariableResolver
Returns VariableResolver

Methods

getAvailableVariables

getAvailableVariables(
typeVariablesSchemaJson: string | null,
testVariablesJson: string | null,
): TestVariableDefinition[]
Get available variables for a test (combines type and test configuration). Useful for CLI help and variable listing.
Parameters
- typeVariablesSchemaJson: string | null
- testVariablesJson: string | null
Returns TestVariableDefinition[]
- Defined in packages/TestingFramework/Engine/src/utils/variable-resolver.ts:298

parseCliValue

parseCliValue(
varDef: TestVariableDefinition,
cliValue: string,
): TestVariableValue
Parse a variable value from a CLI string. Converts string input to appropriate type based on variable definition.
Parameters
- varDef: TestVariableDefinition
- cliValue: string
Returns TestVariableValue
- Defined in packages/TestingFramework/Engine/src/utils/variable-resolver.ts:339

parseCliVariables

parseCliVariables(
cliArgs: string[],
typeVariablesSchemaJson?: string | null,
): Record<string, TestVariableValue>
Parse CLI variable arguments (name=value format) into a variables object. If type schema is provided, values are converted to appropriate types.
Parameters
- cliArgs: string[]
- OptionaltypeVariablesSchemaJson: string | null
Returns Record<string, TestVariableValue>
- Defined in packages/TestingFramework/Engine/src/utils/variable-resolver.ts:395

parseSuiteConfig

parseSuiteConfig(json: string | null): TestSuiteVariablesConfig | null
Parse the TestSuite.Variables JSON
Parameters
- json: string | null
Returns TestSuiteVariablesConfig | null
- Defined in packages/TestingFramework/Engine/src/utils/variable-resolver.ts:151

parseTestConfig

parseTestConfig(json: string | null): TestVariablesConfig | null
Parse the Test.Variables JSON
Parameters
- json: string | null
Returns TestVariablesConfig | null
- Defined in packages/TestingFramework/Engine/src/utils/variable-resolver.ts:135

parseTypeSchema

parseTypeSchema(json: string | null): TestTypeVariablesSchema | null
Parse the TestType.VariablesSchema JSON
Parameters
- json: string | null
Returns TestTypeVariablesSchema | null
- Defined in packages/TestingFramework/Engine/src/utils/variable-resolver.ts:110

resolveVariables

resolveVariables(
    typeVariablesSchemaJson: string | null,
    testVariablesJson: string | null,
    suiteVariablesJson: string | null,
    runOptions: TestRunOptions,
): ResolvedTestVariables
Resolve variables for a test execution.
Parameters
- typeVariablesSchemaJson: string | null
  JSON string from TestType.VariablesSchema
- testVariablesJson: string | null
  JSON string from Test.Variables (optional)
- suiteVariablesJson: string | null
  JSON string from TestSuite.Variables (optional)
- runOptions: TestRunOptions
  Runtime options containing user-provided variable values
Returns ResolvedTestVariables
Resolved variables with values and sources

Throws
VariableResolutionError if required variables are missing or values are invalid
- Defined in packages/TestingFramework/Engine/src/utils/variable-resolver.ts:60

validateDataType

validateDataType(varDef: TestVariableDefinition, value: unknown): void
Validate value matches the expected data type.
Parameters
- varDef: TestVariableDefinition
- value: unknown
Returns void
- Defined in packages/TestingFramework/Engine/src/utils/variable-resolver.ts:247

validateValue

validateValue(
    varDef: TestVariableDefinition,
    testOverride: TestVariableOverride | undefined,
    value: unknown,
    source: string,
): void
Validate a variable value against its definition.
Parameters
- varDef: TestVariableDefinition
- testOverride: TestVariableOverride | undefined
- value: unknown
- source: string
Returns void
- Defined in packages/TestingFramework/Engine/src/utils/variable-resolver.ts:219