1App::Yath::Command::colUlseecrtoCro(n3t)ributed Perl DocAupmpe:n:tYaattiho:n:Command::collector(3)
2
6 App::Yath::Command::collector - For internal use only
7
9 No Description
10
12 $ yath [YATH OPTIONS] collector [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 it 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 YathUI Options
219 --yathui-api-key ARG
221 --yathui-api-key=ARG
222 --no-yathui-api-key
223 Yath-UI API key. This is not necessary if your Yath-UI instance is
224 set to single-user
225 --yathui-db
227 --no-yathui-db
228 Add the YathUI DB renderer in addition to other renderers
229 --yathui-grace
231 --no-yathui-grace
232 If yath cannot connect to yath-ui it normally throws an error, use
233 this to make it fail gracefully. You get a warning, but things keep
234 going.
235 --yathui-long-duration 10
237 --no-yathui-long-duration
238 Minimum duration length (seconds) before a test goes from MEDIUM to
239 LONG
240 --yathui-medium-duration 5
242 --no-yathui-medium-duration
243 Minimum duration length (seconds) before a test goes from SHORT to
244 MEDIUM
245 --yathui-mode summary
247 --yathui-mode qvf
248 --yathui-mode qvfd
249 --yathui-mode complete
250 --no-yathui-mode
251 Set the upload mode (default 'qvfd')
252 --yathui-only
254 --no-yathui-only
255 Only use the YathUI renderer
256 --yathui-only-db
258 --no-yathui-only-db
259 Only use the YathUI DB renderer
260 --yathui-port 8080
262 --no-yathui-port
263 Port to use when running a local server
264 --yathui-port-command get_port.sh
266 --yathui-port-command get_port.sh --pid $$
267 --no-yathui-port-command
268 Use a command to get a port number. "$$" will be replaced with the
269 PID of the yath process
270 --yathui-project ARG
272 --yathui-project=ARG
273 --no-yathui-project
274 The Yath-UI project for your test results
275 --yathui-render
277 --no-yathui-render
278 Add the YathUI renderer in addition to other renderers
279 --yathui-retry
281 --no-yathui-retry
282 How many times to try an operation before giving up
283 Can be specified multiple times
285 --yathui-schema PostgreSQL
287 --yathui-schema MySQL
288 --yathui-schema MySQL56
289 --no-yathui-schema
290 What type of DB/schema to use when using a temporary database
291 --yathui-url http://my-yath-ui.com/...
293 --uri http://my-yath-ui.com/...
294 --no-yathui-url
295 Yath-UI url
296 --yathui-user ARG
298 --yathui-user=ARG
299 --no-yathui-user
300 Username to attach to the data sent to the db
301 --yathui-db-buffering none
303 --yathui-db-buffering job
304 --yathui-db-buffering diag
305 --yathui-db-buffering run
306 --no-yathui-db-buffering
307 Type of buffering to use, if "none" then events are written to the
308 db one at a time, which is SLOW
309 --yathui-db-config ARG
311 --yathui-db-config=ARG
312 --no-yathui-db-config
313 Module that implements 'MODULE->yath_ui_config(%params)' which
314 should return a Test2::Harness::UI::Config instance.
315 --yathui-db-coverage
317 --no-yathui-db-coverage
318 Pull coverage data directly from the database (default: off)
319 --yathui-db-driver Pg
321 --yathui-db-drivermysql
322 --yathui-db-driverMariaDB
323 --no-yathui-db-driver
324 DBI Driver to use
325 --yathui-db-dsn ARG
327 --yathui-db-dsn=ARG
328 --no-yathui-db-dsn
329 DSN to use when connecting to the db
330 --yathui-db-durations
332 --no-yathui-db-durations
333 Pull duration data directly from the database (default: off)
334 --yathui-db-flush-interval 2
336 --yathui-db-flush-interval 1.5
337 --no-yathui-db-flush-interval
338 When buffering DB writes, force a flush when an event is recieved
339 at least N seconds after the last flush.
340 --yathui-db-host ARG
342 --yathui-db-host=ARG
343 --no-yathui-db-host
344 hostname to use when connecting to the db
345 --yathui-db-name ARG
347 --yathui-db-name=ARG
348 --no-yathui-db-name
349 Name of the database to use for yathui
350 --yathui-db-pass ARG
352 --yathui-db-pass=ARG
353 --no-yathui-db-pass
354 Password to use when connecting to the db
355 --yathui-db-port ARG
357 --yathui-db-port=ARG
358 --no-yathui-db-port
359 port to use when connecting to the db
360 --yathui-db-publisher ARG
362 --yathui-db-publisher=ARG
363 --no-yathui-db-publisher
364 When using coverage or duration data, only use data uploaded by
365 this user
366 --yathui-db-socket ARG
368 --yathui-db-socket=ARG
369 --no-yathui-db-socket
370 socket to use when connecting to the db
371 --yathui-db-user ARG
373 --yathui-db-user=ARG
374 --no-yathui-db-user
375 Username to use when connecting to the db
376
378 The source code repository for Test2-Harness can be found at
379 http://github.com/Test-More/Test2-Harness/.
380
382 Chad Granum <exodist@cpan.org>
383
385 Chad Granum <exodist@cpan.org>
386
388 Copyright 2021 Chad Granum <exodist7@gmail.com>.
389 This program is free software; you can redistribute it and/or modify it
391 under the same terms as Perl itself.
392 See http://dev.perl.org/licenses/
394perl v5.34.0 2021-11-05 App::Yath::Command::collector(3)