1App::Yath::Command::repUlsaeyr(3C)ontributed Perl DocumeAnptpa:t:iYoanth::Command::replay(3)
2
6 App::Yath::Command::replay - Command to replay a test run from an event
7 log.
8
12 $ yath replay [options] [--] event_log.jsonl[.gz|.bz2] [job1, job2, ...]
13 Help
15 --show-opts
16 Exit after showing what yath thinks your options mean
17 -h
19 --help
20 Exit after showing this help message
21 -V
23 --version
24 Show version information
25 Harness Options
27 --id ID
28 --run_id ID
29 Set a specific run-id
30 (Default: a UUID)
32 --no-long
34 Do not run tests with the HARNESS-DURATION-LONG header
35 --only-long
37 only run tests with the HARNESS-DURATION-LONG header
38 -m Module
40 --load Module
41 --load-module Mod
42 Load a module in each test (after fork)
43 this option may be given multiple times
45 -M Module
47 --loadim Module
48 --load-import Mod
49 Load and import module in each test (after fork)
50 this option may be given multiple times
52 -X foo
54 --exclude-pattern bar
55 Exclude files that match
56 May be specified multiple times
58 matched using `m/$PATTERN/`
60 -x t/bad.t
62 --exclude-file t/bad.t
63 Exclude a file from testing
64 May be specified multiple times
66 --durations path
68 --durations url
69 Point at a json file or url which has a hash of relative test
70 filenames as keys, and 'SHORT', 'MEDIUM', or 'LONG' as values. This
71 will override durations listed in the file headers. An exception
72 will be thrown if the durations file or url does not work.
73 --et SECONDS
75 --event_timeout #
76 Kill test if no events received in timeout period
77 (Default: 60 seconds)
79 This is used to prevent the harness for waiting forever for a hung
81 test. Add the "# HARNESS-NO-TIMEOUT" comment to the top of a test
82 file to disable timeouts on a per-test basis.
83 --maybe-durations path
85 --maybe-durations url
86 Same as 'durations' except not fatal if not found. If this and
87 'durations' are both specified then 'durations' is used as a
88 fallback when this fails. You may specify this option multiple
89 times and the first one that works will be used
90 --pet SECONDS
92 --post-exit-timeout #
93 Stop waiting post-exit after the timeout period
94 (Default: 15 seconds)
96 Some tests fork and allow the parent to exit before writing all
98 their output. If Test2::Harness detects an incomplete plan after
99 the test exists it will monitor for more events until the timeout
100 period. Add the "# HARNESS-NO-TIMEOUT" comment to the top of a test
101 file to disable timeouts on a per-test basis.
102 Job Options
104 --blib
105 --no-blib
106 (Default: on) Include 'blib/lib' and 'blib/arch'
107 Do not include 'blib/lib' and 'blib/arch'
109 --input-file file
111 Use the specified file as standard input to ALL tests
112 --lib
114 --no-lib
115 (Default: on) Include 'lib' in your module path
116 Do not include 'lib'
118 --no-mem-usage
120 Disable Test2::Plugin::MemUsage (Loaded by default)
121 --no-uuids
123 Disable Test2::Plugin::UUID (Loaded by default)
124 --retry-job-count=1
126 When re-running failed tests, use a different number of parallel
127 jobs. You might do this if your tests are not reliably parallel
128 safe
129 --retry=1
131 Run any jobs that failed a second time. NOTE: --retry=1 means
132 failing tests will be attempted twice!
133 --slack "#CHANNEL"
135 --slack "@USER"
136 Send results to a slack channel
137 Send results to a slack user
139 --slack-fail "#CHANNEL"
141 --slack-fail "@USER"
142 Send failing results to a slack channel
143 Send failing results to a slack user
145 --tlib
147 (Default: off) Include 't/lib' in your module path
148 -E VAR=value
150 --env-var VAR=val
151 Set an environment variable for each test
152 (but not the harness)
154 -i "string"
156 This input string will be used as standard input for ALL tests
157 See also --input-file
159 -I path/lib
161 --include lib/
162 Add a directory to your include paths
163 This can be used multiple times
165 --cover
167 use Devel::Cover to calculate test coverage
168 This is essentially the same as combining: '--no-fork', and
170 '-MDevel::Cover=-silent,1,+ignore,^t/,+ignore,^t2/,+ignore,^xt,+ignore,^test.pl'
171 Devel::Cover and preload/fork do not work well together.
172 --default-at-search xt
174 Specify the default file/dir search when 'AUTHOR_TESTING' is set.
175 Defaults to './xt'. The default AT search is only used if no files
176 were specified at the command line
177 --default-search t
179 Specify the default file/dir search. defaults to './t', './t2', and
180 'test.pl'. The default search is only used if no files were
181 specified at the command line
182 --email foo@example.com
184 Email the test results (and any log file) to the specified email
185 address(es)
186 --email-from foo@example.com
188 If any email is sent, this is who it will be from
189 --email-owner
191 Email the owner of broken tests files upon failure. Add `# HARNESS-
192 META-OWNER foo@example.com` to the top of a test file to give it an
193 owner
194 --fork
196 --no-fork
197 (Default: on) fork to start tests
198 Do not fork to start tests
200 Test2::Harness normally forks to start a test. Forking can break
202 some select tests, this option will allow such tests to pass. This
203 is not compatible with the "preload" option. This is also
204 significantly slower. You can also add the "# HARNESS-NO-PRELOAD"
205 comment to the top of the test file to enable this on a per-test
206 basis.
207 --no-batch-owner-notices
209 Usually owner failures are sent as a single batch at the end of
210 testing. Toggle this to send failures as they happen.
211 --notify-text "custom"
213 Add a custom text snippet to email/slack notifications
214 --slack-log
216 --no-slack-log
217 Off by default, log file will be attached if available
218 Attach the event log to any slack notifications.
220 --slack-notify
222 --no-slack-notify
223 On by default if --slack-url is specified
224 Send slack notifications to the slack channels/users listed in test
226 meta-data when tests fail.
227 --slack-url "URL"
229 Specify an API endpoint for slack webhook integrations
230 This should be your slack webhook url.
232 --stream
234 --no-stream
235 --TAP
236 --tap
237 Use 'stream' instead of TAP (Default: use stream)
238 Do not use stream
240 Use TAP
242 The TAP format is lossy and clunky. Test2::Harness normally uses a
244 newer streaming format to receive test results. There are
245 old/legacy tests where this causes problems, in which case setting
246 --TAP or --no-stream can help.
247 --unsafe-inc
249 --no-unsafe-inc
250 (Default: On) put '.' in @INC
251 Do not put '.' in @INC
253 perl is removing '.' from @INC as a security concern. This option
255 keeps things from breaking for now.
256 -A
258 --author-testing
259 --no-author-testing
260 This will set the AUTHOR_TESTING environment to true
261 Many cpan modules have tests that are only run if the
263 AUTHOR_TESTING environment variable is set. This will cause those
264 tests to run.
265 -k
267 --keep-dir
268 Do not delete the work directory when done
269 This is useful if you want to inspect the work directory after the
271 harness is done. The work directory path will be printed at the
272 end.
273 -S SW
275 -S SW=val
276 --switch SW=val
277 Pass the specified switch to perl for each test
278 This is not compatible with preload.
280 Display Options
282 --color
283 --no-color
284 Turn color on (Default: on)
285 Turn color off
287 --show-job-info
289 --no-show-job-info
290 Show the job configuration when a job starts
291 (Default: off, unless -vv)
293 --show-job-launch
295 --no-show-job-launch
296 Show output for the start of a job
297 (Default: off unless -v)
299 --show-run-info
301 --no-show-run-info
302 Show the run configuration when a run starts
303 (Default: off, unless -vv)
305 -q
307 --quiet
308 Be very quiet
309 -T
311 --show-times
312 Show the timing data for each job
313 -v
315 -vv
316 --verbose
317 Turn on verbose mode.
318 Specify multiple times to be more verbose.
320 --formatter Mod
322 --formatter +Mod
323 Specify the formatter to use
324 (Default: "Test2")
326 Only useful when a renderer is set to "Formatter". This specified
328 the Test2::Formatter::XXX that will be used to render the test
329 output.
330 --no-progress
332 Turn off progress indicators
333 This disables "events seen" counter and buffered event pre-display
335 --qvf
337 Quiet, but verbose on failure
338 Hide all output from tests when they pass, except to say they
340 passed. If a test fails then ALL output from the test is verbosely
341 output.
342 --show-job-end
344 --no-show-job-end
345 Show output when a job ends
346 (Default: on)
348 This is only used when the renderer is set to "Formatter"
350 -r +Module
352 -r Postfix
353 --renderer ...
354 -r +Module=arg1,arg2,...
355 Specify renderers
356 (Default: "Formatter")
358 Use "+" to give a fully qualified module name. Without "+"
360 "Test2::Harness::Renderer::" will be prepended to your argument.
361 You may specify custom arguments to the constructor after an "="
362 sign.
363 Plugins
365 -pPlugin
366 -pPlugin=arg1,arg2,...
367 -p+My::Plugin
368 --plugin Plugin
369 Load a plugin
370 can be specified multiple times
372 --no-plugins
374 cancel any plugins listed until now
375 This can be used to negate plugins specified in .yath.rc or similar
377
379 The source code repository for Test2-Harness can be found at
380 http://github.com/Test-More/Test2-Harness/.
381
383 Chad Granum <exodist@cpan.org>
384
386 Chad Granum <exodist@cpan.org>
387
389 Copyright 2019 Chad Granum <exodist7@gmail.com>.
390 This program is free software; you can redistribute it and/or modify it
392 under the same terms as Perl itself.
393 See http://dev.perl.org/licenses/
395perl v5.30.1 2020-01-30 App::Yath::Command::replay(3)