Line

You are reading the unreleased docs (next). See latest (v0.9)

ui/client/features/tests/domain/FreshnessShapes

Shapes for a clone's freshness: the server's verdict and comparison, and what the banner draws from them.

Cockpit client (features), next. Source: ui/client/features/tests/domain/FreshnessShapes.ts.

Type Aliases#

Comparison#

Comparison = Freshness & object

Defined in: ui/client/features/tests/domain/FreshnessShapes.ts:10

/api/tests/:feature/compare: one clone against the flow as it is now.

Type Declaration#

changes

changes: FlowChange[]

comparable

comparable: boolean

from

from: { file: string; scenario: string; } | null

name

name: string

next

next: string | null

now

now: { route: string; title: string; } | null

ok

ok: true

path

path: string


ComparisonView#

ComparisonView = { status: "none"; } | { status: "loading"; } | { message: string; status: "error"; } | { data: Comparison; status: "ready"; }

Defined in: ui/client/features/tests/domain/FreshnessShapes.ts:19


FailureKind#

FailureKind = object

Defined in: ui/client/features/tests/domain/FreshnessShapes.ts:22

A way a generated test can fail, in words (domain/FailureKinds.ts).

Properties#

action

action: string

Defined in: ui/client/features/tests/domain/FreshnessShapes.ts:22

example

example: string

Defined in: ui/client/features/tests/domain/FreshnessShapes.ts:22

id

id: "convention" | "app"

Defined in: ui/client/features/tests/domain/FreshnessShapes.ts:22

title

title: string

Defined in: ui/client/features/tests/domain/FreshnessShapes.ts:22

tone

tone: "warn" | "error"

Defined in: ui/client/features/tests/domain/FreshnessShapes.ts:22

what

what: string

Defined in: ui/client/features/tests/domain/FreshnessShapes.ts:22


FlowChange#

FlowChange = object

Defined in: ui/client/features/tests/domain/FreshnessShapes.ts:8

One difference between a clone's flow steps and the steps Construct would generate today.

Properties#

after?

optional after?: string

Defined in: ui/client/features/tests/domain/FreshnessShapes.ts:8

at

at: number

Defined in: ui/client/features/tests/domain/FreshnessShapes.ts:8

before?

optional before?: string

Defined in: ui/client/features/tests/domain/FreshnessShapes.ts:8

kind

kind: "added" | "removed" | "changed"

Defined in: ui/client/features/tests/domain/FreshnessShapes.ts:8

text

text: string

Defined in: ui/client/features/tests/domain/FreshnessShapes.ts:8


Freshness#

Freshness = object

Defined in: ui/client/features/tests/domain/FreshnessShapes.ts:5

Properties#

changes

changes: number

Defined in: ui/client/features/tests/domain/FreshnessShapes.ts:5

stale

stale: boolean

Defined in: ui/client/features/tests/domain/FreshnessShapes.ts:5

state

state: FreshnessState

Defined in: ui/client/features/tests/domain/FreshnessShapes.ts:5

summary

summary: string

Defined in: ui/client/features/tests/domain/FreshnessShapes.ts:5


FreshnessModel#

FreshnessModel = { kind: "none"; } | { kind: "loading"; } | { kind: "error"; message: string; } | { kind: "note"; text: string; } | { caveat: string | null; changes: object[]; from: string | null; kind: "stale"; next: string | null; summary: string; title: string; }

Defined in: ui/client/features/tests/domain/FreshnessShapes.ts:12

What the clone banner draws (domain/FreshnessView.ts).


FreshnessState#

FreshnessState = "current" | "machine-changed" | "scenario-changed" | "scenario-removed" | "unknown"

Defined in: ui/client/features/tests/domain/FreshnessShapes.ts:4

Is a clone still in step with the flow it was cloned from? Only stale clones are flagged; nothing is rewritten for the user.


StaleOverview#

StaleOverview = object

Defined in: ui/client/features/tests/domain/FreshnessShapes.ts:18

Properties#

names

names: string[]

Defined in: ui/client/features/tests/domain/FreshnessShapes.ts:18

summary

summary: string

Defined in: ui/client/features/tests/domain/FreshnessShapes.ts:18