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 Collector Options
105 --max-open-jobs 18
107 --no-max-open-jobs
108 Maximum number of jobs a collector can process at a time, if more
109 jobs are pending their output will be delayed until the earlier
110 jobs have been processed. (Default: double the -j value)
111 --max-poll-events 1000
113 --no-max-poll-events
114 Maximum number of events to poll from a job before jumping to the
115 next job. (Default: 1000)
116 Cover Options
118 --cover-aggregator ByTest
120 --cover-aggregator ByRun
121 --cover-aggregator +Custom::Aggregator
122 --cover-agg ByTest
123 --cover-agg ByRun
124 --cover-agg +Custom::Aggregator
125 --no-cover-aggregator
126 Choose a custom aggregator subclass
127 --cover-class ARG
129 --cover-class=ARG
130 --no-cover-class
131 Choose a Test2::Plugin::Cover subclass
132 --cover-dirs ARG
134 --cover-dirs=ARG
135 --cover-dir ARG
136 --cover-dir=ARG
137 --no-cover-dirs
138 NO DESCRIPTION - FIX ME
139 Can be specified multiple times
141 --cover-exclude-private
143 --no-cover-exclude-private
144 --cover-files
145 --no-cover-files
146 Use Test2::Plugin::Cover to collect coverage data for what files
147 are touched by what tests. Unlike Devel::Cover this has very little
148 performance impact (About 4% difference)
149 --cover-from path/to/log.jsonl
151 --cover-from http://example.com/coverage
152 --cover-from path/to/coverage.jsonl
153 --no-cover-from
154 This can be a test log, a coverage dump (old style json or new
155 jsonl format), or a url to any of the previous. Tests will not be
156 run if the file/url is invalid.
157 --cover-from-type json
159 --cover-from-type jsonl
160 --cover-from-type log
161 --no-cover-from-type
162 File type for coverage source. Usually it can be detected, but when
163 it cannot be you should specify. "json" is old style single-blob
164 coverage data, "jsonl" is the new by-test style, "log" is a logfile
165 from a previous run.
166 --cover-maybe-from path/to/log.jsonl
168 --cover-maybe-from http://example.com/coverage
169 --cover-maybe-from path/to/coverage.jsonl
170 --no-cover-maybe-from
171 This can be a test log, a coverage dump (old style json or new
172 jsonl format), or a url to any of the previous. Tests will coninue
173 if even if the coverage file/url is invalid.
174 --cover-maybe-from-type json
176 --cover-maybe-from-type jsonl
177 --cover-maybe-from-type log
178 --no-cover-maybe-from-type
179 Same as "from_type" but for "maybe_from". Defaults to "from_type"
180 if that is specified, otherwise auto-detect
181 --cover-metrics
183 --no-cover-metrics
184 --cover-types ARG
185 --cover-types=ARG
186 --cover-type ARG
187 --cover-type=ARG
188 --no-cover-types
189 NO DESCRIPTION - FIX ME
190 Can be specified multiple times
192 --cover-write
194 --cover-write=coverage.jsonl
195 --cover-write=coverage.json
196 --no-cover-write
197 Create a json or jsonl file of all coverage data seen during the
198 run (This implies --cover-files).
199 Display Options
201 --color
203 --no-color
204 Turn color on, default is true if STDOUT is a TTY.
205 --hide-runner-output
207 --no-hide-runner-output
208 Hide output from the runner, showing only test output. (See Also
209 truncate_runner_output)
210 --no-wrap
212 --no-no-wrap
213 Do not do fancy text-wrapping, let the terminal handle it
214 --progress
216 --no-progress
217 Toggle progress indicators. On by default if STDOUT is a TTY. You
218 can use --no-progress to disable the 'events seen' counter and
219 buffered event pre-display
220 --quiet
222 -q
223 --no-quiet
224 Be very quiet.
225 Can be specified multiple times
227 --renderers +My::Renderer
229 --renderers Renderer=arg1,arg2,...
230 --renderer +My::Renderer
231 --renderer Renderer=arg1,arg2,...
232 --no-renderers
233 Specify renderers, (Default: "Formatter=Test2"). Use "+" to give a
234 fully qualified module name. Without "+"
235 "Test2::Harness::Renderer::" will be prepended to your argument.
236 Can be specified multiple times. If the same key is listed multiple
238 times the value lists will be appended together.
239 --show-times
241 -T
242 --no-show-times
243 Show the timing data for each job
244 --term-width 80
246 --term-width 200
247 --term-size 80
248 --term-size 200
249 --no-term-width
250 Alternative to setting $TABLE_TERM_SIZE. Setting this will override
251 the terminal width detection to the number of characters specified.
252 --truncate-runner-output
254 --no-truncate-runner-output
255 Only show runner output that was generated after the current
256 command. This is only useful with a persistent runner.
257 --verbose
259 -v
260 --no-verbose
261 Be more verbose
262 Can be specified multiple times
264 Finder Options
266 --default-at-search ARG
268 --default-at-search=ARG
269 --no-default-at-search
270 Specify the default file/dir search when 'AUTHOR_TESTING' is set.
271 Defaults to './xt'. The default AT search is only used if no files
272 were specified at the command line
273 Can be specified multiple times
275 --default-search ARG
277 --default-search=ARG
278 --no-default-search
279 Specify the default file/dir search. defaults to './t', './t2', and
280 'test.pl'. The default search is only used if no files were
281 specified at the command line
282 Can be specified multiple times
284 --durations file.json
286 --durations http://example.com/durations.json
287 --no-durations
288 Point at a json file or url which has a hash of relative test
289 filenames as keys, and 'SHORT', 'MEDIUM', or 'LONG' as values. This
290 will override durations listed in the file headers. An exception
291 will be thrown if the durations file or url does not work.
292 --durations-threshold ARG
294 --durations-threshold=ARG
295 --Dt ARG
296 --Dt=ARG
297 --no-durations-threshold
298 Only fetch duration data if running at least this number of tests.
299 Default (-j value + 1)
300 --exclude-file t/nope.t
302 --no-exclude-file
303 Exclude a file from testing
304 Can be specified multiple times
306 --exclude-list file.txt
308 --exclude-list http://example.com/exclusions.txt
309 --no-exclude-list
310 Point at a file or url which has a new line separated list of test
311 file names to exclude from testing. Starting a line with a '#' will
312 comment it out (for compatibility with Test2::Aggregate list
313 files).
314 Can be specified multiple times
316 --exclude-pattern t/nope.t
318 --no-exclude-pattern
319 Exclude a pattern from testing, matched using m/$PATTERN/
320 Can be specified multiple times
322 --extension ARG
324 --extension=ARG
325 --ext ARG
326 --ext=ARG
327 --no-extension
328 Specify valid test filename extensions, default: t and t2
329 Can be specified multiple times
331 --maybe-durations file.json
333 --maybe-durations http://example.com/durations.json
334 --no-maybe-durations
335 Point at a json file or url which has a hash of relative test
336 filenames as keys, and 'SHORT', 'MEDIUM', or 'LONG' as values. This
337 will override durations listed in the file headers. An exception
338 will be thrown if the durations file or url does not work.
339 --no-long
341 --no-no-long
342 Do not run tests that have their duration flag set to 'LONG'
343 --only-long
345 --no-only-long
346 Only run tests that have their duration flag set to 'LONG'
347 --rerun
349 --rerun=path/to/log.jsonl
350 --rerun=plugin_specific_string
351 --no-rerun
352 Re-Run tests from a previous run from a log file (or last log
353 file). Plugins can intercept this, such as YathUIDB which will grab
354 a run UUID and derive tests to re-run from that.
355 --rerun-failed
357 --rerun-failed=path/to/log.jsonl
358 --rerun-failed=plugin_specific_string
359 --no-rerun-failed
360 Re-Run failed tests from a previous run from a log file (or last
361 log file). Plugins can intercept this, such as YathUIDB which will
362 grab a run UUID and derive tests to re-run from that.
363 --rerun-plugin Foo
365 --rerun-plugin +App::Yath::Plugin::Foo
366 --no-rerun-plugin
367 What plugin(s) should be used for rerun (will fallback to other
368 plugins if the listed ones decline the value, this is just used ot
369 set an order of priority)
370 Can be specified multiple times
372 --search ARG
374 --search=ARG
375 --no-search
376 List of tests and test directories to use instead of the default
377 search paths. Typically these can simply be listed as command line
378 arguments without the --search prefix.
379 Can be specified multiple times
381 Formatter Options
383 --formatter ARG
385 --formatter=ARG
386 --no-formatter
387 NO DESCRIPTION - FIX ME
388 --qvf
390 --no-qvf
391 [Q]uiet, but [V]erbose on [F]ailure. Hide all output from tests
392 when they pass, except to say they passed. If a test fails then ALL
393 output from the test is verbosely output.
394 --show-job-end
396 --no-show-job-end
397 Show output when a job ends. (Default: on)
398 --show-job-info
400 --no-show-job-info
401 Show the job configuration when a job starts. (Default: off, unless
402 -vv)
403 --show-job-launch
405 --no-show-job-launch
406 Show output for the start of a job. (Default: off unless -v)
407 --show-run-info
409 --no-show-run-info
410 Show the run configuration when a run starts. (Default: off, unless
411 -vv)
412 Git Options
414 --git-change-base master
416 --git-change-base HEAD^
417 --git-change-base df22abe4
418 --no-git-change-base
419 Find files changed by all commits in the current branch from most
420 recent stopping when a commit is found that is also present in the
421 history of the branch/commit specified as the change base.
422 Help and Debugging
424 --dummy
426 -d
427 --no-dummy
428 Dummy run, do not actually execute anything
429 Can also be set with the following environment variables:
431 "T2_HARNESS_DUMMY"
432 --help
434 -h
435 --no-help
436 exit after showing help information
437 --interactive
439 -i
440 --no-interactive
441 Use interactive mode, 1 test at a time, stdin forwarded to it
442 --keep-dirs
444 --keep_dir
445 -k
446 --no-keep-dirs
447 Do not delete directories when done. This is useful if you want to
448 inspect the directories used for various commands.
449 --procname-prefix ARG
451 --procname-prefix=ARG
452 --no-procname-prefix
453 Add a prefix to all proc names (as seen by ps).
454 --summary
456 --summary=/path/to/summary.json
457 --no-summary
458 Write out a summary json file, if no path is provided
459 'summary.json' will be used. The .json extension is added
460 automatically if omitted.
461 Logging Options
463 --bzip2
465 --bz2
466 --bzip2_log
467 -B
468 --no-bzip2
469 Use bzip2 compression when writing the log. This option implies -L.
470 The .bz2 prefix is added to log file name for you
471 --gzip
473 --gz
474 --gzip_log
475 -G
476 --no-gzip
477 Use gzip compression when writing the log. This option implies -L.
478 The .gz prefix is added to log file name for you
479 --log
481 -L
482 --no-log
483 Turn on logging
484 --log-dir ARG
486 --log-dir=ARG
487 --no-log-dir
488 Specify a log directory. Will fall back to the system temp dir.
489 --log-file ARG
491 --log-file=ARG
492 -F ARG
493 -F=ARG
494 --no-log-file
495 Specify the name of the log file. This option implies -L.
496 --log-file-format ARG
498 --log-file-format=ARG
499 --lff ARG
500 --lff=ARG
501 --no-log-file-format
502 Specify the format for automatically-generated log files.
503 Overridden by --log-file, if given. This option implies -L
504 (Default: \$YATH_LOG_FILE_FORMAT, if that is set, or else
505 "%!P%Y-%m-%d~%H:%M:%S~%!U~%!p.jsonl"). This is a string in which
506 percent-escape sequences will be replaced as per POSIX::strftime.
507 The following special escape sequences are also replaced: (%!P :
508 Project name followed by a ~, if a project is defined, otherwise
509 empty string) (%!U : the unique test run ID) (%!p : the process ID)
510 (%!S : the number of seconds since local midnight UTC)
511 Can also be set with the following environment variables:
513 "YATH_LOG_FILE_FORMAT", "TEST2_HARNESS_LOG_FORMAT"
514 Notification Options
516 --notify-email foo@example.com
518 --no-notify-email
519 Email the test results to the specified email address(es)
520 Can be specified multiple times
522 --notify-email-fail foo@example.com
524 --no-notify-email-fail
525 Email failing results to the specified email address(es)
526 Can be specified multiple times
528 --notify-email-from foo@example.com
530 --no-notify-email-from
531 If any email is sent, this is who it will be from
532 --notify-email-owner
534 --no-notify-email-owner
535 Email the owner of broken tests files upon failure. Add `# HARNESS-
536 META-OWNER foo@example.com` to the top of a test file to give it an
537 owner
538 --notify-no-batch-email
540 --no-notify-no-batch-email
541 Usually owner failures are sent as a single batch at the end of
542 testing. Toggle this to send failures as they happen.
543 --notify-no-batch-slack
545 --no-notify-no-batch-slack
546 Usually owner failures are sent as a single batch at the end of
547 testing. Toggle this to send failures as they happen.
548 --notify-slack '#foo'
550 --notify-slack '@bar'
551 --no-notify-slack
552 Send results to a slack channel and/or user
553 Can be specified multiple times
555 --notify-slack-fail '#foo'
557 --notify-slack-fail '@bar'
558 --no-notify-slack-fail
559 Send failing results to a slack channel and/or user
560 Can be specified multiple times
562 --notify-slack-owner
564 --no-notify-slack-owner
565 Send slack notifications to the slack channels/users listed in test
566 meta-data when tests fail.
567 --notify-slack-url https://hooks.slack.com/...
569 --no-notify-slack-url
570 Specify an API endpoint for slack webhook integrations
571 --notify-text ARG
573 --notify-text=ARG
574 --message ARG
575 --message=ARG
576 --msg ARG
577 --msg=ARG
578 --no-notify-text
579 Add a custom text snippet to email/slack notifications
580 --notify-text-module ARG
582 --notify-text-module=ARG
583 --message_module ARG
584 --message_module=ARG
585 --no-notify-text-module
586 Use the specified module to generate messages for emails and/or
587 slack.
588 Run Options
590 --author-testing
592 -A
593 --no-author-testing
594 This will set the AUTHOR_TESTING environment to true
595 --dbi-profiling
597 --no-dbi-profiling
598 Use Test2::Plugin::DBIProfile to collect database profiling data
599 --env-var VAR=VAL
601 -EVAR=VAL
602 -E VAR=VAL
603 --no-env-var
604 Set environment variables to set when each test is run.
605 Can be specified multiple times
607 --event-uuids
609 --uuids
610 --no-event-uuids
611 Use Test2::Plugin::UUID inside tests (default: on)
612 --fields name:details
614 --fields JSON_STRING
615 -f name:details
616 -f JSON_STRING
617 --no-fields
618 Add custom data to the harness run
619 Can be specified multiple times
621 --input ARG
623 --input=ARG
624 --no-input
625 Input string to be used as standard input for ALL tests. See also:
626 --input-file
627 --input-file ARG
629 --input-file=ARG
630 --no-input-file
631 Use the specified file as standard input to ALL tests
632 --io-events
634 --no-io-events
635 Use Test2::Plugin::IOEvents inside tests to turn all prints into
636 test2 events (default: off)
637 --link 'https://travis.work/builds/42'
639 --link 'https://jenkins.work/job/42'
640 --link 'https://buildbot.work/builders/foo/builds/42'
641 --no-link
642 Provide one or more links people can follow to see more about this
643 run.
644 Can be specified multiple times
646 --load ARG
648 --load=ARG
649 --load-module ARG
650 --load-module=ARG
651 -m ARG
652 -m=ARG
653 --no-load
654 Load a module in each test (after fork). The "import" method is not
655 called.
656 Can be specified multiple times
658 --load-import Module
660 --load-import Module=import_arg1,arg2,...
661 --loadim Module
662 --loadim Module=import_arg1,arg2,...
663 -M Module
664 -M Module=import_arg1,arg2,...
665 --no-load-import
666 Load a module in each test (after fork). Import is called.
667 Can be specified multiple times. If the same key is listed multiple
669 times the value lists will be appended together.
670 --mem-usage
672 --no-mem-usage
673 Use Test2::Plugin::MemUsage inside tests (default: on)
674 --retry ARG
676 --retry=ARG
677 -r ARG
678 -r=ARG
679 --no-retry
680 Run any jobs that failed a second time. NOTE: --retry=1 means
681 failing tests will be attempted twice!
682 --retry-isolated
684 --retry-iso
685 --no-retry-isolated
686 If true then any job retries will be done in isolation (as though
687 -j1 was set)
688 --run-id
690 --id
691 --no-run-id
692 Set a specific run-id. (Default: a UUID)
693 --test-args ARG
695 --test-args=ARG
696 --no-test-args
697 Arguments to pass in as @ARGV for all tests that are run. These can
698 be provided easier using the '::' argument separator.
699 Can be specified multiple times
701 --stream
703 --no-stream
704 Use the stream formatter (default is on)
705 --tap
707 --TAP
708 ----no-stream
709 --no-tap
710 The TAP format is lossy and clunky. Test2::Harness normally uses a
711 newer streaming format to receive test results. There are
712 old/legacy tests where this causes problems, in which case setting
713 --TAP or --no-stream can help.
714 Runner Options
716 --abort-on-bail
718 --no-abort-on-bail
719 Abort all testing if a bail-out is encountered (default: on)
720 --blib
722 -b
723 --no-blib
724 (Default: include if it exists) Include 'blib/lib' and 'blib/arch'
725 in your module path
726 --cover
728 --cover=-silent,1,+ignore,^t/,+ignore,^t2/,+ignore,^xt,+ignore,^test.pl
729 --no-cover
730 Use Devel::Cover to calculate test coverage. This disables forking.
731 If no args are specified the following are used:
732 -silent,1,+ignore,^t/,+ignore,^t2/,+ignore,^xt,+ignore,^test.pl
733 --dump-depmap
735 --no-dump-depmap
736 When using staged preload, dump the depmap for each stage as json
737 files
738 --event-timeout SECONDS
740 --et SECONDS
741 --no-event-timeout
742 Kill test if no output is received within timeout period. (Default:
743 60 seconds). Add the "# HARNESS-NO-TIMEOUT" comment to the top of a
744 test file to disable timeouts on a per-test basis. This prevents a
745 hung test from running forever.
746 --include ARG
748 --include=ARG
749 -I ARG
750 -I=ARG
751 --no-include
752 Add a directory to your include paths
753 Can be specified multiple times
755 --job-count ARG
757 --job-count=ARG
758 --jobs ARG
759 --jobs=ARG
760 -j ARG
761 -j=ARG
762 --no-job-count
763 Set the number of concurrent jobs to run
764 Can also be set with the following environment variables:
766 "YATH_JOB_COUNT", "T2_HARNESS_JOB_COUNT", "HARNESS_JOB_COUNT"
767 --lib
769 -l
770 --no-lib
771 (Default: include if it exists) Include 'lib' in your module path
772 --nytprof
774 --no-nytprof
775 Use Devel::NYTProf on tests. This will set addpid=1 for you. This
776 works with or without fork.
777 --post-exit-timeout SECONDS
779 --pet SECONDS
780 --no-post-exit-timeout
781 Stop waiting post-exit after the timeout period. (Default: 15
782 seconds) Some tests fork and allow the parent to exit before
783 writing all their output. If Test2::Harness detects an incomplete
784 plan after the test exits it will monitor for more events until the
785 timeout period. Add the "# HARNESS-NO-TIMEOUT" comment to the top
786 of a test file to disable timeouts on a per-test basis.
787 --preload-threshold ARG
789 --preload-threshold=ARG
790 --Pt ARG
791 --Pt=ARG
792 -W ARG
793 -W=ARG
794 --no-preload-threshold
795 Only do preload if at least N tests are going to be run. In some
796 cases a full preload takes longer than simply running the tests,
797 this lets you specify a minimum number of test jobs that will be
798 run for preload to happen. This has no effect for a persistent
799 runner. The default is 0, and it means always preload.
800 --preloads ARG
802 --preloads=ARG
803 --preload ARG
804 --preload=ARG
805 -P ARG
806 -P=ARG
807 --no-preloads
808 Preload a module before running tests
809 Can be specified multiple times
811 --resource Port
813 --resource +Test2::Harness::Runner::Resource::Port
814 -R Port
815 --no-resource
816 Use a resource module to assign resource assignments to individual
817 tests
818 Can be specified multiple times
820 --switch ARG
822 --switch=ARG
823 -S ARG
824 -S=ARG
825 --no-switch
826 Pass the specified switch to perl for each test. This is not
827 compatible with preload.
828 Can be specified multiple times
830 --tlib
832 --no-tlib
833 (Default: off) Include 't/lib' in your module path
834 --unsafe-inc
836 --no-unsafe-inc
837 perl is removing '.' from @INC as a security concern. This option
838 keeps things from breaking for now.
839 Can also be set with the following environment variables:
841 "PERL_USE_UNSAFE_INC"
842 --use-fork
844 --fork
845 --no-use-fork
846 (default: on, except on windows) Normally tests are run by forking,
847 which allows for features like preloading. This will turn off the
848 behavior globally (which is not compatible with preloading). This
849 is slower, it is better to tag misbehaving tests with the '#
850 HARNESS-NO-PRELOAD' comment in their header to disable forking only
851 for those tests.
852 Can also be set with the following environment variables:
854 "!T2_NO_FORK", "T2_HARNESS_FORK", "!T2_HARNESS_NO_FORK",
855 "YATH_FORK", "!YATH_NO_FORK"
856 --use-timeout
858 --timeout
859 --no-use-timeout
860 (default: on) Enable/disable timeouts
861 Workspace Options
863 --clear
865 -C
866 --no-clear
867 Clear the work directory if it is not already empty
868 --tmp-dir ARG
870 --tmp-dir=ARG
871 --tmpdir ARG
872 --tmpdir=ARG
873 -t ARG
874 -t=ARG
875 --no-tmp-dir
876 Use a specific temp directory (Default: use system temp dir)
877 Can also be set with the following environment variables:
879 "T2_HARNESS_TEMP_DIR", "YATH_TEMP_DIR", "TMPDIR", "TEMPDIR",
880 "TMP_DIR", "TEMP_DIR"
881 --workdir ARG
883 --workdir=ARG
884 -w ARG
885 -w=ARG
886 --no-workdir
887 Set the work directory (Default: new temp directory)
888 Can also be set with the following environment variables:
890 "T2_WORKDIR", "YATH_WORKDIR"
891 YathUI Options
893 --yathui-api-key ARG
895 --yathui-api-key=ARG
896 --no-yathui-api-key
897 Yath-UI API key. This is not necessary if your Yath-UI instance is
898 set to single-user
899 --yathui-coverage
901 --no-yathui-coverage
902 Poll coverage data from Yath-UI to determine what tests should be
903 run for changed files
904 --yathui-db
906 --no-yathui-db
907 Add the YathUI DB renderer in addition to other renderers
908 --yathui-durations
910 --no-yathui-durations
911 Poll duration data from Yath-UI to help order tests efficiently
912 --yathui-grace
914 --no-yathui-grace
915 If yath cannot connect to yath-ui it normally throws an error, use
916 this to make it fail gracefully. You get a warning, but things keep
917 going.
918 --yathui-long-duration 10
920 --no-yathui-long-duration
921 Minimum duration length (seconds) before a test goes from MEDIUM to
922 LONG
923 --yathui-medium-duration 5
925 --no-yathui-medium-duration
926 Minimum duration length (seconds) before a test goes from SHORT to
927 MEDIUM
928 --yathui-mode summary
930 --yathui-mode qvf
931 --yathui-mode qvfd
932 --yathui-mode complete
933 --no-yathui-mode
934 Set the upload mode (default 'qvfd')
935 --yathui-only
937 --no-yathui-only
938 Only use the YathUI renderer
939 --yathui-only-db
941 --no-yathui-only-db
942 Only use the YathUI DB renderer
943 --yathui-port 8080
945 --no-yathui-port
946 Port to use when running a local server
947 --yathui-port-command get_port.sh
949 --yathui-port-command get_port.sh --pid $$
950 --no-yathui-port-command
951 Use a command to get a port number. "$$" will be replaced with the
952 PID of the yath process
953 --yathui-project ARG
955 --yathui-project=ARG
956 --no-yathui-project
957 The Yath-UI project for your test results
958 --yathui-render
960 --no-yathui-render
961 Add the YathUI renderer in addition to other renderers
962 --yathui-retry
964 --no-yathui-retry
965 How many times to try an operation before giving up
966 Can be specified multiple times
968 --yathui-schema PostgreSQL
970 --yathui-schema MySQL
971 --yathui-schema MySQL56
972 --no-yathui-schema
973 What type of DB/schema to use when using a temporary database
974 --yathui-upload
976 --no-yathui-upload
977 Upload the log to Yath-UI
978 --yathui-url http://my-yath-ui.com/...
980 --uri http://my-yath-ui.com/...
981 --no-yathui-url
982 Yath-UI url
983 --yathui-user ARG
985 --yathui-user=ARG
986 --no-yathui-user
987 Username to attach to the data sent to the db
988 --yathui-db-buffering none
990 --yathui-db-buffering job
991 --yathui-db-buffering diag
992 --yathui-db-buffering run
993 --no-yathui-db-buffering
994 Type of buffering to use, if "none" then events are written to the
995 db one at a time, which is SLOW
996 --yathui-db-config ARG
998 --yathui-db-config=ARG
999 --no-yathui-db-config
1000 Module that implements 'MODULE->yath_ui_config(%params)' which
1001 should return a Test2::Harness::UI::Config instance.
1002 --yathui-db-coverage
1004 --no-yathui-db-coverage
1005 Pull coverage data directly from the database (default: off)
1006 --yathui-db-driver Pg
1008 --yathui-db-drivermysql
1009 --yathui-db-driverMariaDB
1010 --no-yathui-db-driver
1011 DBI Driver to use
1012 --yathui-db-dsn ARG
1014 --yathui-db-dsn=ARG
1015 --no-yathui-db-dsn
1016 DSN to use when connecting to the db
1017 --yathui-db-durations
1019 --no-yathui-db-durations
1020 Pull duration data directly from the database (default: off)
1021 --yathui-db-flush-interval 2
1023 --yathui-db-flush-interval 1.5
1024 --no-yathui-db-flush-interval
1025 When buffering DB writes, force a flush when an event is recieved
1026 at least N seconds after the last flush.
1027 --yathui-db-host ARG
1029 --yathui-db-host=ARG
1030 --no-yathui-db-host
1031 hostname to use when connecting to the db
1032 --yathui-db-name ARG
1034 --yathui-db-name=ARG
1035 --no-yathui-db-name
1036 Name of the database to use for yathui
1037 --yathui-db-pass ARG
1039 --yathui-db-pass=ARG
1040 --no-yathui-db-pass
1041 Password to use when connecting to the db
1042 --yathui-db-port ARG
1044 --yathui-db-port=ARG
1045 --no-yathui-db-port
1046 port to use when connecting to the db
1047 --yathui-db-publisher ARG
1049 --yathui-db-publisher=ARG
1050 --no-yathui-db-publisher
1051 When using coverage or duration data, only use data uploaded by
1052 this user
1053 --yathui-db-socket ARG
1055 --yathui-db-socket=ARG
1056 --no-yathui-db-socket
1057 socket to use when connecting to the db
1058 --yathui-db-user ARG
1060 --yathui-db-user=ARG
1061 --no-yathui-db-user
1062 Username to use when connecting to the db
1063
1065 The source code repository for Test2-Harness can be found at
1066 http://github.com/Test-More/Test2-Harness/.
1067
1069 Chad Granum <exodist@cpan.org>
1070
1072 Chad Granum <exodist@cpan.org>
1073
1075 Copyright 2022 Chad Granum <exodist7@gmail.com>.
1076 This program is free software; you can redistribute it and/or modify it
1078 under the same terms as Perl itself.
1079 See http://dev.perl.org/licenses/
1081perl v5.34.1 2022-07-11 App::Yath::Command::projects(3)