1App::Yath::Command::iniUts(e3r)Contributed Perl DocumentAaptpi:o:nYath::Command::init(3)
2
6 App::Yath::Command::init - Create/update test.pl to run tests via
7 Test2::Harness
8
10 This command will create or update the 'test.pl' file in the current
11 directory. This 'test.pl' file this creates will run all your tests
12 via yath.
13 This command will fail if there is already a test.pl file that does not
15 look like it was generated by this command.
16
18 $ yath [YATH OPTIONS] init [COMMAND OPTIONS]
19 YATH OPTIONS
21 Developer
22 --dev-lib
24 --dev-lib=lib
25 -D
26 -D=lib
27 -Dlib
28 --no-dev-lib
29 Add paths to @INC before loading ANYTHING. This is what you use if
30 you are developing yath or yath plugins to make sure the yath
31 script finds the local code instead of the installed versions of
32 the same code. You can provide an argument (-Dfoo) to provide a
33 custom path, or you can just use -D without and arg to add lib,
34 blib/lib and blib/arch.
35 Can be specified multiple times
37 Environment
39 --persist-dir ARG
41 --persist-dir=ARG
42 --no-persist-dir
43 Where to find persistence files.
44 --persist-file ARG
46 --persist-file=ARG
47 --pfile ARG
48 --pfile=ARG
49 --no-persist-file
50 Where to find the persistence file. The default is
51 /{system-tempdir}/project-yath-persist.json. If no project is
52 specified then it will fall back to the current directory. If the
53 current directory is not writable it will default to
54 /tmp/yath-persist.json which limits you to one persistent runner on
55 your system.
56 --project ARG
58 --project=ARG
59 --project-name ARG
60 --project-name=ARG
61 --no-project
62 This lets you provide a label for your current project/codebase.
63 This is best used in a .yath.rc file. This is necessary for a
64 persistent runner.
65 Help and Debugging
67 --show-opts
69 --no-show-opts
70 Exit after showing what yath thinks your options mean
71 --version
73 -V
74 --no-version
75 Exit after showing a helpful usage message
76 Plugins
78 --no-scan-plugins
80 --no-no-scan-plugins
81 Normally yath scans for and loads all App::Yath::Plugin::* modules
82 in order to bring in command-line options they may provide. This
83 flag will disable that. This is useful if you have a naughty plugin
84 that it loading other modules when it should not.
85 --plugins PLUGIN
87 --plugins +App::Yath::Plugin::PLUGIN
88 --plugins PLUGIN=arg1,arg2,...
89 --plugin PLUGIN
90 --plugin +App::Yath::Plugin::PLUGIN
91 --plugin PLUGIN=arg1,arg2,...
92 -pPLUGIN
93 --no-plugins
94 Load a yath plugin.
95 Can be specified multiple times
97 COMMAND OPTIONS
99 Cover Options
100 --cover-aggregator ByTest
102 --cover-aggregator ByRun
103 --cover-aggregator +Custom::Aggregator
104 --cover-agg ByTest
105 --cover-agg ByRun
106 --cover-agg +Custom::Aggregator
107 --no-cover-aggregator
108 Choose a custom aggregator subclass
109 --cover-class ARG
111 --cover-class=ARG
112 --no-cover-class
113 Choose a Test2::Plugin::Cover subclass
114 --cover-dirs ARG
116 --cover-dirs=ARG
117 --cover-dir ARG
118 --cover-dir=ARG
119 --no-cover-dirs
120 NO DESCRIPTION - FIX ME
121 Can be specified multiple times
123 --cover-exclude-private
125 --no-cover-exclude-private
126 --cover-files
127 --no-cover-files
128 Use Test2::Plugin::Cover to collect coverage data for what files
129 are touched by what tests. Unlike Devel::Cover this has very little
130 performance impact (About 4% difference)
131 --cover-from path/to/log.jsonl
133 --cover-from http://example.com/coverage
134 --cover-from path/to/coverage.jsonl
135 --no-cover-from
136 This can be a test log, a coverage dump (old style json or new
137 jsonl format), or a url to any of the previous. Tests will not be
138 run if the file/url is invalid.
139 --cover-from-type json
141 --cover-from-type jsonl
142 --cover-from-type log
143 --no-cover-from-type
144 File type for coverage source. Usually it can be detected, but when
145 it cannot be you should specify. "json" is old style single-blob
146 coverage data, "jsonl" is the new by-test style, "log" is a logfile
147 from a previous run.
148 --cover-manager My::Coverage::Manager
150 --no-cover-manager
151 Coverage 'from' manager to use when coverage data does not provide
152 one
153 --cover-maybe-from path/to/log.jsonl
155 --cover-maybe-from http://example.com/coverage
156 --cover-maybe-from path/to/coverage.jsonl
157 --no-cover-maybe-from
158 This can be a test log, a coverage dump (old style json or new
159 jsonl format), or a url to any of the previous. Tests will coninue
160 if even if the coverage file/url is invalid.
161 --cover-maybe-from-type json
163 --cover-maybe-from-type jsonl
164 --cover-maybe-from-type log
165 --no-cover-maybe-from-type
166 Same as "from_type" but for "maybe_from". Defaults to "from_type"
167 if that is specified, otherwise auto-detect
168 --cover-metrics
170 --no-cover-metrics
171 --cover-types ARG
172 --cover-types=ARG
173 --cover-type ARG
174 --cover-type=ARG
175 --no-cover-types
176 NO DESCRIPTION - FIX ME
177 Can be specified multiple times
179 --cover-write
181 --cover-write=coverage.jsonl
182 --cover-write=coverage.json
183 --no-cover-write
184 Create a json or jsonl file of all coverage data seen during the
185 run (This implies --cover-files).
186 Git Options
188 --git-change-base master
190 --git-change-base HEAD^
191 --git-change-base df22abe4
192 --no-git-change-base
193 Find files changed by all commits in the current branch from most
194 recent stopping when a commit is found that is also present in the
195 history of the branch/commit specified as the change base.
196 Help and Debugging
198 --dummy
200 -d
201 --no-dummy
202 Dummy run, do not actually execute anything
203 Can also be set with the following environment variables:
205 "T2_HARNESS_DUMMY"
206 --help
208 -h
209 --no-help
210 exit after showing help information
211 --interactive
213 -i
214 --no-interactive
215 Use interactive mode, 1 test at a time, stdin forwarded to it
216 --keep-dirs
218 --keep_dir
219 -k
220 --no-keep-dirs
221 Do not delete directories when done. This is useful if you want to
222 inspect the directories used for various commands.
223 YathUI Options
225 --yathui-api-key ARG
227 --yathui-api-key=ARG
228 --no-yathui-api-key
229 Yath-UI API key. This is not necessary if your Yath-UI instance is
230 set to single-user
231 --yathui-db
233 --no-yathui-db
234 Add the YathUI DB renderer in addition to other renderers
235 --yathui-grace
237 --no-yathui-grace
238 If yath cannot connect to yath-ui it normally throws an error, use
239 this to make it fail gracefully. You get a warning, but things keep
240 going.
241 --yathui-long-duration 10
243 --no-yathui-long-duration
244 Minimum duration length (seconds) before a test goes from MEDIUM to
245 LONG
246 --yathui-medium-duration 5
248 --no-yathui-medium-duration
249 Minimum duration length (seconds) before a test goes from SHORT to
250 MEDIUM
251 --yathui-mode summary
253 --yathui-mode qvf
254 --yathui-mode qvfd
255 --yathui-mode complete
256 --no-yathui-mode
257 Set the upload mode (default 'qvfd')
258 --yathui-only
260 --no-yathui-only
261 Only use the YathUI renderer
262 --yathui-only-db
264 --no-yathui-only-db
265 Only use the YathUI DB renderer
266 --yathui-port 8080
268 --no-yathui-port
269 Port to use when running a local server
270 --yathui-port-command get_port.sh
272 --yathui-port-command get_port.sh --pid $$
273 --no-yathui-port-command
274 Use a command to get a port number. "$$" will be replaced with the
275 PID of the yath process
276 --yathui-project ARG
278 --yathui-project=ARG
279 --no-yathui-project
280 The Yath-UI project for your test results
281 --yathui-render
283 --no-yathui-render
284 Add the YathUI renderer in addition to other renderers
285 --yathui-retry
287 --no-yathui-retry
288 How many times to try an operation before giving up
289 Can be specified multiple times
291 --yathui-schema PostgreSQL
293 --yathui-schema MySQL
294 --yathui-schema MySQL56
295 --no-yathui-schema
296 What type of DB/schema to use when using a temporary database
297 --yathui-url http://my-yath-ui.com/...
299 --uri http://my-yath-ui.com/...
300 --no-yathui-url
301 Yath-UI url
302 --yathui-user ARG
304 --yathui-user=ARG
305 --no-yathui-user
306 Username to attach to the data sent to the db
307 --yathui-db-buffering none
309 --yathui-db-buffering job
310 --yathui-db-buffering diag
311 --yathui-db-buffering run
312 --no-yathui-db-buffering
313 Type of buffering to use, if "none" then events are written to the
314 db one at a time, which is SLOW
315 --yathui-db-config ARG
317 --yathui-db-config=ARG
318 --no-yathui-db-config
319 Module that implements 'MODULE->yath_ui_config(%params)' which
320 should return a Test2::Harness::UI::Config instance.
321 --yathui-db-coverage
323 --no-yathui-db-coverage
324 Pull coverage data directly from the database (default: off)
325 --yathui-db-driver Pg
327 --yathui-db-drivermysql
328 --yathui-db-driverMariaDB
329 --no-yathui-db-driver
330 DBI Driver to use
331 --yathui-db-dsn ARG
333 --yathui-db-dsn=ARG
334 --no-yathui-db-dsn
335 DSN to use when connecting to the db
336 --yathui-db-durations
338 --no-yathui-db-durations
339 Pull duration data directly from the database (default: off)
340 --yathui-db-flush-interval 2
342 --yathui-db-flush-interval 1.5
343 --no-yathui-db-flush-interval
344 When buffering DB writes, force a flush when an event is recieved
345 at least N seconds after the last flush.
346 --yathui-db-host ARG
348 --yathui-db-host=ARG
349 --no-yathui-db-host
350 hostname to use when connecting to the db
351 --yathui-db-name ARG
353 --yathui-db-name=ARG
354 --no-yathui-db-name
355 Name of the database to use for yathui
356 --yathui-db-pass ARG
358 --yathui-db-pass=ARG
359 --no-yathui-db-pass
360 Password to use when connecting to the db
361 --yathui-db-port ARG
363 --yathui-db-port=ARG
364 --no-yathui-db-port
365 port to use when connecting to the db
366 --yathui-db-publisher ARG
368 --yathui-db-publisher=ARG
369 --no-yathui-db-publisher
370 When using coverage or duration data, only use data uploaded by
371 this user
372 --yathui-db-socket ARG
374 --yathui-db-socket=ARG
375 --no-yathui-db-socket
376 socket to use when connecting to the db
377 --yathui-db-user ARG
379 --yathui-db-user=ARG
380 --no-yathui-db-user
381 Username to use when connecting to the db
382
384 The source code repository for Test2-Harness can be found at
385 http://github.com/Test-More/Test2-Harness/.
386
388 Chad Granum <exodist@cpan.org>
389
391 Chad Granum <exodist@cpan.org>
392
394 Copyright 2021 Chad Granum <exodist7@gmail.com>.
395 This program is free software; you can redistribute it and/or modify it
397 under the same terms as Perl itself.
398 See http://dev.perl.org/licenses/
400perl v5.34.0 2021-11-05 App::Yath::Command::init(3)