1App::Yath::Command::whiUcshe(r3)Contributed Perl DocumenAtpapt:i:oYnath::Command::which(3)
2
6 App::Yath::Command::which - Locate the persistent test runner
7
9 This will tell you about any persistent runners it can find.
10
12 $ yath [YATH OPTIONS] which [COMMAND OPTIONS]
13 YATH OPTIONS
15 Developer
16 --dev-lib
18 --dev-lib=lib
19 -D
20 -D=lib
21 -Dlib
22 --no-dev-lib
23 Add paths to @INC before loading ANYTHING. This is what you use if
24 you are developing yath or yath plugins to make sure the yath
25 script finds the local code instead of the installed versions of
26 the same code. You can provide an argument (-Dfoo) to provide a
27 custom path, or you can just use -D without and arg to add lib,
28 blib/lib and blib/arch.
29 Can be specified multiple times
31 Environment
33 --persist-dir ARG
35 --persist-dir=ARG
36 --no-persist-dir
37 Where to find persistence files.
38 --persist-file ARG
40 --persist-file=ARG
41 --pfile ARG
42 --pfile=ARG
43 --no-persist-file
44 Where to find the persistence file. The default is
45 /{system-tempdir}/project-yath-persist.json. If no project is
46 specified then it will fall back to the current directory. If the
47 current directory is not writable it will default to
48 /tmp/yath-persist.json which limits you to one persistent runner on
49 your system.
50 --project ARG
52 --project=ARG
53 --project-name ARG
54 --project-name=ARG
55 --no-project
56 This lets you provide a label for your current project/codebase.
57 This is best used in a .yath.rc file. This is necessary for a
58 persistent runner.
59 Help and Debugging
61 --show-opts
63 --no-show-opts
64 Exit after showing what yath thinks your options mean
65 --version
67 -V
68 --no-version
69 Exit after showing a helpful usage message
70 Plugins
72 --no-scan-plugins
74 --no-no-scan-plugins
75 Normally yath scans for and loads all App::Yath::Plugin::* modules
76 in order to bring in command-line options they may provide. This
77 flag will disable that. This is useful if you have a naughty plugin
78 that is loading other modules when it should not.
79 --plugins PLUGIN
81 --plugins +App::Yath::Plugin::PLUGIN
82 --plugins PLUGIN=arg1,arg2,...
83 --plugin PLUGIN
84 --plugin +App::Yath::Plugin::PLUGIN
85 --plugin PLUGIN=arg1,arg2,...
86 -pPLUGIN
87 --no-plugins
88 Load a yath plugin.
89 Can be specified multiple times
91 COMMAND OPTIONS
93 Cover Options
94 --cover-aggregator ByTest
96 --cover-aggregator ByRun
97 --cover-aggregator +Custom::Aggregator
98 --cover-agg ByTest
99 --cover-agg ByRun
100 --cover-agg +Custom::Aggregator
101 --no-cover-aggregator
102 Choose a custom aggregator subclass
103 --cover-class ARG
105 --cover-class=ARG
106 --no-cover-class
107 Choose a Test2::Plugin::Cover subclass
108 --cover-dirs ARG
110 --cover-dirs=ARG
111 --cover-dir ARG
112 --cover-dir=ARG
113 --no-cover-dirs
114 NO DESCRIPTION - FIX ME
115 Can be specified multiple times
117 --cover-exclude-private
119 --no-cover-exclude-private
120 --cover-files
121 --no-cover-files
122 Use Test2::Plugin::Cover to collect coverage data for what files
123 are touched by what tests. Unlike Devel::Cover this has very little
124 performance impact (About 4% difference)
125 --cover-from path/to/log.jsonl
127 --cover-from http://example.com/coverage
128 --cover-from path/to/coverage.jsonl
129 --no-cover-from
130 This can be a test log, a coverage dump (old style json or new
131 jsonl format), or a url to any of the previous. Tests will not be
132 run if the file/url is invalid.
133 --cover-from-type json
135 --cover-from-type jsonl
136 --cover-from-type log
137 --no-cover-from-type
138 File type for coverage source. Usually it can be detected, but when
139 it cannot be you should specify. "json" is old style single-blob
140 coverage data, "jsonl" is the new by-test style, "log" is a logfile
141 from a previous run.
142 --cover-manager My::Coverage::Manager
144 --no-cover-manager
145 Coverage 'from' manager to use when coverage data does not provide
146 one
147 --cover-maybe-from path/to/log.jsonl
149 --cover-maybe-from http://example.com/coverage
150 --cover-maybe-from path/to/coverage.jsonl
151 --no-cover-maybe-from
152 This can be a test log, a coverage dump (old style json or new
153 jsonl format), or a url to any of the previous. Tests will coninue
154 if even if the coverage file/url is invalid.
155 --cover-maybe-from-type json
157 --cover-maybe-from-type jsonl
158 --cover-maybe-from-type log
159 --no-cover-maybe-from-type
160 Same as "from_type" but for "maybe_from". Defaults to "from_type"
161 if that is specified, otherwise auto-detect
162 --cover-metrics
164 --no-cover-metrics
165 --cover-types ARG
166 --cover-types=ARG
167 --cover-type ARG
168 --cover-type=ARG
169 --no-cover-types
170 NO DESCRIPTION - FIX ME
171 Can be specified multiple times
173 --cover-write
175 --cover-write=coverage.jsonl
176 --cover-write=coverage.json
177 --no-cover-write
178 Create a json or jsonl file of all coverage data seen during the
179 run (This implies --cover-files).
180 Git Options
182 --git-change-base master
184 --git-change-base HEAD^
185 --git-change-base df22abe4
186 --no-git-change-base
187 Find files changed by all commits in the current branch from most
188 recent stopping when a commit is found that is also present in the
189 history of the branch/commit specified as the change base.
190 Help and Debugging
192 --dummy
194 -d
195 --no-dummy
196 Dummy run, do not actually execute anything
197 Can also be set with the following environment variables:
199 "T2_HARNESS_DUMMY"
200 --help
202 -h
203 --no-help
204 exit after showing help information
205 --interactive
207 -i
208 --no-interactive
209 Use interactive mode, 1 test at a time, stdin forwarded to it
210 --keep-dirs
212 --keep_dir
213 -k
214 --no-keep-dirs
215 Do not delete directories when done. This is useful if you want to
216 inspect the directories used for various commands.
217 --procname-prefix ARG
219 --procname-prefix=ARG
220 --no-procname-prefix
221 Add a prefix to all proc names (as seen by ps).
222 YathUI Options
224 --yathui-api-key ARG
226 --yathui-api-key=ARG
227 --no-yathui-api-key
228 Yath-UI API key. This is not necessary if your Yath-UI instance is
229 set to single-user
230 --yathui-db
232 --no-yathui-db
233 Add the YathUI DB renderer in addition to other renderers
234 --yathui-grace
236 --no-yathui-grace
237 If yath cannot connect to yath-ui it normally throws an error, use
238 this to make it fail gracefully. You get a warning, but things keep
239 going.
240 --yathui-long-duration 10
242 --no-yathui-long-duration
243 Minimum duration length (seconds) before a test goes from MEDIUM to
244 LONG
245 --yathui-medium-duration 5
247 --no-yathui-medium-duration
248 Minimum duration length (seconds) before a test goes from SHORT to
249 MEDIUM
250 --yathui-mode summary
252 --yathui-mode qvf
253 --yathui-mode qvfd
254 --yathui-mode complete
255 --no-yathui-mode
256 Set the upload mode (default 'qvfd')
257 --yathui-only
259 --no-yathui-only
260 Only use the YathUI renderer
261 --yathui-only-db
263 --no-yathui-only-db
264 Only use the YathUI DB renderer
265 --yathui-port 8080
267 --no-yathui-port
268 Port to use when running a local server
269 --yathui-port-command get_port.sh
271 --yathui-port-command get_port.sh --pid $$
272 --no-yathui-port-command
273 Use a command to get a port number. "$$" will be replaced with the
274 PID of the yath process
275 --yathui-project ARG
277 --yathui-project=ARG
278 --no-yathui-project
279 The Yath-UI project for your test results
280 --yathui-render
282 --no-yathui-render
283 Add the YathUI renderer in addition to other renderers
284 --yathui-resources
286 --yathui-resources=5
287 --no-yathui-resources
288 Send resource info (for supported resources) to yathui at the
289 specified interval in seconds (5 if not specified)
290 --yathui-retry
292 --no-yathui-retry
293 How many times to try an operation before giving up
294 Can be specified multiple times
296 --yathui-schema PostgreSQL
298 --yathui-schema MySQL
299 --yathui-schema MySQL56
300 --no-yathui-schema
301 What type of DB/schema to use when using a temporary database
302 --yathui-url http://my-yath-ui.com/...
304 --uri http://my-yath-ui.com/...
305 --no-yathui-url
306 Yath-UI url
307 --yathui-user ARG
309 --yathui-user=ARG
310 --no-yathui-user
311 Username to attach to the data sent to the db
312 --yathui-db-buffering none
314 --yathui-db-buffering job
315 --yathui-db-buffering diag
316 --yathui-db-buffering run
317 --no-yathui-db-buffering
318 Type of buffering to use, if "none" then events are written to the
319 db one at a time, which is SLOW
320 --yathui-db-config ARG
322 --yathui-db-config=ARG
323 --no-yathui-db-config
324 Module that implements 'MODULE->yath_ui_config(%params)' which
325 should return a Test2::Harness::UI::Config instance.
326 --yathui-db-coverage
328 --no-yathui-db-coverage
329 Pull coverage data directly from the database (default: off)
330 --yathui-db-driver Pg
332 --yathui-db-drivermysql
333 --yathui-db-driverMariaDB
334 --no-yathui-db-driver
335 DBI Driver to use
336 --yathui-db-dsn ARG
338 --yathui-db-dsn=ARG
339 --no-yathui-db-dsn
340 DSN to use when connecting to the db
341 --yathui-db-duration-limit ARG
343 --yathui-db-duration-limit=ARG
344 --no-yathui-db-duration-limit
345 Limit the number of runs to look at for durations data (default:
346 10)
347 --yathui-db-durations
349 --no-yathui-db-durations
350 Pull duration data directly from the database (default: off)
351 --yathui-db-flush-interval 2
353 --yathui-db-flush-interval 1.5
354 --no-yathui-db-flush-interval
355 When buffering DB writes, force a flush when an event is recieved
356 at least N seconds after the last flush.
357 --yathui-db-host ARG
359 --yathui-db-host=ARG
360 --no-yathui-db-host
361 hostname to use when connecting to the db
362 --yathui-db-name ARG
364 --yathui-db-name=ARG
365 --no-yathui-db-name
366 Name of the database to use for yathui
367 --yathui-db-pass ARG
369 --yathui-db-pass=ARG
370 --no-yathui-db-pass
371 Password to use when connecting to the db
372 --yathui-db-port ARG
374 --yathui-db-port=ARG
375 --no-yathui-db-port
376 port to use when connecting to the db
377 --yathui-db-publisher ARG
379 --yathui-db-publisher=ARG
380 --no-yathui-db-publisher
381 When using coverage or duration data, only use data uploaded by
382 this user
383 --yathui-db-socket ARG
385 --yathui-db-socket=ARG
386 --no-yathui-db-socket
387 socket to use when connecting to the db
388 --yathui-db-user ARG
390 --yathui-db-user=ARG
391 --no-yathui-db-user
392 Username to use when connecting to the db
393
395 The source code repository for Test2-Harness can be found at
396 http://github.com/Test-More/Test2-Harness/.
397
399 Chad Granum <exodist@cpan.org>
400
402 Chad Granum <exodist@cpan.org>
403
405 Copyright 2023 Chad Granum <exodist7@gmail.com>.
406 This program is free software; you can redistribute it and/or modify it
408 under the same terms as Perl itself.
409 See http://dev.perl.org/licenses/
411perl v5.36.1 2023-10-04 App::Yath::Command::which(3)