1App::Yath::Command::stoUps(e3r)Contributed Perl DocumentAaptpi:o:nYath::Command::stop(3)
2
6 App::Yath::Command::stop - Stop the persistent test runner
7
9 This command will stop a persistent instance, and output any log
10 contents.
11
13 $ yath [YATH OPTIONS] stop [COMMAND OPTIONS]
14 YATH OPTIONS
16 Developer
17 --dev-lib
19 --dev-lib=lib
20 -D
21 -D=lib
22 -Dlib
23 --no-dev-lib
24 Add paths to @INC before loading ANYTHING. This is what you use if
25 you are developing yath or yath plugins to make sure the yath
26 script finds the local code instead of the installed versions of
27 the same code. You can provide an argument (-Dfoo) to provide a
28 custom path, or you can just use -D without and arg to add lib,
29 blib/lib and blib/arch.
30 Can be specified multiple times
32 Environment
34 --persist-dir ARG
36 --persist-dir=ARG
37 --no-persist-dir
38 Where to find persistence files.
39 --persist-file ARG
41 --persist-file=ARG
42 --pfile ARG
43 --pfile=ARG
44 --no-persist-file
45 Where to find the persistence file. The default is
46 /{system-tempdir}/project-yath-persist.json. If no project is
47 specified then it will fall back to the current directory. If the
48 current directory is not writable it will default to
49 /tmp/yath-persist.json which limits you to one persistent runner on
50 your system.
51 --project ARG
53 --project=ARG
54 --project-name ARG
55 --project-name=ARG
56 --no-project
57 This lets you provide a label for your current project/codebase.
58 This is best used in a .yath.rc file. This is necessary for a
59 persistent runner.
60 Finder Options
62 --finder MyFinder
64 --finder +Test2::Harness::Finder::MyFinder
65 --no-finder
66 Specify what Finder subclass to use when searching for
67 files/processing the file list. Use the "+" prefix to specify a
68 fully qualified namespace, otherwise Test2::Harness::Finder::XXX
69 namespace is assumed.
70 Help and Debugging
72 --show-opts
74 --no-show-opts
75 Exit after showing what yath thinks your options mean
76 --version
78 -V
79 --no-version
80 Exit after showing a helpful usage message
81 Plugins
83 --no-scan-plugins
85 --no-no-scan-plugins
86 Normally yath scans for and loads all App::Yath::Plugin::* modules
87 in order to bring in command-line options they may provide. This
88 flag will disable that. This is useful if you have a naughty plugin
89 that is loading other modules when it should not.
90 --plugins PLUGIN
92 --plugins +App::Yath::Plugin::PLUGIN
93 --plugins PLUGIN=arg1,arg2,...
94 --plugin PLUGIN
95 --plugin +App::Yath::Plugin::PLUGIN
96 --plugin PLUGIN=arg1,arg2,...
97 -pPLUGIN
98 --no-plugins
99 Load a yath plugin.
100 Can be specified multiple times
102 COMMAND OPTIONS
104 Cover Options
105 --cover-aggregator ByTest
107 --cover-aggregator ByRun
108 --cover-aggregator +Custom::Aggregator
109 --cover-agg ByTest
110 --cover-agg ByRun
111 --cover-agg +Custom::Aggregator
112 --no-cover-aggregator
113 Choose a custom aggregator subclass
114 --cover-class ARG
116 --cover-class=ARG
117 --no-cover-class
118 Choose a Test2::Plugin::Cover subclass
119 --cover-dirs ARG
121 --cover-dirs=ARG
122 --cover-dir ARG
123 --cover-dir=ARG
124 --no-cover-dirs
125 NO DESCRIPTION - FIX ME
126 Can be specified multiple times
128 --cover-exclude-private
130 --no-cover-exclude-private
131 --cover-files
132 --no-cover-files
133 Use Test2::Plugin::Cover to collect coverage data for what files
134 are touched by what tests. Unlike Devel::Cover this has very little
135 performance impact (About 4% difference)
136 --cover-from path/to/log.jsonl
138 --cover-from http://example.com/coverage
139 --cover-from path/to/coverage.jsonl
140 --no-cover-from
141 This can be a test log, a coverage dump (old style json or new
142 jsonl format), or a url to any of the previous. Tests will not be
143 run if the file/url is invalid.
144 --cover-from-type json
146 --cover-from-type jsonl
147 --cover-from-type log
148 --no-cover-from-type
149 File type for coverage source. Usually it can be detected, but when
150 it cannot be you should specify. "json" is old style single-blob
151 coverage data, "jsonl" is the new by-test style, "log" is a logfile
152 from a previous run.
153 --cover-manager My::Coverage::Manager
155 --no-cover-manager
156 Coverage 'from' manager to use when coverage data does not provide
157 one
158 --cover-maybe-from path/to/log.jsonl
160 --cover-maybe-from http://example.com/coverage
161 --cover-maybe-from path/to/coverage.jsonl
162 --no-cover-maybe-from
163 This can be a test log, a coverage dump (old style json or new
164 jsonl format), or a url to any of the previous. Tests will coninue
165 if even if the coverage file/url is invalid.
166 --cover-maybe-from-type json
168 --cover-maybe-from-type jsonl
169 --cover-maybe-from-type log
170 --no-cover-maybe-from-type
171 Same as "from_type" but for "maybe_from". Defaults to "from_type"
172 if that is specified, otherwise auto-detect
173 --cover-metrics
175 --no-cover-metrics
176 --cover-types ARG
177 --cover-types=ARG
178 --cover-type ARG
179 --cover-type=ARG
180 --no-cover-types
181 NO DESCRIPTION - FIX ME
182 Can be specified multiple times
184 --cover-write
186 --cover-write=coverage.jsonl
187 --cover-write=coverage.json
188 --no-cover-write
189 Create a json or jsonl file of all coverage data seen during the
190 run (This implies --cover-files).
191 Display Options
193 --color
195 --no-color
196 Turn color on, default is true if STDOUT is a TTY.
197 --hide-runner-output
199 --no-hide-runner-output
200 Hide output from the runner, showing only test output. (See Also
201 truncate_runner_output)
202 --no-wrap
204 --no-no-wrap
205 Do not do fancy text-wrapping, let the terminal handle it
206 --progress
208 --no-progress
209 Toggle progress indicators. On by default if STDOUT is a TTY. You
210 can use --no-progress to disable the 'events seen' counter and
211 buffered event pre-display
212 --quiet
214 -q
215 --no-quiet
216 Be very quiet.
217 Can be specified multiple times
219 --renderers +My::Renderer
221 --renderers Renderer=arg1,arg2,...
222 --renderer +My::Renderer
223 --renderer Renderer=arg1,arg2,...
224 --no-renderers
225 Specify renderers, (Default: "Formatter=Test2"). Use "+" to give a
226 fully qualified module name. Without "+"
227 "Test2::Harness::Renderer::" will be prepended to your argument.
228 Can be specified multiple times. If the same key is listed multiple
230 times the value lists will be appended together.
231 --show-times
233 -T
234 --no-show-times
235 Show the timing data for each job
236 --term-width 80
238 --term-width 200
239 --term-size 80
240 --term-size 200
241 --no-term-width
242 Alternative to setting $TABLE_TERM_SIZE. Setting this will override
243 the terminal width detection to the number of characters specified.
244 --truncate-runner-output
246 --no-truncate-runner-output
247 Only show runner output that was generated after the current
248 command. This is only useful with a persistent runner.
249 --verbose
251 -v
252 --no-verbose
253 Be more verbose
254 Can be specified multiple times
256 Finder Options
258 --changed path/to/file
260 --no-changed
261 Specify one or more files as having been changed.
262 Can be specified multiple times
264 --changed-only
266 --no-changed-only
267 Only search for tests for changed files (Requires a coverage data
268 source, also requires a list of changes either from the --changed
269 option, or a plugin that implements changed_files() or
270 changed_diff())
271 --changes-diff path/to/diff.diff
273 --no-changes-diff
274 Path to a diff file that should be used to find changed files for
275 use with --changed-only. This must be in the same format as `git
276 diff -W --minimal -U1000000`
277 --changes-exclude-file path/to/file
279 --no-changes-exclude-file
280 Specify one or more files to ignore when looking at changes
281 Can be specified multiple times
283 --changes-exclude-loads
285 --no-changes-exclude-loads
286 Exclude coverage tests which only load changed files, but never
287 call code from them. (default: off)
288 --changes-exclude-nonsub
290 --no-changes-exclude-nonsub
291 Exclude changes outside of subroutines (perl files only) (default:
292 off)
293 --changes-exclude-opens
295 --no-changes-exclude-opens
296 Exclude coverage tests which only open() changed files, but never
297 call code from them. (default: off)
298 --changes-exclude-pattern '(apple|pear|orange)'
300 --no-changes-exclude-pattern
301 Ignore files matching this pattern when looking for changes. Your
302 pattern will be inserted unmodified into a `$file =~ m/$pattern/`
303 check.
304 Can be specified multiple times
306 --changes-filter-file path/to/file
308 --no-changes-filter-file
309 Specify one or more files to check for changes. Changes to other
310 files will be ignored
311 Can be specified multiple times
313 --changes-filter-pattern '(apple|pear|orange)'
315 --no-changes-filter-pattern
316 Specify a pattern for change checking. When only running tests for
317 changed files this will limit which files are checked for changes.
318 Only files that match this pattern will be checked. Your pattern
319 will be inserted unmodified into a `$file =~ m/$pattern/` check.
320 Can be specified multiple times
322 --changes-include-whitespace
324 --no-changes-include-whitespace
325 Include changed lines that are whitespace only (default: off)
326 --changes-plugin Git
328 --changes-plugin +App::Yath::Plugin::Git
329 --no-changes-plugin
330 What plugin should be used to detect changed files.
331 --default-at-search ARG
333 --default-at-search=ARG
334 --no-default-at-search
335 Specify the default file/dir search when 'AUTHOR_TESTING' is set.
336 Defaults to './xt'. The default AT search is only used if no files
337 were specified at the command line
338 Can be specified multiple times
340 --default-search ARG
342 --default-search=ARG
343 --no-default-search
344 Specify the default file/dir search. defaults to './t', './t2', and
345 'test.pl'. The default search is only used if no files were
346 specified at the command line
347 Can be specified multiple times
349 --durations file.json
351 --durations http://example.com/durations.json
352 --no-durations
353 Point at a json file or url which has a hash of relative test
354 filenames as keys, and 'SHORT', 'MEDIUM', or 'LONG' as values. This
355 will override durations listed in the file headers. An exception
356 will be thrown if the durations file or url does not work.
357 --durations-threshold ARG
359 --durations-threshold=ARG
360 --Dt ARG
361 --Dt=ARG
362 --no-durations-threshold
363 Only fetch duration data if running at least this number of tests.
364 Default (-j value + 1)
365 --exclude-file t/nope.t
367 --no-exclude-file
368 Exclude a file from testing
369 Can be specified multiple times
371 --exclude-list file.txt
373 --exclude-list http://example.com/exclusions.txt
374 --no-exclude-list
375 Point at a file or url which has a new line separated list of test
376 file names to exclude from testing. Starting a line with a '#' will
377 comment it out (for compatibility with Test2::Aggregate list
378 files).
379 Can be specified multiple times
381 --exclude-pattern t/nope.t
383 --no-exclude-pattern
384 Exclude a pattern from testing, matched using m/$PATTERN/
385 Can be specified multiple times
387 --extension ARG
389 --extension=ARG
390 --ext ARG
391 --ext=ARG
392 --no-extension
393 Specify valid test filename extensions, default: t and t2
394 Can be specified multiple times
396 --maybe-durations file.json
398 --maybe-durations http://example.com/durations.json
399 --no-maybe-durations
400 Point at a json file or url which has a hash of relative test
401 filenames as keys, and 'SHORT', 'MEDIUM', or 'LONG' as values. This
402 will override durations listed in the file headers. An exception
403 will be thrown if the durations file or url does not work.
404 --no-long
406 --no-no-long
407 Do not run tests that have their duration flag set to 'LONG'
408 --only-long
410 --no-only-long
411 Only run tests that have their duration flag set to 'LONG'
412 --rerun
414 --rerun=path/to/log.jsonl
415 --rerun=plugin_specific_string
416 --no-rerun
417 Re-Run tests from a previous run from a log file (or last log
418 file). Plugins can intercept this, such as YathUIDB which will grab
419 a run UUID and derive tests to re-run from that.
420 --rerun-all
422 --rerun-all=path/to/log.jsonl
423 --rerun-all=plugin_specific_string
424 --no-rerun-all
425 Re-Run all tests from a previous run from a log file (or last log
426 file). Plugins can intercept this, such as YathUIDB which will grab
427 a run UUID and derive tests to re-run from that.
428 --rerun-failed
430 --rerun-failed=path/to/log.jsonl
431 --rerun-failed=plugin_specific_string
432 --no-rerun-failed
433 Re-Run failed tests from a previous run from a log file (or last
434 log file). Plugins can intercept this, such as YathUIDB which will
435 grab a run UUID and derive tests to re-run from that.
436 --rerun-missed
438 --rerun-missed=path/to/log.jsonl
439 --rerun-missed=plugin_specific_string
440 --no-rerun-missed
441 Run missed tests from a previously aborted/stopped run from a log
442 file (or last log file). Plugins can intercept this, such as
443 YathUIDB which will grab a run UUID and derive tests to re-run from
444 that.
445 --rerun-modes failed,missed,...
447 --rerun-modes all
448 --rerun-modes failed
449 --rerun-modes missed
450 --rerun-modes passed
451 --rerun-modes retried
452 --rerun-mode failed,missed,...
453 --rerun-mode all
454 --rerun-mode failed
455 --rerun-mode missed
456 --rerun-mode passed
457 --rerun-mode retried
458 --no-rerun-modes
459 Pick which test categories to run
460 Can be specified multiple times
462 --rerun-passed
464 --rerun-passed=path/to/log.jsonl
465 --rerun-passed=plugin_specific_string
466 --no-rerun-passed
467 Re-Run passed tests from a previous run from a log file (or last
468 log file). Plugins can intercept this, such as YathUIDB which will
469 grab a run UUID and derive tests to re-run from that.
470 --rerun-plugin Foo
472 --rerun-plugin +App::Yath::Plugin::Foo
473 --no-rerun-plugin
474 What plugin(s) should be used for rerun (will fallback to other
475 plugins if the listed ones decline the value, this is just used ot
476 set an order of priority)
477 Can be specified multiple times
479 --rerun-retried
481 --rerun-retried=path/to/log.jsonl
482 --rerun-retried=plugin_specific_string
483 --no-rerun-retried
484 Re-Run retried tests from a previous run from a log file (or last
485 log file). Plugins can intercept this, such as YathUIDB which will
486 grab a run UUID and derive tests to re-run from that.
487 --search ARG
489 --search=ARG
490 --no-search
491 List of tests and test directories to use instead of the default
492 search paths. Typically these can simply be listed as command line
493 arguments without the --search prefix.
494 Can be specified multiple times
496 --show-changed-files
498 --no-show-changed-files
499 Print a list of changed files if any are found
500 Formatter Options
502 --formatter ARG
504 --formatter=ARG
505 --no-formatter
506 NO DESCRIPTION - FIX ME
507 --qvf
509 --no-qvf
510 [Q]uiet, but [V]erbose on [F]ailure. Hide all output from tests
511 when they pass, except to say they passed. If a test fails then ALL
512 output from the test is verbosely output.
513 --show-job-end
515 --no-show-job-end
516 Show output when a job ends. (Default: on)
517 --show-job-info
519 --no-show-job-info
520 Show the job configuration when a job starts. (Default: off, unless
521 -vv)
522 --show-job-launch
524 --no-show-job-launch
525 Show output for the start of a job. (Default: off unless -v)
526 --show-run-info
528 --no-show-run-info
529 Show the run configuration when a run starts. (Default: off, unless
530 -vv)
531 Git Options
533 --git-change-base master
535 --git-change-base HEAD^
536 --git-change-base df22abe4
537 --no-git-change-base
538 Find files changed by all commits in the current branch from most
539 recent stopping when a commit is found that is also present in the
540 history of the branch/commit specified as the change base.
541 Help and Debugging
543 --dummy
545 -d
546 --no-dummy
547 Dummy run, do not actually execute anything
548 Can also be set with the following environment variables:
550 "T2_HARNESS_DUMMY"
551 --help
553 -h
554 --no-help
555 exit after showing help information
556 --interactive
558 -i
559 --no-interactive
560 Use interactive mode, 1 test at a time, stdin forwarded to it
561 --keep-dirs
563 --keep_dir
564 -k
565 --no-keep-dirs
566 Do not delete directories when done. This is useful if you want to
567 inspect the directories used for various commands.
568 --procname-prefix ARG
570 --procname-prefix=ARG
571 --no-procname-prefix
572 Add a prefix to all proc names (as seen by ps).
573 --summary
575 --summary=/path/to/summary.json
576 --no-summary
577 Write out a summary json file, if no path is provided
578 'summary.json' will be used. The .json extension is added
579 automatically if omitted.
580 Logging Options
582 --bzip2
584 --bz2
585 --bzip2_log
586 -B
587 --no-bzip2
588 Use bzip2 compression when writing the log. This option implies -L.
589 The .bz2 prefix is added to log file name for you
590 --gzip
592 --gz
593 --gzip_log
594 -G
595 --no-gzip
596 Use gzip compression when writing the log. This option implies -L.
597 The .gz prefix is added to log file name for you
598 --log
600 -L
601 --no-log
602 Turn on logging
603 --log-dir ARG
605 --log-dir=ARG
606 --no-log-dir
607 Specify a log directory. Will fall back to the system temp dir.
608 --log-file ARG
610 --log-file=ARG
611 -F ARG
612 -F=ARG
613 --no-log-file
614 Specify the name of the log file. This option implies -L.
615 --log-file-format ARG
617 --log-file-format=ARG
618 --lff ARG
619 --lff=ARG
620 --no-log-file-format
621 Specify the format for automatically-generated log files.
622 Overridden by --log-file, if given. This option implies -L
623 (Default: \$YATH_LOG_FILE_FORMAT, if that is set, or else
624 "%!P%Y-%m-%d~%H:%M:%S~%!U~%!p.jsonl"). This is a string in which
625 percent-escape sequences will be replaced as per POSIX::strftime.
626 The following special escape sequences are also replaced: (%!P :
627 Project name followed by a ~, if a project is defined, otherwise
628 empty string) (%!U : the unique test run ID) (%!p : the process ID)
629 (%!S : the number of seconds since local midnight UTC)
630 Can also be set with the following environment variables:
632 "YATH_LOG_FILE_FORMAT", "TEST2_HARNESS_LOG_FORMAT"
633 Notification Options
635 --notify-email foo@example.com
637 --no-notify-email
638 Email the test results to the specified email address(es)
639 Can be specified multiple times
641 --notify-email-fail foo@example.com
643 --no-notify-email-fail
644 Email failing results to the specified email address(es)
645 Can be specified multiple times
647 --notify-email-from foo@example.com
649 --no-notify-email-from
650 If any email is sent, this is who it will be from
651 --notify-email-owner
653 --no-notify-email-owner
654 Email the owner of broken tests files upon failure. Add `# HARNESS-
655 META-OWNER foo@example.com` to the top of a test file to give it an
656 owner
657 --notify-no-batch-email
659 --no-notify-no-batch-email
660 Usually owner failures are sent as a single batch at the end of
661 testing. Toggle this to send failures as they happen.
662 --notify-no-batch-slack
664 --no-notify-no-batch-slack
665 Usually owner failures are sent as a single batch at the end of
666 testing. Toggle this to send failures as they happen.
667 --notify-slack '#foo'
669 --notify-slack '@bar'
670 --no-notify-slack
671 Send results to a slack channel and/or user
672 Can be specified multiple times
674 --notify-slack-fail '#foo'
676 --notify-slack-fail '@bar'
677 --no-notify-slack-fail
678 Send failing results to a slack channel and/or user
679 Can be specified multiple times
681 --notify-slack-owner
683 --no-notify-slack-owner
684 Send slack notifications to the slack channels/users listed in test
685 meta-data when tests fail.
686 --notify-slack-url https://hooks.slack.com/...
688 --no-notify-slack-url
689 Specify an API endpoint for slack webhook integrations
690 --notify-text ARG
692 --notify-text=ARG
693 --message ARG
694 --message=ARG
695 --msg ARG
696 --msg=ARG
697 --no-notify-text
698 Add a custom text snippet to email/slack notifications
699 --notify-text-module ARG
701 --notify-text-module=ARG
702 --message_module ARG
703 --message_module=ARG
704 --no-notify-text-module
705 Use the specified module to generate messages for emails and/or
706 slack.
707 Run Options
709 --author-testing
711 -A
712 --no-author-testing
713 This will set the AUTHOR_TESTING environment to true
714 --dbi-profiling
716 --no-dbi-profiling
717 Use Test2::Plugin::DBIProfile to collect database profiling data
718 --env-var VAR=VAL
720 -EVAR=VAL
721 -E VAR=VAL
722 --no-env-var
723 Set environment variables to set when each test is run.
724 Can be specified multiple times
726 --event-uuids
728 --uuids
729 --no-event-uuids
730 Use Test2::Plugin::UUID inside tests (default: on)
731 --fields name:details
733 --fields JSON_STRING
734 -f name:details
735 -f JSON_STRING
736 --no-fields
737 Add custom data to the harness run
738 Can be specified multiple times
740 --input ARG
742 --input=ARG
743 --no-input
744 Input string to be used as standard input for ALL tests. See also:
745 --input-file
746 --input-file ARG
748 --input-file=ARG
749 --no-input-file
750 Use the specified file as standard input to ALL tests
751 --io-events
753 --no-io-events
754 Use Test2::Plugin::IOEvents inside tests to turn all prints into
755 test2 events (default: off)
756 --link 'https://travis.work/builds/42'
758 --link 'https://jenkins.work/job/42'
759 --link 'https://buildbot.work/builders/foo/builds/42'
760 --no-link
761 Provide one or more links people can follow to see more about this
762 run.
763 Can be specified multiple times
765 --load ARG
767 --load=ARG
768 --load-module ARG
769 --load-module=ARG
770 -m ARG
771 -m=ARG
772 --no-load
773 Load a module in each test (after fork). The "import" method is not
774 called.
775 Can be specified multiple times
777 --load-import Module
779 --load-import Module=import_arg1,arg2,...
780 --loadim Module
781 --loadim Module=import_arg1,arg2,...
782 -M Module
783 -M Module=import_arg1,arg2,...
784 --no-load-import
785 Load a module in each test (after fork). Import is called.
786 Can be specified multiple times. If the same key is listed multiple
788 times the value lists will be appended together.
789 --mem-usage
791 --no-mem-usage
792 Use Test2::Plugin::MemUsage inside tests (default: on)
793 --retry ARG
795 --retry=ARG
796 -r ARG
797 -r=ARG
798 --no-retry
799 Run any jobs that failed a second time. NOTE: --retry=1 means
800 failing tests will be attempted twice!
801 --retry-isolated
803 --retry-iso
804 --no-retry-isolated
805 If true then any job retries will be done in isolation (as though
806 -j1 was set)
807 --run-id
809 --id
810 --no-run-id
811 Set a specific run-id. (Default: a UUID)
812 --test-args ARG
814 --test-args=ARG
815 --no-test-args
816 Arguments to pass in as @ARGV for all tests that are run. These can
817 be provided easier using the '::' argument separator.
818 Can be specified multiple times
820 --stream
822 --no-stream
823 Use the stream formatter (default is on)
824 --tap
826 --TAP
827 ----no-stream
828 --no-tap
829 The TAP format is lossy and clunky. Test2::Harness normally uses a
830 newer streaming format to receive test results. There are
831 old/legacy tests where this causes problems, in which case setting
832 --TAP or --no-stream can help.
833 YathUI Options
835 --yathui-api-key ARG
837 --yathui-api-key=ARG
838 --no-yathui-api-key
839 Yath-UI API key. This is not necessary if your Yath-UI instance is
840 set to single-user
841 --yathui-coverage
843 --no-yathui-coverage
844 Poll coverage data from Yath-UI to determine what tests should be
845 run for changed files
846 --yathui-db
848 --no-yathui-db
849 Add the YathUI DB renderer in addition to other renderers
850 --yathui-durations
852 --no-yathui-durations
853 Poll duration data from Yath-UI to help order tests efficiently
854 --yathui-grace
856 --no-yathui-grace
857 If yath cannot connect to yath-ui it normally throws an error, use
858 this to make it fail gracefully. You get a warning, but things keep
859 going.
860 --yathui-long-duration 10
862 --no-yathui-long-duration
863 Minimum duration length (seconds) before a test goes from MEDIUM to
864 LONG
865 --yathui-medium-duration 5
867 --no-yathui-medium-duration
868 Minimum duration length (seconds) before a test goes from SHORT to
869 MEDIUM
870 --yathui-mode summary
872 --yathui-mode qvf
873 --yathui-mode qvfd
874 --yathui-mode complete
875 --no-yathui-mode
876 Set the upload mode (default 'qvfd')
877 --yathui-only
879 --no-yathui-only
880 Only use the YathUI renderer
881 --yathui-only-db
883 --no-yathui-only-db
884 Only use the YathUI DB renderer
885 --yathui-port 8080
887 --no-yathui-port
888 Port to use when running a local server
889 --yathui-port-command get_port.sh
891 --yathui-port-command get_port.sh --pid $$
892 --no-yathui-port-command
893 Use a command to get a port number. "$$" will be replaced with the
894 PID of the yath process
895 --yathui-project ARG
897 --yathui-project=ARG
898 --no-yathui-project
899 The Yath-UI project for your test results
900 --yathui-render
902 --no-yathui-render
903 Add the YathUI renderer in addition to other renderers
904 --yathui-resources
906 --yathui-resources=5
907 --no-yathui-resources
908 Send resource info (for supported resources) to yathui at the
909 specified interval in seconds (5 if not specified)
910 --yathui-retry
912 --no-yathui-retry
913 How many times to try an operation before giving up
914 Can be specified multiple times
916 --yathui-schema PostgreSQL
918 --yathui-schema MySQL
919 --yathui-schema MySQL56
920 --no-yathui-schema
921 What type of DB/schema to use when using a temporary database
922 --yathui-upload
924 --no-yathui-upload
925 Upload the log to Yath-UI
926 --yathui-url http://my-yath-ui.com/...
928 --uri http://my-yath-ui.com/...
929 --no-yathui-url
930 Yath-UI url
931 --yathui-user ARG
933 --yathui-user=ARG
934 --no-yathui-user
935 Username to attach to the data sent to the db
936 --yathui-db-buffering none
938 --yathui-db-buffering job
939 --yathui-db-buffering diag
940 --yathui-db-buffering run
941 --no-yathui-db-buffering
942 Type of buffering to use, if "none" then events are written to the
943 db one at a time, which is SLOW
944 --yathui-db-config ARG
946 --yathui-db-config=ARG
947 --no-yathui-db-config
948 Module that implements 'MODULE->yath_ui_config(%params)' which
949 should return a Test2::Harness::UI::Config instance.
950 --yathui-db-coverage
952 --no-yathui-db-coverage
953 Pull coverage data directly from the database (default: off)
954 --yathui-db-driver Pg
956 --yathui-db-drivermysql
957 --yathui-db-driverMariaDB
958 --no-yathui-db-driver
959 DBI Driver to use
960 --yathui-db-dsn ARG
962 --yathui-db-dsn=ARG
963 --no-yathui-db-dsn
964 DSN to use when connecting to the db
965 --yathui-db-duration-limit ARG
967 --yathui-db-duration-limit=ARG
968 --no-yathui-db-duration-limit
969 Limit the number of runs to look at for durations data (default:
970 10)
971 --yathui-db-durations
973 --no-yathui-db-durations
974 Pull duration data directly from the database (default: off)
975 --yathui-db-flush-interval 2
977 --yathui-db-flush-interval 1.5
978 --no-yathui-db-flush-interval
979 When buffering DB writes, force a flush when an event is recieved
980 at least N seconds after the last flush.
981 --yathui-db-host ARG
983 --yathui-db-host=ARG
984 --no-yathui-db-host
985 hostname to use when connecting to the db
986 --yathui-db-name ARG
988 --yathui-db-name=ARG
989 --no-yathui-db-name
990 Name of the database to use for yathui
991 --yathui-db-pass ARG
993 --yathui-db-pass=ARG
994 --no-yathui-db-pass
995 Password to use when connecting to the db
996 --yathui-db-port ARG
998 --yathui-db-port=ARG
999 --no-yathui-db-port
1000 port to use when connecting to the db
1001 --yathui-db-publisher ARG
1003 --yathui-db-publisher=ARG
1004 --no-yathui-db-publisher
1005 When using coverage or duration data, only use data uploaded by
1006 this user
1007 --yathui-db-socket ARG
1009 --yathui-db-socket=ARG
1010 --no-yathui-db-socket
1011 socket to use when connecting to the db
1012 --yathui-db-user ARG
1014 --yathui-db-user=ARG
1015 --no-yathui-db-user
1016 Username to use when connecting to the db
1017 NO CATEGORY - FIX ME
1019 --check-reload-state
1021 --no-check-reload-state
1022 Abort the run if there are unfixes reload errors and show a
1023 confirmation dialogue for unfixed reload warnings.
1024
1026 The source code repository for Test2-Harness can be found at
1027 http://github.com/Test-More/Test2-Harness/.
1028
1030 Chad Granum <exodist@cpan.org>
1031
1033 Chad Granum <exodist@cpan.org>
1034
1036 Copyright 2023 Chad Granum <exodist7@gmail.com>.
1037 This program is free software; you can redistribute it and/or modify it
1039 under the same terms as Perl itself.
1040 See http://dev.perl.org/licenses/
1042perl v5.38.0 2023-10-04 App::Yath::Command::stop(3)