1App::Yath::Options::RunUnseerr(3C)ontributed Perl DocumeAnptpa:t:iYoanth::Options::Runner(3)
2
6 App::Yath::Options::Runner - Runner options for Yath.
7
9 This is where command line options for the runner are defined.
10
12 COMMAND OPTIONS
13 Runner Options
14 --abort-on-bail
16 --no-abort-on-bail
17 Abort all testing if a bail-out is encountered (default: on)
18 --blib
20 -b
21 --no-blib
22 (Default: include if it exists) Include 'blib/lib' and 'blib/arch'
23 in your module path
24 --cover
26 --cover=-silent,1,+ignore,^t/,+ignore,^t2/,+ignore,^xt,+ignore,^test.pl
27 --no-cover
28 Use Devel::Cover to calculate test coverage. This disables forking.
29 If no args are specified the following are used:
30 -silent,1,+ignore,^t/,+ignore,^t2/,+ignore,^xt,+ignore,^test.pl
31 --dump-depmap
33 --no-dump-depmap
34 When using staged preload, dump the depmap for each stage as json
35 files
36 --event-timeout SECONDS
38 --et SECONDS
39 --no-event-timeout
40 Kill test if no output is received within timeout period. (Default:
41 60 seconds). Add the "# HARNESS-NO-TIMEOUT" comment to the top of a
42 test file to disable timeouts on a per-test basis. This prevents a
43 hung test from running forever.
44 --include ARG
46 --include=ARG
47 -I ARG
48 -I=ARG
49 --no-include
50 Add a directory to your include paths
51 Can be specified multiple times
53 --job-count 4
55 --job-count 8:2
56 --jobs 4
57 --jobs 8:2
58 -j4
59 -j8:2
60 --no-job-count
61 Set the number of concurrent jobs to run. Add a :# if you also wish
62 to designate multiple slots per test. 8:2 means 8 slots, but each
63 test gets 2 slots, so 4 tests run concurrently. Tests can find
64 their concurrency assignemnt in the "T2_HARNESS_MY_JOB_CONCURRENCY"
65 environment variable.
66 Can also be set with the following environment variables:
68 "YATH_JOB_COUNT", "T2_HARNESS_JOB_COUNT", "HARNESS_JOB_COUNT"
69 --lib
71 -l
72 --no-lib
73 (Default: include if it exists) Include 'lib' in your module path
74 --nytprof
76 --no-nytprof
77 Use Devel::NYTProf on tests. This will set addpid=1 for you. This
78 works with or without fork.
79 --post-exit-timeout SECONDS
81 --pet SECONDS
82 --no-post-exit-timeout
83 Stop waiting post-exit after the timeout period. (Default: 15
84 seconds) Some tests fork and allow the parent to exit before
85 writing all their output. If Test2::Harness detects an incomplete
86 plan after the test exits it will monitor for more events until the
87 timeout period. Add the "# HARNESS-NO-TIMEOUT" comment to the top
88 of a test file to disable timeouts on a per-test basis.
89 --preload-threshold ARG
91 --preload-threshold=ARG
92 --Pt ARG
93 --Pt=ARG
94 -W ARG
95 -W=ARG
96 --no-preload-threshold
97 Only do preload if at least N tests are going to be run. In some
98 cases a full preload takes longer than simply running the tests,
99 this lets you specify a minimum number of test jobs that will be
100 run for preload to happen. This has no effect for a persistent
101 runner. The default is 0, and it means always preload.
102 --preloads ARG
104 --preloads=ARG
105 --preload ARG
106 --preload=ARG
107 -P ARG
108 -P=ARG
109 --no-preloads
110 Preload a module before running tests
111 Can be specified multiple times
113 --resource Port
115 --resource +Test2::Harness::Runner::Resource::Port
116 -R Port
117 --no-resource
118 Use a resource module to assign resource assignments to individual
119 tests
120 Can be specified multiple times
122 --runner-id ARG
124 --runner-id=ARG
125 --no-runner-id
126 Runner ID (usually a generated uuid)
127 --shared-jobs-config .sharedjobslots.yml
129 --shared-jobs-config relative/path/.sharedjobslots.yml
130 --shared-jobs-config /absolute/path/.sharedjobslots.yml
131 --no-shared-jobs-config
132 Where to look for a shared slot config file. If a filename with no
133 path is provided yath will search the current and all parent
134 directories for the name.
135 --slots-per-job 2
137 -x2
138 --no-slots-per-job
139 This sets the number of slots each job will use (default 1). This
140 is normally set by the ':#' in '-j#:#'.
141 Can also be set with the following environment variables:
143 "T2_HARNESS_JOB_CONCURRENCY"
144 --switch ARG
146 --switch=ARG
147 -S ARG
148 -S=ARG
149 --no-switch
150 Pass the specified switch to perl for each test. This is not
151 compatible with preload.
152 Can be specified multiple times
154 --tlib
156 --no-tlib
157 (Default: off) Include 't/lib' in your module path
158 --unsafe-inc
160 --no-unsafe-inc
161 perl is removing '.' from @INC as a security concern. This option
162 keeps things from breaking for now.
163 Can also be set with the following environment variables:
165 "PERL_USE_UNSAFE_INC"
166 --use-fork
168 --fork
169 --no-use-fork
170 (default: on, except on windows) Normally tests are run by forking,
171 which allows for features like preloading. This will turn off the
172 behavior globally (which is not compatible with preloading). This
173 is slower, it is better to tag misbehaving tests with the '#
174 HARNESS-NO-PRELOAD' comment in their header to disable forking only
175 for those tests.
176 Can also be set with the following environment variables:
178 "!T2_NO_FORK", "T2_HARNESS_FORK", "!T2_HARNESS_NO_FORK",
179 "YATH_FORK", "!YATH_NO_FORK"
180 --use-timeout
182 --timeout
183 --no-use-timeout
184 (default: on) Enable/disable timeouts
185
187 The source code repository for Test2-Harness can be found at
188 http://github.com/Test-More/Test2-Harness/.
189
191 Chad Granum <exodist@cpan.org>
192
194 Chad Granum <exodist@cpan.org>
195
197 Copyright 2020 Chad Granum <exodist7@gmail.com>.
198 This program is free software; you can redistribute it and/or modify it
200 under the same terms as Perl itself.
201 See http://dev.perl.org/licenses/
203perl v5.38.0 2023-10-04 App::Yath::Options::Runner(3)