App::Yath::Command::spawn(3pm)

1App::Yath::Command::spaUwsne(r3)Contributed Perl DocumenAtpapt:i:oYnath::Command::spawn(3)
2
3
4

NAME

6       App::Yath::Command::spawn - Launch a perl script from the preloaded
7       environment
8

DESCRIPTION

10       This will launch the specified script from the preloaded yath process.
11
12       NOTE: environment variables are not automatically passed to the spawned
13       process. You must use -e or -E (see help) to specify what environment
14       variables you care about.
15

USAGE

17           $ yath [YATH OPTIONS] spawn [COMMAND OPTIONS]
18
19   YATH OPTIONS
20       Developer
21
22       --dev-lib
23       --dev-lib=lib
24       -D
25       -D=lib
26       -Dlib
27       --no-dev-lib
28           Add paths to @INC before loading ANYTHING. This is what you use if
29           you are developing yath or yath plugins to make sure the yath
30           script finds the local code instead of the installed versions of
31           the same code. You can provide an argument (-Dfoo) to provide a
32           custom path, or you can just use -D without and arg to add lib,
33           blib/lib and blib/arch.
34
35           Can be specified multiple times
36
37       Environment
38
39       --persist-dir ARG
40       --persist-dir=ARG
41       --no-persist-dir
42           Where to find persistence files.
43
44       --persist-file ARG
45       --persist-file=ARG
46       --pfile ARG
47       --pfile=ARG
48       --no-persist-file
49           Where to find the persistence file. The default is
50           /{system-tempdir}/project-yath-persist.json. If no project is
51           specified then it will fall back to the current directory. If the
52           current directory is not writable it will default to
53           /tmp/yath-persist.json which limits you to one persistent runner on
54           your system.
55
56       --project ARG
57       --project=ARG
58       --project-name ARG
59       --project-name=ARG
60       --no-project
61           This lets you provide a label for your current project/codebase.
62           This is best used in a .yath.rc file. This is necessary for a
63           persistent runner.
64
65       Help and Debugging
66
67       --show-opts
68       --no-show-opts
69           Exit after showing what yath thinks your options mean
70
71       --version
72       -V
73       --no-version
74           Exit after showing a helpful usage message
75
76       Plugins
77
78       --no-scan-plugins
79       --no-no-scan-plugins
80           Normally yath scans for and loads all App::Yath::Plugin::* modules
81           in order to bring in command-line options they may provide. This
82           flag will disable that. This is useful if you have a naughty plugin
83           that it loading other modules when it should not.
84
85       --plugins PLUGIN
86       --plugins +App::Yath::Plugin::PLUGIN
87       --plugins PLUGIN=arg1,arg2,...
88       --plugin PLUGIN
89       --plugin +App::Yath::Plugin::PLUGIN
90       --plugin PLUGIN=arg1,arg2,...
91       -pPLUGIN
92       --no-plugins
93           Load a yath plugin.
94
95           Can be specified multiple times
96
97   COMMAND OPTIONS
98       Git Options
99
100       --git-change-base master
101       --git-change-base HEAD^
102       --git-change-base df22abe4
103       --no-git-change-base
104           Find files changed by all commits in the current branch from most
105           recent stopping when a commit is found that is also present in the
106           history of the branch/commit specified as the change base.
107
108       Help and Debugging
109
110       --dummy
111       -d
112       --no-dummy
113           Dummy run, do not actually execute anything
114
115           Can also be set with the following environment variables:
116           "T2_HARNESS_DUMMY"
117
118       --help
119       -h
120       --no-help
121           exit after showing help information
122
123       --keep-dirs
124       --keep_dir
125       -k
126       --no-keep-dirs
127           Do not delete directories when done. This is useful if you want to
128           inspect the directories used for various commands.
129
130       YathUI Options
131
132       --yathui-api-key ARG
133       --yathui-api-key=ARG
134       --no-yathui-api-key
135           Yath-UI API key. This is not necessary if your Yath-UI instance is
136           set to single-user
137
138       --yathui-db
139       --no-yathui-db
140           Add the YathUI DB renderer in addition to other renderers
141
142       --yathui-grace
143       --no-yathui-grace
144           If yath cannot connect to yath-ui it normally throws an error, use
145           this to make it fail gracefully. You get a warning, but things keep
146           going.
147
148       --yathui-long-duration 10
149       --no-yathui-long-duration
150           Minimum duration length (seconds) before a test goes from MEDIUM to
151           LONG
152
153       --yathui-medium-duration 5
154       --no-yathui-medium-duration
155           Minimum duration length (seconds) before a test goes from SHORT to
156           MEDIUM
157
158       --yathui-mode summary
159       --yathui-mode qvf
160       --yathui-mode qvfd
161       --yathui-mode complete
162       --no-yathui-mode
163           Set the upload mode (default 'qvfd')
164
165       --yathui-only
166       --no-yathui-only
167           Only use the YathUI renderer
168
169       --yathui-only-db
170       --no-yathui-only-db
171           Only use the YathUI DB renderer
172
173       --yathui-port 8080
174       --no-yathui-port
175           Port to use when running a local server
176
177       --yathui-port-command get_port.sh
178       --yathui-port-command get_port.sh --pid $$
179       --no-yathui-port-command
180           Use a command to get a port number. "$$" will be replaced with the
181           PID of the yath process
182
183       --yathui-project ARG
184       --yathui-project=ARG
185       --no-yathui-project
186           The Yath-UI project for your test results
187
188       --yathui-render
189       --no-yathui-render
190           Add the YathUI renderer in addition to other renderers
191
192       --yathui-retry
193       --no-yathui-retry
194           How many times to try an operation before giving up
195
196           Can be specified multiple times
197
198       --yathui-schema PostgreSQL
199       --yathui-schema MySQL
200       --yathui-schema MySQL56
201       --no-yathui-schema
202           What type of DB/schema to use when using a temporary database
203
204       --yathui-url http://my-yath-ui.com/...
205       --uri http://my-yath-ui.com/...
206       --no-yathui-url
207           Yath-UI url
208
209       --yathui-user ARG
210       --yathui-user=ARG
211       --no-yathui-user
212           Username to attach to the data sent to the db
213
214       --yathui-db-buffering none
215       --yathui-db-buffering job
216       --yathui-db-buffering diag
217       --yathui-db-buffering run
218       --no-yathui-db-buffering
219           Type of buffering to use, if "none" then events are written to the
220           db one at a time, which is SLOW
221
222       --yathui-db-config ARG
223       --yathui-db-config=ARG
224       --no-yathui-db-config
225           Module that implements 'MODULE->yath_ui_config(%params)' which
226           should return a Test2::Harness::UI::Config instance.
227
228       --yathui-db-driver Pg
229       --yathui-db-drivermysql
230       --yathui-db-driverMariaDB
231       --no-yathui-db-driver
232           DBI Driver to use
233
234       --yathui-db-dsn ARG
235       --yathui-db-dsn=ARG
236       --no-yathui-db-dsn
237           DSN to use when connecting to the db
238
239       --yathui-db-flush-interval 2
240       --yathui-db-flush-interval 1.5
241       --no-yathui-db-flush-interval
242           When buffering DB writes, force a flush when an event is recieved
243           at least N seconds after the last flush.
244
245       --yathui-db-host ARG
246       --yathui-db-host=ARG
247       --no-yathui-db-host
248           hostname to use when connecting to the db
249
250       --yathui-db-name ARG
251       --yathui-db-name=ARG
252       --no-yathui-db-name
253           Name of the database to use for yathui
254
255       --yathui-db-pass ARG
256       --yathui-db-pass=ARG
257       --no-yathui-db-pass
258           Password to use when connecting to the db
259
260       --yathui-db-port ARG
261       --yathui-db-port=ARG
262       --no-yathui-db-port
263           port to use when connecting to the db
264
265       --yathui-db-socket ARG
266       --yathui-db-socket=ARG
267       --no-yathui-db-socket
268           socket to use when connecting to the db
269
270       --yathui-db-user ARG
271       --yathui-db-user=ARG
272       --no-yathui-db-user
273           Username to use when connecting to the db
274
275       spawn options
276
277       --copy-env HOME
278       --copy-env SHELL
279       --copy-env /PERL_.*/i
280       -e HOME
281       -e SHELL
282       -e /PERL_.*/i
283       --no-copy-env
284           Specify environment variables to pass along with their current
285           values, can also use a regex
286
287           Can be specified multiple times
288
289       --env-var VAR=VAL
290       -EVAR=VAL
291       -E VAR=VAL
292       --no-env-var
293           Set environment variables for the spawn
294
295           Can be specified multiple times
296
297       --stage foo
298       -s foo
299       --no-stage
300           Specify the stage to be used for launching the script
301

SOURCE

303       The source code repository for Test2-Harness can be found at
304       http://github.com/Test-More/Test2-Harness/.
305

MAINTAINERS

307       Chad Granum <exodist@cpan.org>
308

AUTHORS

310       Chad Granum <exodist@cpan.org>
311

COPYRIGHT

313       Copyright 2021 Chad Granum <exodist7@gmail.com>.
314
315       This program is free software; you can redistribute it and/or modify it
316       under the same terms as Perl itself.
317
318       See http://dev.perl.org/licenses/
319
320
321
322perl v5.32.1                      2021-03-12      App::Yath::Command::spawn(3)