@svatah/yam-host-playwright
Playwright Test host for Yam flows: the yam fixture, generated specs and the results reporter
- Source:
packages/host-playwright· README:packages/host-playwright/README.md - Install:
npm install @svatah/yam-host-playwright - Version 0.1.0 · Apache-2.0
Exports
| Export | Kind | Signature | |
|---|---|---|---|
Binder | class | declare class Binder | A bind() bound to one page. |
BindMode | typealias | type BindMode = "run" | "record" | "heal"; | |
BindOptions | interface | interface BindOptions | |
BindOutcome | interface | interface BindOutcome | How a bind() call was answered, for the reporter and the annotations. |
bindTest | variable | test: _playwright_test.TestType<_playwright_test.PlaywrightTestArgs & _playwright_test.PlaywrightTestOptions & YamOptions & YamFixtures, _playwright_test.Playwr | |
expect | variable | expect: Expect<{}> | |
FAILURE_ANNOTATION | variable | FAILURE_ANNOTATION = "yam-failure" | The annotation a failing step leaves, so a report can group by class. |
GeneratedSpec | interface | export interface GeneratedSpec | |
GenerateOptions | interface | export interface GenerateOptions | |
generateSpecs | function | export function generateSpecs(options: GenerateOptions): GeneratedSpec[] | Write one spec per flow that has something to run. |
HEALED_ANNOTATION | variable | HEALED_ANNOTATION = "healed" | The annotation a healed test leaves (REQ-HEAL-4). |
modeFromEnvironment | function | declare function modeFromEnvironment(value: string | undefined): BindMode; | YAM_MODE, defaulting to run (LLD §6.5). |
renderSpec | function | export function renderSpec( | The spec's text for one flow. Pure, so it can be asserted without a disk. |
RESULTS_ATTACHMENT | variable | RESULTS_ATTACHMENT = "yam-results" | The attachment name the fixture uses and the reporter reads. |
retriesAllowed | function | export function retriesAllowed(plan: Plan, storyName: string): boolean | Whether retries are permitted for a story (LLD §9.1). |
specName | function | export function specName(flow: string): string | A flow file path as a spec file name: flows/simple.flow → simple. |
test | variable | test = base.extend< | |
YamHostFixture | interface | export interface YamHostFixture | |
YamHostFixtures | interface | export interface YamHostFixtures | |
YamHostOptions | interface | export interface YamHostOptions | |
YamReporter | class | export default class YamReporter implements Reporter | |
YamReporterOptions | interface | export interface YamReporterOptions |