App::Yath::Command::stop - Stop the persistent test runner
This command will stop a persistent instance, and output any log contents.
$ yath [YATH OPTIONS] stop [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.
Specify what Finder subclass to use when searching for files/processing the file list. Use the "+" prefix to specify a fully qualified namespace, otherwise Test2::Harness::Finder::XXX namespace is assumed.
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.
Turn color on, default is true if STDOUT is a TTY.
Do not do fancy text-wrapping, let the terminal handle it
Toggle progress indicators. On by default if STDOUT is a TTY. You can use --no-progress to disable the 'events seen' counter and buffered event pre-display
Be very quiet.
Specify renderers, (Default: "Formatter=Test2"). Use "+" to give a fully qualified module name. Without "+" "Test2::Harness::Renderer::" will be prepended to your argument.
Can be specified multiple times. If the same key is listed multiple times the value lists will be appended together.
Show the timing data for each job
Alternative to setting $TABLE_TERM_SIZE. Setting this will override the terminal width detection to the number of characters specified.
Be more verbose
Specify one or more files as having been changed.
Only search for tests for changed files (Requires --coverage-from, also requires a list of changes either from the --changed option, or a plugin that implements changed_files())
What plugin should be used to detect changed files.
Where to fetch coverage data. Can be a path to a .jsonl(.bz|.gz)? log file. Can be a path or url to a json file containing a hash where source files are key, and value is a list of tests to run.
Specify the default file/dir search when 'AUTHOR_TESTING' is set. Defaults to './xt'. The default AT search is only used if no files were specified at the command line
Specify the default file/dir search. defaults to './t', './t2', and 'test.pl'. The default search is only used if no files were specified at the command line
Point at a json file or url which has a hash of relative test filenames as keys, and 'SHORT', 'MEDIUM', or 'LONG' as values. This will override durations listed in the file headers. An exception will be thrown if the durations file or url does not work.
Exclude a file from testing
Point at a file or url which has a new line separated list of test file names to exclude from testing. Starting a line with a '#' will comment it out (for compatibility with Test2::Aggregate list files).
Exclude a pattern from testing, matched using m/$PATTERN/
Specify valid test filename extensions, default: t and t2
Do not run tests that have their duration flag set to 'LONG'
Only run tests that have their duration flag set to 'LONG'
List of tests and test directories to use instead of the default search paths. Typically these can simply be listed as command line arguments without the --search prefix.
Print a list of changed files if any are found
NO DESCRIPTION - FIX ME
[Q]uiet, but [V]erbose on [F]ailure. Hide all output from tests when they pass, except to say they passed. If a test fails then ALL output from the test is verbosely output.
Show output when a job ends. (Default: on)
Show the job configuration when a job starts. (Default: off, unless -vv)
Show output for the start of a job. (Default: off unless -v)
Show the run configuration when a run starts. (Default: off, unless -vv)
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.
Write out a summary json file, if no path is provided 'summary.json' will be used. The .json extension is added automatically if omitted.
Use bzip2 compression when writing the log. This option implies -L. The .bz2 prefix is added to log file name for you
Use gzip compression when writing the log. This option implies -L. The .gz prefix is added to log file name for you
Turn on logging
Specify a log directory. Will fall back to the system temp dir.
Specify the name of the log file. This option implies -L.
Specify the format for automatically-generated log files. Overridden by --log-file, if given. This option implies -L (Default: \$YATH_LOG_FILE_FORMAT, if that is set, or else "%!P%Y-%m-%d~%H:%M:%S~%!U~%!p.jsonl"). This is a string in which percent-escape sequences will be replaced as per POSIX::strftime. The following special escape sequences are also replaced: (%!P : Project name followed by a ~, if a project is defined, otherwise empty string) (%!U : the unique test run ID) (%!p : the process ID) (%!S : the number of seconds since local midnight UTC)
Can also be set with the following environment variables: YATH_LOG_FILE_FORMAT, TEST2_HARNESS_LOG_FORMAT
YATH_LOG_FILE_FORMAT
TEST2_HARNESS_LOG_FORMAT
Create a json file of all coverage data seen during the run (This implies --cover-files).
Email the test results to the specified email address(es)
Email failing results to the specified email address(es)
If any email is sent, this is who it will be from
Email the owner of broken tests files upon failure. Add `# HARNESS-META-OWNER foo@example.com` to the top of a test file to give it an owner
Usually owner failures are sent as a single batch at the end of testing. Toggle this to send failures as they happen.
Send results to a slack channel and/or user
Send failing results to a slack channel and/or user
Send slack notifications to the slack channels/users listed in test meta-data when tests fail.
Specify an API endpoint for slack webhook integrations
Add a custom text snippet to email/slack notifications
This will set the AUTHOR_TESTING environment to true
Use Test2::Plugin::Cover to collect coverage data for what files are touched by what tests. Unlike Devel::Cover this has very little performance impact (About 4% difference)
Use Test2::Plugin::DBIProfile to collect database profiling data
Set environment variables to set when each test is run.
Use Test2::Plugin::UUID inside tests (default: on)
Add custom data to the harness run
Input string to be used as standard input for ALL tests. See also: --input-file
Use the specified file as standard input to ALL tests
Use Test2::Plugin::IOEvents inside tests to turn all prints into test2 events (default: off)
Provide one or more links people can follow to see more about this run.
Load a module in each test (after fork). The "import" method is not called.
Load a module in each test (after fork). Import is called.
Use Test2::Plugin::MemUsage inside tests (default: on)
Run any jobs that failed a second time. NOTE: --retry=1 means failing tests will be attempted twice!
If true then any job retries will be done in isolation (as though -j1 was set)
Set a specific run-id. (Default: a UUID)
Arguments to pass in as @ARGV for all tests that are run. These can be provided easier using the '::' argument separator.
Use the stream formatter (default is on)
The TAP format is lossy and clunky. Test2::Harness normally uses a newer streaming format to receive test results. There are old/legacy tests where this causes problems, in which case setting --TAP or --no-stream can help.
Yath-UI API key. This is not necessary if your Yath-UI instance is set to single-user
Poll coverage data from Yath-UI to determine what tests should be run for changed files
Add the YathUI DB renderer in addition to other renderers
Poll duration data from Yath-UI to help order tests efficiently
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
Upload the log to Yath-UI
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.