@qawolf/cli 2.6.0 → 2.8.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.
|
@@ -135,6 +135,7 @@ that `url`; never guess a route and never send a repository link in its place.
|
|
|
135
135
|
<!-- prettier-ignore -->
|
|
136
136
|
| Command | Kind | What it does |
|
|
137
137
|
| --- | --- | --- |
|
|
138
|
+
| `qawolf activity wait` | read | Wait on many QA Wolf AI (Tester) sessions and runs in one call. Pass every Tester session and run you are waiting on. The call returns as soon as any session replies or changes status or any run finishes, and reports every item with news. Send back open as the next call's input, and call again as soon as it returns. Pass waitSeconds above 45 only when your instructions say your client keeps the call open while progress arrives. |
|
|
138
139
|
| `qawolf agent get` | read | Read what the QA Wolf AI has said and whether it is still working |
|
|
139
140
|
| `qawolf agent send` | write | Ask the QA Wolf AI to do a piece of work, such as covering a journey or fixing a broken flow |
|
|
140
141
|
| `qawolf attempt get` | read | Get a finished run attempt: its run and flow status, its place among that flow's attempts in the run, and signed links to its logs, trace, and video when they were captured. |
|
|
@@ -150,6 +151,7 @@ that `url`; never guess a route and never send a repository link in its place.
|
|
|
150
151
|
| `qawolf build list` | read | List the workspace's undeleted builds, newest first. With latestOnly, list what the environment's next run installs. |
|
|
151
152
|
| `qawolf build requestDownload` | read | Get a URL to download a build's file. Deleted builds can be downloaded while their file exists. Answers 404 when the file has expired. |
|
|
152
153
|
| `qawolf build requestUpload` | write | Get a URL to upload an app build: an .apk, .aab or .ipa, up to 500 MB. PUT the file there with uploadHeaders, then call build.create with the buildId. |
|
|
154
|
+
| `qawolf build upload` | write | Upload an app file (.apk, .aab or .ipa, up to 500 MB) and create a build from it. Runs build requestUpload, the PUT and build create in one step |
|
|
153
155
|
| `qawolf codeHostIntegration find` | read | List the workspace's code host integrations (GitHub or GitLab). A connected integration lets QA Wolf read repositories and receive the code host's webhooks. codeHostIntegration.listRepositories pages the repositories each integration covers. |
|
|
154
156
|
| `qawolf codeHostIntegration listRepositories` | read | List the repositories the workspace's code host integrations cover, alphabetical by full name. The list reflects the last sync from the code host; codeHostIntegration.find lists the integrations themselves. |
|
|
155
157
|
| `qawolf deployment find` | read | List the deployments QA Wolf has received for the workspace, newest first. A deployment arrives through a code host integration's webhook or through deployment.reportStatus, and is what a deployment trigger evaluates against. deployment.listTriggerEvaluations reports each trigger's verdict for one deployment. |
|
|
@@ -187,14 +189,17 @@ that `url`; never guess a route and never send a repository link in its place.
|
|
|
187
189
|
| `qawolf install browsers` | local | Install Playwright browsers used by the project's web flows |
|
|
188
190
|
| `qawolf install clear` | local | Remove the managed runtime cache (all installed runtime versions) |
|
|
189
191
|
| `qawolf investigation get` | read | Read what the QA Wolf AI investigating a run has concluded: one finding per cause of its failures, with the question waiting for a person and any answer or dispute the investigation hasn't acted on yet. A run that automatic investigation does not cover answers status "not-enabled". |
|
|
190
|
-
| `qawolf investigation question
|
|
192
|
+
| `qawolf investigation question answer` | write | Answer the questions the QA Wolf AI investigating a failed run is waiting on, as the signed-in person. List the questions with investigation.question.find, and answer only with the person's approval. The first answer to a question wins, and the investigation acts on it. Only a person's own sign-in or user API key can answer; a team or organization key cannot. |
|
|
193
|
+
| `qawolf investigation question find` | read | List the questions the QA Wolf AI investigating failed runs is waiting for a person to answer, across a workspace's runs. Each question names its run, flows, details and offered answers. To answer them, call investigation.question.answer with the run and the person's answers. |
|
|
191
194
|
| `qawolf issue addFlows` | write | Add flows to a coverage request owned by the caller's team. Flows already covered stay covered. Bug reports and blockers link to flows through the runs that reproduce them; use run.diagnose to record one. |
|
|
192
195
|
| `qawolf issue attachFiles` | write | Attach files from the team's storage to a bug report owned by the caller's team, for example the files a bug was reproduced with. Files already attached stay attached. Upload a file with file.requestUpload first. |
|
|
196
|
+
| `qawolf issue comment` | write | Comment on a bug report, blocker (issue type `maintenance`), or coverage request owned by the caller's team. The comment changes nothing else on the issue, such as its status or priority. |
|
|
193
197
|
| `qawolf issue create` | write | Create a bug report, blocker (issue type `maintenance`), or coverage request issue for the caller's team. A user can create a blocker only when they can see the workspace's blockers; a team or organization API key credits it to the workspace's automation user. Link its failed flows afterwards with run.diagnose. |
|
|
194
198
|
| `qawolf issue decideSuggestion` | write | Decide a coverage request or bug report that QA Wolf suggested after exploring an environment. Add turns on the suggested flow in the environment. Report files a potential bug. Skip declines the suggestion. Undo takes back a decision before the flow joins. The issue's status follows the decision, so change the status only through this tool while the suggestion is undecided. |
|
|
195
199
|
| `qawolf issue find` | read | List the team's bug reports, blockers, or coverage requests, newest first. |
|
|
196
200
|
| `qawolf issue get` | read | Get an issue by id. |
|
|
197
201
|
| `qawolf issue listActivity` | read | List an issue's activity, oldest first: creation, status and priority changes, and the flows that started or stopped reproducing it. Use it to measure time to fix or to find issues that came back. |
|
|
202
|
+
| `qawolf issue listComments` | read | List the comments on a bug report, blocker (issue type `maintenance`), or coverage request, oldest first, with who wrote each one. |
|
|
198
203
|
| `qawolf issue removeFlows` | write | Remove flows from a coverage request or remove bug report or blocker reproductions in an environment. Unlinked flows are left alone. Reports auto-close when no active reproductions remain and auto-close is enabled. For reports, omit environmentId only when each selected flow is linked in at most one environment. |
|
|
199
204
|
| `qawolf issue update` | write | Update an issue owned by the caller's team. Omitted fields remain unchanged. |
|
|
200
205
|
| `qawolf legacyTrigger find` | read | List a workspace's legacy per-environment triggers; trigger.find lists the current ones. For migration only; it goes when legacy triggers go. adaptiveFlowSelection becomes a generativeSuite action, which takes no tags. |
|
|
@@ -208,7 +213,7 @@ that `url`; never guess a route and never send a repository link in its place.
|
|
|
208
213
|
| `qawolf run create` | write | Create a run for the selected flows and/or tags in an environment. |
|
|
209
214
|
| `qawolf run diagnose` | write | Link failed flows in a run to an existing bug report or blocker owned by the caller's team, recording them as its reproductions. It does not explain why a run failed; read investigation.get or attempt.get for that. The issue's type selects the diagnosis. Each flow must have failed in the run. A flow that is already diagnosed in the run moves to this issue, and may stay linked to other open reports. The diagnosis appears on the run, and the reproduction appears under the issue's reproductions. Coverage requests cannot be diagnosed; use issue.addFlows to cover flows instead. |
|
|
210
215
|
| `qawolf run find` | read | List an environment's recent runs, newest first, including failed-attempt discovery metadata. |
|
|
211
|
-
| `qawolf run get` | read | Get a run's status, per-flow results, links, and how many of its bugs are blocking. |
|
|
216
|
+
| `qawolf run get` | read | Get a run's status, per-flow results, links, and how many of its bugs are blocking. Call it without waitSeconds for an immediate answer. To wait on a run that is still queued or running, pass waitSeconds up to 45: the server holds the check open and answers the moment the status changes. A held check also waits while the run is still being created. After a held check returns, call again only while status is queued or running. Stop when status is passed, failed, canceled, or superseded. |
|
|
212
217
|
| `qawolf run listScreenshotComparisons` | read | List the screenshot comparisons that failed a run's flows, with the expected, actual and diff images of each. Only comparisons that caused a failure are listed: a screenshot that differs within tolerance, or that differs on a line that did not fail, is left out. Each comparison tells whether its baseline changed since the run and whether the baseline still passes in other environments. The image URLs expire after a few minutes; fetch the preview URLs to look at the images. The first call for an image makes its missing JPEG preview and keeps it in team storage, so later calls reuse it. |
|
|
213
218
|
| `qawolf run optOutOfInvestigation` | write | Mark failed flows in a run as "do not investigate" (DNI): the failures need no bug report or blocker. Each flow must have failed in the run and still be under investigation. A flow that already has a diagnosis cannot be opted out. A team or organization key records the opt-out as the workspace's automation user. To link a failure to a report instead, use run.diagnose. |
|
|
214
219
|
| `qawolf run reattempt` | write | Request new attempts for a run's flows. A flow is eligible once its result is failed or canceled and QA Wolf's automatic retries have finished. A flow that kept failing in later runs is attempted in the latest of them, because that is the run carrying the failure, so read reattemptedInRunIds for where each attempt landed. A fully investigated run no longer accepts reattempts. Attempts run with the flow code the environment has synced when the request arrives: after publishing a fix, pass afterCommit so the request waits for that commit instead of rerunning older code. Poll run.get for results, or pass aiTaskId or chatSessionId to be notified when they settle. |
|
|
@@ -313,6 +318,21 @@ more until the AI speaks, so several minutes with no output is the session
|
|
|
313
318
|
working, not the command hanging. `--timeout` bounds the wait; it is 30 minutes
|
|
314
319
|
by default.
|
|
315
320
|
|
|
321
|
+
## Uploading an app build: `build upload`
|
|
322
|
+
|
|
323
|
+
`qawolf build upload <file>` uploads an `.apk`, `.aab` or `.ipa` and creates a
|
|
324
|
+
build from it in one step. Use it instead of `build requestUpload`, a PUT and
|
|
325
|
+
`build create` whenever the file is on this machine.
|
|
326
|
+
|
|
327
|
+
Without an environment flag, the build belongs to no environment: only a run
|
|
328
|
+
created with it installs it. `--environment-id <id>` or
|
|
329
|
+
`--environment-name <name>` puts it on an environment, and that environment's
|
|
330
|
+
runs install it from then on. It does not read `QAWOLF_ENVIRONMENT`: pass the
|
|
331
|
+
environment on purpose.
|
|
332
|
+
|
|
333
|
+
If the upload succeeds but creating the build fails, do not upload again.
|
|
334
|
+
Finish it with `qawolf build create --build-id <id>` and the same flags.
|
|
335
|
+
|
|
316
336
|
## Driving a browser: the `runner` group
|
|
317
337
|
|
|
318
338
|
The `runner` commands drive a live cloud browser: `launch` one, `screenshot` to
|
|
@@ -245,6 +245,8 @@ Every documented field of the `run.get` response. `[]` marks an array, so
|
|
|
245
245
|
- `siteVersions[].observed[].source` — One of header, meta, versionPath, frameworkBuildId, fingerprint; newer servers may add values, so ignore any you don't know. Where the attempt read the version.
|
|
246
246
|
- `siteVersions[].origin` — The site origin the attempts visited.
|
|
247
247
|
- `siteVersions[].warnings` — Why the site may not be the version the run should test.
|
|
248
|
+
- `waitSeconds` — The hold this check was allowed, in seconds, after clamping. Absent when the check did not wait.
|
|
249
|
+
- `wokeOn` — One of: status, timeout
|
|
248
250
|
- `url` — Absolute URL of the run page.
|
|
249
251
|
|
|
250
252
|
<!-- fields:end -->
|
|
@@ -376,6 +376,9 @@ Options:
|
|
|
376
376
|
--env-id, they go on top of that environment's
|
|
377
377
|
--var, --env-var <name=value> One variable for this run only, on top of the environment and
|
|
378
378
|
--env-file; repeat for several (default: [])
|
|
379
|
+
--builds <ids...> Builds to install in this run, from build.create, one per app and
|
|
380
|
+
platform. Each replaces the environment's latest build of its app
|
|
381
|
+
and platform. Put the flow file before this flag (default: [])
|
|
379
382
|
--lines <start-end> Run only these 1-indexed lines against the browser as it stands,
|
|
380
383
|
instead of the whole flow from a fresh one
|
|
381
384
|
--lines-file <path> File the --lines range lives in. Defaults to <flowFile>; pass it
|
|
@@ -403,6 +406,7 @@ Examples:
|
|
|
403
406
|
$ qawolf runner run flows/checkout.flow.ts --lines 4-9 --lines-file pages/login.ts
|
|
404
407
|
$ qawolf runner run flows/checkout.flow.ts --env-id staging
|
|
405
408
|
$ qawolf runner run flows/checkout.flow.ts --env-var RUN_INPUT_PATH=uploads/app.apk
|
|
409
|
+
$ qawolf runner run flows/checkout.flow.ts --builds <buildId> <buildId>
|
|
406
410
|
|
|
407
411
|
What travels:
|
|
408
412
|
run ships the flow file, everything it imports, and your package.json and
|