1App::Yath::Command::repUlsaeyr(3C)ontributed Perl DocumeAnptpa:t:iYoanth::Command::replay(3)
2
3
4

NAME

6       App::Yath::Command::replay - Replay a test run from an event log
7

DESCRIPTION

9       This yath command will re-run the harness against an event log produced
10       by a previous test run. The only required argument is the path to the
11       log file, which maybe compressed. Any extra arguments are assumed to be
12       job id's. If you list any jobs, only listed jobs will be processed.
13
14       This command accepts all the same renderer/formatter options that the
15       'test' command accepts.
16

USAGE

18           $ yath [YATH OPTIONS] replay [COMMAND OPTIONS]
19
20   YATH OPTIONS
21       Developer
22
23       --dev-lib
24       --dev-lib=lib
25       -D
26       -D=lib
27       -Dlib
28       --no-dev-lib
29           Add paths to @INC before loading ANYTHING. This is what you use if
30           you are developing yath or yath plugins to make sure the yath
31           script finds the local code instead of the installed versions of
32           the same code. You can provide an argument (-Dfoo) to provide a
33           custom path, or you can just use -D without and arg to add lib,
34           blib/lib and blib/arch.
35
36           Can be specified multiple times
37
38       Environment
39
40       --persist-dir ARG
41       --persist-dir=ARG
42       --no-persist-dir
43           Where to find persistence files.
44
45       --persist-file ARG
46       --persist-file=ARG
47       --pfile ARG
48       --pfile=ARG
49       --no-persist-file
50           Where to find the persistence file. The default is
51           /{system-tempdir}/project-yath-persist.json. If no project is
52           specified then it will fall back to the current directory. If the
53           current directory is not writable it will default to
54           /tmp/yath-persist.json which limits you to one persistent runner on
55           your system.
56
57       --project ARG
58       --project=ARG
59       --project-name ARG
60       --project-name=ARG
61       --no-project
62           This lets you provide a label for your current project/codebase.
63           This is best used in a .yath.rc file. This is necessary for a
64           persistent runner.
65
66       Help and Debugging
67
68       --show-opts
69       --no-show-opts
70           Exit after showing what yath thinks your options mean
71
72       --version
73       -V
74       --no-version
75           Exit after showing a helpful usage message
76
77       Plugins
78
79       --no-scan-plugins
80       --no-no-scan-plugins
81           Normally yath scans for and loads all App::Yath::Plugin::* modules
82           in order to bring in command-line options they may provide. This
83           flag will disable that. This is useful if you have a naughty plugin
84           that is loading other modules when it should not.
85
86       --plugins PLUGIN
87       --plugins +App::Yath::Plugin::PLUGIN
88       --plugins PLUGIN=arg1,arg2,...
89       --plugin PLUGIN
90       --plugin +App::Yath::Plugin::PLUGIN
91       --plugin PLUGIN=arg1,arg2,...
92       -pPLUGIN
93       --no-plugins
94           Load a yath plugin.
95
96           Can be specified multiple times
97
98   COMMAND OPTIONS
99       Cover Options
100
101       --cover-aggregator ByTest
102       --cover-aggregator ByRun
103       --cover-aggregator +Custom::Aggregator
104       --cover-agg ByTest
105       --cover-agg ByRun
106       --cover-agg +Custom::Aggregator
107       --no-cover-aggregator
108           Choose a custom aggregator subclass
109
110       --cover-class ARG
111       --cover-class=ARG
112       --no-cover-class
113           Choose a Test2::Plugin::Cover subclass
114
115       --cover-dirs ARG
116       --cover-dirs=ARG
117       --cover-dir ARG
118       --cover-dir=ARG
119       --no-cover-dirs
120           NO DESCRIPTION - FIX ME
121
122           Can be specified multiple times
123
124       --cover-exclude-private
125       --no-cover-exclude-private
126       --cover-files
127       --no-cover-files
128           Use Test2::Plugin::Cover to collect coverage data for what files
129           are touched by what tests. Unlike Devel::Cover this has very little
130           performance impact (About 4% difference)
131
132       --cover-from path/to/log.jsonl
133       --cover-from http://example.com/coverage
134       --cover-from path/to/coverage.jsonl
135       --no-cover-from
136           This can be a test log, a coverage dump (old style json or new
137           jsonl format), or a url to any of the previous. Tests will not be
138           run if the file/url is invalid.
139
140       --cover-from-type json
141       --cover-from-type jsonl
142       --cover-from-type log
143       --no-cover-from-type
144           File type for coverage source. Usually it can be detected, but when
145           it cannot be you should specify. "json" is old style single-blob
146           coverage data, "jsonl" is the new by-test style, "log" is a logfile
147           from a previous run.
148
149       --cover-manager My::Coverage::Manager
150       --no-cover-manager
151           Coverage 'from' manager to use when coverage data does not provide
152           one
153
154       --cover-maybe-from path/to/log.jsonl
155       --cover-maybe-from http://example.com/coverage
156       --cover-maybe-from path/to/coverage.jsonl
157       --no-cover-maybe-from
158           This can be a test log, a coverage dump (old style json or new
159           jsonl format), or a url to any of the previous. Tests will coninue
160           if even if the coverage file/url is invalid.
161
162       --cover-maybe-from-type json
163       --cover-maybe-from-type jsonl
164       --cover-maybe-from-type log
165       --no-cover-maybe-from-type
166           Same as "from_type" but for "maybe_from". Defaults to "from_type"
167           if that is specified, otherwise auto-detect
168
169       --cover-metrics
170       --no-cover-metrics
171       --cover-types ARG
172       --cover-types=ARG
173       --cover-type ARG
174       --cover-type=ARG
175       --no-cover-types
176           NO DESCRIPTION - FIX ME
177
178           Can be specified multiple times
179
180       --cover-write
181       --cover-write=coverage.jsonl
182       --cover-write=coverage.json
183       --no-cover-write
184           Create a json or jsonl file of all coverage data seen during the
185           run (This implies --cover-files).
186
187       Display Options
188
189       --color
190       --no-color
191           Turn color on, default is true if STDOUT is a TTY.
192
193       --hide-runner-output
194       --no-hide-runner-output
195           Hide output from the runner, showing only test output. (See Also
196           truncate_runner_output)
197
198       --no-wrap
199       --no-no-wrap
200           Do not do fancy text-wrapping, let the terminal handle it
201
202       --progress
203       --no-progress
204           Toggle progress indicators. On by default if STDOUT is a TTY. You
205           can use --no-progress to disable the 'events seen' counter and
206           buffered event pre-display
207
208       --quiet
209       -q
210       --no-quiet
211           Be very quiet.
212
213           Can be specified multiple times
214
215       --renderers +My::Renderer
216       --renderers Renderer=arg1,arg2,...
217       --renderer +My::Renderer
218       --renderer Renderer=arg1,arg2,...
219       --no-renderers
220           Specify renderers, (Default: "Formatter=Test2"). Use "+" to give a
221           fully qualified module name. Without "+"
222           "Test2::Harness::Renderer::" will be prepended to your argument.
223
224           Can be specified multiple times. If the same key is listed multiple
225           times the value lists will be appended together.
226
227       --show-times
228       -T
229       --no-show-times
230           Show the timing data for each job
231
232       --term-width 80
233       --term-width 200
234       --term-size 80
235       --term-size 200
236       --no-term-width
237           Alternative to setting $TABLE_TERM_SIZE. Setting this will override
238           the terminal width detection to the number of characters specified.
239
240       --truncate-runner-output
241       --no-truncate-runner-output
242           Only show runner output that was generated after the current
243           command. This is only useful with a persistent runner.
244
245       --verbose
246       -v
247       --no-verbose
248           Be more verbose
249
250           Can be specified multiple times
251
252       Formatter Options
253
254       --formatter ARG
255       --formatter=ARG
256       --no-formatter
257           NO DESCRIPTION - FIX ME
258
259       --qvf
260       --no-qvf
261           [Q]uiet, but [V]erbose on [F]ailure. Hide all output from tests
262           when they pass, except to say they passed. If a test fails then ALL
263           output from the test is verbosely output.
264
265       --show-job-end
266       --no-show-job-end
267           Show output when a job ends. (Default: on)
268
269       --show-job-info
270       --no-show-job-info
271           Show the job configuration when a job starts. (Default: off, unless
272           -vv)
273
274       --show-job-launch
275       --no-show-job-launch
276           Show output for the start of a job. (Default: off unless -v)
277
278       --show-run-info
279       --no-show-run-info
280           Show the run configuration when a run starts. (Default: off, unless
281           -vv)
282
283       Git Options
284
285       --git-change-base master
286       --git-change-base HEAD^
287       --git-change-base df22abe4
288       --no-git-change-base
289           Find files changed by all commits in the current branch from most
290           recent stopping when a commit is found that is also present in the
291           history of the branch/commit specified as the change base.
292
293       Help and Debugging
294
295       --dummy
296       -d
297       --no-dummy
298           Dummy run, do not actually execute anything
299
300           Can also be set with the following environment variables:
301           "T2_HARNESS_DUMMY"
302
303       --help
304       -h
305       --no-help
306           exit after showing help information
307
308       --interactive
309       -i
310       --no-interactive
311           Use interactive mode, 1 test at a time, stdin forwarded to it
312
313       --keep-dirs
314       --keep_dir
315       -k
316       --no-keep-dirs
317           Do not delete directories when done. This is useful if you want to
318           inspect the directories used for various commands.
319
320       --procname-prefix ARG
321       --procname-prefix=ARG
322       --no-procname-prefix
323           Add a prefix to all proc names (as seen by ps).
324
325       YathUI Options
326
327       --yathui-api-key ARG
328       --yathui-api-key=ARG
329       --no-yathui-api-key
330           Yath-UI API key. This is not necessary if your Yath-UI instance is
331           set to single-user
332
333       --yathui-db
334       --no-yathui-db
335           Add the YathUI DB renderer in addition to other renderers
336
337       --yathui-grace
338       --no-yathui-grace
339           If yath cannot connect to yath-ui it normally throws an error, use
340           this to make it fail gracefully. You get a warning, but things keep
341           going.
342
343       --yathui-long-duration 10
344       --no-yathui-long-duration
345           Minimum duration length (seconds) before a test goes from MEDIUM to
346           LONG
347
348       --yathui-medium-duration 5
349       --no-yathui-medium-duration
350           Minimum duration length (seconds) before a test goes from SHORT to
351           MEDIUM
352
353       --yathui-mode summary
354       --yathui-mode qvf
355       --yathui-mode qvfd
356       --yathui-mode complete
357       --no-yathui-mode
358           Set the upload mode (default 'qvfd')
359
360       --yathui-only
361       --no-yathui-only
362           Only use the YathUI renderer
363
364       --yathui-only-db
365       --no-yathui-only-db
366           Only use the YathUI DB renderer
367
368       --yathui-port 8080
369       --no-yathui-port
370           Port to use when running a local server
371
372       --yathui-port-command get_port.sh
373       --yathui-port-command get_port.sh --pid $$
374       --no-yathui-port-command
375           Use a command to get a port number. "$$" will be replaced with the
376           PID of the yath process
377
378       --yathui-project ARG
379       --yathui-project=ARG
380       --no-yathui-project
381           The Yath-UI project for your test results
382
383       --yathui-render
384       --no-yathui-render
385           Add the YathUI renderer in addition to other renderers
386
387       --yathui-retry
388       --no-yathui-retry
389           How many times to try an operation before giving up
390
391           Can be specified multiple times
392
393       --yathui-schema PostgreSQL
394       --yathui-schema MySQL
395       --yathui-schema MySQL56
396       --no-yathui-schema
397           What type of DB/schema to use when using a temporary database
398
399       --yathui-url http://my-yath-ui.com/...
400       --uri http://my-yath-ui.com/...
401       --no-yathui-url
402           Yath-UI url
403
404       --yathui-user ARG
405       --yathui-user=ARG
406       --no-yathui-user
407           Username to attach to the data sent to the db
408
409       --yathui-db-buffering none
410       --yathui-db-buffering job
411       --yathui-db-buffering diag
412       --yathui-db-buffering run
413       --no-yathui-db-buffering
414           Type of buffering to use, if "none" then events are written to the
415           db one at a time, which is SLOW
416
417       --yathui-db-config ARG
418       --yathui-db-config=ARG
419       --no-yathui-db-config
420           Module that implements 'MODULE->yath_ui_config(%params)' which
421           should return a Test2::Harness::UI::Config instance.
422
423       --yathui-db-coverage
424       --no-yathui-db-coverage
425           Pull coverage data directly from the database (default: off)
426
427       --yathui-db-driver Pg
428       --yathui-db-drivermysql
429       --yathui-db-driverMariaDB
430       --no-yathui-db-driver
431           DBI Driver to use
432
433       --yathui-db-dsn ARG
434       --yathui-db-dsn=ARG
435       --no-yathui-db-dsn
436           DSN to use when connecting to the db
437
438       --yathui-db-duration-limit ARG
439       --yathui-db-duration-limit=ARG
440       --no-yathui-db-duration-limit
441           Limit the number of runs to look at for durations data (default:
442           10)
443
444       --yathui-db-durations
445       --no-yathui-db-durations
446           Pull duration data directly from the database (default: off)
447
448       --yathui-db-flush-interval 2
449       --yathui-db-flush-interval 1.5
450       --no-yathui-db-flush-interval
451           When buffering DB writes, force a flush when an event is recieved
452           at least N seconds after the last flush.
453
454       --yathui-db-host ARG
455       --yathui-db-host=ARG
456       --no-yathui-db-host
457           hostname to use when connecting to the db
458
459       --yathui-db-name ARG
460       --yathui-db-name=ARG
461       --no-yathui-db-name
462           Name of the database to use for yathui
463
464       --yathui-db-pass ARG
465       --yathui-db-pass=ARG
466       --no-yathui-db-pass
467           Password to use when connecting to the db
468
469       --yathui-db-port ARG
470       --yathui-db-port=ARG
471       --no-yathui-db-port
472           port to use when connecting to the db
473
474       --yathui-db-publisher ARG
475       --yathui-db-publisher=ARG
476       --no-yathui-db-publisher
477           When using coverage or duration data, only use data uploaded by
478           this user
479
480       --yathui-db-socket ARG
481       --yathui-db-socket=ARG
482       --no-yathui-db-socket
483           socket to use when connecting to the db
484
485       --yathui-db-user ARG
486       --yathui-db-user=ARG
487       --no-yathui-db-user
488           Username to use when connecting to the db
489

SOURCE

491       The source code repository for Test2-Harness can be found at
492       http://github.com/Test-More/Test2-Harness/.
493

MAINTAINERS

495       Chad Granum <exodist@cpan.org>
496

AUTHORS

498       Chad Granum <exodist@cpan.org>
499
501       Copyright 2022 Chad Granum <exodist7@gmail.com>.
502
503       This program is free software; you can redistribute it and/or modify it
504       under the same terms as Perl itself.
505
506       See http://dev.perl.org/licenses/
507
508
509
510perl v5.36.0                      2022-09-08     App::Yath::Command::replay(3)
Impressum