App::Y...::stop(3pm)

๐Ÿ’– App::Y...::stop(3pm) ๐Ÿ’–

User Contributed Perl Documentation ยท App::Y...::stop(3pm) ยท yes bestie, that's the manual name, she's a little mysterious but she's valid ๐Ÿ’…


๐Ÿฆ‹ NAME ๐Ÿฆ‹

App::Yath::Command::stop โ€” Stop the persistent test runner ๐Ÿ›‘


๐Ÿ’… DESCRIPTION ๐Ÿ’…

okay so, real talk? This command will stop a persistent instance, and output any log contents. That's it. That's the whole job. She stops the thing, she shows you the logs, she leaves. main character energy, no notes โœจ


๐ŸŒธ USAGE ๐ŸŒธ

$ yath [YATH OPTIONS] stop [COMMAND OPTIONS]

โœจ YATH OPTIONS โœจ

the global vibes. these apply to yath itself, not just to stop.

๐ŸŒˆ Developer

  • --dev-lib, --dev-lib=lib, -D, -D=lib, -Dlib, --no-dev-lib โ€” adds paths to @INC before loading ANYTHING. This is what you reach for if you're developing yath or yath plugins, so the yath script finds your local code instead of the installed versions of that exact same code. You can hand it an argument (-Dfoo) for a custom path, or just do -D with no arg and it adds 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. And 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. 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 the 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 so it can bring in whatever command-line options they provide. This flag disables that. Super useful if you have a naughty plugin that is 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 ๐Ÿš€


๐ŸŽ€ Cover Options

  • --cover-aggregator ByTest, --cover-aggregator ByRun, --cover-aggregator +Custom::Aggregator, --cover-agg ByTest, --cover-agg ByRun, --cover-agg +Custom::Aggregator, --no-cover-aggregator โ€” choose a custom aggregator subclass ๐Ÿงฎ
  • --cover-class ARG, --cover-class=ARG, --no-cover-class โ€” choose a Test2::Plugin::Cover subclass ๐ŸŽจ
  • --cover-dirs ARG, --cover-dirs=ARG, --cover-dir ARG, --cover-dir=ARG, --no-cover-dirs โ€” NO DESCRIPTION - FIX ME ๐Ÿ˜ญ (that's literally what the docs say, I'm not gonna invent a meaning for you). Can be specified multiple times.
  • --cover-exclude-private, --no-cover-exclude-private, --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) โšก
  • --cover-from path/to/log.jsonl, --cover-from http://example.com/coverage, --cover-from path/to/coverage.jsonl, --no-cover-from โ€” this can be a test log, a coverage dump (old style json or new jsonl format), or a url to any of the previous. Tests will not be run if the file/url is invalid ๐Ÿšซ
  • --cover-from-type json, --cover-from-type jsonl, --cover-from-type log, --no-cover-from-type โ€” file type for coverage source. Usually it can be detected, but when it cannot be you should specify. "json" is old style single-blob coverage data, "jsonl" is the new by-test style, "log" is a logfile from a previous run ๐Ÿ”Ž
  • --cover-manager My::Coverage::Manager, --no-cover-manager โ€” coverage 'from' manager to use when coverage data does not provide one ๐Ÿง‘๐Ÿ’ผ
  • --cover-maybe-from path/to/log.jsonl, --cover-maybe-from http://example.com/coverage, --cover-maybe-from path/to/coverage.jsonl, --no-cover-maybe-from โ€” this can be a test log, a coverage dump (old style json or new jsonl format), or a url to any of the previous. Tests will coninue if even if the coverage file/url is invalid ๐Ÿซถ
  • --cover-maybe-from-type json, --cover-maybe-from-type jsonl, --cover-maybe-from-type log, --no-cover-maybe-from-type โ€” same as from_type but for maybe_from. Defaults to from_type if that is specified, otherwise auto-detect ๐Ÿ”
  • --cover-metrics, --no-cover-metrics, --cover-types ARG, --cover-types=ARG, --cover-type ARG, --cover-type=ARG, --no-cover-types โ€” NO DESCRIPTION - FIX ME ๐Ÿ˜ญ again, that's the literal doc, I'm being honest with you. Can be specified multiple times.
  • --cover-write, --cover-write=coverage.jsonl, --cover-write=coverage.json, --no-cover-write โ€” create a json or jsonl file of all coverage data seen during the run (This implies --cover-files) ๐Ÿ“

๐Ÿ’– Display Options

  • --color, --no-color โ€” turn color on, default is true if STDOUT is a TTY ๐ŸŒˆ
  • --hide-runner-output, --no-hide-runner-output โ€” hide output from the runner, showing only test output. (See Also truncate_runner_output) ๐Ÿคซ
  • --no-final-table, --no-no-final-table โ€” when printing final results, don't use table-style display ๐Ÿ™…
  • --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 ๐Ÿ“
  • --truncate-runner-output, --no-truncate-runner-output โ€” only show runner output that was generated after the current command. This is only useful with a persistent runner โœ‚๏ธ
  • --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 a coverage data source, also requires a list of changes either from the --changed option, or a plugin that implements changed_files() or changed_diff()) ๐ŸŽฏ
  • --changes-diff path/to/diff.diff, --no-changes-diff โ€” path to a diff file that should be used to find changed files for use with --changed-only. This must be in the same format as git diff -W --minimal -U1000000 ๐Ÿงพ
  • --changes-exclude-file path/to/file, --no-changes-exclude-file โ€” specify one or more files to ignore when looking at changes ๐Ÿšฎ Can be specified multiple times.
  • --changes-exclude-loads, --no-changes-exclude-loads โ€” exclude coverage tests which only load changed files, but never call code from them. (default: off) ๐Ÿ“ฆ
  • --changes-exclude-nonsub, --no-changes-exclude-nonsub โ€” exclude changes outside of subroutines (perl files only) (default: off) ๐Ÿ“›
  • --changes-exclude-opens, --no-changes-exclude-opens โ€” exclude coverage tests which only open() changed files, but never call code from them. (default: off) ๐ŸชŸ
  • --changes-exclude-pattern '(apple|pear|orange)', --no-changes-exclude-pattern โ€” ignore files matching this pattern when looking for changes. Your pattern will be inserted unmodified into a $file =~ m/$pattern/ check ๐ŸŽ Can be specified multiple times.
  • --changes-filter-file path/to/file, --no-changes-filter-file โ€” specify one or more files to check for changes. Changes to other files will be ignored ๐Ÿ”ฌ Can be specified multiple times.
  • --changes-filter-pattern '(apple|pear|orange)', --no-changes-filter-pattern โ€” specify a pattern for change checking. When only running tests for changed files this will limit which files are checked for changes. Only files that match this pattern will be checked. Your pattern will be inserted unmodified into a $file =~ m/$pattern/ check ๐Ÿ Can be specified multiple times.
  • --changes-include-whitespace, --no-changes-include-whitespace โ€” include changed lines that are whitespace only (default: off) ๐ŸŒฌ๏ธ
  • --changes-plugin Git, --changes-plugin +App::Yath::Plugin::Git, --no-changes-plugin โ€” what plugin should be used to detect changed files ๐Ÿง™
  • --default-at-search ARG, --default-at-search=ARG, --no-default-at-search โ€” 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, --no-default-search โ€” 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 a url that's got a hash where the keys are relative test filenames and the values are 'SHORT', 'MEDIUM', or 'LONG'. This overrides the durations that are listed in the file headers. Heads up though: if the durations file or url doesn't work, an exception gets thrown. No silent fails, bestie. ๐Ÿ’€
  • --durations-threshold ARG, --durations-threshold=ARG, --Dt ARG, --Dt=ARG, --no-durations-threshold โ€” Only go fetch the duration data if you're running at least this many tests. Default is (-j value + 1). โœจ
  • --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 leave out of testing. If a line starts with a # it gets commented out (that's for compatibility with Test2::Aggregate list files, iykyk). ๐Ÿ’…
    • Can be specified multiple times
  • --exclude-pattern t/nope.t, --no-exclude-pattern โ€” Exclude a pattern from testing โ€” it gets matched using m/$PATTERN/. ๐ŸŽ€
    • Can be specified multiple times
  • --extension ARG, --extension=ARG, --ext ARG, --ext=ARG, --no-extension โ€” Tell it which test filename extensions are valid. Default: t and t2. ๐ŸŒธ
    • Can be specified multiple times
  • --maybe-durations file.json, --maybe-durations http://example.com/durations.json, --no-maybe-durations โ€” Point at a json file or url with a hash of relative test filenames as keys and 'SHORT', 'MEDIUM', or 'LONG' as values. This overrides the durations listed in the file headers. And same as above: 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'. periodt.
  • --only-long, --no-only-long โ€” Only run tests that have their duration flag set to 'LONG'. ๐Ÿ‘‘
  • --rerun, --rerun=path/to/log.jsonl, --rerun=plugin_specific_string, --no-rerun โ€” Re-run tests from a previous run, pulled from a log file (or the last log file). Plugins can intercept this โ€” like YathUIDB, which will grab a run UUID and derive the tests to re-run from that. ๐Ÿ”ฅ
  • --rerun-all, --rerun-all=path/to/log.jsonl, --rerun-all=plugin_specific_string, --no-rerun-all โ€” Re-run all the tests from a previous run, from a log file (or the last log file). Plugins can intercept this too, such as YathUIDB, which grabs a run UUID and derives the tests to re-run from that. โœจ
  • --rerun-failed, --rerun-failed=path/to/log.jsonl, --rerun-failed=plugin_specific_string, --no-rerun-failed โ€” Re-run the failed tests from a previous run, from a log file (or the last log file). Again, plugins like YathUIDB can intercept this โ€” they'll grab a run UUID and derive the tests to re-run from it. ๐Ÿ˜ญ
  • --rerun-missed, --rerun-missed=path/to/log.jsonl, --rerun-missed=plugin_specific_string, --no-rerun-missed โ€” Run the tests that got missed from a previously aborted/stopped run, from a log file (or the last log file). Plugins can intercept โ€” like YathUIDB, which grabs a run UUID and derives the tests to re-run from that. ๐Ÿ™ˆ
  • --rerun-modes failed,missed,..., --rerun-modes all, --rerun-modes failed, --rerun-modes missed, --rerun-modes passed, --rerun-modes retried, --rerun-mode failed,missed,..., --rerun-mode all, --rerun-mode failed, --rerun-mode missed, --rerun-mode passed, --rerun-mode retried, --no-rerun-modes โ€” Pick which test categories to run. ๐ŸŽฏ
    • Can be specified multiple times
  • --rerun-passed, --rerun-passed=path/to/log.jsonl, --rerun-passed=plugin_specific_string, --no-rerun-passed โ€” Re-run the passed tests from a previous run, from a log file (or the last log file). Plugins can intercept, such as YathUIDB, which grabs a run UUID and derives the tests to re-run from that. ๐Ÿ’–
  • --rerun-plugin Foo, --rerun-plugin +App::Yath::Plugin::Foo, --no-rerun-plugin โ€” Which plugin(s) should be used for rerun. It'll fall back to other plugins if the ones you listed decline the value โ€” this is just used to set an order of priority. ๐ŸŒˆ
    • Can be specified multiple times
  • --rerun-retried, --rerun-retried=path/to/log.jsonl, --rerun-retried=plugin_specific_string, --no-rerun-retried โ€” Re-run the retried tests from a previous run, from a log file (or the last log file). Plugins can intercept this โ€” like YathUIDB, grabbing a run UUID and deriving the tests to re-run from that. ๐Ÿซถ
  • --search ARG, --search=ARG, --no-search โ€” A list of tests and test directories to use instead of the default search paths. Usually you can just list these as plain command line arguments without the --search prefix. ๐Ÿ”
    • Can be specified multiple times
  • --show-changed-files, --no-show-changed-files โ€” Print a list of the changed files, if any are found. ๐Ÿ“

๐ŸŽ€ Formatter Options ๐ŸŽ€

  • --formatter ARG, --formatter=ARG, --no-formatter โ€” NO DESCRIPTION - FIX ME ๐Ÿ˜ญ (yes really, that's literally what it says, not me being lazy)
  • --qvf, --no-qvf โ€” [Q]uiet, but [V]erbose on [F]ailure. Hide all output from tests when they pass โ€” except to say they passed. But if a test fails, then ALL the output from that test gets verbosely output. best of both worlds fr fr. ๐Ÿ’…
  • --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 the files changed by all the commits in the current branch from most recent, stopping when a commit is found that's also present in the history of the branch/commit you 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.
  • --interactive, -i, --no-interactive โ€” Use interactive mode, 1 test at a time, stdin forwarded to it. ๐ŸŽฎ
  • --keep-dirs, --keep_dir, -k, --no-keep-dirs โ€” Do not delete directories when done. Super useful if you wanna go inspect the directories used for various commands. ๐Ÿ”
  • --procname-prefix ARG, --procname-prefix=ARG, --no-procname-prefix โ€” Add a prefix to all proc names (as seen by ps). ๐Ÿท๏ธ
  • --summary, --summary=/path/to/summary.json, --no-summary โ€” Write out a summary json file. If no path is provided then 'summary.json' gets used. The .json extension is added automatically if you omit it. ๐Ÿ“„

๐Ÿ’œ 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 the 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 the 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 the automatically-generated log files. Overridden by --log-file, if given. This option implies -L. Default: $YATH_LOG_FILE_FORMAT, if that's set, or else "%!P%Y-%m-%d~%H:%M:%S~%!U~%!p.jsonl". This is a string where percent-escape sequences get replaced as per POSIX::strftime. There are also these special escape sequences that get 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

๐Ÿฆ‹ 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 the 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 gets sent, this is who it'll be from. โœ‰๏ธ
  • --notify-email-owner, --no-notify-email-owner โ€” Email the owner of the broken test 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 the 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 the 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 the 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 the 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 your email/slack notifications. โœ๏ธ
  • --notify-text-module ARG, --notify-text-module=ARG, --message_module ARG, --message_module=ARG, --no-notify-text-module โ€” Use the specified module to generate messages for emails and/or slack. ๐Ÿงฉ

โญ Run Options โญ

  • --author-testing, -A, --no-author-testing โ€” flips the AUTHOR_TESTING environment variable to true. bestie your author tests are getting RUN. ๐Ÿ’…
  • --dbi-profiling, --no-dbi-profiling โ€” pulls in Test2::Plugin::DBIProfile to gather database profiling data. we're profiling the db, no cap ๐Ÿ“Š
  • --env-var VAR=VAL, -EVAR=VAL, -E VAR=VAL, --no-env-var โ€” sets environment variables that get set when each test runs.

Can be specified multiple times โœจ

  • --event-uuids, --uuids, --no-event-uuids โ€” uses Test2::Plugin::UUID inside tests (default: on). literally every event gets its own little serial number ๐ŸŽ€
  • --fields name:details, --fields JSON_STRING, -f name:details, -f JSON_STRING, --no-fields โ€” adds custom data to the harness run.

Can be specified multiple times ๐Ÿ’–

  • --input ARG, --input=ARG, --no-input โ€” an input string used as standard input for ALL the tests. see also: --input-file ๐Ÿ‘€
  • --input-file ARG, --input-file=ARG, --no-input-file โ€” uses the file you name as standard input to ALL the tests ๐Ÿ“„
  • --io-events, --no-io-events โ€” uses Test2::Plugin::IOEvents inside tests so that every print becomes a test2 event (default: off). turning prints into events is lowkey iconic ๐Ÿฆ‹
  • --link 'https://travis.work/builds/42', --link 'https://jenkins.work/job/42', --link 'https://buildbot.work/builders/foo/builds/42', --no-link โ€” give one or more links that 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 โ€” loads a module in each test (after fork). the import method does not get 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 โ€” loads a module in each test (after fork). here, 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 โ€” uses Test2::Plugin::MemUsage inside tests (default: on). watching the memory go brrr ๐Ÿ“
  • --retry ARG, --retry=ARG, -r ARG, -r=ARG, --no-retry โ€” reruns any jobs that failed, a second time. NOTE: --retry=1 means failing tests will be attempted twice! not me double-checking the math on that one ๐Ÿ˜ญ
  • --retry-isolated, --retry-iso, --no-retry-isolated โ€” if true, then any job retries get done in isolation (as though -j1 was set).
  • --run-id, --id, --no-run-id โ€” sets a specific run-id. (Default: a UUID)
  • --test-args ARG, --test-args=ARG, --no-test-args โ€” arguments to pass in as @ARGV for all the tests that run. these are easier to provide using the :: argument separator.

Can be specified multiple times โญ

  • --stream, --no-stream โ€” uses 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, and in that case setting --TAP or --no-stream can help. ๐Ÿซถ

๐ŸŒธ 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 โ€” polls coverage data from yath-ui to figure out what tests should be run for the files that changed.
  • --yathui-durations, --no-yathui-durations โ€” polls duration data from yath-ui to help order tests efficiently โฑ๏ธ
  • --yathui-grace, --no-yathui-grace โ€” normally, if yath cannot connect to yath-ui it throws an error. use this to make it fail gracefully. you get a warning, but things keep going. we love a soft landing ๐Ÿ’–
  • --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 โ€” sets 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 ๐Ÿ”

๐Ÿ’€ NO CATEGORY - FIX ME ๐Ÿ’€

  • --check-reload-state, --no-check-reload-state โ€” aborts the run if there are unfixed reload errors, and shows a confirmation dialogue for unfixed reload warnings. (yes bestie the section heading really does say fix me, we're all just living like this ๐Ÿ™ˆ)

๐Ÿ“š SOURCE ๐Ÿ“š

the source code repository for Test2-Harness can be found at http://github.com/Test-More/Test2-Harness/. go star it, it's giving main character energy ๐Ÿ‘‘

๐Ÿซถ MAINTAINERS ๐Ÿซถ

Chad Granum <exodist@cpan.org>

โœจ AUTHORS โœจ

Chad Granum <exodist@cpan.org>

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


and that's a wrap on this gorgeous little manpage, fr fr ๐Ÿ’… this was perl v5.40.1, dated 2026-05-10 โ€” stan the version, stan the date, and go run your tests bestie ๐ŸŒธ๐Ÿ’–โœจ
๐Ÿ“ฆ where this page comes from