App::Yath::Command::start - Start the persistent test runner
This command is used to start a persistant instance of yath. A persistant instance is useful because it allows you to preload modules in advance, reducing start time for any tests you decide to run as you work.
A running instance will watch for changes to any preloaded files, and restart itself if anything changes. Changed files are blacklisted for subsequent reloads so that reloading is not a frequent occurence when editing the same file over and over again.
$ yath [YATH OPTIONS] start [COMMAND OPTIONS]
Add paths to @INC before loading ANYTHING. This is what you use if you are developing yath or yath plugins to make sure the yath script finds the local code instead of the installed versions of the same code. You can provide an argument (-Dfoo) to provide a custom path, or you can just use -D without and arg to add lib, blib/lib and blib/arch.
Can be specified multiple times
Where to find persistence files.
Where to find the persistence file. The default is /{system-tempdir}/project-yath-persist.json. If no project is specified then it will fall back to the current directory. If the current directory is not writable it will default to /tmp/yath-persist.json which limits you to one persistent runner on your system.
This lets you provide a label for your current project/codebase. This is best used in a .yath.rc file. This is necessary for a persistent runner.
Exit after showing what yath thinks your options mean
Exit after showing a helpful usage message
Normally yath scans for and loads all App::Yath::Plugin::* modules in order to bring in command-line options they may provide. This flag will disable that. This is useful if you have a naughty plugin that it loading other modules when it should not.
Load a yath plugin.
Find files changed by all commits in the current branch from most recent stopping when a commit is found that is also present in the history of the branch/commit specified as the change base.
Dummy run, do not actually execute anything
Can also be set with the following environment variables: T2_HARNESS_DUMMY
T2_HARNESS_DUMMY
exit after showing help information
Do not delete directories when done. This is useful if you want to inspect the directories used for various commands.
Be very quiet.
Attempt to reload modified modules in-place, restarting entire stages only when necessary.
(Default: include if it exists) Include 'blib/lib' and 'blib/arch' in your module path
Use Devel::Cover to calculate test coverage. This disables forking. If no args are specified the following are used: -silent,1,+ignore,^t/,+ignore,^t2/,+ignore,^xt,+ignore,^test.pl
Start the runner as a daemon (Default: True)
When using staged preload, dump the depmap for each stage as json files
Kill test if no output is received within timeout period. (Default: 60 seconds). Add the "# HARNESS-NO-TIMEOUT" comment to the top of a test file to disable timeouts on a per-test basis. This prevents a hung test from running forever.
Add a directory to your include paths
Set the number of concurrent jobs to run (Default: 1)
Can also be set with the following environment variables: YATH_JOB_COUNT, T2_HARNESS_JOB_COUNT, HARNESS_JOB_COUNT
YATH_JOB_COUNT
T2_HARNESS_JOB_COUNT
HARNESS_JOB_COUNT
(Default: include if it exists) Include 'lib' in your module path
Use Devel::NYTProf on tests. This will set addpid=1 for you. This works with or without fork.
Stop waiting post-exit after the timeout period. (Default: 15 seconds) Some tests fork and allow the parent to exit before writing all their output. If Test2::Harness detects an incomplete plan after the test exits it will monitor for more events until the timeout period. Add the "# HARNESS-NO-TIMEOUT" comment to the top of a test file to disable timeouts on a per-test basis.
Only do preload if at least N tests are going to be run. In some cases a full preload takes longer than simply running the tests, this lets you specify a minimum number of test jobs that will be run for preload to happen. This has no effect for a persistent runner. The default is 0, and it means always preload.
Preload a module before running tests
Use a resource module to assign resource assignments to individual tests
Pass the specified switch to perl for each test. This is not compatible with preload.
(Default: off) Include 't/lib' in your module path
perl is removing '.' from @INC as a security concern. This option keeps things from breaking for now.
Can also be set with the following environment variables: PERL_USE_UNSAFE_INC
PERL_USE_UNSAFE_INC
(default: on, except on windows) Normally tests are run by forking, which allows for features like preloading. This will turn off the behavior globally (which is not compatible with preloading). This is slower, it is better to tag misbehaving tests with the '# HARNESS-NO-PRELOAD' comment in their header to disable forking only for those tests.
Can also be set with the following environment variables: !T2_NO_FORK, T2_HARNESS_FORK, !T2_HARNESS_NO_FORK, YATH_FORK, !YATH_NO_FORK
!T2_NO_FORK
T2_HARNESS_FORK
!T2_HARNESS_NO_FORK
YATH_FORK
!YATH_NO_FORK
(default: on) Enable/disable timeouts
Clear the work directory if it is not already empty
Use a specific temp directory (Default: use system temp dir)
Can also be set with the following environment variables: T2_HARNESS_TEMP_DIR, YATH_TEMP_DIR, TMPDIR, TEMPDIR, TMP_DIR, TEMP_DIR
T2_HARNESS_TEMP_DIR
YATH_TEMP_DIR
TMPDIR
TEMPDIR
TMP_DIR
TEMP_DIR
Set the work directory (Default: new temp directory)
Can also be set with the following environment variables: T2_WORKDIR, YATH_WORKDIR
T2_WORKDIR
YATH_WORKDIR
Yath-UI API key. This is not necessary if your Yath-UI instance is set to single-user
Add the YathUI DB renderer in addition to other renderers
If yath cannot connect to yath-ui it normally throws an error, use this to make it fail gracefully. You get a warning, but things keep going.
Minimum duration length (seconds) before a test goes from MEDIUM to LONG
Minimum duration length (seconds) before a test goes from SHORT to MEDIUM
Set the upload mode (default 'qvfd')
Only use the YathUI renderer
Only use the YathUI DB renderer
Port to use when running a local server
Use a command to get a port number. "$$" will be replaced with the PID of the yath process
The Yath-UI project for your test results
Add the YathUI renderer in addition to other renderers
How many times to try an operation before giving up
What type of DB/schema to use when using a temporary database
Yath-UI url
Username to attach to the data sent to the db
Type of buffering to use, if "none" then events are written to the db one at a time, which is SLOW
Module that implements 'MODULE->yath_ui_config(%params)' which should return a Test2::Harness::UI::Config instance.
DBI Driver to use
DSN to use when connecting to the db
When buffering DB writes, force a flush when an event is recieved at least N seconds after the last flush.
hostname to use when connecting to the db
Name of the database to use for yathui
Password to use when connecting to the db
port to use when connecting to the db
socket to use when connecting to the db
Username to use when connecting to the db
The source code repository for Test2-Harness can be found at http://github.com/Test-More/Test2-Harness/.
Copyright 2021 Chad Granum <exodist7@gmail.com>.
This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.
See http://dev.perl.org/licenses/
To install Test2::Harness, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Test2::Harness
CPAN shell
perl -MCPAN -e shell install Test2::Harness
For more information on module installation, please visit the detailed CPAN module installation guide.