App::Yath::Command::init - Create/update test.pl to run tests via
Test2::Harness
This command will create or update the 'test.pl' file in the
current directory. This 'test.pl' file this creates will run all your tests
via yath.
This command will fail if there is already a test.pl file that
does not look like it was generated by this command.
$ yath [YATH OPTIONS] init [COMMAND OPTIONS]
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
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
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).
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
- --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. This is useful if you want to 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).
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-db
- --no-yathui-db
- Add the YathUI DB renderer in addition to other renderers
- --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-only
- --no-yathui-only
- Only use the YathUI renderer
- --yathui-only-db
- --no-yathui-only-db
- Only use the YathUI DB renderer
- --yathui-port
8080
- --no-yathui-port
- Port to use when running a local server
- --yathui-port-command
get_port.sh
- --yathui-port-command
get_port.sh --pid $$
- --no-yathui-port-command
- Use a command to get a port number. "$$" will be replaced with
the PID of the yath process
- --yathui-project
ARG
- --yathui-project=ARG
- --no-yathui-project
- The Yath-UI project for your test results
- --yathui-render
- --no-yathui-render
- Add the YathUI renderer in addition to other renderers
- --yathui-resources
- --yathui-resources=5
- --no-yathui-resources
- Send resource info (for supported resources) to yathui at the specified
interval in seconds (5 if not specified)
- --yathui-retry
- --no-yathui-retry
- How many times to try an operation before giving up
Can be specified multiple times
- --yathui-schema
PostgreSQL
- --yathui-schema
MySQL
- --yathui-schema
MySQL56
- --no-yathui-schema
- What type of DB/schema to use when using a temporary database
- --yathui-url
http://my-yath-ui.com/...
- --uri
http://my-yath-ui.com/...
- --no-yathui-url
- Yath-UI url
- --yathui-user
ARG
- --yathui-user=ARG
- --no-yathui-user
- Username to attach to the data sent to the db
- --yathui-db-buffering
none
- --yathui-db-buffering
job
- --yathui-db-buffering
diag
- --yathui-db-buffering
run
- --no-yathui-db-buffering
- Type of buffering to use, if "none" then events are written to
the db one at a time, which is SLOW
- --yathui-db-config
ARG
- --yathui-db-config=ARG
- --no-yathui-db-config
- Module that implements 'MODULE->yath_ui_config(%params)' which should
return a Test2::Harness::UI::Config instance.
- --yathui-db-coverage
- --no-yathui-db-coverage
- Pull coverage data directly from the database (default: off)
- --yathui-db-driver
Pg
- --yathui-db-drivermysql
- --yathui-db-driverMariaDB
- --no-yathui-db-driver
- DBI Driver to use
- --yathui-db-dsn
ARG
- --yathui-db-dsn=ARG
- --no-yathui-db-dsn
- DSN to use when connecting to the db
- --yathui-db-duration-limit
ARG
- --yathui-db-duration-limit=ARG
- --no-yathui-db-duration-limit
- Limit the number of runs to look at for durations data (default: 10)
- --yathui-db-durations
- --no-yathui-db-durations
- Pull duration data directly from the database (default: off)
- --yathui-db-flush-interval
2
- --yathui-db-flush-interval
1.5
- --no-yathui-db-flush-interval
- When buffering DB writes, force a flush when an event is recieved at least
N seconds after the last flush.
- --yathui-db-host
ARG
- --yathui-db-host=ARG
- --no-yathui-db-host
- hostname to use when connecting to the db
- --yathui-db-name
ARG
- --yathui-db-name=ARG
- --no-yathui-db-name
- Name of the database to use for yathui
- --yathui-db-pass
ARG
- --yathui-db-pass=ARG
- --no-yathui-db-pass
- Password to use when connecting to the db
- --yathui-db-port
ARG
- --yathui-db-port=ARG
- --no-yathui-db-port
- port to use when connecting to the db
- --yathui-db-publisher
ARG
- --yathui-db-publisher=ARG
- --no-yathui-db-publisher
- When using coverage or duration data, only use data uploaded by this
user
- --yathui-db-socket
ARG
- --yathui-db-socket=ARG
- --no-yathui-db-socket
- socket to use when connecting to the db
- --yathui-db-user
ARG
- --yathui-db-user=ARG
- --no-yathui-db-user
- 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/