DOKK / manpages / debian 12 / libtest2-harness-perl / App::Yath::Command::which.3pm.en
App::Yath::Command::which(3pm) User Contributed Perl Documentation App::Yath::Command::which(3pm)

App::Yath::Command::which - Locate the persistent test runner

This will tell you about any persistent runners it can find.

    $ yath [YATH OPTIONS] which [COMMAND OPTIONS]

YATH OPTIONS

Developer

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

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.

Help and Debugging

Exit after showing what yath thinks your options mean
Exit after showing a helpful usage message

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 is loading other modules when it should not.
Load a yath plugin.

Can be specified multiple times

COMMAND OPTIONS

Cover Options

Choose a custom aggregator subclass
Choose a Test2::Plugin::Cover subclass
NO DESCRIPTION - FIX ME

Can be specified multiple times

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)
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.
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.
Coverage 'from' manager to use when coverage data does not provide one
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.
Same as "from_type" but for "maybe_from". Defaults to "from_type" if that is specified, otherwise auto-detect
NO DESCRIPTION - FIX ME

Can be specified multiple times

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

Git Options

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 run, do not actually execute anything

Can also be set with the following environment variables: "T2_HARNESS_DUMMY"

exit after showing help information
Use interactive mode, 1 test at a time, stdin forwarded to it
Do not delete directories when done. This is useful if you want to inspect the directories used for various commands.
Add a prefix to all proc names (as seen by ps).

YathUI Options

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
Send resource info (for supported resources) to yathui at the specified interval in seconds (5 if not specified)
How many times to try an operation before giving up

Can be specified multiple times

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.
Pull coverage data directly from the database (default: off)
DBI Driver to use
DSN to use when connecting to the db
Limit the number of runs to look at for durations data (default: 10)
Pull duration data directly from the database (default: off)
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
When using coverage or duration data, only use data uploaded by this user
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 2023 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/

2023-03-12 perl v5.36.0