/ 
App-ProveDirs-0.005
River stage one • 2 direct dependents • 6 total dependents
/ prove-dirs

NAME

prove-dirs - Prove one or more directories

VERSION

This document describes version 0.005 of prove-dirs (from Perl distribution App-ProveDirs), released on 2020-03-07.

SYNOPSIS

Usage:

% prove-dirs [options] <dir> ...

DESCRIPTION

Given one or more directories as argument (which are assumed to be directories of Perl distributions), this utility cd to each directory and run prove in each. It then provides a summary at the end.

You can run with --dry-run (-n) option first to not actually run prove but just see what directories will get tested. An example output:

% prove-dirs perl-* -n
prove-dirs: [DRY] [1/8] Running prove in directory 'perl-Acme-CPANModules' ...
prove-dirs: [DRY] [1/8] Running prove in directory 'perl-Data-Sah' ...
prove-dirs: [DRY] [1/8] Running prove in directory 'perl-Data-Sah-Filter' ...
prove-dirs: [DRY] [1/8] Running prove in directory 'perl-Date-strftimeq' ...
prove-dirs: [DRY] [1/8] Running prove in directory 'perl-Log-ger' ...
prove-dirs: [DRY] [1/8] Running prove in directory 'perl-Log-ger-Output-Screen' ...
prove-dirs: [DRY] [1/8] Running prove in directory 'perl-Module-Installed-Tiny' ...
prove-dirs: [DRY] [1/8] Running prove in directory 'perl-Text-ANSITable' ...
prove-dirs: [DRY] [1/8] Running prove in directory 'perl-lib-filter' ...

If we reinvoke the above command without the -n, prove-dirs will actually run prove in each directory and provide a summary at the end. Example output:

% prove-dirs perl-* -n
...
+-----------------------------+-----------------------------------+--------+
| dist                        | reason                            | status |
+-----------------------------+-----------------------------------+--------+
| perl-Acme-CPANModules       | Test failed (Failed 1/1 subtests) | 500    |
| perl-Date-strftimeq         | Test failed (No subtests run)     | 500    |
| perl-lib-filter             | Non-zero exit code (2)            | 500    |
+-----------------------------+-----------------------------------+--------+

The above example shows that three directories (distributions) failed testing. You can scroll up for the detailed prove output to see why they failed, fix things, and re-run.

When a distribution's test fails, this counts as a 500 error (Error). Otherwise, the status is 200 (OK).

prove-dirs will return status 200 (OK) with the status of each directory. It will exit 0 if all directories are successful, otherwise it will exit 1.

OPTIONS

* marks required options.

Main options

--dir=s@*

The directories.

Can be specified multiple times.

--dirs-json=s

The directories (JSON-encoded).

See --dir.

--prove-opt=s@

Options to pass to the prove command.

Default value:

["-l"]

Can be specified multiple times.

--prove-opts-json=s

Options to pass to the prove command (JSON-encoded).

See --prove-opt.

--summarize-all

If true, also summarize successes in addition to failures.

Logging options

--debug

Shortcut for --log-level=debug.

--log-level=s

Set log level.

--quiet

Shortcut for --log-level=error.

--trace

Shortcut for --log-level=trace.

--verbose

Shortcut for --log-level=info.

Output options

--format=s

Choose output format, e.g. json, text.

Default value:

undef
--json

Set output format to json.

--naked-res

When outputing as JSON, strip result envelope.

Default value:

0

By default, when outputing as JSON, the full enveloped result is returned, e.g.:

[200,"OK",[1,2,3],{"func.extra"=>4}]

The reason is so you can get the status (1st element), status message (2nd element) as well as result metadata/extra result (4th element) instead of just the result (3rd element). However, sometimes you want just the result, e.g. when you want to pipe the result for more post-processing. In this case you can use `--naked-res` so you just get:

[1,2,3]
--page-result

Filter output through a pager.

Other options

--dry-run

Run in simulation mode (also via DRY_RUN=1).

Default value:

""
--help, -h, -?

Display help message and exit.

--version, -v

Display program's version and exit.

COMPLETION

This script has shell tab completion capability with support for several shells.

bash

To activate bash completion for this script, put:

complete -C prove-dirs prove-dirs

in your bash startup (e.g. ~/.bashrc). Your next shell session will then recognize tab completion for the command. Or, you can also directly execute the line above in your shell to activate immediately.

It is recommended, however, that you install modules using cpanm-shcompgen which can activate shell completion for scripts immediately.

tcsh

To activate tcsh completion for this script, put:

complete prove-dirs 'p/*/`prove-dirs`/'

in your tcsh startup (e.g. ~/.tcshrc). Your next shell session will then recognize tab completion for the command. Or, you can also directly execute the line above in your shell to activate immediately.

It is also recommended to install shcompgen (see above).

other shells

For fish and zsh, install shcompgen as described above.

HOMEPAGE

Please visit the project's homepage at https://metacpan.org/release/App-ProveDirs.

SOURCE

Source repository is at https://github.com/perlancar/perl-App-ProveDirs.

BUGS

Please report any bugs or feature requests on the bugtracker website https://rt.cpan.org/Public/Dist/Display.html?Name=App-ProveDirs

When submitting a bug or request, please include a test-file or a patch to an existing test-file that illustrates the bug or desired feature.

AUTHOR

perlancar <perlancar@cpan.org>

COPYRIGHT AND LICENSE

This software is copyright (c) 2020 by perlancar@cpan.org.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.