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 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-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 --no-wrap
199 --no-no-wrap
200 Do not do fancy text-wrapping, let the terminal handle it
201 --progress
203 --no-progress
204 Toggle progress indicators. On by default if STDOUT is a TTY. You
205 can use --no-progress to disable the 'events seen' counter and
206 buffered event pre-display
207 --quiet
209 -q
210 --no-quiet
211 Be very quiet.
212 Can be specified multiple times
214 --renderers +My::Renderer
216 --renderers Renderer=arg1,arg2,...
217 --renderer +My::Renderer
218 --renderer Renderer=arg1,arg2,...
219 --no-renderers
220 Specify renderers, (Default: "Formatter=Test2"). Use "+" to give a
221 fully qualified module name. Without "+"
222 "Test2::Harness::Renderer::" will be prepended to your argument.
223 Can be specified multiple times. If the same key is listed multiple
225 times the value lists will be appended together.
226 --show-times
228 -T
229 --no-show-times
230 Show the timing data for each job
231 --term-width 80
233 --term-width 200
234 --term-size 80
235 --term-size 200
236 --no-term-width
237 Alternative to setting $TABLE_TERM_SIZE. Setting this will override
238 the terminal width detection to the number of characters specified.
239 --verbose
241 -v
242 --no-verbose
243 Be more verbose
244 Can be specified multiple times
246 Finder Options
248 --changed path/to/file
250 --no-changed
251 Specify one or more files as having been changed.
252 Can be specified multiple times
254 --changed-only
256 --no-changed-only
257 Only search for tests for changed files (Requires a coverage data
258 source, also requires a list of changes either from the --changed
259 option, or a plugin that implements changed_files() or
260 changed_diff())
261 --changes-diff path/to/diff.diff
263 --no-changes-diff
264 Path to a diff file that should be used to find changed files for
265 use with --changed-only. This must be in the same format as `git
266 diff -W --minimal -U1000000`
267 --changes-filter-file path/to/file
269 --no-changes-filter-file
270 Specify one or more files to check for changes. Changes to other
271 files will be ignored
272 Can be specified multiple times
274 --changes-filter-pattern '(apple|pear|orange)'
276 --no-changes-filter-pattern
277 Specify a pattern for change checking. When only running tests for
278 changed files this will limit which files are checked for changes.
279 Only files that match this pattern will be checked. Your pattern
280 will be inserted unmodified into a `$file =~ m/$pattern/` check.
281 Can be specified multiple times
283 --changes-plugin Git
285 --changes-plugin +App::Yath::Plugin::Git
286 --no-changes-plugin
287 What plugin should be used to detect changed files.
288 --default-at-search ARG
290 --default-at-search=ARG
291 --no-default-at-search
292 Specify the default file/dir search when 'AUTHOR_TESTING' is set.
293 Defaults to './xt'. The default AT search is only used if no files
294 were specified at the command line
295 Can be specified multiple times
297 --default-search ARG
299 --default-search=ARG
300 --no-default-search
301 Specify the default file/dir search. defaults to './t', './t2', and
302 'test.pl'. The default search is only used if no files were
303 specified at the command line
304 Can be specified multiple times
306 --durations file.json
308 --durations http://example.com/durations.json
309 --no-durations
310 Point at a json file or url which has a hash of relative test
311 filenames as keys, and 'SHORT', 'MEDIUM', or 'LONG' as values. This
312 will override durations listed in the file headers. An exception
313 will be thrown if the durations file or url does not work.
314 --exclude-file t/nope.t
316 --no-exclude-file
317 Exclude a file from testing
318 Can be specified multiple times
320 --exclude-list file.txt
322 --exclude-list http://example.com/exclusions.txt
323 --no-exclude-list
324 Point at a file or url which has a new line separated list of test
325 file names to exclude from testing. Starting a line with a '#' will
326 comment it out (for compatibility with Test2::Aggregate list
327 files).
328 Can be specified multiple times
330 --exclude-pattern t/nope.t
332 --no-exclude-pattern
333 Exclude a pattern from testing, matched using m/$PATTERN/
334 Can be specified multiple times
336 --extension ARG
338 --extension=ARG
339 --ext ARG
340 --ext=ARG
341 --no-extension
342 Specify valid test filename extensions, default: t and t2
343 Can be specified multiple times
345 --maybe-durations file.json
347 --maybe-durations http://example.com/durations.json
348 --no-maybe-durations
349 Point at a json file or url which has a hash of relative test
350 filenames as keys, and 'SHORT', 'MEDIUM', or 'LONG' as values. This
351 will override durations listed in the file headers. An exception
352 will be thrown if the durations file or url does not work.
353 --no-long
355 --no-no-long
356 Do not run tests that have their duration flag set to 'LONG'
357 --only-long
359 --no-only-long
360 Only run tests that have their duration flag set to 'LONG'
361 --search ARG
363 --search=ARG
364 --no-search
365 List of tests and test directories to use instead of the default
366 search paths. Typically these can simply be listed as command line
367 arguments without the --search prefix.
368 Can be specified multiple times
370 --show-changed-files
372 --no-show-changed-files
373 Print a list of changed files if any are found
374 Formatter Options
376 --formatter ARG
378 --formatter=ARG
379 --no-formatter
380 NO DESCRIPTION - FIX ME
381 --qvf
383 --no-qvf
384 [Q]uiet, but [V]erbose on [F]ailure. Hide all output from tests
385 when they pass, except to say they passed. If a test fails then ALL
386 output from the test is verbosely output.
387 --show-job-end
389 --no-show-job-end
390 Show output when a job ends. (Default: on)
391 --show-job-info
393 --no-show-job-info
394 Show the job configuration when a job starts. (Default: off, unless
395 -vv)
396 --show-job-launch
398 --no-show-job-launch
399 Show output for the start of a job. (Default: off unless -v)
400 --show-run-info
402 --no-show-run-info
403 Show the run configuration when a run starts. (Default: off, unless
404 -vv)
405 Git Options
407 --git-change-base master
409 --git-change-base HEAD^
410 --git-change-base df22abe4
411 --no-git-change-base
412 Find files changed by all commits in the current branch from most
413 recent stopping when a commit is found that is also present in the
414 history of the branch/commit specified as the change base.
415 Help and Debugging
417 --dummy
419 -d
420 --no-dummy
421 Dummy run, do not actually execute anything
422 Can also be set with the following environment variables:
424 "T2_HARNESS_DUMMY"
425 --help
427 -h
428 --no-help
429 exit after showing help information
430 --interactive
432 -i
433 --no-interactive
434 Use interactive mode, 1 test at a time, stdin forwarded to it
435 --keep-dirs
437 --keep_dir
438 -k
439 --no-keep-dirs
440 Do not delete directories when done. This is useful if you want to
441 inspect the directories used for various commands.
442 --summary
444 --summary=/path/to/summary.json
445 --no-summary
446 Write out a summary json file, if no path is provided
447 'summary.json' will be used. The .json extension is added
448 automatically if omitted.
449 Logging Options
451 --bzip2
453 --bz2
454 --bzip2_log
455 -B
456 --no-bzip2
457 Use bzip2 compression when writing the log. This option implies -L.
458 The .bz2 prefix is added to log file name for you
459 --gzip
461 --gz
462 --gzip_log
463 -G
464 --no-gzip
465 Use gzip compression when writing the log. This option implies -L.
466 The .gz prefix is added to log file name for you
467 --log
469 -L
470 --no-log
471 Turn on logging
472 --log-dir ARG
474 --log-dir=ARG
475 --no-log-dir
476 Specify a log directory. Will fall back to the system temp dir.
477 --log-file ARG
479 --log-file=ARG
480 -F ARG
481 -F=ARG
482 --no-log-file
483 Specify the name of the log file. This option implies -L.
484 --log-file-format ARG
486 --log-file-format=ARG
487 --lff ARG
488 --lff=ARG
489 --no-log-file-format
490 Specify the format for automatically-generated log files.
491 Overridden by --log-file, if given. This option implies -L
492 (Default: \$YATH_LOG_FILE_FORMAT, if that is set, or else
493 "%!P%Y-%m-%d~%H:%M:%S~%!U~%!p.jsonl"). This is a string in which
494 percent-escape sequences will be replaced as per POSIX::strftime.
495 The following special escape sequences are also replaced: (%!P :
496 Project name followed by a ~, if a project is defined, otherwise
497 empty string) (%!U : the unique test run ID) (%!p : the process ID)
498 (%!S : the number of seconds since local midnight UTC)
499 Can also be set with the following environment variables:
501 "YATH_LOG_FILE_FORMAT", "TEST2_HARNESS_LOG_FORMAT"
502 Notification Options
504 --notify-email foo@example.com
506 --no-notify-email
507 Email the test results to the specified email address(es)
508 Can be specified multiple times
510 --notify-email-fail foo@example.com
512 --no-notify-email-fail
513 Email failing results to the specified email address(es)
514 Can be specified multiple times
516 --notify-email-from foo@example.com
518 --no-notify-email-from
519 If any email is sent, this is who it will be from
520 --notify-email-owner
522 --no-notify-email-owner
523 Email the owner of broken tests files upon failure. Add `# HARNESS-
524 META-OWNER foo@example.com` to the top of a test file to give it an
525 owner
526 --notify-no-batch-email
528 --no-notify-no-batch-email
529 Usually owner failures are sent as a single batch at the end of
530 testing. Toggle this to send failures as they happen.
531 --notify-no-batch-slack
533 --no-notify-no-batch-slack
534 Usually owner failures are sent as a single batch at the end of
535 testing. Toggle this to send failures as they happen.
536 --notify-slack '#foo'
538 --notify-slack '@bar'
539 --no-notify-slack
540 Send results to a slack channel and/or user
541 Can be specified multiple times
543 --notify-slack-fail '#foo'
545 --notify-slack-fail '@bar'
546 --no-notify-slack-fail
547 Send failing results to a slack channel and/or user
548 Can be specified multiple times
550 --notify-slack-owner
552 --no-notify-slack-owner
553 Send slack notifications to the slack channels/users listed in test
554 meta-data when tests fail.
555 --notify-slack-url https://hooks.slack.com/...
557 --no-notify-slack-url
558 Specify an API endpoint for slack webhook integrations
559 --notify-text ARG
561 --notify-text=ARG
562 --message ARG
563 --message=ARG
564 --msg ARG
565 --msg=ARG
566 --no-notify-text
567 Add a custom text snippet to email/slack notifications
568 --notify-text-module ARG
570 --notify-text-module=ARG
571 --message_module ARG
572 --message_module=ARG
573 --no-notify-text-module
574 Use the specified module to generate messages for emails and/or
575 slack.
576 Run Options
578 --author-testing
580 -A
581 --no-author-testing
582 This will set the AUTHOR_TESTING environment to true
583 --dbi-profiling
585 --no-dbi-profiling
586 Use Test2::Plugin::DBIProfile to collect database profiling data
587 --env-var VAR=VAL
589 -EVAR=VAL
590 -E VAR=VAL
591 --no-env-var
592 Set environment variables to set when each test is run.
593 Can be specified multiple times
595 --event-uuids
597 --uuids
598 --no-event-uuids
599 Use Test2::Plugin::UUID inside tests (default: on)
600 --fields name:details
602 --fields JSON_STRING
603 -f name:details
604 -f JSON_STRING
605 --no-fields
606 Add custom data to the harness run
607 Can be specified multiple times
609 --input ARG
611 --input=ARG
612 --no-input
613 Input string to be used as standard input for ALL tests. See also:
614 --input-file
615 --input-file ARG
617 --input-file=ARG
618 --no-input-file
619 Use the specified file as standard input to ALL tests
620 --io-events
622 --no-io-events
623 Use Test2::Plugin::IOEvents inside tests to turn all prints into
624 test2 events (default: off)
625 --link 'https://travis.work/builds/42'
627 --link 'https://jenkins.work/job/42'
628 --link 'https://buildbot.work/builders/foo/builds/42'
629 --no-link
630 Provide one or more links people can follow to see more about this
631 run.
632 Can be specified multiple times
634 --load ARG
636 --load=ARG
637 --load-module ARG
638 --load-module=ARG
639 -m ARG
640 -m=ARG
641 --no-load
642 Load a module in each test (after fork). The "import" method is not
643 called.
644 Can be specified multiple times
646 --load-import Module
648 --load-import Module=import_arg1,arg2,...
649 --loadim Module
650 --loadim Module=import_arg1,arg2,...
651 -M Module
652 -M Module=import_arg1,arg2,...
653 --no-load-import
654 Load a module in each test (after fork). Import is called.
655 Can be specified multiple times. If the same key is listed multiple
657 times the value lists will be appended together.
658 --mem-usage
660 --no-mem-usage
661 Use Test2::Plugin::MemUsage inside tests (default: on)
662 --retry ARG
664 --retry=ARG
665 -r ARG
666 -r=ARG
667 --no-retry
668 Run any jobs that failed a second time. NOTE: --retry=1 means
669 failing tests will be attempted twice!
670 --retry-isolated
672 --retry-iso
673 --no-retry-isolated
674 If true then any job retries will be done in isolation (as though
675 -j1 was set)
676 --run-id
678 --id
679 --no-run-id
680 Set a specific run-id. (Default: a UUID)
681 --test-args ARG
683 --test-args=ARG
684 --no-test-args
685 Arguments to pass in as @ARGV for all tests that are run. These can
686 be provided easier using the '::' argument separator.
687 Can be specified multiple times
689 --stream
691 --no-stream
692 Use the stream formatter (default is on)
693 --tap
695 --TAP
696 ----no-stream
697 --no-tap
698 The TAP format is lossy and clunky. Test2::Harness normally uses a
699 newer streaming format to receive test results. There are
700 old/legacy tests where this causes problems, in which case setting
701 --TAP or --no-stream can help.
702 YathUI Options
704 --yathui-api-key ARG
706 --yathui-api-key=ARG
707 --no-yathui-api-key
708 Yath-UI API key. This is not necessary if your Yath-UI instance is
709 set to single-user
710 --yathui-coverage
712 --no-yathui-coverage
713 Poll coverage data from Yath-UI to determine what tests should be
714 run for changed files
715 --yathui-db
717 --no-yathui-db
718 Add the YathUI DB renderer in addition to other renderers
719 --yathui-durations
721 --no-yathui-durations
722 Poll duration data from Yath-UI to help order tests efficiently
723 --yathui-grace
725 --no-yathui-grace
726 If yath cannot connect to yath-ui it normally throws an error, use
727 this to make it fail gracefully. You get a warning, but things keep
728 going.
729 --yathui-long-duration 10
731 --no-yathui-long-duration
732 Minimum duration length (seconds) before a test goes from MEDIUM to
733 LONG
734 --yathui-medium-duration 5
736 --no-yathui-medium-duration
737 Minimum duration length (seconds) before a test goes from SHORT to
738 MEDIUM
739 --yathui-mode summary
741 --yathui-mode qvf
742 --yathui-mode qvfd
743 --yathui-mode complete
744 --no-yathui-mode
745 Set the upload mode (default 'qvfd')
746 --yathui-only
748 --no-yathui-only
749 Only use the YathUI renderer
750 --yathui-only-db
752 --no-yathui-only-db
753 Only use the YathUI DB renderer
754 --yathui-port 8080
756 --no-yathui-port
757 Port to use when running a local server
758 --yathui-port-command get_port.sh
760 --yathui-port-command get_port.sh --pid $$
761 --no-yathui-port-command
762 Use a command to get a port number. "$$" will be replaced with the
763 PID of the yath process
764 --yathui-project ARG
766 --yathui-project=ARG
767 --no-yathui-project
768 The Yath-UI project for your test results
769 --yathui-render
771 --no-yathui-render
772 Add the YathUI renderer in addition to other renderers
773 --yathui-retry
775 --no-yathui-retry
776 How many times to try an operation before giving up
777 Can be specified multiple times
779 --yathui-schema PostgreSQL
781 --yathui-schema MySQL
782 --yathui-schema MySQL56
783 --no-yathui-schema
784 What type of DB/schema to use when using a temporary database
785 --yathui-upload
787 --no-yathui-upload
788 Upload the log to Yath-UI
789 --yathui-url http://my-yath-ui.com/...
791 --uri http://my-yath-ui.com/...
792 --no-yathui-url
793 Yath-UI url
794 --yathui-user ARG
796 --yathui-user=ARG
797 --no-yathui-user
798 Username to attach to the data sent to the db
799 --yathui-db-buffering none
801 --yathui-db-buffering job
802 --yathui-db-buffering diag
803 --yathui-db-buffering run
804 --no-yathui-db-buffering
805 Type of buffering to use, if "none" then events are written to the
806 db one at a time, which is SLOW
807 --yathui-db-config ARG
809 --yathui-db-config=ARG
810 --no-yathui-db-config
811 Module that implements 'MODULE->yath_ui_config(%params)' which
812 should return a Test2::Harness::UI::Config instance.
813 --yathui-db-coverage
815 --no-yathui-db-coverage
816 Pull coverage data directly from the database (default: off)
817 --yathui-db-driver Pg
819 --yathui-db-drivermysql
820 --yathui-db-driverMariaDB
821 --no-yathui-db-driver
822 DBI Driver to use
823 --yathui-db-dsn ARG
825 --yathui-db-dsn=ARG
826 --no-yathui-db-dsn
827 DSN to use when connecting to the db
828 --yathui-db-durations
830 --no-yathui-db-durations
831 Pull duration data directly from the database (default: off)
832 --yathui-db-flush-interval 2
834 --yathui-db-flush-interval 1.5
835 --no-yathui-db-flush-interval
836 When buffering DB writes, force a flush when an event is recieved
837 at least N seconds after the last flush.
838 --yathui-db-host ARG
840 --yathui-db-host=ARG
841 --no-yathui-db-host
842 hostname to use when connecting to the db
843 --yathui-db-name ARG
845 --yathui-db-name=ARG
846 --no-yathui-db-name
847 Name of the database to use for yathui
848 --yathui-db-pass ARG
850 --yathui-db-pass=ARG
851 --no-yathui-db-pass
852 Password to use when connecting to the db
853 --yathui-db-port ARG
855 --yathui-db-port=ARG
856 --no-yathui-db-port
857 port to use when connecting to the db
858 --yathui-db-publisher ARG
860 --yathui-db-publisher=ARG
861 --no-yathui-db-publisher
862 When using coverage or duration data, only use data uploaded by
863 this user
864 --yathui-db-socket ARG
866 --yathui-db-socket=ARG
867 --no-yathui-db-socket
868 socket to use when connecting to the db
869 --yathui-db-user ARG
871 --yathui-db-user=ARG
872 --no-yathui-db-user
873 Username to use when connecting to the db
874
876 The source code repository for Test2-Harness can be found at
877 http://github.com/Test-More/Test2-Harness/.
878
880 Chad Granum <exodist@cpan.org>
881
883 Chad Granum <exodist@cpan.org>
884
886 Copyright 2021 Chad Granum <exodist7@gmail.com>.
887 This program is free software; you can redistribute it and/or modify it
889 under the same terms as Perl itself.
890 See http://dev.perl.org/licenses/
892perl v5.34.0 2021-11-05 App::Yath::Command::stop(3)