1App::Yath::Command::proUjseecrtsC(o3n)tributed Perl DocuAmpepn:t:aYtaitohn::Command::projects(3)
2
6 App::Yath::Command::projects - Run tests for multiple projects
7
9 This command will run all the tests for each project within a parent
10 directory.
11
13 $ yath [YATH OPTIONS] projects [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 it 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-maybe-from path/to/log.jsonl
155 --cover-maybe-from http://example.com/coverage
156 --cover-maybe-from path/to/coverage.jsonl
157 --no-cover-maybe-from
158 This can be a test log, a coverage dump (old style json or new
159 jsonl format), or a url to any of the previous. Tests will coninue
160 if even if the coverage file/url is invalid.
161 --cover-maybe-from-type json
163 --cover-maybe-from-type jsonl
164 --cover-maybe-from-type log
165 --no-cover-maybe-from-type
166 Same as "from_type" but for "maybe_from". Defaults to "from_type"
167 if that is specified, otherwise auto-detect
168 --cover-metrics
170 --no-cover-metrics
171 --cover-types ARG
172 --cover-types=ARG
173 --cover-type ARG
174 --cover-type=ARG
175 --no-cover-types
176 NO DESCRIPTION - FIX ME
177 Can be specified multiple times
179 --cover-write
181 --cover-write=coverage.jsonl
182 --cover-write=coverage.json
183 --no-cover-write
184 Create a json or jsonl file of all coverage data seen during the
185 run (This implies --cover-files).
186 Display Options
188 --color
190 --no-color
191 Turn color on, default is true if STDOUT is a TTY.
192 --no-wrap
194 --no-no-wrap
195 Do not do fancy text-wrapping, let the terminal handle it
196 --progress
198 --no-progress
199 Toggle progress indicators. On by default if STDOUT is a TTY. You
200 can use --no-progress to disable the 'events seen' counter and
201 buffered event pre-display
202 --quiet
204 -q
205 --no-quiet
206 Be very quiet.
207 Can be specified multiple times
209 --renderers +My::Renderer
211 --renderers Renderer=arg1,arg2,...
212 --renderer +My::Renderer
213 --renderer Renderer=arg1,arg2,...
214 --no-renderers
215 Specify renderers, (Default: "Formatter=Test2"). Use "+" to give a
216 fully qualified module name. Without "+"
217 "Test2::Harness::Renderer::" will be prepended to your argument.
218 Can be specified multiple times. If the same key is listed multiple
220 times the value lists will be appended together.
221 --show-times
223 -T
224 --no-show-times
225 Show the timing data for each job
226 --term-width 80
228 --term-width 200
229 --term-size 80
230 --term-size 200
231 --no-term-width
232 Alternative to setting $TABLE_TERM_SIZE. Setting this will override
233 the terminal width detection to the number of characters specified.
234 --verbose
236 -v
237 --no-verbose
238 Be more verbose
239 Can be specified multiple times
241 Finder Options
243 --default-at-search ARG
245 --default-at-search=ARG
246 --no-default-at-search
247 Specify the default file/dir search when 'AUTHOR_TESTING' is set.
248 Defaults to './xt'. The default AT search is only used if no files
249 were specified at the command line
250 Can be specified multiple times
252 --default-search ARG
254 --default-search=ARG
255 --no-default-search
256 Specify the default file/dir search. defaults to './t', './t2', and
257 'test.pl'. The default search is only used if no files were
258 specified at the command line
259 Can be specified multiple times
261 --durations file.json
263 --durations http://example.com/durations.json
264 --no-durations
265 Point at a json file or url which has a hash of relative test
266 filenames as keys, and 'SHORT', 'MEDIUM', or 'LONG' as values. This
267 will override durations listed in the file headers. An exception
268 will be thrown if the durations file or url does not work.
269 --exclude-file t/nope.t
271 --no-exclude-file
272 Exclude a file from testing
273 Can be specified multiple times
275 --exclude-list file.txt
277 --exclude-list http://example.com/exclusions.txt
278 --no-exclude-list
279 Point at a file or url which has a new line separated list of test
280 file names to exclude from testing. Starting a line with a '#' will
281 comment it out (for compatibility with Test2::Aggregate list
282 files).
283 Can be specified multiple times
285 --exclude-pattern t/nope.t
287 --no-exclude-pattern
288 Exclude a pattern from testing, matched using m/$PATTERN/
289 Can be specified multiple times
291 --extension ARG
293 --extension=ARG
294 --ext ARG
295 --ext=ARG
296 --no-extension
297 Specify valid test filename extensions, default: t and t2
298 Can be specified multiple times
300 --maybe-durations file.json
302 --maybe-durations http://example.com/durations.json
303 --no-maybe-durations
304 Point at a json file or url which has a hash of relative test
305 filenames as keys, and 'SHORT', 'MEDIUM', or 'LONG' as values. This
306 will override durations listed in the file headers. An exception
307 will be thrown if the durations file or url does not work.
308 --no-long
310 --no-no-long
311 Do not run tests that have their duration flag set to 'LONG'
312 --only-long
314 --no-only-long
315 Only run tests that have their duration flag set to 'LONG'
316 --search ARG
318 --search=ARG
319 --no-search
320 List of tests and test directories to use instead of the default
321 search paths. Typically these can simply be listed as command line
322 arguments without the --search prefix.
323 Can be specified multiple times
325 Formatter Options
327 --formatter ARG
329 --formatter=ARG
330 --no-formatter
331 NO DESCRIPTION - FIX ME
332 --qvf
334 --no-qvf
335 [Q]uiet, but [V]erbose on [F]ailure. Hide all output from tests
336 when they pass, except to say they passed. If a test fails then ALL
337 output from the test is verbosely output.
338 --show-job-end
340 --no-show-job-end
341 Show output when a job ends. (Default: on)
342 --show-job-info
344 --no-show-job-info
345 Show the job configuration when a job starts. (Default: off, unless
346 -vv)
347 --show-job-launch
349 --no-show-job-launch
350 Show output for the start of a job. (Default: off unless -v)
351 --show-run-info
353 --no-show-run-info
354 Show the run configuration when a run starts. (Default: off, unless
355 -vv)
356 Git Options
358 --git-change-base master
360 --git-change-base HEAD^
361 --git-change-base df22abe4
362 --no-git-change-base
363 Find files changed by all commits in the current branch from most
364 recent stopping when a commit is found that is also present in the
365 history of the branch/commit specified as the change base.
366 Help and Debugging
368 --dummy
370 -d
371 --no-dummy
372 Dummy run, do not actually execute anything
373 Can also be set with the following environment variables:
375 "T2_HARNESS_DUMMY"
376 --help
378 -h
379 --no-help
380 exit after showing help information
381 --interactive
383 -i
384 --no-interactive
385 Use interactive mode, 1 test at a time, stdin forwarded to it
386 --keep-dirs
388 --keep_dir
389 -k
390 --no-keep-dirs
391 Do not delete directories when done. This is useful if you want to
392 inspect the directories used for various commands.
393 --summary
395 --summary=/path/to/summary.json
396 --no-summary
397 Write out a summary json file, if no path is provided
398 'summary.json' will be used. The .json extension is added
399 automatically if omitted.
400 Logging Options
402 --bzip2
404 --bz2
405 --bzip2_log
406 -B
407 --no-bzip2
408 Use bzip2 compression when writing the log. This option implies -L.
409 The .bz2 prefix is added to log file name for you
410 --gzip
412 --gz
413 --gzip_log
414 -G
415 --no-gzip
416 Use gzip compression when writing the log. This option implies -L.
417 The .gz prefix is added to log file name for you
418 --log
420 -L
421 --no-log
422 Turn on logging
423 --log-dir ARG
425 --log-dir=ARG
426 --no-log-dir
427 Specify a log directory. Will fall back to the system temp dir.
428 --log-file ARG
430 --log-file=ARG
431 -F ARG
432 -F=ARG
433 --no-log-file
434 Specify the name of the log file. This option implies -L.
435 --log-file-format ARG
437 --log-file-format=ARG
438 --lff ARG
439 --lff=ARG
440 --no-log-file-format
441 Specify the format for automatically-generated log files.
442 Overridden by --log-file, if given. This option implies -L
443 (Default: \$YATH_LOG_FILE_FORMAT, if that is set, or else
444 "%!P%Y-%m-%d~%H:%M:%S~%!U~%!p.jsonl"). This is a string in which
445 percent-escape sequences will be replaced as per POSIX::strftime.
446 The following special escape sequences are also replaced: (%!P :
447 Project name followed by a ~, if a project is defined, otherwise
448 empty string) (%!U : the unique test run ID) (%!p : the process ID)
449 (%!S : the number of seconds since local midnight UTC)
450 Can also be set with the following environment variables:
452 "YATH_LOG_FILE_FORMAT", "TEST2_HARNESS_LOG_FORMAT"
453 Notification Options
455 --notify-email foo@example.com
457 --no-notify-email
458 Email the test results to the specified email address(es)
459 Can be specified multiple times
461 --notify-email-fail foo@example.com
463 --no-notify-email-fail
464 Email failing results to the specified email address(es)
465 Can be specified multiple times
467 --notify-email-from foo@example.com
469 --no-notify-email-from
470 If any email is sent, this is who it will be from
471 --notify-email-owner
473 --no-notify-email-owner
474 Email the owner of broken tests files upon failure. Add `# HARNESS-
475 META-OWNER foo@example.com` to the top of a test file to give it an
476 owner
477 --notify-no-batch-email
479 --no-notify-no-batch-email
480 Usually owner failures are sent as a single batch at the end of
481 testing. Toggle this to send failures as they happen.
482 --notify-no-batch-slack
484 --no-notify-no-batch-slack
485 Usually owner failures are sent as a single batch at the end of
486 testing. Toggle this to send failures as they happen.
487 --notify-slack '#foo'
489 --notify-slack '@bar'
490 --no-notify-slack
491 Send results to a slack channel and/or user
492 Can be specified multiple times
494 --notify-slack-fail '#foo'
496 --notify-slack-fail '@bar'
497 --no-notify-slack-fail
498 Send failing results to a slack channel and/or user
499 Can be specified multiple times
501 --notify-slack-owner
503 --no-notify-slack-owner
504 Send slack notifications to the slack channels/users listed in test
505 meta-data when tests fail.
506 --notify-slack-url https://hooks.slack.com/...
508 --no-notify-slack-url
509 Specify an API endpoint for slack webhook integrations
510 --notify-text ARG
512 --notify-text=ARG
513 --message ARG
514 --message=ARG
515 --msg ARG
516 --msg=ARG
517 --no-notify-text
518 Add a custom text snippet to email/slack notifications
519 --notify-text-module ARG
521 --notify-text-module=ARG
522 --message_module ARG
523 --message_module=ARG
524 --no-notify-text-module
525 Use the specified module to generate messages for emails and/or
526 slack.
527 Run Options
529 --author-testing
531 -A
532 --no-author-testing
533 This will set the AUTHOR_TESTING environment to true
534 --dbi-profiling
536 --no-dbi-profiling
537 Use Test2::Plugin::DBIProfile to collect database profiling data
538 --env-var VAR=VAL
540 -EVAR=VAL
541 -E VAR=VAL
542 --no-env-var
543 Set environment variables to set when each test is run.
544 Can be specified multiple times
546 --event-uuids
548 --uuids
549 --no-event-uuids
550 Use Test2::Plugin::UUID inside tests (default: on)
551 --fields name:details
553 --fields JSON_STRING
554 -f name:details
555 -f JSON_STRING
556 --no-fields
557 Add custom data to the harness run
558 Can be specified multiple times
560 --input ARG
562 --input=ARG
563 --no-input
564 Input string to be used as standard input for ALL tests. See also:
565 --input-file
566 --input-file ARG
568 --input-file=ARG
569 --no-input-file
570 Use the specified file as standard input to ALL tests
571 --io-events
573 --no-io-events
574 Use Test2::Plugin::IOEvents inside tests to turn all prints into
575 test2 events (default: off)
576 --link 'https://travis.work/builds/42'
578 --link 'https://jenkins.work/job/42'
579 --link 'https://buildbot.work/builders/foo/builds/42'
580 --no-link
581 Provide one or more links people can follow to see more about this
582 run.
583 Can be specified multiple times
585 --load ARG
587 --load=ARG
588 --load-module ARG
589 --load-module=ARG
590 -m ARG
591 -m=ARG
592 --no-load
593 Load a module in each test (after fork). The "import" method is not
594 called.
595 Can be specified multiple times
597 --load-import Module
599 --load-import Module=import_arg1,arg2,...
600 --loadim Module
601 --loadim Module=import_arg1,arg2,...
602 -M Module
603 -M Module=import_arg1,arg2,...
604 --no-load-import
605 Load a module in each test (after fork). Import is called.
606 Can be specified multiple times. If the same key is listed multiple
608 times the value lists will be appended together.
609 --mem-usage
611 --no-mem-usage
612 Use Test2::Plugin::MemUsage inside tests (default: on)
613 --retry ARG
615 --retry=ARG
616 -r ARG
617 -r=ARG
618 --no-retry
619 Run any jobs that failed a second time. NOTE: --retry=1 means
620 failing tests will be attempted twice!
621 --retry-isolated
623 --retry-iso
624 --no-retry-isolated
625 If true then any job retries will be done in isolation (as though
626 -j1 was set)
627 --run-id
629 --id
630 --no-run-id
631 Set a specific run-id. (Default: a UUID)
632 --test-args ARG
634 --test-args=ARG
635 --no-test-args
636 Arguments to pass in as @ARGV for all tests that are run. These can
637 be provided easier using the '::' argument separator.
638 Can be specified multiple times
640 --stream
642 --no-stream
643 Use the stream formatter (default is on)
644 --tap
646 --TAP
647 ----no-stream
648 --no-tap
649 The TAP format is lossy and clunky. Test2::Harness normally uses a
650 newer streaming format to receive test results. There are
651 old/legacy tests where this causes problems, in which case setting
652 --TAP or --no-stream can help.
653 Runner Options
655 --abort-on-bail
657 --no-abort-on-bail
658 Abort all testing if a bail-out is encountered (default: on)
659 --blib
661 -b
662 --no-blib
663 (Default: include if it exists) Include 'blib/lib' and 'blib/arch'
664 in your module path
665 --cover
667 --cover=-silent,1,+ignore,^t/,+ignore,^t2/,+ignore,^xt,+ignore,^test.pl
668 --no-cover
669 Use Devel::Cover to calculate test coverage. This disables forking.
670 If no args are specified the following are used:
671 -silent,1,+ignore,^t/,+ignore,^t2/,+ignore,^xt,+ignore,^test.pl
672 --dump-depmap
674 --no-dump-depmap
675 When using staged preload, dump the depmap for each stage as json
676 files
677 --event-timeout SECONDS
679 --et SECONDS
680 --no-event-timeout
681 Kill test if no output is received within timeout period. (Default:
682 60 seconds). Add the "# HARNESS-NO-TIMEOUT" comment to the top of a
683 test file to disable timeouts on a per-test basis. This prevents a
684 hung test from running forever.
685 --include ARG
687 --include=ARG
688 -I ARG
689 -I=ARG
690 --no-include
691 Add a directory to your include paths
692 Can be specified multiple times
694 --job-count ARG
696 --job-count=ARG
697 --jobs ARG
698 --jobs=ARG
699 -j ARG
700 -j=ARG
701 --no-job-count
702 Set the number of concurrent jobs to run (Default: 1)
703 Can also be set with the following environment variables:
705 "YATH_JOB_COUNT", "T2_HARNESS_JOB_COUNT", "HARNESS_JOB_COUNT"
706 --lib
708 -l
709 --no-lib
710 (Default: include if it exists) Include 'lib' in your module path
711 --nytprof
713 --no-nytprof
714 Use Devel::NYTProf on tests. This will set addpid=1 for you. This
715 works with or without fork.
716 --post-exit-timeout SECONDS
718 --pet SECONDS
719 --no-post-exit-timeout
720 Stop waiting post-exit after the timeout period. (Default: 15
721 seconds) Some tests fork and allow the parent to exit before
722 writing all their output. If Test2::Harness detects an incomplete
723 plan after the test exits it will monitor for more events until the
724 timeout period. Add the "# HARNESS-NO-TIMEOUT" comment to the top
725 of a test file to disable timeouts on a per-test basis.
726 --preload-threshold ARG
728 --preload-threshold=ARG
729 --Pt ARG
730 --Pt=ARG
731 -W ARG
732 -W=ARG
733 --no-preload-threshold
734 Only do preload if at least N tests are going to be run. In some
735 cases a full preload takes longer than simply running the tests,
736 this lets you specify a minimum number of test jobs that will be
737 run for preload to happen. This has no effect for a persistent
738 runner. The default is 0, and it means always preload.
739 --preloads ARG
741 --preloads=ARG
742 --preload ARG
743 --preload=ARG
744 -P ARG
745 -P=ARG
746 --no-preloads
747 Preload a module before running tests
748 Can be specified multiple times
750 --resource Port
752 --resource +Test2::Harness::Runner::Resource::Port
753 -R Port
754 --no-resource
755 Use a resource module to assign resource assignments to individual
756 tests
757 Can be specified multiple times
759 --switch ARG
761 --switch=ARG
762 -S ARG
763 -S=ARG
764 --no-switch
765 Pass the specified switch to perl for each test. This is not
766 compatible with preload.
767 Can be specified multiple times
769 --tlib
771 --no-tlib
772 (Default: off) Include 't/lib' in your module path
773 --unsafe-inc
775 --no-unsafe-inc
776 perl is removing '.' from @INC as a security concern. This option
777 keeps things from breaking for now.
778 Can also be set with the following environment variables:
780 "PERL_USE_UNSAFE_INC"
781 --use-fork
783 --fork
784 --no-use-fork
785 (default: on, except on windows) Normally tests are run by forking,
786 which allows for features like preloading. This will turn off the
787 behavior globally (which is not compatible with preloading). This
788 is slower, it is better to tag misbehaving tests with the '#
789 HARNESS-NO-PRELOAD' comment in their header to disable forking only
790 for those tests.
791 Can also be set with the following environment variables:
793 "!T2_NO_FORK", "T2_HARNESS_FORK", "!T2_HARNESS_NO_FORK",
794 "YATH_FORK", "!YATH_NO_FORK"
795 --use-timeout
797 --timeout
798 --no-use-timeout
799 (default: on) Enable/disable timeouts
800 Workspace Options
802 --clear
804 -C
805 --no-clear
806 Clear the work directory if it is not already empty
807 --tmp-dir ARG
809 --tmp-dir=ARG
810 --tmpdir ARG
811 --tmpdir=ARG
812 -t ARG
813 -t=ARG
814 --no-tmp-dir
815 Use a specific temp directory (Default: use system temp dir)
816 Can also be set with the following environment variables:
818 "T2_HARNESS_TEMP_DIR", "YATH_TEMP_DIR", "TMPDIR", "TEMPDIR",
819 "TMP_DIR", "TEMP_DIR"
820 --workdir ARG
822 --workdir=ARG
823 -w ARG
824 -w=ARG
825 --no-workdir
826 Set the work directory (Default: new temp directory)
827 Can also be set with the following environment variables:
829 "T2_WORKDIR", "YATH_WORKDIR"
830 YathUI Options
832 --yathui-api-key ARG
834 --yathui-api-key=ARG
835 --no-yathui-api-key
836 Yath-UI API key. This is not necessary if your Yath-UI instance is
837 set to single-user
838 --yathui-coverage
840 --no-yathui-coverage
841 Poll coverage data from Yath-UI to determine what tests should be
842 run for changed files
843 --yathui-db
845 --no-yathui-db
846 Add the YathUI DB renderer in addition to other renderers
847 --yathui-durations
849 --no-yathui-durations
850 Poll duration data from Yath-UI to help order tests efficiently
851 --yathui-grace
853 --no-yathui-grace
854 If yath cannot connect to yath-ui it normally throws an error, use
855 this to make it fail gracefully. You get a warning, but things keep
856 going.
857 --yathui-long-duration 10
859 --no-yathui-long-duration
860 Minimum duration length (seconds) before a test goes from MEDIUM to
861 LONG
862 --yathui-medium-duration 5
864 --no-yathui-medium-duration
865 Minimum duration length (seconds) before a test goes from SHORT to
866 MEDIUM
867 --yathui-mode summary
869 --yathui-mode qvf
870 --yathui-mode qvfd
871 --yathui-mode complete
872 --no-yathui-mode
873 Set the upload mode (default 'qvfd')
874 --yathui-only
876 --no-yathui-only
877 Only use the YathUI renderer
878 --yathui-only-db
880 --no-yathui-only-db
881 Only use the YathUI DB renderer
882 --yathui-port 8080
884 --no-yathui-port
885 Port to use when running a local server
886 --yathui-port-command get_port.sh
888 --yathui-port-command get_port.sh --pid $$
889 --no-yathui-port-command
890 Use a command to get a port number. "$$" will be replaced with the
891 PID of the yath process
892 --yathui-project ARG
894 --yathui-project=ARG
895 --no-yathui-project
896 The Yath-UI project for your test results
897 --yathui-render
899 --no-yathui-render
900 Add the YathUI renderer in addition to other renderers
901 --yathui-retry
903 --no-yathui-retry
904 How many times to try an operation before giving up
905 Can be specified multiple times
907 --yathui-schema PostgreSQL
909 --yathui-schema MySQL
910 --yathui-schema MySQL56
911 --no-yathui-schema
912 What type of DB/schema to use when using a temporary database
913 --yathui-upload
915 --no-yathui-upload
916 Upload the log to Yath-UI
917 --yathui-url http://my-yath-ui.com/...
919 --uri http://my-yath-ui.com/...
920 --no-yathui-url
921 Yath-UI url
922 --yathui-user ARG
924 --yathui-user=ARG
925 --no-yathui-user
926 Username to attach to the data sent to the db
927 --yathui-db-buffering none
929 --yathui-db-buffering job
930 --yathui-db-buffering diag
931 --yathui-db-buffering run
932 --no-yathui-db-buffering
933 Type of buffering to use, if "none" then events are written to the
934 db one at a time, which is SLOW
935 --yathui-db-config ARG
937 --yathui-db-config=ARG
938 --no-yathui-db-config
939 Module that implements 'MODULE->yath_ui_config(%params)' which
940 should return a Test2::Harness::UI::Config instance.
941 --yathui-db-coverage
943 --no-yathui-db-coverage
944 Pull coverage data directly from the database (default: off)
945 --yathui-db-driver Pg
947 --yathui-db-drivermysql
948 --yathui-db-driverMariaDB
949 --no-yathui-db-driver
950 DBI Driver to use
951 --yathui-db-dsn ARG
953 --yathui-db-dsn=ARG
954 --no-yathui-db-dsn
955 DSN to use when connecting to the db
956 --yathui-db-durations
958 --no-yathui-db-durations
959 Pull duration data directly from the database (default: off)
960 --yathui-db-flush-interval 2
962 --yathui-db-flush-interval 1.5
963 --no-yathui-db-flush-interval
964 When buffering DB writes, force a flush when an event is recieved
965 at least N seconds after the last flush.
966 --yathui-db-host ARG
968 --yathui-db-host=ARG
969 --no-yathui-db-host
970 hostname to use when connecting to the db
971 --yathui-db-name ARG
973 --yathui-db-name=ARG
974 --no-yathui-db-name
975 Name of the database to use for yathui
976 --yathui-db-pass ARG
978 --yathui-db-pass=ARG
979 --no-yathui-db-pass
980 Password to use when connecting to the db
981 --yathui-db-port ARG
983 --yathui-db-port=ARG
984 --no-yathui-db-port
985 port to use when connecting to the db
986 --yathui-db-publisher ARG
988 --yathui-db-publisher=ARG
989 --no-yathui-db-publisher
990 When using coverage or duration data, only use data uploaded by
991 this user
992 --yathui-db-socket ARG
994 --yathui-db-socket=ARG
995 --no-yathui-db-socket
996 socket to use when connecting to the db
997 --yathui-db-user ARG
999 --yathui-db-user=ARG
1000 --no-yathui-db-user
1001 Username to use when connecting to the db
1002
1004 The source code repository for Test2-Harness can be found at
1005 http://github.com/Test-More/Test2-Harness/.
1006
1008 Chad Granum <exodist@cpan.org>
1009
1011 Chad Granum <exodist@cpan.org>
1012
1014 Copyright 2021 Chad Granum <exodist7@gmail.com>.
1015 This program is free software; you can redistribute it and/or modify it
1017 under the same terms as Perl itself.
1018 See http://dev.perl.org/licenses/
1020perl v5.34.0 2021-11-05 App::Yath::Command::projects(3)