@allurereport/plugin-agent 3.10.0 → 3.12.0
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/README.md +118 -77
- package/dist/capabilities.d.ts +127 -0
- package/dist/capabilities.js +266 -0
- package/dist/errors.d.ts +9 -0
- package/dist/errors.js +15 -0
- package/dist/guidance.d.ts +4 -5
- package/dist/guidance.js +223 -60
- package/dist/harness.d.ts +72 -4
- package/dist/harness.js +49 -17
- package/dist/index.d.ts +9 -1
- package/dist/index.js +9 -0
- package/dist/inline-expectations.d.ts +23 -0
- package/dist/inline-expectations.js +186 -0
- package/dist/invalid-output.d.ts +58 -0
- package/dist/invalid-output.js +238 -0
- package/dist/model.d.ts +59 -0
- package/dist/model.js +8 -1
- package/dist/paths.d.ts +3 -0
- package/dist/paths.js +10 -0
- package/dist/plugin.js +916 -137
- package/dist/query.d.ts +195 -0
- package/dist/query.js +177 -0
- package/dist/selection.d.ts +42 -0
- package/dist/selection.js +141 -0
- package/dist/state.d.ts +56 -0
- package/dist/state.js +277 -0
- package/dist/utils.d.ts +17 -0
- package/dist/utils.js +171 -0
- package/package.json +6 -6
package/README.md
CHANGED
|
@@ -27,14 +27,13 @@ When enabled, the plugin writes:
|
|
|
27
27
|
- `manifest/run.json`, `manifest/tests.jsonl`, and `manifest/findings.jsonl` for machine-readable review
|
|
28
28
|
- copied run logs and other artifacts under `artifacts/`
|
|
29
29
|
- `AGENTS.md` with guidance for consuming the directory
|
|
30
|
-
- `manifest/expected.json` when
|
|
31
|
-
- `project/docs/allure-agent-mode.md` when the project has a guide at `docs/allure-agent-mode.md`
|
|
30
|
+
- `manifest/expected.json` when inline flags, `--expectations <file>`, or plugin options provide expectations
|
|
32
31
|
|
|
33
32
|
If no output directory is configured, the plugin does nothing.
|
|
34
33
|
|
|
35
34
|
The plugin stays read-only by design. A separate harness layer can consume the
|
|
36
35
|
generated manifests, plan enrichment work, and decide whether a rerun is ready to
|
|
37
|
-
accept.
|
|
36
|
+
accept.
|
|
38
37
|
|
|
39
38
|
## Verification Standard
|
|
40
39
|
|
|
@@ -42,19 +41,34 @@ accept. See [the enrichment loop guide](../../docs/agent_enrichment_loop.md).
|
|
|
42
41
|
- Use `allure agent` for smoke checks too, even when the change is small or mechanical.
|
|
43
42
|
- Only skip agent mode when it is impossible or when you are debugging agent mode itself.
|
|
44
43
|
|
|
45
|
-
##
|
|
44
|
+
## CLI Capability Workflow
|
|
46
45
|
|
|
47
|
-
The
|
|
46
|
+
The installed CLI help is the local contract for agent mode. When an agent needs
|
|
47
|
+
to choose supported commands or flags, detect the local CLI surface first:
|
|
48
48
|
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
49
|
+
```shell
|
|
50
|
+
allure --version
|
|
51
|
+
allure agent capabilities --json
|
|
52
|
+
allure agent --help
|
|
53
|
+
allure agent query --help
|
|
54
|
+
allure agent select --help
|
|
55
|
+
allure agent latest --help
|
|
56
|
+
allure agent state-dir --help
|
|
57
|
+
```
|
|
54
58
|
|
|
55
|
-
|
|
56
|
-
`
|
|
57
|
-
|
|
59
|
+
`allure agent capabilities --json` is the structured local contract for agents.
|
|
60
|
+
`allure agent --help` includes the human-readable command task map. Each
|
|
61
|
+
agent-mode command names the loop it supports, the problem signal that calls for
|
|
62
|
+
it, and the task the agent should perform with it. For example, `allure agent
|
|
63
|
+
latest` belongs to output recovery, `allure agent state-dir` belongs to tooling
|
|
64
|
+
diagnosis, `allure agent query` belongs to output inspection,
|
|
65
|
+
`allure agent select` belongs to rerun planning, and `--rerun-*` belongs to
|
|
66
|
+
focused retry loops.
|
|
67
|
+
|
|
68
|
+
Every generated run includes an `AGENTS.md` playbook with the same stable
|
|
69
|
+
artifact-reading order, command task map, workflow guidance, and remediation
|
|
70
|
+
rules. Reusable skills and common knowledge files should not hard-code
|
|
71
|
+
version-specific flags; they should ask the local CLI when support is unclear.
|
|
58
72
|
|
|
59
73
|
## Install
|
|
60
74
|
|
|
@@ -90,50 +104,77 @@ The preferred CLI entrypoint is:
|
|
|
90
104
|
npx allure agent -- npm test
|
|
91
105
|
```
|
|
92
106
|
|
|
93
|
-
|
|
107
|
+
To analyze existing Allure results or dump archives downloaded from CI without
|
|
108
|
+
rerunning tests, use `agent inspect`. Positional arguments match Allure results
|
|
109
|
+
directories. `--dump` accepts paths or glob patterns and can be repeated for
|
|
110
|
+
multiple jobs or environments:
|
|
94
111
|
|
|
95
112
|
```shell
|
|
96
|
-
npx allure agent
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
-- npm test
|
|
113
|
+
npx allure agent inspect path/to/allure-results
|
|
114
|
+
npx allure agent inspect --dump allure-results-linux.zip --dump allure-results-macos.zip
|
|
115
|
+
npx allure agent inspect --config ./allurerc.mjs --output ./agent-output path/to/allure-results
|
|
100
116
|
```
|
|
101
117
|
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
|
|
118
|
+
`agent inspect` accepts the same result inputs and configuration-style options as
|
|
119
|
+
`allure generate`, including result directory globs, `--dump`, `--config`,
|
|
120
|
+
`--cwd`, `--report-name`, `--history-limit`, and `--hide-labels`. Its `--output`
|
|
121
|
+
option writes the agentic output directory.
|
|
122
|
+
|
|
123
|
+
`allure agent` and `allure agent inspect` use `--report auto` by default. This
|
|
124
|
+
writes the agent-readable artifacts and, when the stored visible result count is
|
|
125
|
+
1000 or fewer, also writes a single-file Awesome report at `awesome/index.html`
|
|
126
|
+
inside the agent output directory. Runs above that threshold skip the human
|
|
127
|
+
report to avoid excessive output. Check `manifest/human-report.json`, the Human
|
|
128
|
+
Report section in `index.md`, or `allure agent query --latest summary` to see
|
|
129
|
+
whether a report was generated.
|
|
130
|
+
|
|
131
|
+
If you need the human-readable report from the most recent agent run, first run
|
|
132
|
+
`npx allure agent latest` when the output directory is unknown. Then check
|
|
133
|
+
`<output>/manifest/human-report.json`; when its status is `generated`, open
|
|
134
|
+
`<output>/<path>` from that manifest, usually `<output>/awesome/index.html`.
|
|
135
|
+
Use `--report off` for agent-only artifacts, `--report awesome` to force the
|
|
136
|
+
single-file Awesome report regardless of result count, or `--report config` to
|
|
137
|
+
force the configured non-agent report plugins inside the agent output directory.
|
|
138
|
+
|
|
139
|
+
You can provide compact inline expectations for the common review path:
|
|
105
140
|
|
|
106
141
|
```shell
|
|
107
|
-
|
|
142
|
+
npx allure agent \
|
|
143
|
+
--goal "Review feature A" \
|
|
144
|
+
--expect-tests 3 \
|
|
145
|
+
--expect-label feature=feature-a \
|
|
146
|
+
--expect-step-containing "validate feature A" \
|
|
147
|
+
--expect-steps 1 \
|
|
148
|
+
-- npm test
|
|
108
149
|
```
|
|
109
150
|
|
|
110
|
-
|
|
151
|
+
Use an explicit expectations file and output directory when inline flags become awkward or you need deterministic paths:
|
|
111
152
|
|
|
112
153
|
```shell
|
|
113
|
-
|
|
114
|
-
|
|
115
|
-
|
|
154
|
+
npx allure agent \
|
|
155
|
+
--output ./out/agent-report \
|
|
156
|
+
--expectations ./out/agent-expected.yaml \
|
|
157
|
+
-- npm test
|
|
116
158
|
```
|
|
117
159
|
|
|
160
|
+
That command uses the default `--report auto` policy. Configured presentation or
|
|
161
|
+
export plugins such as Dashboard or TestOps are otherwise ignored for agent runs
|
|
162
|
+
unless you explicitly use `--report config`.
|
|
163
|
+
|
|
118
164
|
## Options
|
|
119
165
|
|
|
120
166
|
The plugin accepts the following options:
|
|
121
167
|
|
|
122
168
|
| Option | Description | Type | Default |
|
|
123
169
|
|--------|-------------|------|---------|
|
|
124
|
-
| `outputDir` | Directory where the markdown report will be written. Relative paths are resolved from the `allure` process working directory | `string` |
|
|
125
|
-
|
|
126
|
-
|
|
127
|
-
|
|
128
|
-
|
|
|
129
|
-
|
|
130
|
-
| `
|
|
131
|
-
| `
|
|
132
|
-
| `ALLURE_AGENT_COMMAND` | The executed command string recorded in `manifest/run.json` and `index.md` |
|
|
133
|
-
| `ALLURE_AGENT_NAME` | Optional agent identifier recorded in `manifest/run.json` |
|
|
134
|
-
| `ALLURE_AGENT_LOOP_ID` | Optional loop identifier recorded in `manifest/run.json` |
|
|
135
|
-
| `ALLURE_AGENT_TASK_ID` | Optional task identifier recorded in `manifest/run.json` |
|
|
136
|
-
| `ALLURE_AGENT_CONVERSATION_ID` | Optional conversation identifier recorded in `manifest/run.json` |
|
|
170
|
+
| `outputDir` | Directory where the markdown report will be written. Relative paths are resolved from the `allure` process working directory | `string` | none |
|
|
171
|
+
| `expectationsPath` | Path to a YAML or JSON file describing expected and forbidden test scope | `string` | none |
|
|
172
|
+
| `expectations` | Inline expectations object. Use either `expectationsPath` or `expectations`, not both | `AgentExpectationsInput` | none |
|
|
173
|
+
| `command` | Executed command string recorded in `manifest/run.json` and `index.md` | `string` | none |
|
|
174
|
+
| `agentName` | Optional agent identifier recorded in `manifest/run.json` | `string` | none |
|
|
175
|
+
| `loopId` | Optional loop identifier recorded in `manifest/run.json` | `string` | none |
|
|
176
|
+
| `taskId` | Optional task identifier recorded in `manifest/run.json` | `string` | expectations task id |
|
|
177
|
+
| `conversationId` | Optional conversation identifier recorded in `manifest/run.json` | `string` | none |
|
|
137
178
|
|
|
138
179
|
## Manifest Contract
|
|
139
180
|
|
|
@@ -148,8 +189,7 @@ The plugin emits a hybrid output:
|
|
|
148
189
|
- `manifest/test-events.jsonl`
|
|
149
190
|
- `manifest/tests.jsonl`
|
|
150
191
|
- `manifest/findings.jsonl`
|
|
151
|
-
- `manifest/expected.json` when
|
|
152
|
-
- `project/docs/allure-agent-mode.md` when the project guide is available
|
|
192
|
+
- `manifest/expected.json` when expectations are provided
|
|
153
193
|
|
|
154
194
|
`index.md` is the landing page for the run. It includes run identity, expected scope,
|
|
155
195
|
advisory check summary, process logs, and grouped test links.
|
|
@@ -162,10 +202,20 @@ Each test markdown file includes:
|
|
|
162
202
|
- retry history
|
|
163
203
|
- advisory findings and rerun guidance when evidence is weak
|
|
164
204
|
|
|
205
|
+
## Expectations
|
|
206
|
+
|
|
207
|
+
The preferred `allure agent` workflow uses inline flags:
|
|
208
|
+
|
|
209
|
+
- `--goal <text>` records the review intent.
|
|
210
|
+
- `--expect-tests <count>` checks visible logical test count.
|
|
211
|
+
- `--expect-label name=value`, `--expect-env <id>`, `--expect-test "<fullName>"`, and `--expect-prefix <prefix>` define expected scope. For a newly added test, use `--expect-test "<fullName>"` so a missing reported test becomes an explicit finding.
|
|
212
|
+
- `--expect-step-containing <text>`, `--expect-steps <count>`, `--expect-attachments <count>`, and `--expect-attachment <name|name=value|content-type=value>` define evidence expectations per evidence-target logical test.
|
|
213
|
+
|
|
214
|
+
The plugin normalizes inline expectations into `manifest/expected.json`.
|
|
215
|
+
|
|
165
216
|
## Expectations File
|
|
166
217
|
|
|
167
|
-
When `
|
|
168
|
-
it into `manifest/expected.json`, and compares the run against it.
|
|
218
|
+
When `--expectations <file>` or the plugin `expectationsPath` option is set, the plugin accepts YAML or JSON, normalizes it into `manifest/expected.json`, and compares the run against it.
|
|
169
219
|
|
|
170
220
|
Expected top-level fields:
|
|
171
221
|
|
|
@@ -173,6 +223,7 @@ Expected top-level fields:
|
|
|
173
223
|
goal: Validate feature A
|
|
174
224
|
task_id: feature-a
|
|
175
225
|
expected:
|
|
226
|
+
test_count: 3
|
|
176
227
|
environments:
|
|
177
228
|
- default
|
|
178
229
|
full_names:
|
|
@@ -197,23 +248,27 @@ notes:
|
|
|
197
248
|
Selectors are advisory. The plugin does not fail the run; it records findings in
|
|
198
249
|
markdown and `manifest/findings.jsonl`.
|
|
199
250
|
|
|
200
|
-
##
|
|
251
|
+
## Agent Workflow Pattern
|
|
201
252
|
|
|
202
|
-
|
|
253
|
+
Use the smallest workflow that matches the task. For the common change-validation path:
|
|
203
254
|
|
|
204
|
-
1. Run tests with `allure agent -- <command>`.
|
|
255
|
+
1. Run tests with `allure agent --goal <text> --expect-test "<fullName>" --expect-label name=value --expect-step-containing <text> -- <command>`.
|
|
205
256
|
2. Watch `manifest/run.json` and `manifest/test-events.jsonl` while the run is active.
|
|
206
257
|
3. Review `index.md` plus the manifest files.
|
|
207
258
|
4. If evidence is weak, add steps, attachments, labels, or parameters.
|
|
208
|
-
5. Rerun the same scope with the same expectations
|
|
259
|
+
5. Rerun the same scope with the same expectations.
|
|
209
260
|
6. Accept the run or iterate based on advisory findings.
|
|
210
261
|
|
|
262
|
+
When a prior agent run already captured failed tests, prefer
|
|
263
|
+
`allure agent --rerun-latest --rerun-preset failed -- <command>` or
|
|
264
|
+
`allure agent --rerun-from <output-dir> --rerun-preset failed -- <command>`
|
|
265
|
+
instead of spending context reconstructing runner-specific test names.
|
|
266
|
+
|
|
211
267
|
For small mechanical test changes, use a scoped agent-mode run for the smoke check
|
|
212
268
|
too. Plain runner commands should be reserved for cases where agent mode is
|
|
213
269
|
impossible or when you are debugging agent mode itself.
|
|
214
270
|
|
|
215
|
-
For grouped coverage reviews, prefer one
|
|
216
|
-
file per scope instead of trying to review a whole command matrix from a single run.
|
|
271
|
+
For grouped coverage reviews, prefer one scoped expectation set per group instead of trying to review a whole command matrix from a single run.
|
|
217
272
|
|
|
218
273
|
## Test Enrichment Best Practices
|
|
219
274
|
|
|
@@ -246,25 +301,12 @@ When agent output does not fully model runner-visible failures:
|
|
|
246
301
|
- treat the review as partial when suite-load, import, or setup failures are visible outside logical test files
|
|
247
302
|
- keep console-only conclusions provisional until the missing modeling is understood
|
|
248
303
|
|
|
249
|
-
## Project Guide
|
|
250
|
-
|
|
251
|
-
Projects using the skills flow should keep a short root `AGENTS.md` and a deeper
|
|
252
|
-
`docs/allure-agent-mode.md`.
|
|
253
|
-
|
|
254
|
-
`AGENTS.md` should route all test-related work to the deeper guide. The deeper guide
|
|
255
|
-
should explain:
|
|
256
|
-
|
|
257
|
-
- the feature-delivery loop
|
|
258
|
-
- the metadata-enrichment loop
|
|
259
|
-
- per-run temp expectations and output paths
|
|
260
|
-
- meaningful evidence rules
|
|
261
|
-
- minimal metadata rules
|
|
262
|
-
- future loops like flaky, known-issue, mute, and quality gates
|
|
263
|
-
|
|
264
304
|
## Copyable Agent Instructions
|
|
265
305
|
|
|
266
306
|
The generated `AGENTS.md` already contains this guidance for each run. If you want
|
|
267
|
-
the same policy in a
|
|
307
|
+
the same stable policy in a reusable skill or agent prompt, keep version-specific
|
|
308
|
+
CLI details out of that reusable body and make agents inspect local CLI help when
|
|
309
|
+
support is unclear:
|
|
268
310
|
|
|
269
311
|
```md
|
|
270
312
|
## Allure Agent Mode Instructions
|
|
@@ -273,15 +315,14 @@ the same policy in a project-level skill or agent prompt, you can start with:
|
|
|
273
315
|
- Use `allure agent` for smoke checks too, even when the change is small or mechanical.
|
|
274
316
|
- Only skip agent mode when it is impossible or when you are debugging agent mode itself.
|
|
275
317
|
- After each agent-mode test run, print the `index.md` path from that run's output directory so users can open the run overview quickly.
|
|
276
|
-
- Use `allure agent
|
|
277
|
-
- Use `allure agent
|
|
278
|
-
- Use `allure agent
|
|
279
|
-
- Use `allure agent
|
|
280
|
-
- Use
|
|
281
|
-
- Use `
|
|
282
|
-
-
|
|
283
|
-
-
|
|
284
|
-
- Run tests with `ALLURE_AGENT_OUTPUT` and review `manifest/run.json`, `manifest/test-events.jsonl`, `index.md`, `manifest/tests.jsonl`, and `manifest/findings.jsonl`.
|
|
318
|
+
- Use `allure --version`, `allure agent capabilities --json`, and `allure agent --help` before choosing flags when the local CLI surface is unknown.
|
|
319
|
+
- Use `allure agent latest` to print the newest output directory and `index.md` path when `--output` was omitted.
|
|
320
|
+
- Use `allure agent latest`, `state-dir`, `query`, `select`, and `--rerun-*` according to their loop/task/problem mapping instead of treating them as interchangeable helper commands.
|
|
321
|
+
- Use `allure agent inspect <allure-results-dir-or-glob>` or `allure agent inspect --dump <archive-or-glob>` when you need agent-readable markdown and manifests from existing Allure results without rerunning tests locally; repeat `--dump` for multiple CI jobs or environments.
|
|
322
|
+
- Use `allure agent query --latest summary|tests|findings|test` or `allure agent query --from <output-dir> ...` to inspect prior output as focused JSON before manually opening raw manifests.
|
|
323
|
+
- Use `allure agent select --from <output-dir> --output <file>` when you want the CLI to write the test plan and print a short summary with the file path, source output, preset, and selected count.
|
|
324
|
+
- When rerunning previous failures, use `allure agent --rerun-latest --rerun-preset failed -- <command>` or `allure agent --rerun-from <output-dir> --rerun-preset failed -- <command>` instead of manually rebuilding runner-specific test names.
|
|
325
|
+
- Run tests with `allure agent` and review `manifest/run.json`, `manifest/test-events.jsonl`, `index.md`, `manifest/tests.jsonl`, and `manifest/findings.jsonl`.
|
|
285
326
|
- Enrich only the intended tests. Add real steps for real setup, actions, and assertions.
|
|
286
327
|
- Attach only real runtime evidence such as payloads, responses, screenshots, DOM snapshots, diffs, logs, or traces.
|
|
287
328
|
- Keep metadata minimal. Add labels or severity only when scope review, debugging, or quality policy uses them.
|
|
@@ -303,7 +344,7 @@ import {
|
|
|
303
344
|
```
|
|
304
345
|
|
|
305
346
|
- `buildAgentExpectations(...)` converts a goal plus target/forbidden selectors into
|
|
306
|
-
the
|
|
347
|
+
the expectations shape accepted by inline flags, expectations files, and the plugin expectations option.
|
|
307
348
|
- `loadAgentOutput(...)` reads `manifest/run.json`, `manifest/tests.jsonl`, and
|
|
308
349
|
`manifest/findings.jsonl`.
|
|
309
350
|
- `planAgentEnrichmentReview(...)` maps `check_name` values to enrichment actions
|
|
@@ -325,5 +366,5 @@ The enrichment loop should add only real runtime evidence:
|
|
|
325
366
|
Avoid dummy enrichment such as empty wrapper steps, placeholder `"passed"` text
|
|
326
367
|
attachments, or labels that are never used downstream.
|
|
327
368
|
|
|
328
|
-
For
|
|
329
|
-
|
|
369
|
+
For remediation mapping and JS/Vitest examples based on the existing sandbox
|
|
370
|
+
tests, inspect the package tests and generated run `AGENTS.md` guidance.
|
|
@@ -0,0 +1,127 @@
|
|
|
1
|
+
export declare const AGENT_CAPABILITIES_SCHEMA = "allure-agent-capabilities/v1";
|
|
2
|
+
export declare const createAgentCapabilities: () => {
|
|
3
|
+
readonly schema: "allure-agent-capabilities/v1";
|
|
4
|
+
readonly commands: {
|
|
5
|
+
readonly help: {
|
|
6
|
+
readonly supported: true;
|
|
7
|
+
readonly usage: "allure --version; allure agent --help; allure agent capabilities";
|
|
8
|
+
readonly output: readonly ["human", "json"];
|
|
9
|
+
};
|
|
10
|
+
readonly run: {
|
|
11
|
+
readonly supported: true;
|
|
12
|
+
readonly usage: "allure agent [options] -- <command>";
|
|
13
|
+
readonly options: readonly ["--config", "--cwd", "--output", "--report", "--expectations", "--goal", "--task-id", "--expect-tests", "--expect-label", "--expect-env", "--expect-test", "--expect-prefix", "--expect-step-containing", "--forbid-label", "--expect-steps", "--expect-attachments", "--expect-attachment", "--environment", "--environment-name", "--silent", "--rerun-from", "--rerun-latest", "--rerun-preset", "--rerun-environment", "--rerun-label"];
|
|
14
|
+
};
|
|
15
|
+
readonly inspect: {
|
|
16
|
+
readonly supported: true;
|
|
17
|
+
readonly usage: "allure agent inspect [options] [<allure-results-dir-or-glob> ...]";
|
|
18
|
+
readonly inputs: readonly ["allure-results-directories", "dump-archives"];
|
|
19
|
+
readonly options: readonly ["--config", "--cwd", "--output", "--report", "--report-name", "--name", "--dump", "--open", "--port", "--history-limit", "--hide-labels", "--expectations", "--goal", "--task-id", "--expect-tests", "--expect-label", "--expect-env", "--expect-test", "--expect-prefix", "--expect-step-containing", "--forbid-label", "--expect-steps", "--expect-attachments", "--expect-attachment", "--environment", "--environment-name"];
|
|
20
|
+
};
|
|
21
|
+
readonly latest: {
|
|
22
|
+
readonly supported: true;
|
|
23
|
+
readonly usage: "allure agent latest [--cwd <dir>]";
|
|
24
|
+
readonly output: readonly ["agent output: <dir>", "agent index: <dir>/index.md"];
|
|
25
|
+
};
|
|
26
|
+
readonly stateDir: {
|
|
27
|
+
readonly supported: true;
|
|
28
|
+
readonly usage: "allure agent state-dir [--cwd <dir>]";
|
|
29
|
+
readonly environmentVariable: "ALLURE_AGENT_STATE_DIR";
|
|
30
|
+
};
|
|
31
|
+
readonly select: {
|
|
32
|
+
readonly supported: true;
|
|
33
|
+
readonly usage: "allure agent select (--latest | --from <output-dir>) [options]";
|
|
34
|
+
readonly presets: readonly ["review", "failed", "unsuccessful", "all"];
|
|
35
|
+
readonly filters: readonly ["environment", "label"];
|
|
36
|
+
readonly output: readonly ["stdout-testplan-json", "file-testplan-json", "file-summary"];
|
|
37
|
+
};
|
|
38
|
+
readonly query: {
|
|
39
|
+
readonly supported: true;
|
|
40
|
+
readonly usage: "allure agent query (--latest | --from <output-dir>) [summary|tests|findings|test] [options]";
|
|
41
|
+
readonly views: readonly ["summary", "tests", "findings", "test"];
|
|
42
|
+
readonly filters: readonly ["status", "environment", "label", "severity", "category", "check", "test"];
|
|
43
|
+
readonly output: readonly ["json"];
|
|
44
|
+
};
|
|
45
|
+
readonly rerun: {
|
|
46
|
+
readonly supported: true;
|
|
47
|
+
readonly usage: "allure agent (--rerun-latest | --rerun-from <output-dir>) [filters] -- <command>";
|
|
48
|
+
readonly presets: readonly ["review", "failed", "unsuccessful", "all"];
|
|
49
|
+
readonly filters: readonly ["environment", "label"];
|
|
50
|
+
readonly transport: "ALLURE_TESTPLAN_PATH";
|
|
51
|
+
};
|
|
52
|
+
};
|
|
53
|
+
readonly expectations: {
|
|
54
|
+
readonly inline: {
|
|
55
|
+
readonly supported: true;
|
|
56
|
+
readonly goal: true;
|
|
57
|
+
readonly taskId: true;
|
|
58
|
+
readonly expected: {
|
|
59
|
+
readonly testCount: true;
|
|
60
|
+
readonly labels: true;
|
|
61
|
+
readonly environments: true;
|
|
62
|
+
readonly fullNames: true;
|
|
63
|
+
readonly fullNamePrefixes: true;
|
|
64
|
+
};
|
|
65
|
+
readonly forbidden: {
|
|
66
|
+
readonly labels: true;
|
|
67
|
+
readonly environments: false;
|
|
68
|
+
readonly fullNames: false;
|
|
69
|
+
readonly fullNamePrefixes: false;
|
|
70
|
+
};
|
|
71
|
+
readonly evidence: {
|
|
72
|
+
readonly stepNameContains: true;
|
|
73
|
+
readonly minSteps: true;
|
|
74
|
+
readonly minAttachments: true;
|
|
75
|
+
readonly attachmentFilters: readonly ["name", "content-type"];
|
|
76
|
+
};
|
|
77
|
+
};
|
|
78
|
+
readonly file: {
|
|
79
|
+
readonly supported: true;
|
|
80
|
+
readonly formats: readonly ["yaml", "json"];
|
|
81
|
+
};
|
|
82
|
+
};
|
|
83
|
+
readonly output: {
|
|
84
|
+
readonly automaticTempDirectory: true;
|
|
85
|
+
readonly explicitOutputOption: "--output <dir>";
|
|
86
|
+
readonly explicitOutputCleanup: "When --output is provided, the output directory and its lifetime are caller-managed. Agent-mode cleanup will not remove it, so agents that pass --output should remove or archive that directory when it is no longer needed; later state compaction drops missing explicit outputs from the registry.";
|
|
87
|
+
readonly schema: "allure-agent-output/v1";
|
|
88
|
+
readonly files: readonly ["index.md", "AGENTS.md", "manifest/run.json", "manifest/test-events.jsonl", "manifest/tests.jsonl", "manifest/findings.jsonl", "manifest/expected.json", "manifest/human-report.json", "tests/<environment>/<slug>.md", "artifacts/global/", "awesome/index.html"];
|
|
89
|
+
};
|
|
90
|
+
readonly humanReports: {
|
|
91
|
+
readonly supported: true;
|
|
92
|
+
readonly option: "--report <auto|off|awesome|config>";
|
|
93
|
+
readonly defaultMode: "auto";
|
|
94
|
+
readonly modes: {
|
|
95
|
+
readonly auto: "Generate a single-file Awesome report when the stored visible result count is 1000 or fewer; skip above that threshold.";
|
|
96
|
+
readonly off: "Disable human-readable reports and write agent artifacts only.";
|
|
97
|
+
readonly awesome: "Force a single-file Awesome report and ignore the auto threshold.";
|
|
98
|
+
readonly config: "Force the configured non-agent report plugins inside the agent output directory and ignore the auto threshold.";
|
|
99
|
+
};
|
|
100
|
+
readonly threshold: {
|
|
101
|
+
readonly resultCount: 1000;
|
|
102
|
+
readonly appliesTo: "auto";
|
|
103
|
+
readonly countSource: "Allure store visible logical test results with retries excluded";
|
|
104
|
+
readonly generatedWhen: "<= 1000";
|
|
105
|
+
readonly skippedWhen: "> 1000";
|
|
106
|
+
};
|
|
107
|
+
readonly statusManifest: "manifest/human-report.json";
|
|
108
|
+
readonly defaultGeneratedPath: "awesome/index.html";
|
|
109
|
+
readonly discovery: readonly ["When a user asks for a human-readable report after an agent run, first use `allure agent latest` if no output directory is known.", "Read `<output>/manifest/human-report.json`, the Human Report section of `<output>/index.md`, or `allure agent query --latest summary` to check whether a report already exists.", "If the status is `generated`, use `<output>/<path>` from the human-report manifest; for auto and awesome this is usually `<output>/awesome/index.html`.", "If the status is `skipped`, `disabled`, `failed`, or the manifest is missing, generate a report only from available results or dumps with the requested `--report` mode."];
|
|
110
|
+
};
|
|
111
|
+
readonly unsupported: {
|
|
112
|
+
readonly discovery: true;
|
|
113
|
+
readonly configureIntegration: true;
|
|
114
|
+
readonly executionSignal: true;
|
|
115
|
+
readonly compare: true;
|
|
116
|
+
readonly flaky: true;
|
|
117
|
+
readonly duplicates: true;
|
|
118
|
+
readonly stale: true;
|
|
119
|
+
readonly suppressions: true;
|
|
120
|
+
readonly observe: true;
|
|
121
|
+
readonly interrupt: true;
|
|
122
|
+
readonly localAgentService: true;
|
|
123
|
+
readonly expectationControls: readonly ["--expect-evidence"];
|
|
124
|
+
};
|
|
125
|
+
};
|
|
126
|
+
export declare const AGENT_TASK_MAP_HELP = "Agent task map:\n allure --version\n allure agent --help\n allure agent capabilities\n Setup and capability detection. Use when the local CLI surface is unknown,\n generated guidance may be stale, or an agent needs supported flags without\n guessing.\n\n allure agent --goal ... -- <command>\n Run a test command with runtime evidence, scope expectations, and\n agent-readable artifacts for review, debugging, smoke checks, or validation.\n Use --report auto|off|awesome|config to control the optional human report.\n The default --report auto may already generate awesome/index.html in the\n agent output when the stored visible result count is 1000 or fewer.\n\n allure agent inspect [<allure-results-dir-or-glob> ...]\n allure agent inspect --dump <archive-or-glob> [--dump <archive-or-glob> ...]\n Restore one or more dump archives and/or read existing Allure results\n directories, then produce agent-readable artifacts without executing a\n test command. Use --report auto|off|awesome|config to control the optional\n human report. Use after downloading CI dump artifacts created by\n allure run --dump or when local results already exist.\n\n allure agent latest\n Recover the newest agent output directory and index.md when --output was\n omitted or a follow-up task needs the previous run. If a user asks for a\n human-readable report from the last run, start here, then inspect\n <output>/manifest/human-report.json and use <output>/<path> when status is\n generated.\n\n allure agent state-dir\n Show the shared state directory that stores per-project run registries. Useful when\n latest cannot find a run or CI/sandbox state looks wrong.\n\n allure agent select --latest\n allure agent select --from <output-dir>\n Inspect/filter prior results and write an Allure test plan before rerun.\n\n allure agent query --latest summary\n allure agent query --from <output-dir> tests\n allure agent query --from <output-dir> findings\n Inspect prior agent output as focused JSON without manually loading raw\n manifests. Use for summaries, human_report status, filtered test lists,\n findings, or one test.\n\n allure agent --rerun-latest -- <command>\n allure agent --rerun-from <output-dir> -- <command>\n Rerun the failed, unsuccessful, or selected tests from prior agent output\n through Allure test plan support.\n\nEnvironment:\n ALLURE_AGENT_STATE_DIR=<dir>\n Override the shared agent state directory. Useful in CI, sandboxes, or\n multi-job setups that need a deterministic shared state location.\n\nHuman reports:\n Default agent runs use --report auto. For 1000 or fewer stored visible logical\n results, the last run may already contain a human-readable single-file Awesome\n report at <output>/awesome/index.html. Larger runs are skipped in auto mode to\n avoid excessive output.\n\n When a user asks for \"the report\" after a run, do not assume it needs to be\n regenerated. First run allure agent latest when the output directory is\n unknown, then read <output>/manifest/human-report.json or\n allure agent query --latest summary. If the human-report status is generated,\n return or open <output>/<path> from that manifest. If the status is skipped,\n disabled, failed, or missing, rerun or inspect existing results/dumps with the\n requested --report mode, for example --report awesome to force the single-file\n Awesome report or --report config to force configured report plugins.\n";
|
|
127
|
+
export declare const isAgentTaskMapHelpRequest: (args: string[]) => boolean;
|