1App::Yath::Command::runU(s3e)r Contributed Perl DocumentaAtpipo:n:Yath::Command::run(3)
2
6 App::Yath::Command::run - Run tests using the persistent test runner
7
9 This command will run tests through an already started persistent
10 instance. See the start command for details on how to launch a
11 persistant instance.
12
14 $ yath [YATH OPTIONS] run [COMMAND OPTIONS]
15 YATH OPTIONS
17 Developer
18 --dev-lib
20 --dev-lib=lib
21 -D
22 -D=lib
23 -Dlib
24 --no-dev-lib
25 Add paths to @INC before loading ANYTHING. This is what you use if
26 you are developing yath or yath plugins to make sure the yath
27 script finds the local code instead of the installed versions of
28 the same code. You can provide an argument (-Dfoo) to provide a
29 custom path, or you can just use -D without and arg to add lib,
30 blib/lib and blib/arch.
31 Can be specified multiple times
33 Environment
35 --persist-dir ARG
37 --persist-dir=ARG
38 --no-persist-dir
39 Where to find persistence files.
40 --persist-file ARG
42 --persist-file=ARG
43 --pfile ARG
44 --pfile=ARG
45 --no-persist-file
46 Where to find the persistence file. The default is
47 /{system-tempdir}/project-yath-persist.json. If no project is
48 specified then it will fall back to the current directory. If the
49 current directory is not writable it will default to
50 /tmp/yath-persist.json which limits you to one persistent runner on
51 your system.
52 --project ARG
54 --project=ARG
55 --project-name ARG
56 --project-name=ARG
57 --no-project
58 This lets you provide a label for your current project/codebase.
59 This is best used in a .yath.rc file. This is necessary for a
60 persistent runner.
61 Finder Options
63 --finder MyFinder
65 --finder +Test2::Harness::Finder::MyFinder
66 --no-finder
67 Specify what Finder subclass to use when searching for
68 files/processing the file list. Use the "+" prefix to specify a
69 fully qualified namespace, otherwise Test2::Harness::Finder::XXX
70 namespace is assumed.
71 Help and Debugging
73 --show-opts
75 --no-show-opts
76 Exit after showing what yath thinks your options mean
77 --version
79 -V
80 --no-version
81 Exit after showing a helpful usage message
82 Plugins
84 --no-scan-plugins
86 --no-no-scan-plugins
87 Normally yath scans for and loads all App::Yath::Plugin::* modules
88 in order to bring in command-line options they may provide. This
89 flag will disable that. This is useful if you have a naughty plugin
90 that is loading other modules when it should not.
91 --plugins PLUGIN
93 --plugins +App::Yath::Plugin::PLUGIN
94 --plugins PLUGIN=arg1,arg2,...
95 --plugin PLUGIN
96 --plugin +App::Yath::Plugin::PLUGIN
97 --plugin PLUGIN=arg1,arg2,...
98 -pPLUGIN
99 --no-plugins
100 Load a yath plugin.
101 Can be specified multiple times
103 COMMAND OPTIONS
105 Cover Options
106 --cover-aggregator ByTest
108 --cover-aggregator ByRun
109 --cover-aggregator +Custom::Aggregator
110 --cover-agg ByTest
111 --cover-agg ByRun
112 --cover-agg +Custom::Aggregator
113 --no-cover-aggregator
114 Choose a custom aggregator subclass
115 --cover-class ARG
117 --cover-class=ARG
118 --no-cover-class
119 Choose a Test2::Plugin::Cover subclass
120 --cover-dirs ARG
122 --cover-dirs=ARG
123 --cover-dir ARG
124 --cover-dir=ARG
125 --no-cover-dirs
126 NO DESCRIPTION - FIX ME
127 Can be specified multiple times
129 --cover-exclude-private
131 --no-cover-exclude-private
132 --cover-files
133 --no-cover-files
134 Use Test2::Plugin::Cover to collect coverage data for what files
135 are touched by what tests. Unlike Devel::Cover this has very little
136 performance impact (About 4% difference)
137 --cover-from path/to/log.jsonl
139 --cover-from http://example.com/coverage
140 --cover-from path/to/coverage.jsonl
141 --no-cover-from
142 This can be a test log, a coverage dump (old style json or new
143 jsonl format), or a url to any of the previous. Tests will not be
144 run if the file/url is invalid.
145 --cover-from-type json
147 --cover-from-type jsonl
148 --cover-from-type log
149 --no-cover-from-type
150 File type for coverage source. Usually it can be detected, but when
151 it cannot be you should specify. "json" is old style single-blob
152 coverage data, "jsonl" is the new by-test style, "log" is a logfile
153 from a previous run.
154 --cover-manager My::Coverage::Manager
156 --no-cover-manager
157 Coverage 'from' manager to use when coverage data does not provide
158 one
159 --cover-maybe-from path/to/log.jsonl
161 --cover-maybe-from http://example.com/coverage
162 --cover-maybe-from path/to/coverage.jsonl
163 --no-cover-maybe-from
164 This can be a test log, a coverage dump (old style json or new
165 jsonl format), or a url to any of the previous. Tests will coninue
166 if even if the coverage file/url is invalid.
167 --cover-maybe-from-type json
169 --cover-maybe-from-type jsonl
170 --cover-maybe-from-type log
171 --no-cover-maybe-from-type
172 Same as "from_type" but for "maybe_from". Defaults to "from_type"
173 if that is specified, otherwise auto-detect
174 --cover-metrics
176 --no-cover-metrics
177 --cover-types ARG
178 --cover-types=ARG
179 --cover-type ARG
180 --cover-type=ARG
181 --no-cover-types
182 NO DESCRIPTION - FIX ME
183 Can be specified multiple times
185 --cover-write
187 --cover-write=coverage.jsonl
188 --cover-write=coverage.json
189 --no-cover-write
190 Create a json or jsonl file of all coverage data seen during the
191 run (This implies --cover-files).
192 Display Options
194 --color
196 --no-color
197 Turn color on, default is true if STDOUT is a TTY.
198 --hide-runner-output
200 --no-hide-runner-output
201 Hide output from the runner, showing only test output. (See Also
202 truncate_runner_output)
203 --no-wrap
205 --no-no-wrap
206 Do not do fancy text-wrapping, let the terminal handle it
207 --progress
209 --no-progress
210 Toggle progress indicators. On by default if STDOUT is a TTY. You
211 can use --no-progress to disable the 'events seen' counter and
212 buffered event pre-display
213 --quiet
215 -q
216 --no-quiet
217 Be very quiet.
218 Can be specified multiple times
220 --renderers +My::Renderer
222 --renderers Renderer=arg1,arg2,...
223 --renderer +My::Renderer
224 --renderer Renderer=arg1,arg2,...
225 --no-renderers
226 Specify renderers, (Default: "Formatter=Test2"). Use "+" to give a
227 fully qualified module name. Without "+"
228 "Test2::Harness::Renderer::" will be prepended to your argument.
229 Can be specified multiple times. If the same key is listed multiple
231 times the value lists will be appended together.
232 --show-times
234 -T
235 --no-show-times
236 Show the timing data for each job
237 --term-width 80
239 --term-width 200
240 --term-size 80
241 --term-size 200
242 --no-term-width
243 Alternative to setting $TABLE_TERM_SIZE. Setting this will override
244 the terminal width detection to the number of characters specified.
245 --truncate-runner-output
247 --no-truncate-runner-output
248 Only show runner output that was generated after the current
249 command. This is only useful with a persistent runner.
250 --verbose
252 -v
253 --no-verbose
254 Be more verbose
255 Can be specified multiple times
257 Finder Options
259 --changed path/to/file
261 --no-changed
262 Specify one or more files as having been changed.
263 Can be specified multiple times
265 --changed-only
267 --no-changed-only
268 Only search for tests for changed files (Requires a coverage data
269 source, also requires a list of changes either from the --changed
270 option, or a plugin that implements changed_files() or
271 changed_diff())
272 --changes-diff path/to/diff.diff
274 --no-changes-diff
275 Path to a diff file that should be used to find changed files for
276 use with --changed-only. This must be in the same format as `git
277 diff -W --minimal -U1000000`
278 --changes-exclude-file path/to/file
280 --no-changes-exclude-file
281 Specify one or more files to ignore when looking at changes
282 Can be specified multiple times
284 --changes-exclude-loads
286 --no-changes-exclude-loads
287 Exclude coverage tests which only load changed files, but never
288 call code from them. (default: off)
289 --changes-exclude-nonsub
291 --no-changes-exclude-nonsub
292 Exclude changes outside of subroutines (perl files only) (default:
293 off)
294 --changes-exclude-opens
296 --no-changes-exclude-opens
297 Exclude coverage tests which only open() changed files, but never
298 call code from them. (default: off)
299 --changes-exclude-pattern '(apple|pear|orange)'
301 --no-changes-exclude-pattern
302 Ignore files matching this pattern when looking for changes. Your
303 pattern will be inserted unmodified into a `$file =~ m/$pattern/`
304 check.
305 Can be specified multiple times
307 --changes-filter-file path/to/file
309 --no-changes-filter-file
310 Specify one or more files to check for changes. Changes to other
311 files will be ignored
312 Can be specified multiple times
314 --changes-filter-pattern '(apple|pear|orange)'
316 --no-changes-filter-pattern
317 Specify a pattern for change checking. When only running tests for
318 changed files this will limit which files are checked for changes.
319 Only files that match this pattern will be checked. Your pattern
320 will be inserted unmodified into a `$file =~ m/$pattern/` check.
321 Can be specified multiple times
323 --changes-include-whitespace
325 --no-changes-include-whitespace
326 Include changed lines that are whitespace only (default: off)
327 --changes-plugin Git
329 --changes-plugin +App::Yath::Plugin::Git
330 --no-changes-plugin
331 What plugin should be used to detect changed files.
332 --default-at-search ARG
334 --default-at-search=ARG
335 --no-default-at-search
336 Specify the default file/dir search when 'AUTHOR_TESTING' is set.
337 Defaults to './xt'. The default AT search is only used if no files
338 were specified at the command line
339 Can be specified multiple times
341 --default-search ARG
343 --default-search=ARG
344 --no-default-search
345 Specify the default file/dir search. defaults to './t', './t2', and
346 'test.pl'. The default search is only used if no files were
347 specified at the command line
348 Can be specified multiple times
350 --durations file.json
352 --durations http://example.com/durations.json
353 --no-durations
354 Point at a json file or url which has a hash of relative test
355 filenames as keys, and 'SHORT', 'MEDIUM', or 'LONG' as values. This
356 will override durations listed in the file headers. An exception
357 will be thrown if the durations file or url does not work.
358 --durations-threshold ARG
360 --durations-threshold=ARG
361 --Dt ARG
362 --Dt=ARG
363 --no-durations-threshold
364 Only fetch duration data if running at least this number of tests.
365 Default (-j value + 1)
366 --exclude-file t/nope.t
368 --no-exclude-file
369 Exclude a file from testing
370 Can be specified multiple times
372 --exclude-list file.txt
374 --exclude-list http://example.com/exclusions.txt
375 --no-exclude-list
376 Point at a file or url which has a new line separated list of test
377 file names to exclude from testing. Starting a line with a '#' will
378 comment it out (for compatibility with Test2::Aggregate list
379 files).
380 Can be specified multiple times
382 --exclude-pattern t/nope.t
384 --no-exclude-pattern
385 Exclude a pattern from testing, matched using m/$PATTERN/
386 Can be specified multiple times
388 --extension ARG
390 --extension=ARG
391 --ext ARG
392 --ext=ARG
393 --no-extension
394 Specify valid test filename extensions, default: t and t2
395 Can be specified multiple times
397 --maybe-durations file.json
399 --maybe-durations http://example.com/durations.json
400 --no-maybe-durations
401 Point at a json file or url which has a hash of relative test
402 filenames as keys, and 'SHORT', 'MEDIUM', or 'LONG' as values. This
403 will override durations listed in the file headers. An exception
404 will be thrown if the durations file or url does not work.
405 --no-long
407 --no-no-long
408 Do not run tests that have their duration flag set to 'LONG'
409 --only-long
411 --no-only-long
412 Only run tests that have their duration flag set to 'LONG'
413 --rerun
415 --rerun=path/to/log.jsonl
416 --rerun=plugin_specific_string
417 --no-rerun
418 Re-Run tests from a previous run from a log file (or last log
419 file). Plugins can intercept this, such as YathUIDB which will grab
420 a run UUID and derive tests to re-run from that.
421 --rerun-all
423 --rerun-all=path/to/log.jsonl
424 --rerun-all=plugin_specific_string
425 --no-rerun-all
426 Re-Run all tests from a previous run from a log file (or last log
427 file). Plugins can intercept this, such as YathUIDB which will grab
428 a run UUID and derive tests to re-run from that.
429 --rerun-failed
431 --rerun-failed=path/to/log.jsonl
432 --rerun-failed=plugin_specific_string
433 --no-rerun-failed
434 Re-Run failed tests from a previous run from a log file (or last
435 log file). Plugins can intercept this, such as YathUIDB which will
436 grab a run UUID and derive tests to re-run from that.
437 --rerun-missed
439 --rerun-missed=path/to/log.jsonl
440 --rerun-missed=plugin_specific_string
441 --no-rerun-missed
442 Run missed tests from a previously aborted/stopped run from a log
443 file (or last log file). Plugins can intercept this, such as
444 YathUIDB which will grab a run UUID and derive tests to re-run from
445 that.
446 --rerun-modes failed,missed,...
448 --rerun-modes all
449 --rerun-modes failed
450 --rerun-modes missed
451 --rerun-modes passed
452 --rerun-modes retried
453 --rerun-mode failed,missed,...
454 --rerun-mode all
455 --rerun-mode failed
456 --rerun-mode missed
457 --rerun-mode passed
458 --rerun-mode retried
459 --no-rerun-modes
460 Pick which test categories to run
461 Can be specified multiple times
463 --rerun-passed
465 --rerun-passed=path/to/log.jsonl
466 --rerun-passed=plugin_specific_string
467 --no-rerun-passed
468 Re-Run passed tests from a previous run from a log file (or last
469 log file). Plugins can intercept this, such as YathUIDB which will
470 grab a run UUID and derive tests to re-run from that.
471 --rerun-plugin Foo
473 --rerun-plugin +App::Yath::Plugin::Foo
474 --no-rerun-plugin
475 What plugin(s) should be used for rerun (will fallback to other
476 plugins if the listed ones decline the value, this is just used ot
477 set an order of priority)
478 Can be specified multiple times
480 --rerun-retried
482 --rerun-retried=path/to/log.jsonl
483 --rerun-retried=plugin_specific_string
484 --no-rerun-retried
485 Re-Run retried tests from a previous run from a log file (or last
486 log file). Plugins can intercept this, such as YathUIDB which will
487 grab a run UUID and derive tests to re-run from that.
488 --search ARG
490 --search=ARG
491 --no-search
492 List of tests and test directories to use instead of the default
493 search paths. Typically these can simply be listed as command line
494 arguments without the --search prefix.
495 Can be specified multiple times
497 --show-changed-files
499 --no-show-changed-files
500 Print a list of changed files if any are found
501 Formatter Options
503 --formatter ARG
505 --formatter=ARG
506 --no-formatter
507 NO DESCRIPTION - FIX ME
508 --qvf
510 --no-qvf
511 [Q]uiet, but [V]erbose on [F]ailure. Hide all output from tests
512 when they pass, except to say they passed. If a test fails then ALL
513 output from the test is verbosely output.
514 --show-job-end
516 --no-show-job-end
517 Show output when a job ends. (Default: on)
518 --show-job-info
520 --no-show-job-info
521 Show the job configuration when a job starts. (Default: off, unless
522 -vv)
523 --show-job-launch
525 --no-show-job-launch
526 Show output for the start of a job. (Default: off unless -v)
527 --show-run-info
529 --no-show-run-info
530 Show the run configuration when a run starts. (Default: off, unless
531 -vv)
532 Git Options
534 --git-change-base master
536 --git-change-base HEAD^
537 --git-change-base df22abe4
538 --no-git-change-base
539 Find files changed by all commits in the current branch from most
540 recent stopping when a commit is found that is also present in the
541 history of the branch/commit specified as the change base.
542 Help and Debugging
544 --dummy
546 -d
547 --no-dummy
548 Dummy run, do not actually execute anything
549 Can also be set with the following environment variables:
551 "T2_HARNESS_DUMMY"
552 --help
554 -h
555 --no-help
556 exit after showing help information
557 --interactive
559 -i
560 --no-interactive
561 Use interactive mode, 1 test at a time, stdin forwarded to it
562 --keep-dirs
564 --keep_dir
565 -k
566 --no-keep-dirs
567 Do not delete directories when done. This is useful if you want to
568 inspect the directories used for various commands.
569 --procname-prefix ARG
571 --procname-prefix=ARG
572 --no-procname-prefix
573 Add a prefix to all proc names (as seen by ps).
574 --summary
576 --summary=/path/to/summary.json
577 --no-summary
578 Write out a summary json file, if no path is provided
579 'summary.json' will be used. The .json extension is added
580 automatically if omitted.
581 Logging Options
583 --bzip2
585 --bz2
586 --bzip2_log
587 -B
588 --no-bzip2
589 Use bzip2 compression when writing the log. This option implies -L.
590 The .bz2 prefix is added to log file name for you
591 --gzip
593 --gz
594 --gzip_log
595 -G
596 --no-gzip
597 Use gzip compression when writing the log. This option implies -L.
598 The .gz prefix is added to log file name for you
599 --log
601 -L
602 --no-log
603 Turn on logging
604 --log-dir ARG
606 --log-dir=ARG
607 --no-log-dir
608 Specify a log directory. Will fall back to the system temp dir.
609 --log-file ARG
611 --log-file=ARG
612 -F ARG
613 -F=ARG
614 --no-log-file
615 Specify the name of the log file. This option implies -L.
616 --log-file-format ARG
618 --log-file-format=ARG
619 --lff ARG
620 --lff=ARG
621 --no-log-file-format
622 Specify the format for automatically-generated log files.
623 Overridden by --log-file, if given. This option implies -L
624 (Default: \$YATH_LOG_FILE_FORMAT, if that is set, or else
625 "%!P%Y-%m-%d~%H:%M:%S~%!U~%!p.jsonl"). This is a string in which
626 percent-escape sequences will be replaced as per POSIX::strftime.
627 The following special escape sequences are also replaced: (%!P :
628 Project name followed by a ~, if a project is defined, otherwise
629 empty string) (%!U : the unique test run ID) (%!p : the process ID)
630 (%!S : the number of seconds since local midnight UTC)
631 Can also be set with the following environment variables:
633 "YATH_LOG_FILE_FORMAT", "TEST2_HARNESS_LOG_FORMAT"
634 Notification Options
636 --notify-email foo@example.com
638 --no-notify-email
639 Email the test results to the specified email address(es)
640 Can be specified multiple times
642 --notify-email-fail foo@example.com
644 --no-notify-email-fail
645 Email failing results to the specified email address(es)
646 Can be specified multiple times
648 --notify-email-from foo@example.com
650 --no-notify-email-from
651 If any email is sent, this is who it will be from
652 --notify-email-owner
654 --no-notify-email-owner
655 Email the owner of broken tests files upon failure. Add `# HARNESS-
656 META-OWNER foo@example.com` to the top of a test file to give it an
657 owner
658 --notify-no-batch-email
660 --no-notify-no-batch-email
661 Usually owner failures are sent as a single batch at the end of
662 testing. Toggle this to send failures as they happen.
663 --notify-no-batch-slack
665 --no-notify-no-batch-slack
666 Usually owner failures are sent as a single batch at the end of
667 testing. Toggle this to send failures as they happen.
668 --notify-slack '#foo'
670 --notify-slack '@bar'
671 --no-notify-slack
672 Send results to a slack channel and/or user
673 Can be specified multiple times
675 --notify-slack-fail '#foo'
677 --notify-slack-fail '@bar'
678 --no-notify-slack-fail
679 Send failing results to a slack channel and/or user
680 Can be specified multiple times
682 --notify-slack-owner
684 --no-notify-slack-owner
685 Send slack notifications to the slack channels/users listed in test
686 meta-data when tests fail.
687 --notify-slack-url https://hooks.slack.com/...
689 --no-notify-slack-url
690 Specify an API endpoint for slack webhook integrations
691 --notify-text ARG
693 --notify-text=ARG
694 --message ARG
695 --message=ARG
696 --msg ARG
697 --msg=ARG
698 --no-notify-text
699 Add a custom text snippet to email/slack notifications
700 --notify-text-module ARG
702 --notify-text-module=ARG
703 --message_module ARG
704 --message_module=ARG
705 --no-notify-text-module
706 Use the specified module to generate messages for emails and/or
707 slack.
708 Run Options
710 --author-testing
712 -A
713 --no-author-testing
714 This will set the AUTHOR_TESTING environment to true
715 --dbi-profiling
717 --no-dbi-profiling
718 Use Test2::Plugin::DBIProfile to collect database profiling data
719 --env-var VAR=VAL
721 -EVAR=VAL
722 -E VAR=VAL
723 --no-env-var
724 Set environment variables to set when each test is run.
725 Can be specified multiple times
727 --event-uuids
729 --uuids
730 --no-event-uuids
731 Use Test2::Plugin::UUID inside tests (default: on)
732 --fields name:details
734 --fields JSON_STRING
735 -f name:details
736 -f JSON_STRING
737 --no-fields
738 Add custom data to the harness run
739 Can be specified multiple times
741 --input ARG
743 --input=ARG
744 --no-input
745 Input string to be used as standard input for ALL tests. See also:
746 --input-file
747 --input-file ARG
749 --input-file=ARG
750 --no-input-file
751 Use the specified file as standard input to ALL tests
752 --io-events
754 --no-io-events
755 Use Test2::Plugin::IOEvents inside tests to turn all prints into
756 test2 events (default: off)
757 --link 'https://travis.work/builds/42'
759 --link 'https://jenkins.work/job/42'
760 --link 'https://buildbot.work/builders/foo/builds/42'
761 --no-link
762 Provide one or more links people can follow to see more about this
763 run.
764 Can be specified multiple times
766 --load ARG
768 --load=ARG
769 --load-module ARG
770 --load-module=ARG
771 -m ARG
772 -m=ARG
773 --no-load
774 Load a module in each test (after fork). The "import" method is not
775 called.
776 Can be specified multiple times
778 --load-import Module
780 --load-import Module=import_arg1,arg2,...
781 --loadim Module
782 --loadim Module=import_arg1,arg2,...
783 -M Module
784 -M Module=import_arg1,arg2,...
785 --no-load-import
786 Load a module in each test (after fork). Import is called.
787 Can be specified multiple times. If the same key is listed multiple
789 times the value lists will be appended together.
790 --mem-usage
792 --no-mem-usage
793 Use Test2::Plugin::MemUsage inside tests (default: on)
794 --retry ARG
796 --retry=ARG
797 -r ARG
798 -r=ARG
799 --no-retry
800 Run any jobs that failed a second time. NOTE: --retry=1 means
801 failing tests will be attempted twice!
802 --retry-isolated
804 --retry-iso
805 --no-retry-isolated
806 If true then any job retries will be done in isolation (as though
807 -j1 was set)
808 --run-id
810 --id
811 --no-run-id
812 Set a specific run-id. (Default: a UUID)
813 --test-args ARG
815 --test-args=ARG
816 --no-test-args
817 Arguments to pass in as @ARGV for all tests that are run. These can
818 be provided easier using the '::' argument separator.
819 Can be specified multiple times
821 --stream
823 --no-stream
824 Use the stream formatter (default is on)
825 --tap
827 --TAP
828 ----no-stream
829 --no-tap
830 The TAP format is lossy and clunky. Test2::Harness normally uses a
831 newer streaming format to receive test results. There are
832 old/legacy tests where this causes problems, in which case setting
833 --TAP or --no-stream can help.
834 YathUI Options
836 --yathui-api-key ARG
838 --yathui-api-key=ARG
839 --no-yathui-api-key
840 Yath-UI API key. This is not necessary if your Yath-UI instance is
841 set to single-user
842 --yathui-coverage
844 --no-yathui-coverage
845 Poll coverage data from Yath-UI to determine what tests should be
846 run for changed files
847 --yathui-db
849 --no-yathui-db
850 Add the YathUI DB renderer in addition to other renderers
851 --yathui-durations
853 --no-yathui-durations
854 Poll duration data from Yath-UI to help order tests efficiently
855 --yathui-grace
857 --no-yathui-grace
858 If yath cannot connect to yath-ui it normally throws an error, use
859 this to make it fail gracefully. You get a warning, but things keep
860 going.
861 --yathui-long-duration 10
863 --no-yathui-long-duration
864 Minimum duration length (seconds) before a test goes from MEDIUM to
865 LONG
866 --yathui-medium-duration 5
868 --no-yathui-medium-duration
869 Minimum duration length (seconds) before a test goes from SHORT to
870 MEDIUM
871 --yathui-mode summary
873 --yathui-mode qvf
874 --yathui-mode qvfd
875 --yathui-mode complete
876 --no-yathui-mode
877 Set the upload mode (default 'qvfd')
878 --yathui-only
880 --no-yathui-only
881 Only use the YathUI renderer
882 --yathui-only-db
884 --no-yathui-only-db
885 Only use the YathUI DB renderer
886 --yathui-port 8080
888 --no-yathui-port
889 Port to use when running a local server
890 --yathui-port-command get_port.sh
892 --yathui-port-command get_port.sh --pid $$
893 --no-yathui-port-command
894 Use a command to get a port number. "$$" will be replaced with the
895 PID of the yath process
896 --yathui-project ARG
898 --yathui-project=ARG
899 --no-yathui-project
900 The Yath-UI project for your test results
901 --yathui-render
903 --no-yathui-render
904 Add the YathUI renderer in addition to other renderers
905 --yathui-resources
907 --yathui-resources=5
908 --no-yathui-resources
909 Send resource info (for supported resources) to yathui at the
910 specified interval in seconds (5 if not specified)
911 --yathui-retry
913 --no-yathui-retry
914 How many times to try an operation before giving up
915 Can be specified multiple times
917 --yathui-schema PostgreSQL
919 --yathui-schema MySQL
920 --yathui-schema MySQL56
921 --no-yathui-schema
922 What type of DB/schema to use when using a temporary database
923 --yathui-upload
925 --no-yathui-upload
926 Upload the log to Yath-UI
927 --yathui-url http://my-yath-ui.com/...
929 --uri http://my-yath-ui.com/...
930 --no-yathui-url
931 Yath-UI url
932 --yathui-user ARG
934 --yathui-user=ARG
935 --no-yathui-user
936 Username to attach to the data sent to the db
937 --yathui-db-buffering none
939 --yathui-db-buffering job
940 --yathui-db-buffering diag
941 --yathui-db-buffering run
942 --no-yathui-db-buffering
943 Type of buffering to use, if "none" then events are written to the
944 db one at a time, which is SLOW
945 --yathui-db-config ARG
947 --yathui-db-config=ARG
948 --no-yathui-db-config
949 Module that implements 'MODULE->yath_ui_config(%params)' which
950 should return a Test2::Harness::UI::Config instance.
951 --yathui-db-coverage
953 --no-yathui-db-coverage
954 Pull coverage data directly from the database (default: off)
955 --yathui-db-driver Pg
957 --yathui-db-drivermysql
958 --yathui-db-driverMariaDB
959 --no-yathui-db-driver
960 DBI Driver to use
961 --yathui-db-dsn ARG
963 --yathui-db-dsn=ARG
964 --no-yathui-db-dsn
965 DSN to use when connecting to the db
966 --yathui-db-duration-limit ARG
968 --yathui-db-duration-limit=ARG
969 --no-yathui-db-duration-limit
970 Limit the number of runs to look at for durations data (default:
971 10)
972 --yathui-db-durations
974 --no-yathui-db-durations
975 Pull duration data directly from the database (default: off)
976 --yathui-db-flush-interval 2
978 --yathui-db-flush-interval 1.5
979 --no-yathui-db-flush-interval
980 When buffering DB writes, force a flush when an event is recieved
981 at least N seconds after the last flush.
982 --yathui-db-host ARG
984 --yathui-db-host=ARG
985 --no-yathui-db-host
986 hostname to use when connecting to the db
987 --yathui-db-name ARG
989 --yathui-db-name=ARG
990 --no-yathui-db-name
991 Name of the database to use for yathui
992 --yathui-db-pass ARG
994 --yathui-db-pass=ARG
995 --no-yathui-db-pass
996 Password to use when connecting to the db
997 --yathui-db-port ARG
999 --yathui-db-port=ARG
1000 --no-yathui-db-port
1001 port to use when connecting to the db
1002 --yathui-db-publisher ARG
1004 --yathui-db-publisher=ARG
1005 --no-yathui-db-publisher
1006 When using coverage or duration data, only use data uploaded by
1007 this user
1008 --yathui-db-socket ARG
1010 --yathui-db-socket=ARG
1011 --no-yathui-db-socket
1012 socket to use when connecting to the db
1013 --yathui-db-user ARG
1015 --yathui-db-user=ARG
1016 --no-yathui-db-user
1017 Username to use when connecting to the db
1018 NO CATEGORY - FIX ME
1020 --check-reload-state
1022 --no-check-reload-state
1023 Abort the run if there are unfixes reload errors and show a
1024 confirmation dialogue for unfixed reload warnings.
1025
1027 The source code repository for Test2-Harness can be found at
1028 http://github.com/Test-More/Test2-Harness/.
1029
1031 Chad Granum <exodist@cpan.org>
1032
1034 Chad Granum <exodist@cpan.org>
1035
1037 Copyright 2023 Chad Granum <exodist7@gmail.com>.
1038 This program is free software; you can redistribute it and/or modify it
1040 under the same terms as Perl itself.
1041 See http://dev.perl.org/licenses/
1043perl v5.36.1 2023-10-04 App::Yath::Command::run(3)