@itmetsam/samurai-framework 0.22.2 → 0.22.3
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/cli/record.js +3 -1
- package/dist/cli/usage.d.ts +1 -1
- package/dist/cli/usage.js +1 -1
- package/dist/recorder/session.d.ts +1 -1
- package/dist/recorder/session.js +1 -1
- package/package.json +1 -1
package/dist/cli/record.js
CHANGED
|
@@ -66,6 +66,8 @@ export async function recordCommand({ values, positionals }, io) {
|
|
|
66
66
|
if (at !== undefined && (!Number.isInteger(at) || at < 0))
|
|
67
67
|
throw new Error(`--at must be a step number, got "${values.at}"`);
|
|
68
68
|
const flags = parseRunnerFlags(values);
|
|
69
|
+
if (flags.headless === true)
|
|
70
|
+
throw new Error("--headless: a recording needs a window; the recorder never runs without one");
|
|
69
71
|
if (flags.browsers && flags.browsers.length > 1)
|
|
70
72
|
throw new Error("--browser: a recording uses one browser");
|
|
71
73
|
const test = values.test === undefined
|
|
@@ -81,7 +83,7 @@ export async function recordCommand({ values, positionals }, io) {
|
|
|
81
83
|
...(values.new !== undefined && { create: values.new }),
|
|
82
84
|
...(at !== undefined && { at }),
|
|
83
85
|
...(values.url !== undefined && { url: values.url }),
|
|
84
|
-
|
|
86
|
+
headless: false,
|
|
85
87
|
...(flags.port !== undefined && { port: flags.port }),
|
|
86
88
|
...(flags.browsers && { browser: flags.browsers[0] }),
|
|
87
89
|
...(io.signal && { signal: io.signal }),
|
package/dist/cli/usage.d.ts
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export declare const USAGE = "samurai: browser tests over WebDriver BiDi\n\nUsage:\n samurai run [options] Run the tests (the default command)\n samurai list [options] List the tests without running them\n samurai record <spec> Open a browser and record what you do into a spec file\n samurai init [folder] Scaffold a project: config, an example test, .env.example\n samurai flow <command> List, check and run the flows in ./flows (see below)\n samurai browsers [command] List, install and remove the browsers SAMURAI launches\n\nOptions for run and list:\n --env <name> Environment to run against (or SAMURAI_ENV)\n --file <spec> Only this spec file; repeatable\n --grep <text> Only tests whose full name contains the text\n --group <name> Only the tests of this group of the config's groups; repeat it for several\n --browser <name> Run in this browser (firefox or chrome) instead of the config's\n browsers; repeat it for more than one\n --json Machine-readable output: JSON lines for run, one array for list\n\nOptions for run:\n --timeout <ms> Time one test may take\n --expect-timeout <ms> Time actions and assertions retry\n --headless, --no-headless Run the browser without a window, or with one.\n Default: the config's use.headless, else headless when CI is set\n --port <n> Browser debugging port (default 9223)\n --workers <n|n%> Tests that run at the same time, each in a worker process: a number\n from 1, or a share of the CPUs like 50%. Default: the config's\n workers (or SAMURAI_WORKERS), else half the CPUs\n --retries <n> Run a failing test again up to n times, each with a fresh browser\n (or SAMURAI_RETRIES; default 0)\n --shard <current/total> Run one slice of the selected tests, to split a run over machines:\n --shard=2/4 runs the second of four. Whole files (and serial\n blocks) go to one shard; an empty shard succeeds\n\nOptions for record (also --env, --port, --json
|
|
1
|
+
export declare const USAGE = "samurai: browser tests over WebDriver BiDi\n\nUsage:\n samurai run [options] Run the tests (the default command)\n samurai list [options] List the tests without running them\n samurai record <spec> Open a browser and record what you do into a spec file\n samurai init [folder] Scaffold a project: config, an example test, .env.example\n samurai flow <command> List, check and run the flows in ./flows (see below)\n samurai browsers [command] List, install and remove the browsers SAMURAI launches\n\nOptions for run and list:\n --env <name> Environment to run against (or SAMURAI_ENV)\n --file <spec> Only this spec file; repeatable\n --grep <text> Only tests whose full name contains the text\n --group <name> Only the tests of this group of the config's groups; repeat it for several\n --browser <name> Run in this browser (firefox or chrome) instead of the config's\n browsers; repeat it for more than one\n --json Machine-readable output: JSON lines for run, one array for list\n\nOptions for run:\n --timeout <ms> Time one test may take\n --expect-timeout <ms> Time actions and assertions retry\n --headless, --no-headless Run the browser without a window, or with one.\n Default: the config's use.headless, else headless when CI is set\n --port <n> Browser debugging port (default 9223)\n --workers <n|n%> Tests that run at the same time, each in a worker process: a number\n from 1, or a share of the CPUs like 50%. Default: the config's\n workers (or SAMURAI_WORKERS), else half the CPUs\n --retries <n> Run a failing test again up to n times, each with a fresh browser\n (or SAMURAI_RETRIES; default 0)\n --shard <current/total> Run one slice of the selected tests, to split a run over machines:\n --shard=2/4 runs the second of four. Whole files (and serial\n blocks) go to one shard; an empty shard succeeds\n\nOptions for record (also --env, --port, --json; always with a window):\n --browser <name> Record in this browser (default: the first of the config's browsers)\n --new <title> Add a test with this title (creates the spec file if needed)\n --test <name|index> Record into this test; not needed when the file has one\n --at <n> Insert from step n (default: after the last step)\n --url <url> Page to start on (default: the environment's baseURL)\n Stop with Ctrl+C or by closing the browser window.\n\n -h, --help Show this help\n -v, --version Show the version\n\nExit code: 0 when every test passed, 1 when a test failed, 2 for a usage or configuration error.\n\nsamurai flow:\n list The flows in ./flows\n check [<flow>...] Check flows without running them\n run <flow>... | --all Run flows; each writes result/flows/<id>.json\n Options for run: --env, --headless, --timeout, --expect-timeout, --port, --json, --allow-unsupported\n Run `samurai flow` alone for the details.\n\nsamurai browsers:\n list The pinned browsers and every build in the cache (the default)\n install [firefox|chrome|all]\n Download the pinned builds (default: all)\n uninstall <name> [--build <id>] | --unused\n\nRun it in the project folder, the one holding samurai.config.ts.\n";
|
package/dist/cli/usage.js
CHANGED
|
@@ -33,7 +33,7 @@ Options for run:
|
|
|
33
33
|
--shard=2/4 runs the second of four. Whole files (and serial
|
|
34
34
|
blocks) go to one shard; an empty shard succeeds
|
|
35
35
|
|
|
36
|
-
Options for record (also --env, --port, --json
|
|
36
|
+
Options for record (also --env, --port, --json; always with a window):
|
|
37
37
|
--browser <name> Record in this browser (default: the first of the config's browsers)
|
|
38
38
|
--new <title> Add a test with this title (creates the spec file if needed)
|
|
39
39
|
--test <name|index> Record into this test; not needed when the file has one
|
|
@@ -24,7 +24,7 @@ export interface RecordSpecOptions extends ProjectOptions {
|
|
|
24
24
|
browser?: SupportedBrowser;
|
|
25
25
|
/** The browser's debugging port. @default DEFAULT_PORT (9223) */
|
|
26
26
|
port?: number;
|
|
27
|
-
/** Run the browser without a window. A person can't use it then
|
|
27
|
+
/** Run the browser without a window. A person can't use it then, so this is only for tests of the recorder itself. Never read from the config, the environment or `CI`: a recording always opens a window. @default false */
|
|
28
28
|
headless?: boolean;
|
|
29
29
|
/** Aborting ends the recording, like closing the browser window */
|
|
30
30
|
signal?: AbortSignal;
|
package/dist/recorder/session.js
CHANGED
|
@@ -28,7 +28,7 @@ export async function recordSpec(options) {
|
|
|
28
28
|
const writer = new SpecWriter(spec.source, file, testIndex);
|
|
29
29
|
const { browser, page } = await launchRecordingBrowser(browserName, {
|
|
30
30
|
...options,
|
|
31
|
-
headless: options.headless ??
|
|
31
|
+
headless: options.headless ?? false,
|
|
32
32
|
});
|
|
33
33
|
const loaded = await loadRawConfig();
|
|
34
34
|
const folder = filesFolder(projectDir(), loaded.filesDir);
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@itmetsam/samurai-framework",
|
|
3
|
-
"version": "0.22.
|
|
3
|
+
"version": "0.22.3",
|
|
4
4
|
"description": "Browser test framework over WebDriver BiDi: auto-waiting locators, environments and secrets, a recorder, and a command line.",
|
|
5
5
|
"main": "dist/api.js",
|
|
6
6
|
"exports": {
|