Class Fixture<S>

A Fixture is a class used to instantiate each test sub/case at run time. A new instance of the Fixture is created for every single test subcase (i.e. every time the test function is run).

Type Parameters

S extends SubcaseBatchState = SubcaseBatchState

Hierarchy

Fixture
- GPUTestBase
- IDLTest

Index

Accessors

params sharedState

Methods

debug eventualExpectOK expect expectOK fail info shouldReject shouldResolve shouldThrow skip skipIf trackForCleanup tryTrackForCleanup warn MakeSharedState

Accessors

params

get params(): unknown
Returns the (case+subcase) parameters for this test function invocation.

Returns unknown
- Defined in src/common/framework/fixture.ts:77

sharedState

get sharedState(): S
Gets the test fixture's shared state. This object is shared between subcases within the same testcase.

Returns S
- Defined in src/common/framework/fixture.ts:85

Methods

debug

debug(msg): void
Log a debug message.
Parameters
- msg: string
Returns void
- Defined in src/common/framework/fixture.ts:165

eventualExpectOK

eventualExpectOK(error, __namedParameters?): void
Parameters
- error: Promise<undefined | Error | (undefined | Error)[]>
- __namedParameters: {
  mode?: "fail" | "warn";
  } = {}
  - Optional mode?: "fail" | "warn"
Returns void
- Defined in src/common/framework/fixture.ts:353

expect

expect(cond, msg?): boolean
Expect that a condition is true.
Parameters
- cond: boolean
- Optional msg: string
Returns boolean
- Defined in src/common/framework/fixture.ts:311

expectOK

expectOK(error, __namedParameters?): void
If the argument is an Error, fail (or warn). If it's undefined, no-op. If the argument is an array, apply the above behavior on each of elements.
Parameters
- error: undefined | Error | (undefined | Error)[]
- __namedParameters: {
  mode?: "fail" | "warn";
  niceStack?: Error;
  } = {}
  - Optional mode?: "fail" | "warn"
  - Optional niceStack?: Error
Returns void
- Defined in src/common/framework/fixture.ts:325

fail

fail(msg?): void
Log an error and increase the result status to "ExpectFailed".
Parameters
- Optional msg: string
Returns void
- Defined in src/common/framework/fixture.ts:195

info

info(msg): void
Log an info message. Use sparingly. Use debug() instead if logs are only needed with debug logging enabled.
Parameters
- msg: string
Returns void
- Defined in src/common/framework/fixture.ts:173

shouldReject

shouldReject(expectedName, p, __namedParameters?): void
Expect that the provided promise rejects, with the provided exception name.
Parameters
- expectedName: string
- p: Promise<unknown>
- __namedParameters: ExceptionCheckOptions = {}
Returns void
- Defined in src/common/framework/fixture.ts:253

shouldResolve

shouldResolve(p, msg?): void
Expect that the provided promise resolves (fulfills).
Parameters
- p: Promise<unknown>
- Optional msg: string
Returns void
- Defined in src/common/framework/fixture.ts:236

shouldThrow

shouldThrow(expectedError, fn, __namedParameters?): void
Expect that the provided function throws (if true or string) or not (if false). If a string is provided, expect that the throw exception has that name.

MAINTENANCE_TODO: Change to string | false so the exception name is always checked.
Parameters
- expectedError: string | boolean
- fn: (() => void)
  - - (): void
    - Returns void
- __namedParameters: ExceptionCheckOptions = {}
Returns void
- Defined in src/common/framework/fixture.ts:283

skip

skip(msg): never
Throws an exception marking the subcase as skipped.
Parameters
- msg: string
Returns never
- Defined in src/common/framework/fixture.ts:178

skipIf

skipIf(cond, msg?): void
Throws an exception marking the subcase as skipped if condition is true
Parameters
- cond: boolean
- msg: string | (() => string) = ''
Returns void
- Defined in src/common/framework/fixture.ts:183

trackForCleanup

trackForCleanup<T>(o): T
Tracks an object to be cleaned up after the test finishes.

MAINTENANCE_TODO: Use this in more places. (Will be easier once .destroy() is allowed on invalid objects.)
Type Parameters
- T extends DestroyableObject
Parameters
- o: T
Returns T
- Defined in src/common/framework/fixture.ts:144

tryTrackForCleanup

tryTrackForCleanup<T>(o): T
Tracks an object, if it's destroyable, to be cleaned up after the test finishes.
Type Parameters
- T
Parameters
- o: T
Returns T
- Defined in src/common/framework/fixture.ts:150

warn

warn(msg?): void
Log a warning and increase the result status to "Warn".
Parameters
- Optional msg: string
Returns void
- Defined in src/common/framework/fixture.ts:190

`Static` MakeSharedState

MakeSharedState(recorder, params): SubcaseBatchState
Parameters
- recorder: TestCaseRecorder
- params: TestParams
Returns SubcaseBatchState
- Defined in src/common/framework/fixture.ts:63

Class Fixture<S>

Type Parameters

S extends SubcaseBatchState = SubcaseBatchState

Hierarchy

Index

Accessors

Methods

Accessors

params

Returns unknown

sharedState

Returns S

Methods

debug

Parameters

msg: string

Returns void

eventualExpectOK

Parameters

error: Promise<undefined | Error | (undefined | Error)[]>

__namedParameters: { mode?: "fail" | "warn"; } = {}

Optional mode?: "fail" | "warn"

Returns void

expect

Parameters

cond: boolean

Optional msg: string

Returns boolean

expectOK

Parameters

error: undefined | Error | (undefined | Error)[]

__namedParameters: { mode?: "fail" | "warn"; niceStack?: Error; } = {}

Optional mode?: "fail" | "warn"

Optional niceStack?: Error

Returns void

fail

Parameters

Optional msg: string

Returns void

info

Parameters

msg: string

Returns void

shouldReject

Parameters

expectedName: string

p: Promise<unknown>

__namedParameters: ExceptionCheckOptions = {}

Returns void

shouldResolve

Parameters

p: Promise<unknown>

Optional msg: string

Returns void

shouldThrow

Parameters

expectedError: string | boolean

fn: (() => void)

Returns void

__namedParameters: ExceptionCheckOptions = {}

Returns void

skip

Parameters

msg: string

Returns never

skipIf

Parameters

cond: boolean

msg: string | (() => string) = ''

Returns void

trackForCleanup

Type Parameters

T extends DestroyableObject

Parameters

o: T

Returns T

tryTrackForCleanup

Type Parameters

T

Parameters

__namedParameters: {
mode?: "fail" | "warn";
} = {}

`Optional` mode?: "fail" | "warn"

`Optional` msg: string

__namedParameters: {
mode?: "fail" | "warn";
niceStack?: Error;
} = {}

`Optional` mode?: "fail" | "warn"

`Optional` niceStack?: Error

`Optional` msg: string

`Optional` msg: string

`Optional` msg: string

`Static` MakeSharedState