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

NAME

6       App::Yath::Command::failed
7

DESCRIPTION

SYNOPSIS

COMMAND LINE USAGE

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

SOURCE

283       The source code repository for Test2-Harness can be found at
284       http://github.com/Test-More/Test2-Harness/.
285

MAINTAINERS

287       Chad Granum <exodist@cpan.org>
288

AUTHORS

290       Chad Granum <exodist@cpan.org>
291

COPYRIGHT

293       Copyright 2019 Chad Granum <exodist7@gmail.com>.
294
295       This program is free software; you can redistribute it and/or modify it
296       under the same terms as Perl itself.
297
298       See http://dev.perl.org/licenses/
299
300
301
302perl v5.30.0                      2019-08-14     App::Yath::Command::failed(3)