NAME

App::Yath::Command::start - Start a test runner

DESCRIPTION

This command is used to start a yath daemon that will load up and run tests on demand. (Use --no-daemon or -f to start one and keep it in the foreground)

USAGE

    $ yath [YATH OPTIONS] start [COMMAND OPTIONS]

OPTIONS

Database Options

--db-config ARG

--db-config=ARG

--no-db-config

Module that implements 'MODULE->yath_db_config(%params)' which should return a App::Yath::Schema::Config instance.

Can also be set with the following environment variables: YATH_DB_CONFIG

--db-driver Pg

--db-driver MySQL

--db-driver SQLite

--db-driver MariaDB

--db-driver Percona

--db-driver PostgreSQL

--no-db-driver

DBI Driver to use

Can also be set with the following environment variables: YATH_DB_DRIVER

--db-dsn ARG

--db-dsn=ARG

--no-db-dsn

DSN to use when connecting to the db

Can also be set with the following environment variables: YATH_DB_DSN

--db-host ARG

--db-host=ARG

--no-db-host

hostname to use when connecting to the db

Can also be set with the following environment variables: YATH_DB_HOST

--db-name ARG

--db-name=ARG

--no-db-name

Name of the database to use

Can also be set with the following environment variables: YATH_DB_NAME

--db-pass ARG

--db-pass=ARG

--no-db-pass

Password to use when connecting to the db

Can also be set with the following environment variables: YATH_DB_PASS

--db-port ARG

--db-port=ARG

--no-db-port

port to use when connecting to the db

Can also be set with the following environment variables: YATH_DB_PORT

--db-socket ARG

--db-socket=ARG

--no-db-socket

socket to use when connecting to the db

Can also be set with the following environment variables: YATH_DB_SOCKET

--db-user ARG

--db-user=ARG

--no-db-user

Username to use when connecting to the db

Can also be set with the following environment variables: YATH_DB_USER, USER

Harness Options

-d

--dummy

--no-dummy

Dummy run, do not actually execute anything

Can also be set with the following environment variables: T2_HARNESS_DUMMY

The following environment variables will be cleared after arguments are processed: T2_HARNESS_DUMMY

--procname-prefix ARG

--procname-prefix=ARG

--no-procname-prefix

Add a prefix to all proc names (as seen by ps).

The following environment variables will be set after arguments are processed: T2_HARNESS_PROC_PREFIX

IPC Options

--ipc-address ARG

--ipc-address=ARG

--no-ipc-address

IPC address to use (usually auto-generated or discovered)

--ipc-allow-multiple

--no-ipc-allow-multiple

Normally yath will prevent you from starting multiple persistent runners in the same project, this option will allow you to start more than one.

--ipc-dir ARG

--ipc-dir=ARG

--no-ipc-dir

Directory for ipc files

Can also be set with the following environment variables: T2_HARNESS_IPC_DIR, YATH_IPC_DIR

--ipc-dir-order ARG

--ipc-dir-order=ARG

--ipc-dir-order '["json","list"]'

--ipc-dir-order='["json","list"]'

--ipc-dir-order :{ ARG1 ARG2 ... }:

--ipc-dir-order=:{ ARG1 ARG2 ... }:

--no-ipc-dir-order

When finding ipc-dir automatically, search in this order, default: ['base', 'temp']

Note: Can be specified multiple times

--ipc-file ARG

--ipc-file=ARG

--no-ipc-file

IPC file used to locate instances (usually auto-generated or discovered)

--ipc-peer-pid ARG

--ipc-peer-pid=ARG

--no-ipc-peer-pid

Optionally a peer PID may be provided

--ipc-port ARG

--ipc-port=ARG

--no-ipc-port

Some IPC protocols require a port, otherwise this should be left empty

--ipc-prefix ARG

--ipc-prefix=ARG

--no-ipc-prefix

Prefix for ipc files

--ipc-protocol IPSocket

--ipc-protocol AtomicPipe

--ipc-protocol UnixSocket

--ipc-protocol +Test2::Harness::IPC::Protocol::AtomicPipe

--no-ipc-protocol

Specify what IPC Protocol to use. Use the "+" prefix to specify a fully qualified namespace, otherwise Test2::Harness::IPC::Protocol::XXX namespace is assumed.

Renderer Options

--hide-runner-output

--no-hide-runner-output

Hide output from the runner, showing only test output. (See Also truncate_runner_output)

-q

--quiet

--no-quiet

Be very quiet.

--qvf

--no-qvf

Replaces App::Yath::Theme::Default with App::Yath::Theme::QVF which is quiet for passing tests and verbose for failing ones.

--renderer +My::Renderer

--renderers +My::Renderer

--renderer MyRenderer=opt1,opt2

--renderers MyRenderer=opt1,opt2

--renderer MyRenderer,MyOtherRenderer

--renderers MyRenderer,MyOtherRenderer

--renderer=:{ MyRenderer opt1,opt2,... }:

--renderers=:{ MyRenderer opt1,opt2,... }:

--renderer :{ MyRenderer :{ opt1 opt2 }: }:

--renderers :{ MyRenderer :{ opt1 opt2 }: }:

--no-renderers

Specify renderers. Use "+" to give a fully qualified module name. Without "+" "App::Yath::Renderer::" will be prepended to your argument.

Note: Can be specified multiple times

--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-fields

--no-show-run-fields

Show run fields. (Default: off, unless -vv)

--show-run-info

--no-show-run-info

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

-T

--show-times

--no-show-times

Show the timing data for each job.

-tARG

-t ARG

-t=ARG

--theme ARG

--theme=ARG

--no-theme

Select a theme for the renderer (not all renderers use this)

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

-v

-vv

-vvv..

-v=COUNT

--verbose

--verbose=COUNT

--no-verbose

Be more verbose

The following environment variables will be set after arguments are processed: T2_HARNESS_IS_VERBOSE, HARNESS_IS_VERBOSE

Note: Can be specified multiple times, counter bumps each time it is used.

--wrap

--no-wrap

When active (default) renderers should try to wrap text in a human-friendly way. When this is turned off they should just throw text at the terminal.

Resource Options

-x2

--job-slots 2

--slots-per-job 2

--no-job-slots

This sets the number of slots each job will use (default 1). This is normally set by the ':#' in '-j#:#'.

Can also be set with the following environment variables: T2_HARNESS_JOB_CONCURRENCY

The following environment variables will be cleared after arguments are processed: T2_HARNESS_JOB_CONCURRENCY

-RMyResource

-R +My::Resource

-R MyResource=opt1,opt2

-R MyResource,MyOtherResource

-R=:{ MyResource opt1,opt2,... }:

-R :{ MyResource :{ opt1 opt2 }: }:

--resource +My::Resource

--resources +My::Resource

--resource MyResource=opt1,opt2

--resources MyResource=opt1,opt2

--resource MyResource,MyOtherResource

--resources MyResource,MyOtherResource

--resource=:{ MyResource opt1,opt2,... }:

--resources=:{ MyResource opt1,opt2,... }:

--resource :{ MyResource :{ opt1 opt2 }: }:

--resources :{ MyResource :{ opt1 opt2 }: }:

--no-resources

Specify resources. Use "+" to give a fully qualified module name. Without "+" "App::Yath::Resource::" and "Test2::Harness::Resource::" will be searched for a matching resource module.

Note: Can be specified multiple times

-j4

-j8:2

--jobs 4

--slots 4

--jobs 8:2

--slots 8:2

--job-count 4

--job-count 8:2

--no-slots

Set the number of concurrent jobs to run. Add a :# if you also wish to designate multiple slots per test. 8:2 means 8 slots, but each test gets 2 slots, so 4 tests run concurrently. Tests can find their concurrency assignemnt in the "T2_HARNESS_MY_JOB_CONCURRENCY" environment variable.

Can also be set with the following environment variables: YATH_JOB_COUNT, T2_HARNESS_JOB_COUNT, HARNESS_JOB_COUNT

The following environment variables will be cleared after arguments are processed: YATH_JOB_COUNT, T2_HARNESS_JOB_COUNT, HARNESS_JOB_COUNT

Note: If System::Info is installed, this will default to half the cpu core count, otherwise the default is 2.

Runner Options

--dump-depmap

--no-dump-depmap

When using staged preload, dump the depmap for each stage as json files

--preload-early key=val

--preload-early=key=val

--preload-early '{"json":"hash"}'

--preload-early='{"json":"hash"}'

--preload-early :{ KEY1 VAL KEY2 :{ VAL1 VAL2 ... }: ... }:

--preload-early=:{ KEY1 VAL KEY2 :{ VAL1 VAL2 ... }: ... }:

--no-preload-early

Preload a module when spawning perl to launch the preload stages, before any other preload.

Note: Can be specified multiple times

--preload-retry-delay ARG

--preload-retry-delay=ARG

--no-preload-retry-delay

Time in seconds to wait before trying to load a preload/stage after a failed attempt

-P ARG

-P=ARG

-P '["json","list"]'

-P='["json","list"]'

-P :{ ARG1 ARG2 ... }:

-P=:{ ARG1 ARG2 ... }:

--preload ARG

--preload=ARG

--preloads ARG

--preloads=ARG

--preload '["json","list"]'

--preload='["json","list"]'

--preloads '["json","list"]'

--preloads='["json","list"]'

--preload :{ ARG1 ARG2 ... }:

--preload=:{ ARG1 ARG2 ... }:

--preloads :{ ARG1 ARG2 ... }:

--preloads=:{ ARG1 ARG2 ... }:

--no-preloads

Preload a module before running tests

Note: Can be specified multiple times

--reload

--reload-in-place

--no-reload-in-place

Reload modules in-place when possible (Not recommended)

--reloader

--reloader=ARG

--no-reloader

Use a reloader (default Test2::Harness::Reloader) to detect module changes, and reload stages as necessary.

--restrict-reload

--restrict-reload=ARG

--restrict-reload='["json","list"]'

--restrict-reload=:{ ARG1 ARG2 ... }:

--no-restrict-reload

NO DESCRIPTION - FIX ME

Note: Can be specified multiple times

--runner MyRunner

--runner +Test2::Harness::Runner::MyRunner

--no-runner

Specify what Runner subclass to use. Use the "+" prefix to specify a fully qualified namespace, otherwise Test2::Harness::Runner::XXX namespace is assumed.

Scheduler Options

--scheduler MyScheduler

--scheduler +Test2::Harness::MyScheduler

--no-scheduler

Specify what Scheduler subclass to use. Use the "+" prefix to specify a fully qualified namespace, otherwise Test2::Harness::Scheduler::XXX namespace is assumed.

Start Options

-f

--no-daemon

--foreground

--no-foreground

--daemon

Keep yath in the forground instead of daemonizing and returning you to the shell

Terminal Options

-c

--color

--no-color

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

Can also be set with the following environment variables: YATH_COLOR, CLICOLOR_FORCE

The following environment variables will be set after arguments are processed: YATH_COLOR

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

--term-size 80

--term-width 80

--term-size 200

--term-width 200

--no-term-width

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

Can also be set with the following environment variables: TABLE_TERM_SIZE

The following environment variables will be set after arguments are processed: TABLE_TERM_SIZE

Test Options

--allow-retry

--no-allow-retry

Toggle retry capabilities on and off (default: on)

-b

--blib

--no-blib

(Default: include if it exists) Include 'blib/lib' and 'blib/arch' in your module path (These will come after paths you specify with -D or -I)

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

Can also be set with the following environment variables: T2_DEVEL_COVER

The following environment variables will be set after arguments are processed: T2_DEVEL_COVER

-E key=val

-E=key=val

-Ekey=value

-E '{"json":"hash"}'

-E='{"json":"hash"}'

-E:{ KEY1 VAL KEY2 :{ VAL1 VAL2 ... }: ... }:

-E :{ KEY1 VAL KEY2 :{ VAL1 VAL2 ... }: ... }:

-E=:{ KEY1 VAL KEY2 :{ VAL1 VAL2 ... }: ... }:

--env-var key=val

--env-var=key=val

--env-vars key=val

--env-vars=key=val

--env-var '{"json":"hash"}'

--env-var='{"json":"hash"}'

--env-vars '{"json":"hash"}'

--env-vars='{"json":"hash"}'

--env-var :{ KEY1 VAL KEY2 :{ VAL1 VAL2 ... }: ... }:

--env-var=:{ KEY1 VAL KEY2 :{ VAL1 VAL2 ... }: ... }:

--env-vars :{ KEY1 VAL KEY2 :{ VAL1 VAL2 ... }: ... }:

--env-vars=:{ KEY1 VAL KEY2 :{ VAL1 VAL2 ... }: ... }:

--no-env-vars

Set environment variables

Note: Can be specified multiple times

--et SECONDS

--event-timeout 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.

--event-uuids

--no-event-uuids

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

-I ARG

-I=ARG

-I '*.*'

-I='*.*'

-I '["json","list"]'

-I='["json","list"]'

-I :{ ARG1 ARG2 ... }:

-I=:{ ARG1 ARG2 ... }:

--include ARG

--include=ARG

--include '*.*'

--include='*.*'

--include '["json","list"]'

--include='["json","list"]'

--include :{ ARG1 ARG2 ... }:

--include=:{ ARG1 ARG2 ... }:

--no-include

Add a directory to your include paths

Note: 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

-l

--lib

--no-lib

(Default: include if it exists) Include 'lib' in your module path (These will come after paths you specify with -D or -I)

-m ARG

-m=ARG

-m '["json","list"]'

-m='["json","list"]'

-m :{ ARG1 ARG2 ... }:

-m=:{ ARG1 ARG2 ... }:

--load ARG

--load=ARG

--load-module ARG

--load-module=ARG

--load '["json","list"]'

--load='["json","list"]'

--load :{ ARG1 ARG2 ... }:

--load=:{ ARG1 ARG2 ... }:

--load-module '["json","list"]'

--load-module='["json","list"]'

--load-module :{ ARG1 ARG2 ... }:

--load-module=:{ ARG1 ARG2 ... }:

--no-load

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

Note: Can be specified multiple times

-M Module

-M Module=import_arg1,arg2,...

-M '{"Data::Dumper":["Dumper"]}'

--loadim Module

--load-import Module

--loadim Module=import_arg1,arg2,...

--loadim '{"Data::Dumper":["Dumper"]}'

--load-import Module=import_arg1,arg2,...

--load-import '{"Data::Dumper":["Dumper"]}'

--no-load-import

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

Note: Can be specified multiple times

--mem-usage

--no-mem-usage

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

--pet SECONDS

--post-exit-timeout 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.

-rARG

-r ARG

-r=ARG

--retry ARG

--retry=ARG

--no-retry

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

--retry-iso

--retry-isolated

--no-retry-isolated

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

--stream

--use-stream

--no-stream

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

-S ARG

-S=ARG

-S '["json","list"]'

-S='["json","list"]'

-S :{ ARG1 ARG2 ... }:

-S=:{ ARG1 ARG2 ... }:

--switch ARG

--switch=ARG

--switches ARG

--switches=ARG

--switch '["json","list"]'

--switch='["json","list"]'

--switches '["json","list"]'

--switches='["json","list"]'

--switch :{ ARG1 ARG2 ... }:

--switch=:{ ARG1 ARG2 ... }:

--switches :{ ARG1 ARG2 ... }:

--switches=:{ ARG1 ARG2 ... }:

--no-switches

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

Note: Can be specified multiple times

--test-arg ARG

--test-arg=ARG

--test-args ARG

--test-args=ARG

--test-arg '["json","list"]'

--test-arg='["json","list"]'

--test-args '["json","list"]'

--test-args='["json","list"]'

--test-arg :{ ARG1 ARG2 ... }:

--test-arg=:{ ARG1 ARG2 ... }:

--test-args :{ ARG1 ARG2 ... }:

--test-args=:{ ARG1 ARG2 ... }:

--no-test-args

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

Note: Can be specified multiple times

--tlib

--no-tlib

(Default: off) Include 't/lib' in your module path (These will come after paths you specify with -D or -I)

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

The following environment variables will be set after arguments are processed: PERL_USE_UNSAFE_INC

--fork

--use-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

--timeout

--use-timeout

--no-use-timeout

(default: on) Enable/disable timeouts

Web Client Options

--api-key ARG

--api-key=ARG

--no-api-key

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

Can also be set with the following environment variables: YATH_API_KEY

--grace

--no-grace

If yath cannot connect to a server it normally throws an error, use this to make it fail gracefully. You get a warning, but things keep going.

--request-retry

--request-retry=COUNT

--no-request-retry

How many times to try an operation before giving up

Note: Can be specified multiple times, counter bumps each time it is used.

--url http://my-yath-server.com/...

--uri http://my-yath-server.com/...

--no-url

Yath server url

Can also be set with the following environment variables: YATH_URL

Workspace Options

-C

--clear

--no-clear

Clear the work directory if it is not already empty

-k

--keep-dir

--keep-dirs

--no-keep-dirs

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

--tmpdir ARG

--tmpdir=ARG

--tmp-dir ARG

--tmp-dir=ARG

--no-tmpdir

Use a specific temp directory (Default: create a temp dir under the system one)

Can also be set with the following environment variables: T2_HARNESS_TEMP_DIR, YATH_TEMP_DIR

The following environment variables will be cleared after arguments are processed: T2_HARNESS_TEMP_DIR, YATH_TEMP_DIR

The following environment variables will be set after arguments are processed: TMPDIR, TEMPDIR, TMP_DIR, TEMP_DIR

--workdir ARG

--workdir=ARG

--no-workdir

Set the work directory (Default: new temp directory)

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

The following environment variables will be cleared after arguments are processed: T2_WORKDIR, YATH_WORKDIR

Yath Options

--base-dir ARG

--base-dir=ARG

--no-base-dir

Root directory for the project being tested (usually where .yath.rc lives)

-D

-Dlib

-Dlib

-D=lib

-D"lib/*"

--dev-lib

--dev-lib=lib

--dev-lib="lib/*"

--no-dev-lib

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.

Note: This option can cause yath to use exec() to reload itself with the correct libraries in place. Each occurence of this argument can cause an additional exec() call. Use --dev-libs-verbose BEFORE any -D calls to see the exec() calls.

Note: Can be specified multiple times

--dev-libs-verbose

--no-dev-libs-verbose

Be verbose and announce that yath will re-exec in order to have the correct includes (normally yath will just call exec() quietly)

-h

-h=Group

--help

--help=Group

--no-help

exit after showing help information

-p key=val

-p=key=val

-pkey=value

-p '{"json":"hash"}'

-p='{"json":"hash"}'

-p:{ KEY1 VAL KEY2 :{ VAL1 VAL2 ... }: ... }:

-p :{ KEY1 VAL KEY2 :{ VAL1 VAL2 ... }: ... }:

-p=:{ KEY1 VAL KEY2 :{ VAL1 VAL2 ... }: ... }:

--plugin key=val

--plugin=key=val

--plugins key=val

--plugins=key=val

--plugin '{"json":"hash"}'

--plugin='{"json":"hash"}'

--plugins '{"json":"hash"}'

--plugins='{"json":"hash"}'

--plugin :{ KEY1 VAL KEY2 :{ VAL1 VAL2 ... }: ... }:

--plugin=:{ KEY1 VAL KEY2 :{ VAL1 VAL2 ... }: ... }:

--plugins :{ KEY1 VAL KEY2 :{ VAL1 VAL2 ... }: ... }:

--plugins=:{ KEY1 VAL KEY2 :{ VAL1 VAL2 ... }: ... }:

--no-plugins

Load a yath plugin.

Note: Can be specified multiple times

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

--scan-options key=val

--scan-options=key=val

--scan-options '{"json":"hash"}'

--scan-options='{"json":"hash"}'

--scan-options(?^:^--(no-)?(?^:scan-(.+))$)

--scan-options :{ KEY1 VAL KEY2 :{ VAL1 VAL2 ... }: ... }:

--scan-options=:{ KEY1 VAL KEY2 :{ VAL1 VAL2 ... }: ... }:

--no-scan-options

/^--(no-)?scan-(.+)$/

Yath will normally scan plugins for options. Some commands scan other libraries (finders, resources, renderers, etc) for options. You can use this to disable all scanning, or selectively disable/enable some scanning.

Note: This is parsed early in the argument processing sequence, before options that may be earlier in your argument list.

Note: Can be specified multiple times

--show-opts

--show-opts=group

--no-show-opts

Exit after showing what yath thinks your options mean

--user ARG

--user=ARG

--no-user

Username to associate with logs, database entries, and yath servers.

Can also be set with the following environment variables: YATH_USER, USER

-V

--version

--no-version

Exit after showing a helpful usage message

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

cpanm Test2::Harness

perl -MCPAN -e shell
install Test2::Harness