1App::Yath::Command::runU(s3e)r Contributed Perl DocumentaAtpipo:n:Yath::Command::run(3)
2
3
4

NAME

6       App::Yath::Command::persist
7

DESCRIPTION

SYNOPSIS

COMMAND LINE USAGE

11           $ yath run [options] [--] [test files/dirs] [::] [arguments to test scripts]
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   Logging Options
270       -B
271       --bz2
272       --bzip2-log
273           Use bzip2 compression when writing the log
274
275           This option implies -L
276
277           .bz2 prefix is added to log file name for you
278
279       -F file.jsonl
280       --log-file FILE
281           Specify the name of the log file
282
283           This option implies -L
284
285           (Default: event_log-RUN_ID.jsonl)
286
287       -G
288       --gz
289       --gzip-log
290           Use gzip compression when writing the log
291
292           This option implies -L
293
294           .gz prefix is added to log file name for you
295
296       -L
297       --log
298           Turn on logging
299
300       --lff format-string
301       --log-file-format format-string
302           Specify the format for automatically-generated log files.
303
304           Overridden by --log-file, if given
305
306           This option implies -L
307
308           (Default: $YATH_LOG_FILE_FORMAT, if that is set, or else
309           '%Y-%m-%d~%H:%M:%S~%!U~%!p.jsonl')
310
311           This is a string in which percent-escape sequences will be replaced
312           as per POSIX::strftime.  The following special escape sequences are
313           also replaced: (%!U : the unique test run ID)  (%!p : the process
314           ID) (%!S : the number of seconds since local midnight UTC
315
316   Display Options
317       --color
318       --no-color
319           Turn color on (Default: on)
320
321           Turn color off
322
323       --show-job-info
324       --no-show-job-info
325           Show the job configuration when a job starts
326
327           (Default: off, unless -vv)
328
329       --show-job-launch
330       --no-show-job-launch
331           Show output for the start of a job
332
333           (Default: off unless -v)
334
335       --show-run-info
336       --no-show-run-info
337           Show the run configuration when a run starts
338
339           (Default: off, unless -vv)
340
341       -q
342       --quiet
343           Be very quiet
344
345       -T
346       --show-times
347           Show the timing data for each job
348
349       -v
350       -vv
351       --verbose
352           Turn on verbose mode.
353
354           Specify multiple times to be more verbose.
355
356       --formatter Mod
357       --formatter +Mod
358           Specify the formatter to use
359
360           (Default: "Test2")
361
362           Only useful when a renderer is set to "Formatter". This specified
363           the Test2::Formatter::XXX that will be used to render the test
364           output.
365
366       --no-progress
367           Turn off progress indicators
368
369           This disables "events seen" counter and buffered event pre-display
370
371       --qvf
372           Quiet, but verbose on failure
373
374           Hide all output from tests when they pass, except to say they
375           passed. If a test fails then ALL output from the test is verbosely
376           output.
377
378       --show-job-end
379       --no-show-job-end
380           Show output when a job ends
381
382           (Default: on)
383
384           This is only used when the renderer is set to "Formatter"
385
386       -r +Module
387       -r Postfix
388       --renderer ...
389       -r +Module=arg1,arg2,...
390           Specify renderers
391
392           (Default: "Formatter")
393
394           Use "+" to give a fully qualified module name. Without "+"
395           "Test2::Harness::Renderer::" will be prepended to your argument.
396           You may specify custom arguments to the constructor after an "="
397           sign.
398
399   Plugins
400       -pPlugin
401       -p+My::Plugin
402       --plugin Plugin
403           Load a plugin
404
405           can be specified multiple times
406
407       --no-plugins
408           cancel any plugins listed until now
409
410           This can be used to negate plugins specified in .yath.rc or similar
411

SOURCE

413       The source code repository for Test2-Harness can be found at
414       http://github.com/Test-More/Test2-Harness/.
415

MAINTAINERS

417       Chad Granum <exodist@cpan.org>
418

AUTHORS

420       Chad Granum <exodist@cpan.org>
421

COPYRIGHT

423       Copyright 2019 Chad Granum <exodist7@gmail.com>.
424
425       This program is free software; you can redistribute it and/or modify it
426       under the same terms as Perl itself.
427
428       See http://dev.perl.org/licenses/
429
430
431
432perl v5.30.0                      2019-08-14        App::Yath::Command::run(3)