1App::Yath::Command::audUisteorr(C3o)ntributed Perl DocumAepnpt:a:tYiaotnh::Command::auditor(3)
2
3
4
6 App::Yath::Command::auditor - For internal use only
7
9 No Description
10
12 $ yath [YATH OPTIONS] auditor [COMMAND OPTIONS]
13
14 YATH OPTIONS
15 Developer
16
17 --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
30 Can be specified multiple times
31
32 Environment
33
34 --persist-dir ARG
35 --persist-dir=ARG
36 --no-persist-dir
37 Where to find persistence files.
38
39 --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
51 --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
60 Help and Debugging
61
62 --show-opts
63 --no-show-opts
64 Exit after showing what yath thinks your options mean
65
66 --version
67 -V
68 --no-version
69 Exit after showing a helpful usage message
70
71 Plugins
72
73 --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
80 --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
90 Can be specified multiple times
91
92 COMMAND OPTIONS
93 Git Options
94
95 --git-change-base master
96 --git-change-base HEAD^
97 --git-change-base df22abe4
98 --no-git-change-base
99 Find files changed by all commits in the current branch from most
100 recent stopping when a commit is found that is also present in the
101 history of the branch/commit specified as the change base.
102
103 Help and Debugging
104
105 --dummy
106 -d
107 --no-dummy
108 Dummy run, do not actually execute anything
109
110 Can also be set with the following environment variables:
111 "T2_HARNESS_DUMMY"
112
113 --help
114 -h
115 --no-help
116 exit after showing help information
117
118 --keep-dirs
119 --keep_dir
120 -k
121 --no-keep-dirs
122 Do not delete directories when done. This is useful if you want to
123 inspect the directories used for various commands.
124
125 YathUI Options
126
127 --yathui-api-key ARG
128 --yathui-api-key=ARG
129 --no-yathui-api-key
130 Yath-UI API key. This is not necessary if your Yath-UI instance is
131 set to single-user
132
133 --yathui-db
134 --no-yathui-db
135 Add the YathUI DB renderer in addition to other renderers
136
137 --yathui-grace
138 --no-yathui-grace
139 If yath cannot connect to yath-ui it normally throws an error, use
140 this to make it fail gracefully. You get a warning, but things keep
141 going.
142
143 --yathui-long-duration 10
144 --no-yathui-long-duration
145 Minimum duration length (seconds) before a test goes from MEDIUM to
146 LONG
147
148 --yathui-medium-duration 5
149 --no-yathui-medium-duration
150 Minimum duration length (seconds) before a test goes from SHORT to
151 MEDIUM
152
153 --yathui-mode summary
154 --yathui-mode qvf
155 --yathui-mode qvfd
156 --yathui-mode complete
157 --no-yathui-mode
158 Set the upload mode (default 'qvfd')
159
160 --yathui-only
161 --no-yathui-only
162 Only use the YathUI renderer
163
164 --yathui-only-db
165 --no-yathui-only-db
166 Only use the YathUI DB renderer
167
168 --yathui-port 8080
169 --no-yathui-port
170 Port to use when running a local server
171
172 --yathui-port-command get_port.sh
173 --yathui-port-command get_port.sh --pid $$
174 --no-yathui-port-command
175 Use a command to get a port number. "$$" will be replaced with the
176 PID of the yath process
177
178 --yathui-project ARG
179 --yathui-project=ARG
180 --no-yathui-project
181 The Yath-UI project for your test results
182
183 --yathui-render
184 --no-yathui-render
185 Add the YathUI renderer in addition to other renderers
186
187 --yathui-retry
188 --no-yathui-retry
189 How many times to try an operation before giving up
190
191 Can be specified multiple times
192
193 --yathui-schema PostgreSQL
194 --yathui-schema MySQL
195 --yathui-schema MySQL56
196 --no-yathui-schema
197 What type of DB/schema to use when using a temporary database
198
199 --yathui-url http://my-yath-ui.com/...
200 --uri http://my-yath-ui.com/...
201 --no-yathui-url
202 Yath-UI url
203
204 --yathui-user ARG
205 --yathui-user=ARG
206 --no-yathui-user
207 Username to attach to the data sent to the db
208
209 --yathui-db-buffering none
210 --yathui-db-buffering job
211 --yathui-db-buffering diag
212 --yathui-db-buffering run
213 --no-yathui-db-buffering
214 Type of buffering to use, if "none" then events are written to the
215 db one at a time, which is SLOW
216
217 --yathui-db-config ARG
218 --yathui-db-config=ARG
219 --no-yathui-db-config
220 Module that implements 'MODULE->yath_ui_config(%params)' which
221 should return a Test2::Harness::UI::Config instance.
222
223 --yathui-db-driver Pg
224 --yathui-db-drivermysql
225 --yathui-db-driverMariaDB
226 --no-yathui-db-driver
227 DBI Driver to use
228
229 --yathui-db-dsn ARG
230 --yathui-db-dsn=ARG
231 --no-yathui-db-dsn
232 DSN to use when connecting to the db
233
234 --yathui-db-flush-interval 2
235 --yathui-db-flush-interval 1.5
236 --no-yathui-db-flush-interval
237 When buffering DB writes, force a flush when an event is recieved
238 at least N seconds after the last flush.
239
240 --yathui-db-host ARG
241 --yathui-db-host=ARG
242 --no-yathui-db-host
243 hostname to use when connecting to the db
244
245 --yathui-db-name ARG
246 --yathui-db-name=ARG
247 --no-yathui-db-name
248 Name of the database to use for yathui
249
250 --yathui-db-pass ARG
251 --yathui-db-pass=ARG
252 --no-yathui-db-pass
253 Password to use when connecting to the db
254
255 --yathui-db-port ARG
256 --yathui-db-port=ARG
257 --no-yathui-db-port
258 port to use when connecting to the db
259
260 --yathui-db-socket ARG
261 --yathui-db-socket=ARG
262 --no-yathui-db-socket
263 socket to use when connecting to the db
264
265 --yathui-db-user ARG
266 --yathui-db-user=ARG
267 --no-yathui-db-user
268 Username to use when connecting to the db
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 2021 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.32.1 2021-03-12 App::Yath::Command::auditor(3)