1App::Yath::Command::staUrste(r3)Contributed Perl DocumenAtpapt:i:oYnath::Command::start(3)
2
3
4
6 App::Yath::Command::start
7
11 $ yath start [options]
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-DURATION-LONG header
34
35 --only-long
36 only run tests with the HARNESS-DURATION-LONG header
37
38 --shm
39 --no-shm
40 Use shm for tempdir if possible (Default: off)
41
42 Do not use shm.
43
44 -C
45 --clear
46 Clear the work directory if it is not already empty
47
48 -D
49 --dummy
50 Dummy run, do not actually execute tests
51
52 -d path
53 --dir path
54 --workdir path
55 Set the work directory
56
57 (Default: new temp directory)
58
59 -f name:details
60 --field 'JSON_STRING'
61 Add custom harness_run_fields
62
63 -j #
64 --jobs #
65 --job-count #
66 Set the number of concurrent jobs to run
67
68 (Default: 1)
69
70 -m Module
71 --load Module
72 --load-module Mod
73 Load a module in each test (after fork)
74
75 this option may be given multiple times
76
77 -M Module
78 --loadim Module
79 --load-import Mod
80 Load and import module in each test (after fork)
81
82 this option may be given multiple times
83
84 -P Module
85 --preload Module
86 Preload a module before running tests
87
88 this option may be given multiple times
89
90 -t path/
91 --tmpdir path/
92 Use a specific temp directory
93
94 (Default: use system temp dir)
95
96 -X foo
97 --exclude-pattern bar
98 Exclude files that match
99
100 May be specified multiple times
101
102 matched using `m/$PATTERN/`
103
104 -x t/bad.t
105 --exclude-file t/bad.t
106 Exclude a file from testing
107
108 May be specified multiple times
109
110 --durations path
111 --durations url
112 Point at a json file or url which has a hash of relative test
113 filenames as keys, and 'SHORT', 'MEDIUM', or 'LONG' as values. This
114 will override durations listed in the file headers. An exception
115 will be thrown if the durations file or url does not work.
116
117 --et SECONDS
118 --event_timeout #
119 Kill test if no events received in timeout period
120
121 (Default: 60 seconds)
122
123 This is used to prevent the harness for waiting forever for a hung
124 test. Add the "# HARNESS-NO-TIMEOUT" comment to the top of a test
125 file to disable timeouts on a per-test basis.
126
127 --maybe-durations path
128 --maybe-durations url
129 Same as 'durations' except not fatal if not found. If this and
130 'durations' are both specified then 'durations' is used as a
131 fallback when this fails. You may specify this option multiple
132 times and the first one that works will be used
133
134 --no-preload
135 cancel any preloads listed until now
136
137 This can be used to negate preloads specified in .yath.rc or
138 similar
139
140 --pet SECONDS
141 --post-exit-timeout #
142 Stop waiting post-exit after the timeout period
143
144 (Default: 15 seconds)
145
146 Some tests fork and allow the parent to exit before writing all
147 their output. If Test2::Harness detects an incomplete plan after
148 the test exists it will monitor for more events until the timeout
149 period. Add the "# HARNESS-NO-TIMEOUT" comment to the top of a test
150 file to disable timeouts on a per-test basis.
151
152 Job Options
153 --blib
154 --no-blib
155 (Default: on) Include 'blib/lib' and 'blib/arch'
156
157 Do not include 'blib/lib' and 'blib/arch'
158
159 --input-file file
160 Use the specified file as standard input to ALL tests
161
162 --lib
163 --no-lib
164 (Default: on) Include 'lib' in your module path
165
166 Do not include 'lib'
167
168 --tlib
169 (Default: off) Include 't/lib' in your module path
170
171 -E VAR=value
172 --env-var VAR=val
173 Set an environment variable for each test
174
175 (but not the harness)
176
177 -i "string"
178 This input string will be used as standard input for ALL tests
179
180 See also --input-file
181
182 -I path/lib
183 --include lib/
184 Add a directory to your include paths
185
186 This can be used multiple times
187
188 --cover
189 use Devel::Cover to calculate test coverage
190
191 This is essentially the same as combining: '--no-fork', and
192 '-MDevel::Cover=-silent,1,+ignore,^t/,+ignore,^t2/,+ignore,^xt,+ignore,^test.pl'
193 Devel::Cover and preload/fork do not work well together.
194
195 --fork
196 --no-fork
197 (Default: on) fork to start tests
198
199 Do not fork to start tests
200
201 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
208 --stream
209 --no-stream
210 --TAP
211 --tap
212 Use 'stream' instead of TAP (Default: use stream)
213
214 Do not use stream
215
216 Use TAP
217
218 The TAP format is lossy and clunky. Test2::Harness normally uses a
219 newer streaming format to receive test results. There are
220 old/legacy tests where this causes problems, in which case setting
221 --TAP or --no-stream can help.
222
223 --unsafe-inc
224 --no-unsafe-inc
225 (Default: On) put '.' in @INC
226
227 Do not put '.' in @INC
228
229 perl is removing '.' from @INC as a security concern. This option
230 keeps things from breaking for now.
231
232 -A
233 --author-testing
234 --no-author-testing
235 This will set the AUTHOR_TESTING environment to true
236
237 Many cpan modules have tests that are only run if the
238 AUTHOR_TESTING environment variable is set. This will cause those
239 tests to run.
240
241 -k
242 --keep-dir
243 Do not delete the work directory when done
244
245 This is useful if you want to inspect the work directory after the
246 harness is done. The work directory path will be printed at the
247 end.
248
249 -S SW
250 -S SW=val
251 --switch SW=val
252 Pass the specified switch to perl for each test
253
254 This is not compatible with preload.
255
256 Plugins
257 -pPlugin
258 -pPlugin=arg1,arg2,...
259 -p+My::Plugin
260 --plugin Plugin
261 Load a plugin
262
263 can be specified multiple times
264
265 --no-plugins
266 cancel any plugins listed until now
267
268 This can be used to negate plugins specified in .yath.rc or similar
269
271 The source code repository for Test2-Harness can be found at
272 http://github.com/Test-More/Test2-Harness/.
273
275 Chad Granum <exodist@cpan.org>
276
278 Chad Granum <exodist@cpan.org>
279
281 Copyright 2019 Chad Granum <exodist7@gmail.com>.
282
283 This program is free software; you can redistribute it and/or modify it
284 under the same terms as Perl itself.
285
286 See http://dev.perl.org/licenses/
287
288
289
290perl v5.30.1 2020-01-30 App::Yath::Command::start(3)