1App::Yath::Command::faiUlseedr(3C)ontributed Perl DocumeAnptpa:t:iYoanth::Command::failed(3)
2
6 App::Yath::Command::failed
7
11 $ yath failed [options] [--] event_log.jsonl[.gz|.bz2] [job1, job2, ...]
12 Help
14 --show-opts
15 Exit after showing what yath thinks your options mean
16 -h
18 --help
19 Exit after showing this help message
20 -V
22 --version
23 Show version information
24 Harness Options
26 --id ID
27 --run_id ID
28 Set a specific run-id
29 (Default: a UUID)
31 --no-long
33 Do not run tests with the HARNESS-DURATION-LONG header
34 --only-long
36 only run tests with the HARNESS-DURATION-LONG header
37 -m Module
39 --load Module
40 --load-module Mod
41 Load a module in each test (after fork)
42 this option may be given multiple times
44 -M Module
46 --loadim Module
47 --load-import Mod
48 Load and import module in each test (after fork)
49 this option may be given multiple times
51 -X foo
53 --exclude-pattern bar
54 Exclude files that match
55 May be specified multiple times
57 matched using `m/$PATTERN/`
59 -x t/bad.t
61 --exclude-file t/bad.t
62 Exclude a file from testing
63 May be specified multiple times
65 --durations path
67 --durations url
68 Point at a json file or url which has a hash of relative test
69 filenames as keys, and 'SHORT', 'MEDIUM', or 'LONG' as values. This
70 will override durations listed in the file headers. An exception
71 will be thrown if the durations file or url does not work.
72 --et SECONDS
74 --event_timeout #
75 Kill test if no events received in timeout period
76 (Default: 60 seconds)
78 This is used to prevent the harness for waiting forever for a hung
80 test. Add the "# HARNESS-NO-TIMEOUT" comment to the top of a test
81 file to disable timeouts on a per-test basis.
82 --maybe-durations path
84 --maybe-durations url
85 Same as 'durations' except not fatal if not found. If this and
86 'durations' are both specified then 'durations' is used as a
87 fallback when this fails. You may specify this option multiple
88 times and the first one that works will be used
89 --pet SECONDS
91 --post-exit-timeout #
92 Stop waiting post-exit after the timeout period
93 (Default: 15 seconds)
95 Some tests fork and allow the parent to exit before writing all
97 their output. If Test2::Harness detects an incomplete plan after
98 the test exists it will monitor for more events until the timeout
99 period. Add the "# HARNESS-NO-TIMEOUT" comment to the top of a test
100 file to disable timeouts on a per-test basis.
101 Job Options
103 --blib
104 --no-blib
105 (Default: on) Include 'blib/lib' and 'blib/arch'
106 Do not include 'blib/lib' and 'blib/arch'
108 --input-file file
110 Use the specified file as standard input to ALL tests
111 --lib
113 --no-lib
114 (Default: on) Include 'lib' in your module path
115 Do not include 'lib'
117 --no-mem-usage
119 Disable Test2::Plugin::MemUsage (Loaded by default)
120 --no-uuids
122 Disable Test2::Plugin::UUID (Loaded by default)
123 --retry-job-count=1
125 When re-running failed tests, use a different number of parallel
126 jobs. You might do this if your tests are not reliably parallel
127 safe
128 --retry=1
130 Run any jobs that failed a second time. NOTE: --retry=1 means
131 failing tests will be attempted twice!
132 --slack "#CHANNEL"
134 --slack "@USER"
135 Send results to a slack channel
136 Send results to a slack user
138 --slack-fail "#CHANNEL"
140 --slack-fail "@USER"
141 Send failing results to a slack channel
142 Send failing results to a slack user
144 --tlib
146 (Default: off) Include 't/lib' in your module path
147 -E VAR=value
149 --env-var VAR=val
150 Set an environment variable for each test
151 (but not the harness)
153 -i "string"
155 This input string will be used as standard input for ALL tests
156 See also --input-file
158 -I path/lib
160 --include lib/
161 Add a directory to your include paths
162 This can be used multiple times
164 --cover
166 use Devel::Cover to calculate test coverage
167 This is essentially the same as combining: '--no-fork', and
169 '-MDevel::Cover=-silent,1,+ignore,^t/,+ignore,^t2/,+ignore,^xt,+ignore,^test.pl'
170 Devel::Cover and preload/fork do not work well together.
171 --default-at-search xt
173 Specify the default file/dir search when 'AUTHOR_TESTING' is set.
174 Defaults to './xt'. The default AT search is only used if no files
175 were specified at the command line
176 --default-search t
178 Specify the default file/dir search. defaults to './t', './t2', and
179 'test.pl'. The default search is only used if no files were
180 specified at the command line
181 --email foo@example.com
183 Email the test results (and any log file) to the specified email
184 address(es)
185 --email-from foo@example.com
187 If any email is sent, this is who it will be from
188 --email-owner
190 Email the owner of broken tests files upon failure. Add `# HARNESS-
191 META-OWNER foo@example.com` to the top of a test file to give it an
192 owner
193 --fork
195 --no-fork
196 (Default: on) fork to start tests
197 Do not fork to start tests
199 Test2::Harness normally forks to start a test. Forking can break
201 some select tests, this option will allow such tests to pass. This
202 is not compatible with the "preload" option. This is also
203 significantly slower. You can also add the "# HARNESS-NO-PRELOAD"
204 comment to the top of the test file to enable this on a per-test
205 basis.
206 --no-batch-owner-notices
208 Usually owner failures are sent as a single batch at the end of
209 testing. Toggle this to send failures as they happen.
210 --notify-text "custom"
212 Add a custom text snippet to email/slack notifications
213 --slack-log
215 --no-slack-log
216 Off by default, log file will be attached if available
217 Attach the event log to any slack notifications.
219 --slack-notify
221 --no-slack-notify
222 On by default if --slack-url is specified
223 Send slack notifications to the slack channels/users listed in test
225 meta-data when tests fail.
226 --slack-url "URL"
228 Specify an API endpoint for slack webhook integrations
229 This should be your slack webhook url.
231 --stream
233 --no-stream
234 --TAP
235 --tap
236 Use 'stream' instead of TAP (Default: use stream)
237 Do not use stream
239 Use TAP
241 The TAP format is lossy and clunky. Test2::Harness normally uses a
243 newer streaming format to receive test results. There are
244 old/legacy tests where this causes problems, in which case setting
245 --TAP or --no-stream can help.
246 --unsafe-inc
248 --no-unsafe-inc
249 (Default: On) put '.' in @INC
250 Do not put '.' in @INC
252 perl is removing '.' from @INC as a security concern. This option
254 keeps things from breaking for now.
255 -A
257 --author-testing
258 --no-author-testing
259 This will set the AUTHOR_TESTING environment to true
260 Many cpan modules have tests that are only run if the
262 AUTHOR_TESTING environment variable is set. This will cause those
263 tests to run.
264 -k
266 --keep-dir
267 Do not delete the work directory when done
268 This is useful if you want to inspect the work directory after the
270 harness is done. The work directory path will be printed at the
271 end.
272 -S SW
274 -S SW=val
275 --switch SW=val
276 Pass the specified switch to perl for each test
277 This is not compatible with preload.
279 Plugins
281 -pPlugin
282 -pPlugin=arg1,arg2,...
283 -p+My::Plugin
284 --plugin Plugin
285 Load a plugin
286 can be specified multiple times
288 --no-plugins
290 cancel any plugins listed until now
291 This can be used to negate plugins specified in .yath.rc or similar
293
295 The source code repository for Test2-Harness can be found at
296 http://github.com/Test-More/Test2-Harness/.
297
299 Chad Granum <exodist@cpan.org>
300
302 Chad Granum <exodist@cpan.org>
303
305 Copyright 2019 Chad Granum <exodist7@gmail.com>.
306 This program is free software; you can redistribute it and/or modify it
308 under the same terms as Perl itself.
309 See http://dev.perl.org/licenses/
311perl v5.30.1 2020-01-30 App::Yath::Command::failed(3)