@sun-asterisk/sungen 3.2.9 → 3.2.10-beta.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/capabilities/discover.js +1 -1
- package/dist/capabilities/discover.js.map +1 -1
- package/dist/capabilities/registry.d.ts +9 -0
- package/dist/capabilities/registry.d.ts.map +1 -1
- package/dist/capabilities/registry.js +4 -0
- package/dist/capabilities/registry.js.map +1 -1
- package/dist/cli/commands/delivery.d.ts.map +1 -1
- package/dist/cli/commands/delivery.js +15 -5
- package/dist/cli/commands/delivery.js.map +1 -1
- package/dist/cli/commands/generate.d.ts.map +1 -1
- package/dist/cli/commands/generate.js +16 -0
- package/dist/cli/commands/generate.js.map +1 -1
- package/dist/exporters/spec-parser.d.ts.map +1 -1
- package/dist/exporters/spec-parser.js +16 -5
- package/dist/exporters/spec-parser.js.map +1 -1
- package/dist/generators/test-generator/adapters/playwright/templates/steps/actions/alert-accept-action.hbs +1 -1
- package/dist/generators/test-generator/adapters/playwright/templates/steps/actions/alert-dismiss-action.hbs +1 -1
- package/dist/generators/test-generator/adapters/playwright/templates/steps/actions/alert-fill-action.hbs +1 -1
- package/dist/generators/test-generator/adapters/playwright/templates/steps/actions/capture-row-column.hbs +2 -0
- package/dist/generators/test-generator/adapters/playwright/templates/steps/actions/click-element-with-text.hbs +1 -1
- package/dist/generators/test-generator/adapters/playwright/templates/steps/actions/click-with-alert-action.hbs +2 -0
- package/dist/generators/test-generator/adapters/playwright/templates/steps/actions/recipe-sequence.hbs +3 -0
- package/dist/generators/test-generator/adapters/playwright/templates/steps/actions/table-action-in-row-nth.hbs +2 -0
- package/dist/generators/test-generator/adapters/playwright/templates/steps/actions/unknown-element-action.hbs +1 -1
- package/dist/generators/test-generator/adapters/playwright/templates/steps/navigation/route-assertion.hbs +3 -0
- package/dist/generators/test-generator/adapters/playwright/templates/steps/navigation/wait-for-element.hbs +1 -1
- package/dist/generators/test-generator/adapters/playwright/templates/steps/navigation/wait-table-refresh.hbs +3 -0
- package/dist/generators/test-generator/adapters/playwright/templates/steps/partials/has-text-value.hbs +1 -0
- package/dist/generators/test-generator/adapters/playwright/templates/steps/partials/locator-base.hbs +1 -1
- package/dist/generators/test-generator/adapters/playwright/templates/steps/partials/locator.hbs +1 -1
- package/dist/generators/test-generator/adapters/playwright/templates/steps/partials/recipe-blur.hbs +1 -0
- package/dist/generators/test-generator/adapters/playwright/templates/steps/partials/recipe-click-text.hbs +3 -0
- package/dist/generators/test-generator/adapters/playwright/templates/steps/partials/recipe-click.hbs +1 -0
- package/dist/generators/test-generator/adapters/playwright/templates/steps/partials/recipe-expect-text.hbs +1 -0
- package/dist/generators/test-generator/adapters/playwright/templates/steps/partials/recipe-expect-value.hbs +1 -0
- package/dist/generators/test-generator/adapters/playwright/templates/steps/partials/recipe-for-each.hbs +5 -0
- package/dist/generators/test-generator/adapters/playwright/templates/steps/partials/recipe-hover.hbs +1 -0
- package/dist/generators/test-generator/adapters/playwright/templates/steps/partials/recipe-press.hbs +1 -0
- package/dist/generators/test-generator/adapters/playwright/templates/steps/partials/recipe-scroll-into-view.hbs +1 -0
- package/dist/generators/test-generator/adapters/playwright/templates/steps/partials/recipe-type.hbs +1 -0
- package/dist/generators/test-generator/adapters/playwright/templates/steps/partials/recipe-wait-for.hbs +1 -0
- package/dist/generators/test-generator/app-profile.d.ts +89 -0
- package/dist/generators/test-generator/app-profile.d.ts.map +1 -0
- package/dist/generators/test-generator/app-profile.js +157 -0
- package/dist/generators/test-generator/app-profile.js.map +1 -0
- package/dist/generators/test-generator/code-generator.d.ts +4 -0
- package/dist/generators/test-generator/code-generator.d.ts.map +1 -1
- package/dist/generators/test-generator/code-generator.js +7 -0
- package/dist/generators/test-generator/code-generator.js.map +1 -1
- package/dist/generators/test-generator/diagnostics.d.ts +36 -0
- package/dist/generators/test-generator/diagnostics.d.ts.map +1 -0
- package/dist/generators/test-generator/diagnostics.js +44 -0
- package/dist/generators/test-generator/diagnostics.js.map +1 -0
- package/dist/generators/test-generator/patterns/types.d.ts +12 -0
- package/dist/generators/test-generator/patterns/types.d.ts.map +1 -1
- package/dist/generators/test-generator/recipe-expander.d.ts +32 -0
- package/dist/generators/test-generator/recipe-expander.d.ts.map +1 -0
- package/dist/generators/test-generator/recipe-expander.js +118 -0
- package/dist/generators/test-generator/recipe-expander.js.map +1 -0
- package/dist/generators/test-generator/step-mapper.d.ts +17 -0
- package/dist/generators/test-generator/step-mapper.d.ts.map +1 -1
- package/dist/generators/test-generator/step-mapper.js +70 -0
- package/dist/generators/test-generator/step-mapper.js.map +1 -1
- package/dist/generators/test-generator/template-engine.d.ts +5 -1
- package/dist/generators/test-generator/template-engine.d.ts.map +1 -1
- package/dist/generators/test-generator/template-engine.js +27 -3
- package/dist/generators/test-generator/template-engine.js.map +1 -1
- package/dist/generators/test-generator/utils/selector-resolver.d.ts +10 -1
- package/dist/generators/test-generator/utils/selector-resolver.d.ts.map +1 -1
- package/dist/generators/test-generator/utils/selector-resolver.js +32 -0
- package/dist/generators/test-generator/utils/selector-resolver.js.map +1 -1
- package/dist/harness/catalog/drivers.yaml +1 -1
- package/dist/harness/query-catalog.d.ts +32 -2
- package/dist/harness/query-catalog.d.ts.map +1 -1
- package/dist/harness/query-catalog.js +0 -0
- package/dist/harness/query-catalog.js.map +1 -1
- package/dist/index.d.ts +5 -2
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +5 -1
- package/dist/index.js.map +1 -1
- package/dist/orchestrator/templates/ai-src/commands/create-data-test.md +83 -0
- package/dist/orchestrator/templates/ai-src/config/claude.md +3 -1
- package/dist/orchestrator/templates/ai-src/config/copilot.md +3 -1
- package/dist/orchestrator/templates/ai-src/skills/sungen-data-factory/SKILL.md +93 -0
- package/dist/orchestrator/templates/ai-src/skills/sungen-error-mapping/SKILL.md +12 -1
- package/dist/orchestrator/templates/ai-src/skills/sungen-gherkin-syntax/SKILL.md +43 -8
- package/dist/orchestrator/templates/ai-src/skills/sungen-selector-fix/SKILL.md +22 -0
- package/dist/orchestrator/templates/ai-src/skills/sungen-selector-keys/SKILL.md +14 -1
- package/dist/orchestrator/templates/specs-db.d.ts +201 -11
- package/dist/orchestrator/templates/specs-db.d.ts.map +1 -1
- package/dist/orchestrator/templates/specs-db.js +440 -91
- package/dist/orchestrator/templates/specs-db.js.map +1 -1
- package/dist/orchestrator/templates/specs-db.ts +463 -79
- package/dist/orchestrator/templates/specs-test-data.ts +39 -3
- package/package.json +7 -4
- package/src/capabilities/discover.ts +1 -1
- package/src/capabilities/registry.ts +13 -0
- package/src/cli/commands/delivery.ts +13 -5
- package/src/cli/commands/generate.ts +15 -0
- package/src/exporters/spec-parser.ts +17 -5
- package/src/generators/test-generator/adapters/playwright/templates/steps/actions/alert-accept-action.hbs +1 -1
- package/src/generators/test-generator/adapters/playwright/templates/steps/actions/alert-dismiss-action.hbs +1 -1
- package/src/generators/test-generator/adapters/playwright/templates/steps/actions/alert-fill-action.hbs +1 -1
- package/src/generators/test-generator/adapters/playwright/templates/steps/actions/capture-row-column.hbs +2 -0
- package/src/generators/test-generator/adapters/playwright/templates/steps/actions/click-element-with-text.hbs +1 -1
- package/src/generators/test-generator/adapters/playwright/templates/steps/actions/click-with-alert-action.hbs +2 -0
- package/src/generators/test-generator/adapters/playwright/templates/steps/actions/recipe-sequence.hbs +3 -0
- package/src/generators/test-generator/adapters/playwright/templates/steps/actions/table-action-in-row-nth.hbs +2 -0
- package/src/generators/test-generator/adapters/playwright/templates/steps/actions/unknown-element-action.hbs +1 -1
- package/src/generators/test-generator/adapters/playwright/templates/steps/navigation/route-assertion.hbs +3 -0
- package/src/generators/test-generator/adapters/playwright/templates/steps/navigation/wait-for-element.hbs +1 -1
- package/src/generators/test-generator/adapters/playwright/templates/steps/navigation/wait-table-refresh.hbs +3 -0
- package/src/generators/test-generator/adapters/playwright/templates/steps/partials/has-text-value.hbs +1 -0
- package/src/generators/test-generator/adapters/playwright/templates/steps/partials/locator-base.hbs +1 -1
- package/src/generators/test-generator/adapters/playwright/templates/steps/partials/locator.hbs +1 -1
- package/src/generators/test-generator/adapters/playwright/templates/steps/partials/recipe-blur.hbs +1 -0
- package/src/generators/test-generator/adapters/playwright/templates/steps/partials/recipe-click-text.hbs +3 -0
- package/src/generators/test-generator/adapters/playwright/templates/steps/partials/recipe-click.hbs +1 -0
- package/src/generators/test-generator/adapters/playwright/templates/steps/partials/recipe-expect-text.hbs +1 -0
- package/src/generators/test-generator/adapters/playwright/templates/steps/partials/recipe-expect-value.hbs +1 -0
- package/src/generators/test-generator/adapters/playwright/templates/steps/partials/recipe-for-each.hbs +5 -0
- package/src/generators/test-generator/adapters/playwright/templates/steps/partials/recipe-hover.hbs +1 -0
- package/src/generators/test-generator/adapters/playwright/templates/steps/partials/recipe-press.hbs +1 -0
- package/src/generators/test-generator/adapters/playwright/templates/steps/partials/recipe-scroll-into-view.hbs +1 -0
- package/src/generators/test-generator/adapters/playwright/templates/steps/partials/recipe-type.hbs +1 -0
- package/src/generators/test-generator/adapters/playwright/templates/steps/partials/recipe-wait-for.hbs +1 -0
- package/src/generators/test-generator/app-profile.ts +185 -0
- package/src/generators/test-generator/code-generator.ts +9 -0
- package/src/generators/test-generator/diagnostics.ts +51 -0
- package/src/generators/test-generator/patterns/types.ts +12 -0
- package/src/generators/test-generator/recipe-expander.ts +129 -0
- package/src/generators/test-generator/step-mapper.ts +73 -0
- package/src/generators/test-generator/template-engine.ts +29 -3
- package/src/generators/test-generator/utils/selector-resolver.ts +49 -2
- package/src/harness/catalog/drivers.yaml +1 -1
- package/src/harness/query-catalog.ts +0 -0
- package/src/index.ts +5 -2
- package/src/orchestrator/templates/ai-src/commands/create-data-test.md +83 -0
- package/src/orchestrator/templates/ai-src/config/claude.md +3 -1
- package/src/orchestrator/templates/ai-src/config/copilot.md +3 -1
- package/src/orchestrator/templates/ai-src/skills/sungen-data-factory/SKILL.md +93 -0
- package/src/orchestrator/templates/ai-src/skills/sungen-error-mapping/SKILL.md +12 -1
- package/src/orchestrator/templates/ai-src/skills/sungen-gherkin-syntax/SKILL.md +43 -8
- package/src/orchestrator/templates/ai-src/skills/sungen-selector-fix/SKILL.md +22 -0
- package/src/orchestrator/templates/ai-src/skills/sungen-selector-keys/SKILL.md +14 -1
- package/src/orchestrator/templates/specs-db.ts +463 -79
- package/src/orchestrator/templates/specs-test-data.ts +39 -3
|
@@ -0,0 +1,93 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: sungen-data-factory
|
|
3
|
+
description: 'Use when create-data-test (or create-test) needs standardized TEST DATA — valid/boundary/invalid values for input fields with CHK-* traceability. Drives the Data Factory catalog + the 4-source method. Invoke after reading spec.md, when authoring the field-map or filling test-data.'
|
|
4
|
+
user-invocable: false
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
## What this skill does
|
|
8
|
+
|
|
9
|
+
Turn a screen/flow's fields into **standardized test data** — not guessed values. You author a
|
|
10
|
+
**field-map**; the deterministic `sungen data gen` expands it from the Data Factory **catalog**
|
|
11
|
+
(field-type + security + technique library) into valid / boundary / invalid values, each carrying a
|
|
12
|
+
`CHK-*` id that traces to the spec. Your judgment goes into *reading the spec correctly* and
|
|
13
|
+
*answering blind spots* — never into inventing values the catalog or the QA should own.
|
|
14
|
+
|
|
15
|
+
Requires the `data-factory` capability. If `qa/capabilities.yaml` lacks it, run
|
|
16
|
+
`sungen capability add data-factory` (runtime-free — safe to enable).
|
|
17
|
+
|
|
18
|
+
## The 4-source method (phuong-phap-tao-test-data.md)
|
|
19
|
+
|
|
20
|
+
Never invent values from memory. Cross-reference four sources — each covers the previous one's gap:
|
|
21
|
+
|
|
22
|
+
1. **Spec validate rules** — required, format, min/max, business rules, and the **error/message code**
|
|
23
|
+
per rule. Defines the legal/illegal boundary. (Says the *law*, not every way to *break* it.)
|
|
24
|
+
2. **Field-type catalog** — the accumulated "how this type breaks" knowledge (email/password/phone/
|
|
25
|
+
number/…). This is the Data Factory `common/` — it fills the "spec doesn't list every break" gap.
|
|
26
|
+
3. **Design technique** — Boundary Value Analysis / Equivalence Partitioning / Decision Table / State
|
|
27
|
+
Transition — reduces the rule + candidates to a *minimal-but-sufficient* representative set.
|
|
28
|
+
4. **DB mapping** — unique constraints, cross-entity dependency, real backend limits → precondition
|
|
29
|
+
data, not just a single input value.
|
|
30
|
+
|
|
31
|
+
Then classify every value into **Valid / Boundary / Invalid** (each invalid tagged with its error
|
|
32
|
+
code) and give it a `CHK-*` id for traceability.
|
|
33
|
+
|
|
34
|
+
## The field-map — `qa/data-factory/<name>.fields.yaml`
|
|
35
|
+
|
|
36
|
+
Your main artifact. One entry per input field; the generator expands it:
|
|
37
|
+
|
|
38
|
+
```yaml
|
|
39
|
+
screen: login # or flow: <name>
|
|
40
|
+
fields:
|
|
41
|
+
- name: email
|
|
42
|
+
type: email # a catalog field-type (see list below)
|
|
43
|
+
required: true
|
|
44
|
+
constraints: { maxLocal: 64, maxTotal: 254 } # the project's REAL limits from spec
|
|
45
|
+
errorMap: { M13: E1042, M02: E1001 } # catalog placeholder code → project's real code
|
|
46
|
+
- name: password
|
|
47
|
+
type: password
|
|
48
|
+
constraints: { minLength: 8, maxLength: 32 }
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
**Catalog field-types** (P1): `email` · `password` · `phone` · `string` · `number-integer` ·
|
|
52
|
+
`number-float` · `currency` · `postcode` · `katakana` (JP). Security payload banks auto-append to a
|
|
53
|
+
field's invalid group via the type's `uses_security` (`sqli`, `xss`, `idor`, `broken-auth`, `upload`,
|
|
54
|
+
`input-validation`).
|
|
55
|
+
|
|
56
|
+
Rules:
|
|
57
|
+
- Pick the closest `type`; put the project's real numbers in `constraints` (they override the
|
|
58
|
+
catalog defaults).
|
|
59
|
+
- Map every `errorRef` placeholder (`M13`, `M39`, …) to the spec's real code via `errorMap`. Leave
|
|
60
|
+
one unmapped **only** if the spec has none — the lint flags it as an open point to confirm.
|
|
61
|
+
|
|
62
|
+
## Blind spots — ask, never fabricate
|
|
63
|
+
|
|
64
|
+
If a field's type is **not** in the catalog — a business enum, a cross-entity constraint, a
|
|
65
|
+
project-specific data model — do **not** guess. Ask the QA (via `AskUserQuestion`) for: (1) the valid
|
|
66
|
+
set, (2) invalid / non-existent values, (3) the error code when wrong, (4) dependencies on other
|
|
67
|
+
fields. Record it in `qa/data-factory/project/<entity>.yaml` so it becomes reusable project catalog.
|
|
68
|
+
This is the core discipline: *common is never enough; when blind, think and ask — don't invent.*
|
|
69
|
+
|
|
70
|
+
## Customizing the catalog — `.overwrite` (survives `sungen update`)
|
|
71
|
+
|
|
72
|
+
The shipped `common/` is a floor. Project rules go in `qa/data-factory/common.overwrite.yaml`,
|
|
73
|
+
deep-merged over the common (**later-wins**, keyed by `type` + data-point `id`): same `id` replaces,
|
|
74
|
+
new `id` appends, `constraints` merge key-by-key. `sungen update` refreshes `common/` but never
|
|
75
|
+
touches your overlay. If an update makes an overlay entry stale (references a bank/constraint that no
|
|
76
|
+
longer exists), the loader **warns you to prune it** — it never edits your file. Prefer a targeted
|
|
77
|
+
`errorMap`/`constraints` in the field-map for per-screen tweaks; use `.overwrite` only for rules that
|
|
78
|
+
apply project-wide.
|
|
79
|
+
|
|
80
|
+
## Verify before done — the phuong-phap §6 checklist
|
|
81
|
+
|
|
82
|
+
Run `sungen data lint` and clear it: every required field has **≥1 valid**, **boundary present**
|
|
83
|
+
(exact min/max, not only over-boundary) for bounded types, **≥1 invalid per rule** (not one generic
|
|
84
|
+
"wrong" value for many rules), no `UNRESOLVED` values, error codes mapped or explicitly left open.
|
|
85
|
+
Then `sungen data gen` writes the standardized `test-data/<name>.yaml`. Do not hand-edit the
|
|
86
|
+
generated values — change the field-map or `.overwrite` and re-run (determinism: same input → same
|
|
87
|
+
data).
|
|
88
|
+
|
|
89
|
+
## Weaving into scenarios
|
|
90
|
+
|
|
91
|
+
When a `.feature` exists, express invalid/boundary sets as data-driven `Scenario Outline` + `Examples`
|
|
92
|
+
(`@cases`) referencing the values — see `sungen-gherkin-syntax`. This keeps one logic + many values
|
|
93
|
+
instead of copy-pasted scenarios, and each row carries its `CHK-*` id for traceability.
|
|
@@ -78,9 +78,20 @@ needs any of these, it is a **finding for QA** — surface it in the run summary
|
|
|
78
78
|
| strict mode violation | Multiple elements match | Add `nth: 0`, `exact: true`, or more specific `name` |
|
|
79
79
|
| Timeout / not found | Element doesn't exist or name wrong | Re-snapshot → copy exact accessible name. Check iframe/dialog scope |
|
|
80
80
|
| Element is not an input | Wrong element type targeted | Change `type` or `value` to match actual element |
|
|
81
|
-
| not a select | Custom dropdown, not native `<select>` | Set `variant:
|
|
81
|
+
| not a select | Custom dropdown, not native `<select>` | Set the widget variant: `variant: radix-select`/`antd-select` (built-in recipes), a custom recipe name from `qa/app.yaml`, or project-wide `widgets.select` in `qa/app.yaml` |
|
|
82
82
|
| Frame not found | iframe selector wrong or doesn't exist | Fix `frame` value, verify iframe in snapshot |
|
|
83
83
|
|
|
84
|
+
### Compile diagnostics (`sungen generate` output) → fix BEFORE running
|
|
85
|
+
|
|
86
|
+
| Code | Meaning | Fix |
|
|
87
|
+
|---|---|---|
|
|
88
|
+
| `SG-W001` | Step matched no pattern — compiled to a no-op `// TODO` (the test runs weaker than it reads) | Rephrase to a documented pattern (`sungen-gherkin-syntax`) or tag `@manual` with a reason |
|
|
89
|
+
| `SG-W002` | A step's `{{value}}` was parsed but never used in the generated code | The step form isn't the one you think — check the pattern's exact syntax |
|
|
90
|
+
| `SG-W003` | `{ name }` filter defaulted from the Gherkin reference on a name-from-content role (toast/alert/status) | Add explicit `name:` or opt out with `name: null` |
|
|
91
|
+
| `SG-W005` | `qa/app.yaml` unknown key / unknown preset / unparseable | Fix the key, or `extends: native\|radix\|antd` |
|
|
92
|
+
| `SG-W006` | `qa/app.<env>.yaml` found — unsupported by design | Describe the app once in `qa/app.yaml`; env differences belong in test-data overlays |
|
|
93
|
+
| `SG-W007` | Browser-alert handler step written AFTER an action — listener registers too late, the dialog auto-dismisses silently | Use the compound form `click [X] button and accept [OK] alert` (preferred), or move the alert step before the trigger |
|
|
94
|
+
|
|
84
95
|
### Assertion errors → apply the Source-of-truth gate above FIRST
|
|
85
96
|
|
|
86
97
|
> The "Fix" column below applies **only when the expected value was wrong relative to `spec.md`** (a test defect). If the app's value contradicts the spec, the row is a **candidate bug → report it, do not edit the expected to match live**. Never weaken `toHaveText`→`toContainText` just to pass.
|
|
@@ -50,16 +50,41 @@ User expand | collapse [T] row
|
|
|
50
50
|
### Alert / Keyboard / Wait / Scroll
|
|
51
51
|
|
|
52
52
|
```
|
|
53
|
-
User click [
|
|
53
|
+
User click [T] button and accept [OK] alert # PREFERRED (v3.3): natural order,
|
|
54
|
+
User click [T] button and dismiss [Cancel] alert # compiler registers the listener first
|
|
55
|
+
User click [OK | Cancel] alert # two-step form: must come BEFORE the trigger
|
|
54
56
|
User fill [T] alert with {{v}}
|
|
55
57
|
User see [message text] alert
|
|
56
58
|
User press Escape key | Enter on [T] field
|
|
57
|
-
User wait for N seconds | [T]
|
|
59
|
+
User wait for N seconds | [T] page
|
|
60
|
+
User wait for [T] TYPE is visible | hidden | enabled | disabled # ANY reference (v3.3)
|
|
61
|
+
User wait for [T] TYPE with {{v}} # until it shows the value
|
|
62
|
+
User wait for [T] table to refresh # filter/search/pagination round-trip (v3.3)
|
|
58
63
|
User scroll to [T] section
|
|
59
64
|
User switch to [T] frame | [main] frame
|
|
60
65
|
```
|
|
61
66
|
|
|
62
|
-
>
|
|
67
|
+
> **Browser alerts (native `window.confirm/alert/prompt` only):** prefer the compound form —
|
|
68
|
+
> it reads in the user's real order and declares the trigger↔dialog causality in one step.
|
|
69
|
+
> The two-step form stays valid but the alert step must appear BEFORE the triggering action
|
|
70
|
+
> (a late `page.once('dialog')` lets the dialog auto-dismiss silently — compile warning
|
|
71
|
+
> `SG-W007`). Custom confirm MODALS (ARIA dialogs — most modern apps) are ordinary buttons:
|
|
72
|
+
> write normal click steps, no alert step at all.
|
|
73
|
+
> State-based waits (`is hidden`, `with {{v}}`, `table to refresh`) are legitimate; time-based
|
|
74
|
+
> `wait for N seconds` stays a last resort. `table to refresh` watches the app's loading
|
|
75
|
+
> indicator (`qa/app.yaml` `feedback.loading.indicator`, default `[aria-busy="true"]`).
|
|
76
|
+
|
|
77
|
+
### Positional table rows (v3.3)
|
|
78
|
+
|
|
79
|
+
```
|
|
80
|
+
User remember [Col] column in [T] table row {{n}} as {{var}} # read a cell by POSITION
|
|
81
|
+
User click [Act] button in [T] table row {{n}} # act on the SAME row
|
|
82
|
+
User click [Act] button in [T] table row 2 # literal row number
|
|
83
|
+
```
|
|
84
|
+
|
|
85
|
+
Row numbers are 1-based data rows (header not counted; override via `qa/app.yaml`
|
|
86
|
+
`conventions.table`). Use positional rows when you must READ then ACT on the same row —
|
|
87
|
+
two content-filtered queries can hit different rows if the table re-renders in between.
|
|
63
88
|
|
|
64
89
|
### Assertions (8 patterns → determines Playwright assertion)
|
|
65
90
|
|
|
@@ -118,14 +143,24 @@ Scenario: ...
|
|
|
118
143
|
|
|
119
144
|
Path access on a bound result: `{{q.count}}`/`{{q.length}}`, `{{q.first.col}}`, `{{q.last.col}}`, `{{q[2].col}}`, `{{q.col}}` (= first row's col). `expect A is B` also supports `is at least` / `is at most` / `is not`. Tier-2 declarative (trivial inline, no catalog): `User see [<table>] row where [<col>] is {{v}} [has [<col2>] = "x"]`, `… no row where …`, `… count is {{n}}`. Full grammar + catalog/datasource/secret rules → **Advanced → Database** doc. Only emit DB steps when the project has a `database/` catalog / `datasources.yaml`.
|
|
120
145
|
|
|
146
|
+
### NoSQL engines (Cosmos, MongoDB, DynamoDB) — natively supported
|
|
147
|
+
|
|
148
|
+
Beyond the three SQL engines, the Data Driver has native NoSQL engines. Declarative steps (`User see [table] row where …`, `… no row …`, `… count is …`) work across ALL of them; only the raw `@query` catalog shape differs per engine:
|
|
149
|
+
|
|
150
|
+
- **`engine: cosmos`** (Azure Cosmos DB, NoSQL API) — SQL dialect. Author `sql:` catalog entries against the mandatory `c` alias (`SELECT * FROM c WHERE c.<field> = :p`); named params bind automatically. Config: `endpoint`+`key` (or a connection-string `url`), `database`, `container` (default when no `[table]`). Read-only by construction (the query API can't mutate).
|
|
151
|
+
- **`engine: mongodb`** — no SQL. Author a `find:` (`{collection, filter, projection?, sort?, limit?}`) or `pipeline:` (`{collection, stages: […]}`) catalog entry; `:param` placeholders bind at runtime. `$out`/`$merge`/`$where`/`$function`/`$accumulator`/`mapReduce` are refused. Config: a `mongodb://` `url`. Read-only = a server-side read role.
|
|
152
|
+
- **`engine: dynamodb`** — raw `@query` is PartiQL SELECT (`sql: SELECT … FROM "table" WHERE pk = :p`). Declarative steps route GetItem/Query only for partition-/sort-key filters via a `keySchema:` registry; a **non-key filter is refused** (use a raw PartiQL SELECT — never a full-table Scan). Config: `region` + `keySchema` (credentials from the AWS env chain). Read-only = IAM `PartiQLSelect`-only.
|
|
153
|
+
|
|
154
|
+
Full config + catalog examples → **Advanced → Database** doc.
|
|
155
|
+
|
|
121
156
|
### Unsupported DB engine — fallback (ask, don't improvise)
|
|
122
157
|
|
|
123
|
-
Direct SQL verification (`@query`, the Data Driver)
|
|
158
|
+
Direct SQL verification (`@query`, the Data Driver) covers these SQL engines: **`{postgres, sqlite, mysql}`** — plus the three native NoSQL engines above (Cosmos, MongoDB, DynamoDB). When a datasource's `engine` (or the DB the user describes) is **outside all of those** — e.g. Cassandra, Oracle, Neo4j, a proprietary store:
|
|
124
159
|
|
|
125
160
|
1. **Do not** attempt a direct connect. **Do not** improvise a verification method.
|
|
126
161
|
2. Present a fixed `AskUserQuestion` with exactly these 3 branches (always these, no others invented):
|
|
127
162
|
- **@api** — verify state via the project's internal API (route to the API driver).
|
|
128
|
-
- **@manual** — emit a `@manual` step + manual-check guidance (e.g.
|
|
163
|
+
- **@manual** — emit a `@manual` step + manual-check guidance (e.g. the vendor console / CLI — `cqlsh` for Cassandra, `cypher-shell` for Neo4j).
|
|
129
164
|
- **Proxy / read-replica SQL** — if the user can supply a SQL-compatible endpoint (including Azure Cosmos DB **for PostgreSQL** / Citus), treat it as `engine: postgres` (or `mysql`) and use the normal Data Driver path above.
|
|
130
165
|
3. **Recommend, don't decide.** Check the project for signals and put the best-fit branch **first**, tagged **"(Recommended)"** with a one-line reason:
|
|
131
166
|
- a project API driver / `qa/api/` catalog / `PEERCONNE_URL`-style internal API exists → **@api** first;
|
|
@@ -138,11 +173,11 @@ Direct SQL verification (`@query`, the Data Driver) only supports these engines:
|
|
|
138
173
|
Example:
|
|
139
174
|
```
|
|
140
175
|
AskUserQuestion:
|
|
141
|
-
question: "This datasource's engine (
|
|
176
|
+
question: "This datasource's engine (cassandra) isn't a supported Data Driver engine ({postgres, sqlite, mysql} + Cosmos/MongoDB/DynamoDB) — direct connect isn't supported. How should DB state be verified?"
|
|
142
177
|
options:
|
|
143
178
|
- "@api — verify via the project's internal API (Recommended: qa/api/ catalog found)"
|
|
144
|
-
- "@manual — emit a @manual step +
|
|
145
|
-
- "Proxy / read-replica SQL — supply a SQL-compatible endpoint
|
|
179
|
+
- "@manual — emit a @manual step + cqlsh check"
|
|
180
|
+
- "Proxy / read-replica SQL — supply a SQL-compatible endpoint → engine: postgres"
|
|
146
181
|
- "Other — describe your own verification approach"
|
|
147
182
|
```
|
|
148
183
|
|
|
@@ -83,6 +83,13 @@ When running Phase 0 for a **flow** (`qa/flows/<name>/`), check existing screen
|
|
|
83
83
|
- If any mismatch → write an explicit YAML entry using the real DOM name. Do not leave a mismatch to be caught at runtime.
|
|
84
84
|
- **Typical mismatch cases**: Gherkin uses English label (`[Submit]`) but app displays Vietnamese (`"Gửi"`); placeholder is descriptive (`"Nhập email của bạn"`) not a bare field name (`"Email"`); button text includes an icon glyph before/after the word.
|
|
85
85
|
7. **Substring ambiguity check**: for each `role` + `name` selector, check if any other element in the snapshot has a name that **contains** this name as a substring (e.g., `"Đăng ký"` vs `"Đăng ký bằng Google"`). If yes → add `exact: true` to prevent strict mode violation at runtime.
|
|
86
|
+
7b. **Widget & profile fingerprinting** (App Profile, v3.3): while the snapshot is open, identify the UI library and non-standard widget behavior, and record it so the compiler stops guessing:
|
|
87
|
+
- **Fingerprints** (check DOM classes/attributes): `.ant-select`/`.ant-picker` → antd · `[data-radix-*]` / shadcn portals → radix · `.MuiSelect-*`/`.MuiPickersDay` → MUI · `.select2-container` → select2 · plain `<select>` → native.
|
|
88
|
+
- **Project-wide** conclusion (the whole app uses one library) → write/update `qa/app.yaml`: `extends: radix|antd|native`. **Element-level** outlier (one widget differs from the rest) → set `variant:` on that selector entry only (e.g. `variant: native`, `variant: antd-select`).
|
|
89
|
+
- Custom widget nobody's preset covers (in-house datepicker etc.) → author a recipe in `qa/app.yaml` `recipes:` (closed primitives: click/type/press/waitFor/clickText/expectText/expectValue/forEach) and bind it per element with `variant: <recipe-name>`.
|
|
90
|
+
- Toast/alert named from content (no aria-label) → `feedback.toast: { role: status, named_by: content }` + `name: null` on the selector entries.
|
|
91
|
+
- Loading indicator for `wait for [T] table to refresh` → `feedback.loading.indicator` (skip if the app sets `aria-busy`).
|
|
92
|
+
- **Every qa/app.yaml edit MUST carry provenance** in `detection:`: who/when (`detected_by`) and the observed evidence per key (`evidence:`). A profile without evidence is a guess a human cannot review.
|
|
86
93
|
8. **Merge, don't overwrite**: preserve the page selector and any user-authored entries in `selectors.yaml`. Only add missing keys.
|
|
87
94
|
- **Type-collision check** (see `sungen-selector-keys` § Collision rule): before writing a base key, check whether it already exists with a *different* `type`. If so, give **both** entries a `--type` suffix instead of clobbering or sharing the base key — a base-key entry of the wrong type gets picked up by any step referencing that label. Watch `page` especially: a `[X] page` step reads `value` as a URL, so if `X` already holds a button (`value: 'button'`) the assertion compiles to `toHaveURL(/button/)`. Write `X--page` (URL from the live page / feature `Path:`) alongside `X--button`.
|
|
88
95
|
9. **Show summary + confirm**: list the keys that will be added, ask the user to approve, then write the file.
|
|
@@ -301,6 +308,18 @@ Only when `test-results/` screenshots are insufficient:
|
|
|
301
308
|
|
|
302
309
|
Never use `browser_evaluate` to inject or read cookies (misses httpOnly). For auth, use Phase 0.5 or `sungen makeauth`.
|
|
303
310
|
|
|
311
|
+
### Step 2b: Selector sanity probe — suspect the compiler/profile BEFORE the app
|
|
312
|
+
|
|
313
|
+
For every failing locator, while the live page is in the failing state, count matches before attributing the failure to server load, timing, or flakiness:
|
|
314
|
+
|
|
315
|
+
1. **Probe the exact generated locator** (copy it from the `.spec.ts`): count = 0 while the element is clearly on screen → the locator is wrong, not the app.
|
|
316
|
+
2. **Peel one constraint at a time and re-count**:
|
|
317
|
+
- drop the `{ name }` filter → now found? → invented/wrong accessible name → fix `name:` or set `name: null` (name-from-content roles; matches compile warning `SG-W003`)
|
|
318
|
+
- drop the dialog/parent scope → now found? → portal-rendered element → check `qa/app.yaml` `layers.portal_roles` / remove a wrong `scope: 'dialog'`
|
|
319
|
+
- drop `exact`/text filter → now found? → text mismatch (NBSP, trailing space, i18n) → fix the value or use `{{variable}}`
|
|
320
|
+
3. **Repair at the right altitude**: a per-element mistake → fix that `selectors.yaml` entry; a pattern repeated across elements (every toast, every dropdown) → fix `qa/app.yaml` once (with `detection.evidence`) so every screen inherits the fix. **Never rewrite the `.feature` to dodge a selector problem** — intent stays, identity/behavior get repaired.
|
|
321
|
+
4. Also read the generate output: `SG-W001/W002/W003` diagnostics fired at compile time usually name the broken step before you run anything.
|
|
322
|
+
|
|
304
323
|
### Step 3: Fix Broken Selectors
|
|
305
324
|
|
|
306
325
|
Selector priority (use first applicable):
|
|
@@ -367,6 +386,9 @@ Quick reference for the most frequent production failures:
|
|
|
367
386
|
| `No element found` on `[X] field` | Field has no placeholder, or placeholder ≠ X | Write explicit YAML: `type: label, value: "Actual label"` or `type: placeholder, value: "Actual placeholder"` |
|
|
368
387
|
| `No element found` on `[X] text` / `message` | Visible text differs from Gherkin label, or text is dynamic | Write explicit YAML or use `{{variable}}` for dynamic content |
|
|
369
388
|
| `strict mode violation` | Multiple elements match the same name/text | Add `exact: true` to YAML entry, or add `nth` |
|
|
389
|
+
| `strict mode violation` on `… with {{v}}` clicks (prefix-sharing options: "Văn phòng Hà Nội 1/2/…") | The `{{v}}` filter is a substring match by default | Add `exact: true` — since 3.3 it also anchors the `.filter({ hasText })` of action steps (`/^value$/`), not just role-name matching |
|
|
390
|
+
| Toast/alert/spinner assertion times out but `[role="status"]` exists on the live page (`SG-W003` at generate time) | Entry has no `name:` → compiler defaulted `{ name: '<Gherkin ref>' }`, but status/alert names derive from CONTENT and never equal the reference | Add `name: null` to the entry (match by role only). Do NOT switch to `type: locator` |
|
|
391
|
+
| Option/menu click inside a dialog times out, but the SAME locator works without dialog scope | Portal-rendered layer (Radix/MUI/antd) lives outside the dialog's DOM subtree | Since 3.3 the compiler page-roots portal roles (option/listbox/menu/menuitem/tooltip) automatically; for a listbox genuinely inside the dialog add `scope: 'dialog'` to the entry. Check `qa/app.yaml` `layers.portal_roles` (preset `native` disables the exemption) |
|
|
370
392
|
| `toBeVisible` timeout on dynamic content | Snapshot was taken while page was still loading | Wait for spinner/skeleton to clear before snapshotting; add `browser_wait_for` |
|
|
371
393
|
| All tests fail with page navigate error | Page selector URL wrong or baseURL mismatch | Re-check `playwright.config.ts` `baseURL` and page selector `value` path |
|
|
372
394
|
| Auth redirect on every test | `specs/.auth/<role>.json` missing or expired | Run Phase 0.5 to capture fresh session |
|
|
@@ -239,7 +239,20 @@ If no YAML key exists, the resolver infers from the Gherkin element type:
|
|
|
239
239
|
|
|
240
240
|
**Special note on `[X] field`**: `getByPlaceholder('X')` only works when (1) the field has a placeholder attribute AND (2) the placeholder text equals X. For fields without placeholders (floating labels, aria-label), write explicit YAML: `type: label, value: "Actual label text"`.
|
|
241
241
|
|
|
242
|
-
**Only add a YAML entry when** auto-infer cannot work: DOM name differs from Gherkin label, need `testid`, need `nth`, need `exact: true`, or the field type requires explicit config.
|
|
242
|
+
**Only add a YAML entry when** auto-infer cannot work: DOM name differs from Gherkin label, need `testid`, need `nth`, need `exact: true`, need `name: null`, or the field type requires explicit config.
|
|
243
|
+
|
|
244
|
+
### `name: null` — name-from-content roles (toast, alert, spinner)
|
|
245
|
+
|
|
246
|
+
For a `type: role` entry **without** `name:`, the compiler defaults the accessible-name filter to the Gherkin `[Reference]` text. That is right for buttons/links — and **always wrong** for roles whose accessible name derives from their CONTENT (`status`, `alert`, `log`, `marquee`, `timer`): a toast's name is its message text, never the string "Success Toast". The compiler warns (`SG-W003`). Opt out explicitly:
|
|
247
|
+
|
|
248
|
+
```yaml
|
|
249
|
+
success toast:
|
|
250
|
+
type: 'role'
|
|
251
|
+
value: 'status'
|
|
252
|
+
name: null # deliberate: match by role only, no name filter
|
|
253
|
+
```
|
|
254
|
+
|
|
255
|
+
Use this for every toast/alert/spinner content assertion. Do NOT fall back to `type: locator, value: '[role="status"]'` — `name: null` keeps role semantics.
|
|
243
256
|
|
|
244
257
|
### Types requiring YAML entry (no auto-infer)
|
|
245
258
|
|