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