1App::Yath::Command::tesUts(e3r)Contributed Perl DocumentAaptpi:o:nYath::Command::test(3)
2
3
4
6 App::Yath::Command::test - Run tests
7
9 This yath command (which is also the default command) will run all the
10 test files for the current project. If no test files are specified this
11 command will look for the 't', and 't2' directories, as well as the
12 'test.pl' file.
13
14 This command is always recursive when given directories.
15
16 This command will add 'lib', 'blib/arch' and 'blib/lib' to the perl
17 path for you by default (after any -I's). You can specify -l if you
18 just want lib, -b if you just want the blib paths. If you specify both
19 -l and -b both will be added in the order you specify (order relative
20 to any -I options will also be preserved. If you do not specify they
21 will be added in this order: -I's, lib, blib/lib, blib/arch. You can
22 also add --no-lib and --no-blib to avoid both.
23
24 Any command line argument that is not an option will be treated as a
25 test file or directory of test files to be run.
26
27 If you wish to specify the ARGV for tests you may append them after
28 '::'. This is mainly useful for Test::Class::Moose and similar tools.
29 EVERY test run will get the same ARGV.
30
32 $ yath [YATH OPTIONS] test [COMMAND OPTIONS]
33
34 YATH OPTIONS
35 Developer
36
37 --dev-lib
38 --dev-lib=lib
39 -D
40 -D=lib
41 -Dlib
42 --no-dev-lib
43 Add paths to @INC before loading ANYTHING. This is what you use if
44 you are developing yath or yath plugins to make sure the yath
45 script finds the local code instead of the installed versions of
46 the same code. You can provide an argument (-Dfoo) to provide a
47 custom path, or you can just use -D without and arg to add lib,
48 blib/lib and blib/arch.
49
50 Can be specified multiple times
51
52 Environment
53
54 --persist-dir ARG
55 --persist-dir=ARG
56 --no-persist-dir
57 Where to find persistence files.
58
59 --persist-file ARG
60 --persist-file=ARG
61 --pfile ARG
62 --pfile=ARG
63 --no-persist-file
64 Where to find the persistence file. The default is
65 /{system-tempdir}/project-yath-persist.json. If no project is
66 specified then it will fall back to the current directory. If the
67 current directory is not writable it will default to
68 /tmp/yath-persist.json which limits you to one persistent runner on
69 your system.
70
71 --project ARG
72 --project=ARG
73 --project-name ARG
74 --project-name=ARG
75 --no-project
76 This lets you provide a label for your current project/codebase.
77 This is best used in a .yath.rc file. This is necessary for a
78 persistent runner.
79
80 Finder Options
81
82 --finder MyFinder
83 --finder +Test2::Harness::Finder::MyFinder
84 --no-finder
85 Specify what Finder subclass to use when searching for
86 files/processing the file list. Use the "+" prefix to specify a
87 fully qualified namespace, otherwise Test2::Harness::Finder::XXX
88 namespace is assumed.
89
90 Help and Debugging
91
92 --show-opts
93 --no-show-opts
94 Exit after showing what yath thinks your options mean
95
96 --version
97 -V
98 --no-version
99 Exit after showing a helpful usage message
100
101 Plugins
102
103 --no-scan-plugins
104 --no-no-scan-plugins
105 Normally yath scans for and loads all App::Yath::Plugin::* modules
106 in order to bring in command-line options they may provide. This
107 flag will disable that. This is useful if you have a naughty plugin
108 that it loading other modules when it should not.
109
110 --plugins PLUGIN
111 --plugins +App::Yath::Plugin::PLUGIN
112 --plugins PLUGIN=arg1,arg2,...
113 --plugin PLUGIN
114 --plugin +App::Yath::Plugin::PLUGIN
115 --plugin PLUGIN=arg1,arg2,...
116 -pPLUGIN
117 --no-plugins
118 Load a yath plugin.
119
120 Can be specified multiple times
121
122 COMMAND OPTIONS
123 Display Options
124
125 --color
126 --no-color
127 Turn color on, default is true if STDOUT is a TTY.
128
129 --no-wrap
130 --no-no-wrap
131 Do not do fancy text-wrapping, let the terminal handle it
132
133 --progress
134 --no-progress
135 Toggle progress indicators. On by default if STDOUT is a TTY. You
136 can use --no-progress to disable the 'events seen' counter and
137 buffered event pre-display
138
139 --quiet
140 -q
141 --no-quiet
142 Be very quiet.
143
144 Can be specified multiple times
145
146 --renderers +My::Renderer
147 --renderers Renderer=arg1,arg2,...
148 --renderer +My::Renderer
149 --renderer Renderer=arg1,arg2,...
150 --no-renderers
151 Specify renderers, (Default: "Formatter=Test2"). Use "+" to give a
152 fully qualified module name. Without "+"
153 "Test2::Harness::Renderer::" will be prepended to your argument.
154
155 Can be specified multiple times. If the same key is listed multiple
156 times the value lists will be appended together.
157
158 --show-times
159 -T
160 --no-show-times
161 Show the timing data for each job
162
163 --term-width 80
164 --term-width 200
165 --term-size 80
166 --term-size 200
167 --no-term-width
168 Alternative to setting $TABLE_TERM_SIZE. Setting this will override
169 the terminal width detection to the number of characters specified.
170
171 --verbose
172 -v
173 --no-verbose
174 Be more verbose
175
176 Can be specified multiple times
177
178 Finder Options
179
180 --changed path/to/file
181 --no-changed
182 Specify one or more files as having been changed.
183
184 Can be specified multiple times
185
186 --changed-only
187 --no-changed-only
188 Only search for tests for changed files (Requires --coverage-from,
189 also requires a list of changes either from the --changed option,
190 or a plugin that implements changed_files())
191
192 --changes-plugin Git
193 --changes-plugin +App::Yath::Plugin::Git
194 --no-changes-plugin
195 What plugin should be used to detect changed files.
196
197 --coverage-from path/to/log.jsonl
198 --coverage-from http://example.com/coverage
199 --coverage-from path/to/coverage.json
200 --no-coverage-from
201 Where to fetch coverage data. Can be a path to a .jsonl(.bz|.gz)?
202 log file. Can be a path or url to a json file containing a hash
203 where source files are key, and value is a list of tests to run.
204
205 --coverage-url-use-post
206 --no-coverage-url-use-post
207 If coverage_from is a url, use the http POST method with a list of
208 changed files. This allows the server to tell us what tests to run
209 instead of downloading all the coverage data and determining what
210 tests to run from that.
211
212 --default-at-search ARG
213 --default-at-search=ARG
214 --no-default-at-search
215 Specify the default file/dir search when 'AUTHOR_TESTING' is set.
216 Defaults to './xt'. The default AT search is only used if no files
217 were specified at the command line
218
219 Can be specified multiple times
220
221 --default-search ARG
222 --default-search=ARG
223 --no-default-search
224 Specify the default file/dir search. defaults to './t', './t2', and
225 'test.pl'. The default search is only used if no files were
226 specified at the command line
227
228 Can be specified multiple times
229
230 --durations file.json
231 --durations http://example.com/durations.json
232 --no-durations
233 Point at a json file or url which has a hash of relative test
234 filenames as keys, and 'SHORT', 'MEDIUM', or 'LONG' as values. This
235 will override durations listed in the file headers. An exception
236 will be thrown if the durations file or url does not work.
237
238 --exclude-file t/nope.t
239 --no-exclude-file
240 Exclude a file from testing
241
242 Can be specified multiple times
243
244 --exclude-list file.txt
245 --exclude-list http://example.com/exclusions.txt
246 --no-exclude-list
247 Point at a file or url which has a new line separated list of test
248 file names to exclude from testing. Starting a line with a '#' will
249 comment it out (for compatibility with Test2::Aggregate list
250 files).
251
252 Can be specified multiple times
253
254 --exclude-pattern t/nope.t
255 --no-exclude-pattern
256 Exclude a pattern from testing, matched using m/$PATTERN/
257
258 Can be specified multiple times
259
260 --extension ARG
261 --extension=ARG
262 --ext ARG
263 --ext=ARG
264 --no-extension
265 Specify valid test filename extensions, default: t and t2
266
267 Can be specified multiple times
268
269 --maybe-coverage-from path/to/log.jsonl
270 --maybe-coverage-from http://example.com/coverage
271 --maybe-coverage-from path/to/coverage.json
272 --no-maybe-coverage-from
273 Where to fetch coverage data. Can be a path to a .jsonl(.bz|.gz)?
274 log file. Can be a path or url to a json file containing a hash
275 where source files are key, and value is a list of tests to run.
276
277 --maybe-durations file.json
278 --maybe-durations http://example.com/durations.json
279 --no-maybe-durations
280 Point at a json file or url which has a hash of relative test
281 filenames as keys, and 'SHORT', 'MEDIUM', or 'LONG' as values. This
282 will override durations listed in the file headers. An exception
283 will be thrown if the durations file or url does not work.
284
285 --no-long
286 --no-no-long
287 Do not run tests that have their duration flag set to 'LONG'
288
289 --only-long
290 --no-only-long
291 Only run tests that have their duration flag set to 'LONG'
292
293 --search ARG
294 --search=ARG
295 --no-search
296 List of tests and test directories to use instead of the default
297 search paths. Typically these can simply be listed as command line
298 arguments without the --search prefix.
299
300 Can be specified multiple times
301
302 --show-changed-files
303 --no-show-changed-files
304 Print a list of changed files if any are found
305
306 Formatter Options
307
308 --formatter ARG
309 --formatter=ARG
310 --no-formatter
311 NO DESCRIPTION - FIX ME
312
313 --qvf
314 --no-qvf
315 [Q]uiet, but [V]erbose on [F]ailure. Hide all output from tests
316 when they pass, except to say they passed. If a test fails then ALL
317 output from the test is verbosely output.
318
319 --show-job-end
320 --no-show-job-end
321 Show output when a job ends. (Default: on)
322
323 --show-job-info
324 --no-show-job-info
325 Show the job configuration when a job starts. (Default: off, unless
326 -vv)
327
328 --show-job-launch
329 --no-show-job-launch
330 Show output for the start of a job. (Default: off unless -v)
331
332 --show-run-info
333 --no-show-run-info
334 Show the run configuration when a run starts. (Default: off, unless
335 -vv)
336
337 Git Options
338
339 --git-change-base master
340 --git-change-base HEAD^
341 --git-change-base df22abe4
342 --no-git-change-base
343 Find files changed by all commits in the current branch from most
344 recent stopping when a commit is found that is also present in the
345 history of the branch/commit specified as the change base.
346
347 Help and Debugging
348
349 --dummy
350 -d
351 --no-dummy
352 Dummy run, do not actually execute anything
353
354 Can also be set with the following environment variables:
355 "T2_HARNESS_DUMMY"
356
357 --help
358 -h
359 --no-help
360 exit after showing help information
361
362 --keep-dirs
363 --keep_dir
364 -k
365 --no-keep-dirs
366 Do not delete directories when done. This is useful if you want to
367 inspect the directories used for various commands.
368
369 --summary
370 --summary=/path/to/summary.json
371 --no-summary
372 Write out a summary json file, if no path is provided
373 'summary.json' will be used. The .json extension is added
374 automatically if omitted.
375
376 Logging Options
377
378 --bzip2
379 --bz2
380 --bzip2_log
381 -B
382 --no-bzip2
383 Use bzip2 compression when writing the log. This option implies -L.
384 The .bz2 prefix is added to log file name for you
385
386 --gzip
387 --gz
388 --gzip_log
389 -G
390 --no-gzip
391 Use gzip compression when writing the log. This option implies -L.
392 The .gz prefix is added to log file name for you
393
394 --log
395 -L
396 --no-log
397 Turn on logging
398
399 --log-dir ARG
400 --log-dir=ARG
401 --no-log-dir
402 Specify a log directory. Will fall back to the system temp dir.
403
404 --log-file ARG
405 --log-file=ARG
406 -F ARG
407 -F=ARG
408 --no-log-file
409 Specify the name of the log file. This option implies -L.
410
411 --log-file-format ARG
412 --log-file-format=ARG
413 --lff ARG
414 --lff=ARG
415 --no-log-file-format
416 Specify the format for automatically-generated log files.
417 Overridden by --log-file, if given. This option implies -L
418 (Default: \$YATH_LOG_FILE_FORMAT, if that is set, or else
419 "%!P%Y-%m-%d~%H:%M:%S~%!U~%!p.jsonl"). This is a string in which
420 percent-escape sequences will be replaced as per POSIX::strftime.
421 The following special escape sequences are also replaced: (%!P :
422 Project name followed by a ~, if a project is defined, otherwise
423 empty string) (%!U : the unique test run ID) (%!p : the process ID)
424 (%!S : the number of seconds since local midnight UTC)
425
426 Can also be set with the following environment variables:
427 "YATH_LOG_FILE_FORMAT", "TEST2_HARNESS_LOG_FORMAT"
428
429 --write-coverage
430 --write-coverage=coverage.json
431 --no-write-coverage
432 Create a json file of all coverage data seen during the run (This
433 implies --cover-files).
434
435 Notification Options
436
437 --notify-email foo@example.com
438 --no-notify-email
439 Email the test results to the specified email address(es)
440
441 Can be specified multiple times
442
443 --notify-email-fail foo@example.com
444 --no-notify-email-fail
445 Email failing results to the specified email address(es)
446
447 Can be specified multiple times
448
449 --notify-email-from foo@example.com
450 --no-notify-email-from
451 If any email is sent, this is who it will be from
452
453 --notify-email-owner
454 --no-notify-email-owner
455 Email the owner of broken tests files upon failure. Add `# HARNESS-
456 META-OWNER foo@example.com` to the top of a test file to give it an
457 owner
458
459 --notify-no-batch-email
460 --no-notify-no-batch-email
461 Usually owner failures are sent as a single batch at the end of
462 testing. Toggle this to send failures as they happen.
463
464 --notify-no-batch-slack
465 --no-notify-no-batch-slack
466 Usually owner failures are sent as a single batch at the end of
467 testing. Toggle this to send failures as they happen.
468
469 --notify-slack '#foo'
470 --notify-slack '@bar'
471 --no-notify-slack
472 Send results to a slack channel and/or user
473
474 Can be specified multiple times
475
476 --notify-slack-fail '#foo'
477 --notify-slack-fail '@bar'
478 --no-notify-slack-fail
479 Send failing results to a slack channel and/or user
480
481 Can be specified multiple times
482
483 --notify-slack-owner
484 --no-notify-slack-owner
485 Send slack notifications to the slack channels/users listed in test
486 meta-data when tests fail.
487
488 --notify-slack-url https://hooks.slack.com/...
489 --no-notify-slack-url
490 Specify an API endpoint for slack webhook integrations
491
492 --notify-text ARG
493 --notify-text=ARG
494 --message ARG
495 --message=ARG
496 --msg ARG
497 --msg=ARG
498 --no-notify-text
499 Add a custom text snippet to email/slack notifications
500
501 Run Options
502
503 --author-testing
504 -A
505 --no-author-testing
506 This will set the AUTHOR_TESTING environment to true
507
508 --cover-files
509 --no-cover-files
510 Use Test2::Plugin::Cover to collect coverage data for what files
511 are touched by what tests. Unlike Devel::Cover this has very little
512 performance impact (About 4% difference)
513
514 --dbi-profiling
515 --no-dbi-profiling
516 Use Test2::Plugin::DBIProfile to collect database profiling data
517
518 --env-var VAR=VAL
519 -EVAR=VAL
520 -E VAR=VAL
521 --no-env-var
522 Set environment variables to set when each test is run.
523
524 Can be specified multiple times
525
526 --event-uuids
527 --uuids
528 --no-event-uuids
529 Use Test2::Plugin::UUID inside tests (default: on)
530
531 --fields name:details
532 --fields JSON_STRING
533 -f name:details
534 -f JSON_STRING
535 --no-fields
536 Add custom data to the harness run
537
538 Can be specified multiple times
539
540 --input ARG
541 --input=ARG
542 --no-input
543 Input string to be used as standard input for ALL tests. See also:
544 --input-file
545
546 --input-file ARG
547 --input-file=ARG
548 --no-input-file
549 Use the specified file as standard input to ALL tests
550
551 --io-events
552 --no-io-events
553 Use Test2::Plugin::IOEvents inside tests to turn all prints into
554 test2 events (default: off)
555
556 --link 'https://travis.work/builds/42'
557 --link 'https://jenkins.work/job/42'
558 --link 'https://buildbot.work/builders/foo/builds/42'
559 --no-link
560 Provide one or more links people can follow to see more about this
561 run.
562
563 Can be specified multiple times
564
565 --load ARG
566 --load=ARG
567 --load-module ARG
568 --load-module=ARG
569 -m ARG
570 -m=ARG
571 --no-load
572 Load a module in each test (after fork). The "import" method is not
573 called.
574
575 Can be specified multiple times
576
577 --load-import Module
578 --load-import Module=import_arg1,arg2,...
579 --loadim Module
580 --loadim Module=import_arg1,arg2,...
581 -M Module
582 -M Module=import_arg1,arg2,...
583 --no-load-import
584 Load a module in each test (after fork). Import is called.
585
586 Can be specified multiple times. If the same key is listed multiple
587 times the value lists will be appended together.
588
589 --mem-usage
590 --no-mem-usage
591 Use Test2::Plugin::MemUsage inside tests (default: on)
592
593 --retry ARG
594 --retry=ARG
595 -r ARG
596 -r=ARG
597 --no-retry
598 Run any jobs that failed a second time. NOTE: --retry=1 means
599 failing tests will be attempted twice!
600
601 --retry-isolated
602 --retry-iso
603 --no-retry-isolated
604 If true then any job retries will be done in isolation (as though
605 -j1 was set)
606
607 --run-id
608 --id
609 --no-run-id
610 Set a specific run-id. (Default: a UUID)
611
612 --test-args ARG
613 --test-args=ARG
614 --no-test-args
615 Arguments to pass in as @ARGV for all tests that are run. These can
616 be provided easier using the '::' argument separator.
617
618 Can be specified multiple times
619
620 --stream
621 --no-stream
622 Use the stream formatter (default is on)
623
624 --tap
625 --TAP
626 ----no-stream
627 --no-tap
628 The TAP format is lossy and clunky. Test2::Harness normally uses a
629 newer streaming format to receive test results. There are
630 old/legacy tests where this causes problems, in which case setting
631 --TAP or --no-stream can help.
632
633 Runner Options
634
635 --blib
636 -b
637 --no-blib
638 (Default: include if it exists) Include 'blib/lib' and 'blib/arch'
639 in your module path
640
641 --cover
642 --cover=-silent,1,+ignore,^t/,+ignore,^t2/,+ignore,^xt,+ignore,^test.pl
643 --no-cover
644 Use Devel::Cover to calculate test coverage. This disables forking.
645 If no args are specified the following are used:
646 -silent,1,+ignore,^t/,+ignore,^t2/,+ignore,^xt,+ignore,^test.pl
647
648 --event-timeout SECONDS
649 --et SECONDS
650 --no-event-timeout
651 Kill test if no output is received within timeout period. (Default:
652 60 seconds). Add the "# HARNESS-NO-TIMEOUT" comment to the top of a
653 test file to disable timeouts on a per-test basis. This prevents a
654 hung test from running forever.
655
656 --include ARG
657 --include=ARG
658 -I ARG
659 -I=ARG
660 --no-include
661 Add a directory to your include paths
662
663 Can be specified multiple times
664
665 --job-count ARG
666 --job-count=ARG
667 --jobs ARG
668 --jobs=ARG
669 -j ARG
670 -j=ARG
671 --no-job-count
672 Set the number of concurrent jobs to run (Default: 1)
673
674 Can also be set with the following environment variables:
675 "YATH_JOB_COUNT", "T2_HARNESS_JOB_COUNT", "HARNESS_JOB_COUNT"
676
677 --lib
678 -l
679 --no-lib
680 (Default: include if it exists) Include 'lib' in your module path
681
682 --nytprof
683 --no-nytprof
684 Use Devel::NYTProf on tests. This will set addpid=1 for you. This
685 works with or without fork.
686
687 --post-exit-timeout SECONDS
688 --pet SECONDS
689 --no-post-exit-timeout
690 Stop waiting post-exit after the timeout period. (Default: 15
691 seconds) Some tests fork and allow the parent to exit before
692 writing all their output. If Test2::Harness detects an incomplete
693 plan after the test exits it will monitor for more events until the
694 timeout period. Add the "# HARNESS-NO-TIMEOUT" comment to the top
695 of a test file to disable timeouts on a per-test basis.
696
697 --preload-threshold ARG
698 --preload-threshold=ARG
699 --Pt ARG
700 --Pt=ARG
701 -W ARG
702 -W=ARG
703 --no-preload-threshold
704 Only do preload if at least N tests are going to be run. In some
705 cases a full preload takes longer than simply running the tests,
706 this lets you specify a minimum number of test jobs that will be
707 run for preload to happen. This has no effect for a persistent
708 runner. The default is 0, and it means always preload.
709
710 --preloads ARG
711 --preloads=ARG
712 --preload ARG
713 --preload=ARG
714 -P ARG
715 -P=ARG
716 --no-preloads
717 Preload a module before running tests
718
719 Can be specified multiple times
720
721 --resource Port
722 --resource +Test2::Harness::Runner::Resource::Port
723 -R Port
724 --no-resource
725 Use a resource module to assign resource assignments to individual
726 tests
727
728 Can be specified multiple times
729
730 --switch ARG
731 --switch=ARG
732 -S ARG
733 -S=ARG
734 --no-switch
735 Pass the specified switch to perl for each test. This is not
736 compatible with preload.
737
738 Can be specified multiple times
739
740 --tlib
741 --no-tlib
742 (Default: off) Include 't/lib' in your module path
743
744 --unsafe-inc
745 --no-unsafe-inc
746 perl is removing '.' from @INC as a security concern. This option
747 keeps things from breaking for now.
748
749 Can also be set with the following environment variables:
750 "PERL_USE_UNSAFE_INC"
751
752 --use-fork
753 --fork
754 --no-use-fork
755 (default: on, except on windows) Normally tests are run by forking,
756 which allows for features like preloading. This will turn off the
757 behavior globally (which is not compatible with preloading). This
758 is slower, it is better to tag misbehaving tests with the '#
759 HARNESS-NO-PRELOAD' comment in their header to disable forking only
760 for those tests.
761
762 Can also be set with the following environment variables:
763 "!T2_NO_FORK", "T2_HARNESS_FORK", "!T2_HARNESS_NO_FORK",
764 "YATH_FORK", "!YATH_NO_FORK"
765
766 --use-timeout
767 --timeout
768 --no-use-timeout
769 (default: on) Enable/disable timeouts
770
771 Workspace Options
772
773 --clear
774 -C
775 --no-clear
776 Clear the work directory if it is not already empty
777
778 --tmp-dir ARG
779 --tmp-dir=ARG
780 --tmpdir ARG
781 --tmpdir=ARG
782 -t ARG
783 -t=ARG
784 --no-tmp-dir
785 Use a specific temp directory (Default: use system temp dir)
786
787 Can also be set with the following environment variables:
788 "T2_HARNESS_TEMP_DIR", "YATH_TEMP_DIR", "TMPDIR", "TEMPDIR",
789 "TMP_DIR", "TEMP_DIR"
790
791 --workdir ARG
792 --workdir=ARG
793 -w ARG
794 -w=ARG
795 --no-workdir
796 Set the work directory (Default: new temp directory)
797
798 Can also be set with the following environment variables:
799 "T2_WORKDIR", "YATH_WORKDIR"
800
801 YathUI Options
802
803 --yathui-api-key ARG
804 --yathui-api-key=ARG
805 --no-yathui-api-key
806 Yath-UI API key. This is not necessary if your Yath-UI instance is
807 set to single-user
808
809 --yathui-coverage
810 --no-yathui-coverage
811 Poll coverage data from Yath-UI to determine what tests should be
812 run for changed files
813
814 --yathui-db
815 --no-yathui-db
816 Add the YathUI DB renderer in addition to other renderers
817
818 --yathui-durations
819 --no-yathui-durations
820 Poll duration data from Yath-UI to help order tests efficiently
821
822 --yathui-grace
823 --no-yathui-grace
824 If yath cannot connect to yath-ui it normally throws an error, use
825 this to make it fail gracefully. You get a warning, but things keep
826 going.
827
828 --yathui-long-duration 10
829 --no-yathui-long-duration
830 Minimum duration length (seconds) before a test goes from MEDIUM to
831 LONG
832
833 --yathui-medium-duration 5
834 --no-yathui-medium-duration
835 Minimum duration length (seconds) before a test goes from SHORT to
836 MEDIUM
837
838 --yathui-mode summary
839 --yathui-mode qvf
840 --yathui-mode qvfd
841 --yathui-mode complete
842 --no-yathui-mode
843 Set the upload mode (default 'qvfd')
844
845 --yathui-only
846 --no-yathui-only
847 Only use the YathUI renderer
848
849 --yathui-only-db
850 --no-yathui-only-db
851 Only use the YathUI DB renderer
852
853 --yathui-port 8080
854 --no-yathui-port
855 Port to use when running a local server
856
857 --yathui-port-command get_port.sh
858 --yathui-port-command get_port.sh --pid $$
859 --no-yathui-port-command
860 Use a command to get a port number. "$$" will be replaced with the
861 PID of the yath process
862
863 --yathui-project ARG
864 --yathui-project=ARG
865 --no-yathui-project
866 The Yath-UI project for your test results
867
868 --yathui-render
869 --no-yathui-render
870 Add the YathUI renderer in addition to other renderers
871
872 --yathui-retry
873 --no-yathui-retry
874 How many times to try an operation before giving up
875
876 Can be specified multiple times
877
878 --yathui-schema PostgreSQL
879 --yathui-schema MySQL
880 --yathui-schema MySQL56
881 --no-yathui-schema
882 What type of DB/schema to use when using a temporary database
883
884 --yathui-upload
885 --no-yathui-upload
886 Upload the log to Yath-UI
887
888 --yathui-url http://my-yath-ui.com/...
889 --uri http://my-yath-ui.com/...
890 --no-yathui-url
891 Yath-UI url
892
893 --yathui-user ARG
894 --yathui-user=ARG
895 --no-yathui-user
896 Username to attach to the data sent to the db
897
898 --yathui-db-buffering none
899 --yathui-db-buffering job
900 --yathui-db-buffering diag
901 --yathui-db-buffering run
902 --no-yathui-db-buffering
903 Type of buffering to use, if "none" then events are written to the
904 db one at a time, which is SLOW
905
906 --yathui-db-config ARG
907 --yathui-db-config=ARG
908 --no-yathui-db-config
909 Module that implements 'MODULE->yath_ui_config(%params)' which
910 should return a Test2::Harness::UI::Config instance.
911
912 --yathui-db-driver Pg
913 --yathui-db-drivermysql
914 --yathui-db-driverMariaDB
915 --no-yathui-db-driver
916 DBI Driver to use
917
918 --yathui-db-dsn ARG
919 --yathui-db-dsn=ARG
920 --no-yathui-db-dsn
921 DSN to use when connecting to the db
922
923 --yathui-db-flush-interval 2
924 --yathui-db-flush-interval 1.5
925 --no-yathui-db-flush-interval
926 When buffering DB writes, force a flush when an event is recieved
927 at least N seconds after the last flush.
928
929 --yathui-db-host ARG
930 --yathui-db-host=ARG
931 --no-yathui-db-host
932 hostname to use when connecting to the db
933
934 --yathui-db-name ARG
935 --yathui-db-name=ARG
936 --no-yathui-db-name
937 Name of the database to use for yathui
938
939 --yathui-db-pass ARG
940 --yathui-db-pass=ARG
941 --no-yathui-db-pass
942 Password to use when connecting to the db
943
944 --yathui-db-port ARG
945 --yathui-db-port=ARG
946 --no-yathui-db-port
947 port to use when connecting to the db
948
949 --yathui-db-socket ARG
950 --yathui-db-socket=ARG
951 --no-yathui-db-socket
952 socket to use when connecting to the db
953
954 --yathui-db-user ARG
955 --yathui-db-user=ARG
956 --no-yathui-db-user
957 Username to use when connecting to the db
958
960 The source code repository for Test2-Harness can be found at
961 http://github.com/Test-More/Test2-Harness/.
962
964 Chad Granum <exodist@cpan.org>
965
967 Chad Granum <exodist@cpan.org>
968
970 Copyright 2021 Chad Granum <exodist7@gmail.com>.
971
972 This program is free software; you can redistribute it and/or modify it
973 under the same terms as Perl itself.
974
975 See http://dev.perl.org/licenses/
976
977
978
979perl v5.32.1 2021-03-12 App::Yath::Command::test(3)