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

NAME

6       App::Yath::Command::replay - Command to replay a test run from an event
7       log.
8

DESCRIPTION

SYNOPSIS

COMMAND LINE USAGE

12           $ yath replay [options] [--] event_log.jsonl[.gz|.bz2] [job1, job2, ...]
13
14   Help
15       --show-opts
16           Exit after showing what yath thinks your options mean
17
18       -h
19       --help
20           Exit after showing this help message
21
22       -V
23       --version
24           Show version information
25
26   Harness Options
27       --id ID
28       --run_id ID
29           Set a specific run-id
30
31           (Default: a UUID)
32
33       --no-long
34           Do not run tests with the HARNESS-CAT-LONG header
35
36       -m Module
37       --load Module
38       --load-module Mod
39           Load a module in each test (after fork)
40
41           this option may be given multiple times
42
43       -M Module
44       --loadim Module
45       --load-import Mod
46           Load and import module in each test (after fork)
47
48           this option may be given multiple times
49
50       -X foo
51       --exclude-pattern bar
52           Exclude files that match
53
54           May be specified multiple times
55
56           matched using `m/$PATTERN/`
57
58       -x t/bad.t
59       --exclude-file t/bad.t
60           Exclude a file from testing
61
62           May be specified multiple times
63
64       --et SECONDS
65       --event_timeout #
66           Kill test if no events received in timeout period
67
68           (Default: 60 seconds)
69
70           This is used to prevent the harness for waiting forever for a hung
71           test. Add the "# HARNESS-NO-TIMEOUT" comment to the top of a test
72           file to disable timeouts on a per-test basis.
73
74       --pet SECONDS
75       --post-exit-timeout #
76           Stop waiting post-exit after the timeout period
77
78           (Default: 15 seconds)
79
80           Some tests fork and allow the parent to exit before writing all
81           their output. If Test2::Harness detects an incomplete plan after
82           the test exists it will monitor for more events until the timeout
83           period. Add the "# HARNESS-NO-TIMEOUT" comment to the top of a test
84           file to disable timeouts on a per-test basis.
85
86   Job Options
87       --blib
88       --no-blib
89           (Default: on) Include 'blib/lib' and 'blib/arch'
90
91           Do not include 'blib/lib' and 'blib/arch'
92
93       --input-file file
94           Use the specified file as standard input to ALL tests
95
96       --lib
97       --no-lib
98           (Default: on) Include 'lib' in your module path
99
100           Do not include 'lib'
101
102       --no-mem-usage
103           Disable Test2::Plugin::MemUsage (Loaded by default)
104
105       --no-uuids
106           Disable Test2::Plugin::UUID (Loaded by default)
107
108       --retry-job-count=1
109           When re-running failed tests, use a different number of parallel
110           jobs. You might do this if your tests are not reliably parallel
111           safe
112
113       --retry=1
114           Run any jobs that failed a second time. NOTE: --retry=1 means
115           failing tests will be attempted twice!
116
117       --slack "#CHANNEL"
118       --slack "@USER"
119           Send results to a slack channel
120
121           Send results to a slack user
122
123       --slack-fail "#CHANNEL"
124       --slack-fail "@USER"
125           Send failing results to a slack channel
126
127           Send failing results to a slack user
128
129       --tlib
130           (Default: off) Include 't/lib' in your module path
131
132       -E VAR=value
133       --env-var VAR=val
134           Set an environment variable for each test
135
136           (but not the harness)
137
138       -i "string"
139           This input string will be used as standard input for ALL tests
140
141           See also --input-file
142
143       -I path/lib
144       --include lib/
145           Add a directory to your include paths
146
147           This can be used multiple times
148
149       --cover
150           use Devel::Cover to calculate test coverage
151
152           This is essentially the same as combining: '--no-fork', and
153           '-MDevel::Cover=-silent,1,+ignore,^t/,+ignore,^t2/,+ignore,^xt,+ignore,^test.pl'
154           Devel::Cover and preload/fork do not work well together.
155
156       --default-at-search xt
157           Specify the default file/dir search when 'AUTHOR_TESTING' is set.
158           Defaults to './xt'. The default AT search is only used if no files
159           were specified at the command line
160
161       --default-search t
162           Specify the default file/dir search. defaults to './t', './t2', and
163           'test.pl'. The default search is only used if no files were
164           specified at the command line
165
166       --email foo@example.com
167           Email the test results (and any log file) to the specified email
168           address(es)
169
170       --email-from foo@example.com
171           If any email is sent, this is who it will be from
172
173       --email-owner
174           Email the owner of broken tests files upon failure. Add `# HARNESS-
175           META-OWNER foo@example.com` to the top of a test file to give it an
176           owner
177
178       --fork
179       --no-fork
180           (Default: on) fork to start tests
181
182           Do not fork to start tests
183
184           Test2::Harness normally forks to start a test. Forking can break
185           some select tests, this option will allow such tests to pass. This
186           is not compatible with the "preload" option. This is also
187           significantly slower. You can also add the "# HARNESS-NO-PRELOAD"
188           comment to the top of the test file to enable this on a per-test
189           basis.
190
191       --no-batch-owner-notices
192           Usually owner failures are sent as a single batch at the end of
193           testing. Toggle this to send failures as they happen.
194
195       --notify-text "custom notification info"
196           Add a custom text snippet to email/slack notifications
197
198       --slack-log
199       --no-slack-log
200           Off by default, log file will be attached if available
201
202           Attach the event log to any slack notifications.
203
204       --slack-notify
205       --no-slack-notify
206           On by default if --slack-url is specified
207
208           Send slack notifications to the slack channels/users listed in test
209           meta-data when tests fail.
210
211       --slack-url "URL"
212           Specify an API endpoint for slack webhook integrations
213
214           This should be your slack webhook url.
215
216       --stream
217       --no-stream
218       --TAP
219       --tap
220           Use 'stream' instead of TAP (Default: use stream)
221
222           Do not use stream
223
224           Use TAP
225
226           The TAP format is lossy and clunky. Test2::Harness normally uses a
227           newer streaming format to receive test results. There are
228           old/legacy tests where this causes problems, in which case setting
229           --TAP or --no-stream can help.
230
231       --times
232           Monitor timing data for each test file
233
234           This tells perl to load Test2::Plugin::Times before starting each
235           test. Use -T to show the timing data
236
237       --unsafe-inc
238       --no-unsafe-inc
239           (Default: On) put '.' in @INC
240
241           Do not put '.' in @INC
242
243           perl is removing '.' from @INC as a security concern. This option
244           keeps things from breaking for now.
245
246       -A
247       --author-testing
248       --no-author-testing
249           This will set the AUTHOR_TESTING environment to true
250
251           Many cpan modules have tests that are only run if the
252           AUTHOR_TESTING environment variable is set. This will cause those
253           tests to run.
254
255       -k
256       --keep-dir
257           Do not delete the work directory when done
258
259           This is useful if you want to inspect the work directory after the
260           harness is done. The work directory path will be printed at the
261           end.
262
263       -S SW
264       -S SW=val
265       --switch SW=val
266           Pass the specified switch to perl for each test
267
268           This is not compatible with preload.
269
270   Display Options
271       --color
272       --no-color
273           Turn color on (Default: on)
274
275           Turn color off
276
277       --show-job-info
278       --no-show-job-info
279           Show the job configuration when a job starts
280
281           (Default: off, unless -vv)
282
283       --show-job-launch
284       --no-show-job-launch
285           Show output for the start of a job
286
287           (Default: off unless -v)
288
289       --show-run-info
290       --no-show-run-info
291           Show the run configuration when a run starts
292
293           (Default: off, unless -vv)
294
295       -q
296       --quiet
297           Be very quiet
298
299       -T
300       --show-times
301           Show the timing data for each job
302
303       -v
304       -vv
305       --verbose
306           Turn on verbose mode.
307
308           Specify multiple times to be more verbose.
309
310       --formatter Mod
311       --formatter +Mod
312           Specify the formatter to use
313
314           (Default: "Test2")
315
316           Only useful when a renderer is set to "Formatter". This specified
317           the Test2::Formatter::XXX that will be used to render the test
318           output.
319
320       --no-progress
321           Turn off progress indicators
322
323           This disables "events seen" counter and buffered event pre-display
324
325       --qvf
326           Quiet, but verbose on failure
327
328           Hide all output from tests when they pass, except to say they
329           passed. If a test fails then ALL output from the test is verbosely
330           output.
331
332       --show-job-end
333       --no-show-job-end
334           Show output when a job ends
335
336           (Default: on)
337
338           This is only used when the renderer is set to "Formatter"
339
340       -r +Module
341       -r Postfix
342       --renderer ...
343       -r +Module=arg1,arg2,...
344           Specify renderers
345
346           (Default: "Formatter")
347
348           Use "+" to give a fully qualified module name. Without "+"
349           "Test2::Harness::Renderer::" will be prepended to your argument.
350           You may specify custom arguments to the constructor after an "="
351           sign.
352
353   Plugins
354       -pPlugin
355       -p+My::Plugin
356       --plugin Plugin
357           Load a plugin
358
359           can be specified multiple times
360
361       --no-plugins
362           cancel any plugins listed until now
363
364           This can be used to negate plugins specified in .yath.rc or similar
365

SOURCE

367       The source code repository for Test2-Harness can be found at
368       http://github.com/Test-More/Test2-Harness/.
369

MAINTAINERS

371       Chad Granum <exodist@cpan.org>
372

AUTHORS

374       Chad Granum <exodist@cpan.org>
375

COPYRIGHT

377       Copyright 2019 Chad Granum <exodist7@gmail.com>.
378
379       This program is free software; you can redistribute it and/or modify it
380       under the same terms as Perl itself.
381
382       See http://dev.perl.org/licenses/
383
384
385
386perl v5.30.0                      2019-08-14     App::Yath::Command::replay(3)