NAME

App::Yath::Command::test - Run tests

DESCRIPTION

This yath command (which is also the default command) will run all the test files for the current project. If no test files are specified this command will look for the 't', and 't2' directories, as well as the 'test.pl' file.

This command is always recursive when given directories.

This command will add 'lib', 'blib/arch' and 'blib/lib' to the perl path for you by default (after any -I's). You can specify -l if you just want lib, -b if you just want the blib paths. If you specify both -l and -b both will be added in the order you specify (order relative to any -I options will also be preserved. If you do not specify they will be added in this order: -I's, lib, blib/lib, blib/arch. You can also add --no-lib and --no-blib to avoid both.

Any command line argument that is not an option will be treated as a test file or directory of test files to be run.

If you wish to specify the ARGV for tests you may append them after '::'. This is mainly useful for Test::Class::Moose and similar tools. EVERY test run will get the same ARGV.

USAGE

    $ yath [YATH OPTIONS] test [COMMAND OPTIONS]

YATH OPTIONS

Developer

--dev-lib
--dev-lib=lib
-D
-D=lib
-Dlib
--no-dev-lib

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

Environment

--persist-dir ARG
--persist-dir=ARG
--no-persist-dir

Where to find persistence files.

--persist-file ARG
--persist-file=ARG
--pfile ARG
--pfile=ARG
--no-persist-file

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.

--project ARG
--project=ARG
--project-name ARG
--project-name=ARG
--no-project

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.

Finder Options

--finder MyFinder
--finder +Test2::Harness::Finder::MyFinder
--no-finder

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.

Help and Debugging

--show-opts
--no-show-opts

Exit after showing what yath thinks your options mean

--version
-V
--no-version

Exit after showing a helpful usage message

Plugins

--no-scan-plugins
--no-no-scan-plugins

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.

--plugins PLUGIN
--plugins +App::Yath::Plugin::PLUGIN
--plugins PLUGIN=arg1,arg2,...
--plugin PLUGIN
--plugin +App::Yath::Plugin::PLUGIN
--plugin PLUGIN=arg1,arg2,...
-pPLUGIN
--no-plugins

Load a yath plugin.

Can be specified multiple times

COMMAND OPTIONS

Display Options

--color
--no-color

Turn color on, default is true if STDOUT is a TTY.

--no-wrap
--no-no-wrap

Do not do fancy text-wrapping, let the terminal handle it

--progress
--no-progress

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

--quiet
-q
--no-quiet

Be very quiet.

Can be specified multiple times

--renderers +My::Renderer
--renderers Renderer=arg1,arg2,...
--renderer +My::Renderer
--renderer Renderer=arg1,arg2,...
--no-renderers

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-times
-T
--no-show-times

Show the timing data for each job

--term-width 80
--term-width 200
--term-size 80
--term-size 200
--no-term-width

Alternative to setting $TABLE_TERM_SIZE. Setting this will override the terminal width detection to the number of characters specified.

--verbose
-v
--no-verbose

Be more verbose

Can be specified multiple times

Finder Options

--changed path/to/file
--no-changed

Specify one or more files as having been changed.

Can be specified multiple times

--changed-only
--no-changed-only

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())

--changes-plugin Git
--changes-plugin +App::Yath::Plugin::Git
--no-changes-plugin

What plugin should be used to detect changed files.

--coverage-from path/to/log.jsonl
--coverage-from http://example.com/coverage
--coverage-from path/to/coverage.json
--no-coverage-from

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.

--coverage-url-use-post
--no-coverage-url-use-post

If coverage_from is a url, use the http POST method with a list of changed files. This allows the server to tell us what tests to run instead of downloading all the coverage data and determining what tests to run from that.

--default-at-search ARG
--default-at-search=ARG

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

Can be specified multiple times

--default-search ARG
--default-search=ARG

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

Can be specified multiple times

--durations file.json
--durations http://example.com/durations.json
--no-durations

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-file t/nope.t
--no-exclude-file

Exclude a file from testing

Can be specified multiple times

--exclude-list file.txt
--exclude-list http://example.com/exclusions.txt
--no-exclude-list

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).

Can be specified multiple times

--exclude-pattern t/nope.t
--no-exclude-pattern

Exclude a pattern from testing, matched using m/$PATTERN/

Can be specified multiple times

--extension ARG
--extension=ARG
--ext ARG
--ext=ARG
--no-extension

Specify valid test filename extensions, default: t and t2

Can be specified multiple times

--maybe-coverage-from path/to/log.jsonl
--maybe-coverage-from http://example.com/coverage
--maybe-coverage-from path/to/coverage.json
--no-maybe-coverage-from

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.

--maybe-durations file.json
--maybe-durations http://example.com/durations.json
--no-maybe-durations

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.

--no-long
--no-no-long

Do not run tests that have their duration flag set to 'LONG'

--only-long
--no-only-long

Only run tests that have their duration flag set to 'LONG'

--search ARG
--search=ARG

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.

Can be specified multiple times

--show-changed-files
--no-show-changed-files

Print a list of changed files if any are found

Formatter Options

--formatter ARG
--formatter=ARG
--no-formatter

NO DESCRIPTION - FIX ME

--qvf
--no-qvf

[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-job-end
--no-show-job-end

Show output when a job ends. (Default: on)

--show-job-info
--no-show-job-info

Show the job configuration when a job starts. (Default: off, unless -vv)

--show-job-launch
--no-show-job-launch

Show output for the start of a job. (Default: off unless -v)

--show-run-info
--no-show-run-info

Show the run configuration when a run starts. (Default: off, unless -vv)

Git Options

--git-change-base master
--git-change-base HEAD^
--git-change-base df22abe4
--no-git-change-base

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.

Help and Debugging

--dummy
-d
--no-dummy

Dummy run, do not actually execute anything

Can also be set with the following environment variables: T2_HARNESS_DUMMY

--help
-h
--no-help

exit after showing help information

--keep-dirs
--keep_dir
-k
--no-keep-dirs

Do not delete directories when done. This is useful if you want to inspect the directories used for various commands.

--summary
--summary=/path/to/summary.json
--no-summary

Write out a summary json file, if no path is provided 'summary.json' will be used. The .json extension is added automatically if omitted.

Logging Options

--bzip2
--bz2
--bzip2_log
-B
--no-bzip2

Use bzip2 compression when writing the log. This option implies -L. The .bz2 prefix is added to log file name for you

--gzip
--gz
--gzip_log
-G
--no-gzip

Use gzip compression when writing the log. This option implies -L. The .gz prefix is added to log file name for you

--log
-L
--no-log

Turn on logging

--log-dir ARG
--log-dir=ARG
--no-log-dir

Specify a log directory. Will fall back to the system temp dir.

--log-file ARG
--log-file=ARG
-F ARG
-F=ARG
--no-log-file

Specify the name of the log file. This option implies -L.

--log-file-format ARG
--log-file-format=ARG
--lff ARG
--lff=ARG
--no-log-file-format

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

--write-coverage
--write-coverage=coverage.json
--no-write-coverage

Create a json file of all coverage data seen during the run (This implies --cover-files).

Notification Options

--notify-email foo@example.com
--no-notify-email

Email the test results to the specified email address(es)

Can be specified multiple times

--notify-email-fail foo@example.com
--no-notify-email-fail

Email failing results to the specified email address(es)

Can be specified multiple times

--notify-email-from foo@example.com
--no-notify-email-from

If any email is sent, this is who it will be from

--notify-email-owner
--no-notify-email-owner

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

--notify-no-batch-email
--no-notify-no-batch-email

Usually owner failures are sent as a single batch at the end of testing. Toggle this to send failures as they happen.

--notify-no-batch-slack
--no-notify-no-batch-slack

Usually owner failures are sent as a single batch at the end of testing. Toggle this to send failures as they happen.

--notify-slack '#foo'
--notify-slack '@bar'
--no-notify-slack

Send results to a slack channel and/or user

Can be specified multiple times

--notify-slack-fail '#foo'
--notify-slack-fail '@bar'
--no-notify-slack-fail

Send failing results to a slack channel and/or user

Can be specified multiple times

--notify-slack-owner
--no-notify-slack-owner

Send slack notifications to the slack channels/users listed in test meta-data when tests fail.

--notify-slack-url https://hooks.slack.com/...
--no-notify-slack-url

Specify an API endpoint for slack webhook integrations

--notify-text ARG
--notify-text=ARG
--message ARG
--message=ARG
--msg ARG
--msg=ARG
--no-notify-text

Add a custom text snippet to email/slack notifications

Run Options

--author-testing
-A
--no-author-testing

This will set the AUTHOR_TESTING environment to true

--cover-files
--no-cover-files

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)

--dbi-profiling
--no-dbi-profiling

Use Test2::Plugin::DBIProfile to collect database profiling data

--env-var VAR=VAL
-EVAR=VAL
-E VAR=VAL
--no-env-var

Set environment variables to set when each test is run.

Can be specified multiple times

--event-uuids
--uuids
--no-event-uuids

Use Test2::Plugin::UUID inside tests (default: on)

--fields name:details
--fields JSON_STRING
-f name:details
-f JSON_STRING
--no-fields

Add custom data to the harness run

Can be specified multiple times

--input ARG
--input=ARG
--no-input

Input string to be used as standard input for ALL tests. See also: --input-file

--input-file ARG
--input-file=ARG
--no-input-file

Use the specified file as standard input to ALL tests

--io-events
--no-io-events

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.

Can be specified multiple times

--load ARG
--load=ARG
--load-module ARG
--load-module=ARG
-m ARG
-m=ARG
--no-load

Load a module in each test (after fork). The "import" method is not called.

Can be specified multiple times

--load-import Module
--load-import Module=import_arg1,arg2,...
--loadim Module
--loadim Module=import_arg1,arg2,...
-M Module
-M Module=import_arg1,arg2,...
--no-load-import

Load a module in each test (after fork). Import is called.

Can be specified multiple times. If the same key is listed multiple times the value lists will be appended together.

--mem-usage
--no-mem-usage

Use Test2::Plugin::MemUsage inside tests (default: on)

--retry ARG
--retry=ARG
-r ARG
-r=ARG
--no-retry

Run any jobs that failed a second time. NOTE: --retry=1 means failing tests will be attempted twice!

--retry-isolated
--retry-iso
--no-retry-isolated

If true then any job retries will be done in isolation (as though -j1 was set)

--run-id
--id
--no-run-id

Set a specific run-id. (Default: a UUID)

--test-args ARG
--test-args=ARG
--no-test-args

Arguments to pass in as @ARGV for all tests that are run. These can be provided easier using the '::' argument separator.

Can be specified multiple times

--stream
--no-stream

Use the stream formatter (default is on)

--tap
--TAP
----no-stream
--no-tap

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.

Runner Options

--blib
-b
--no-blib

(Default: include if it exists) Include 'blib/lib' and 'blib/arch' in your module path

--cover
--cover=-silent,1,+ignore,^t/,+ignore,^t2/,+ignore,^xt,+ignore,^test.pl
--no-cover

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

--event-timeout SECONDS
--et SECONDS
--no-event-timeout

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.

--include ARG
--include=ARG
-I ARG
-I=ARG
--no-include

Add a directory to your include paths

Can be specified multiple times

--job-count ARG
--job-count=ARG
--jobs ARG
--jobs=ARG
-j ARG
-j=ARG
--no-job-count

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

--lib
-l
--no-lib

(Default: include if it exists) Include 'lib' in your module path

--nytprof
--no-nytprof

Use Devel::NYTProf on tests. This will set addpid=1 for you. This works with or without fork.

--post-exit-timeout SECONDS
--pet SECONDS
--no-post-exit-timeout

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.

--preload-threshold ARG
--preload-threshold=ARG
--Pt ARG
--Pt=ARG
-W ARG
-W=ARG
--no-preload-threshold

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.

--preloads ARG
--preloads=ARG
--preload ARG
--preload=ARG
-P ARG
-P=ARG
--no-preloads

Preload a module before running tests

Can be specified multiple times

--resource Port
--resource +Test2::Harness::Runner::Resource::Port
-R Port
--no-resource

Use a resource module to assign resource assignments to individual tests

Can be specified multiple times

--switch ARG
--switch=ARG
-S ARG
-S=ARG
--no-switch

Pass the specified switch to perl for each test. This is not compatible with preload.

Can be specified multiple times

--tlib
--no-tlib

(Default: off) Include 't/lib' in your module path

--unsafe-inc
--no-unsafe-inc

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

--use-fork
--fork
--no-use-fork

(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

--use-timeout
--timeout
--no-use-timeout

(default: on) Enable/disable timeouts

Workspace Options

--clear
-C
--no-clear

Clear the work directory if it is not already empty

--tmp-dir ARG
--tmp-dir=ARG
--tmpdir ARG
--tmpdir=ARG
-t ARG
-t=ARG
--no-tmp-dir

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

--workdir ARG
--workdir=ARG
-w ARG
-w=ARG
--no-workdir

Set the work directory (Default: new temp directory)

Can also be set with the following environment variables: T2_WORKDIR, YATH_WORKDIR

YathUI Options

--yathui-api-key ARG
--yathui-api-key=ARG
--no-yathui-api-key

Yath-UI API key. This is not necessary if your Yath-UI instance is set to single-user

--yathui-coverage
--no-yathui-coverage

Poll coverage data from Yath-UI to determine what tests should be run for changed files

--yathui-durations
--no-yathui-durations

Poll duration data from Yath-UI to help order tests efficiently

--yathui-grace
--no-yathui-grace

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.

--yathui-long-duration 10
--no-yathui-long-duration

Minimum duration length (seconds) before a test goes from MEDIUM to LONG

--yathui-medium-duration 5
--no-yathui-medium-duration

Minimum duration length (seconds) before a test goes from SHORT to MEDIUM

--yathui-mode summary
--yathui-mode qvf
--yathui-mode qvfd
--yathui-mode complete
--no-yathui-mode

Set the upload mode (default 'qvfd')

--yathui-project ARG
--yathui-project=ARG
--no-yathui-project

The Yath-UI project for your test results

--yathui-retry
--no-yathui-retry

How many times to try an operation before giving up

Can be specified multiple times

--yathui-upload
--no-yathui-upload

Upload the log to Yath-UI

--yathui-url http://my-yath-ui.com/...
--uri http://my-yath-ui.com/...
--no-yathui-url

Yath-UI url

SOURCE

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

MAINTAINERS

Chad Granum <exodist@cpan.org>

AUTHORS

Chad Granum <exodist@cpan.org>

COPYRIGHT

Copyright 2020 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/