/ 
App-ProveDists-0.003
River stage one • 4 direct dependents • 5 total dependents
/ prove-dists

NAME

prove-dists - Prove Perl distributions

VERSION

This document describes version 0.003 of prove-dists (from Perl distribution App-ProveDists), released on 2020-03-07.

SYNOPSIS

Usage:

% prove-dists [options] <dist_pattern> ...

DESCRIPTION

To use this utility, first create ~/.config/prove-dists.conf:

dists_dirs = ~/repos
dists_dirs = ~/repos-other

The above tells prove-dists where to look for Perl distributions. Then:

% prove-dists '^Games-Word-Wordlist-.+$'

This will search local CPAN mirror for all distributions that match that regex pattern, then search the distributions in the distribution directories (or download them from local CPAN mirror), cd to each and run prove in it.

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

% prove-dists '^Games-Word-Wordlist-.+$' -n
prove-dists: Found dist: Games-Word-Wordlist-Country
prove-dists: Found dist: Games-Word-Wordlist-Enable
prove-dists: Found dist: Games-Word-Wordlist-HSK
prove-dists: Found dist: Games-Word-Wordlist-KBBI
prove-dists: Found dist: Games-Word-Wordlist-SGB
prove-dists: [DRY] [1/5] Running prove for distribution Games-Word-Wordlist-Country (directory /home/u1/repos/perl-Games-Word-Wordlist-Country) ...
prove-dists: [DRY] [2/5] Running prove for distribution Games-Word-Wordlist-Enable (directory /tmp/AmYe5AHXpm/Games-Word-Wordlist-Enable-2010090401) ...
prove-dists: [DRY] [3/5] Running prove for distribution Games-Word-Wordlist-HSK (directory /home/u1/repos/perl-Games-Word-Wordlist-HSK) ...
prove-dists: [DRY] [4/5] Running prove for distribution Games-Word-Wordlist-KBBI (directory /home/u1/repos/perl-Games-Word-Wordlist-KBBI) ...
prove-dists: [DRY] [5/5] Running prove for distribution Games-Word-Wordlist-SGB (directory /tmp/xHAvt5uAhM/Games-Word-Wordlist-SGB-2010091501) ...

The above example shows that I have the distribution directories locally on my ~/repos, except for Games-Word-Wordlist-Enable and Games-Word-Wordlist-SGB, which prove-dists downloads and extracts from local CPAN mirror and puts into temporary directories.

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

% prove-dists '^Games-Word-Wordlist-.+$'
+----------------------------------------------+---------------------------------------+-----------------------------------+--------+
| dir                                          | label                                 | reason                            | status |
+----------------------------------------------+---------------------------------------+-----------------------------------+--------+
| /home/u1/repos/perl-Games-Word-Wordlist-KBBI | distribution Games-Word-Wordlist-KBBI | Test failed (Failed 1/1 subtests) | 500    |
+----------------------------------------------+---------------------------------------+-----------------------------------+--------+

The above example shows that one distribution failed testing. You can scroll up for the detailed prove output to see the detail of the failure, fix things, and re-run.

To summarize not only failures but all successes as well, use --summarize-all option:

% prove-dists '^Games-Word-Wordlist-.+$' --summarize-all
+-------------------------------------------------------+------------------------------------------+-----------------------------------+--------+
| dir                                                   | label                                    | reason                            | status |
+-------------------------------------------------------+------------------------------------------+-----------------------------------+--------+
| /home/u1/repos/perl-Games-Word-Wordlist-Country       | distribution Games-Word-Wordlist-Country | PASS                              | 200    |
| /tmp/rjjMJVgaXg/Games-Word-Wordlist-Enable-2010090401 | distribution Games-Word-Wordlist-Enable  | PASS                              | 200    |
| /home/u1/repos/perl-Games-Word-Wordlist-HSK           | distribution Games-Word-Wordlist-HSK     | NOTESTS                           | 200    |
| /home/u1/repos/perl-Games-Word-Wordlist-KBBI          | distribution Games-Word-Wordlist-KBBI    | Test failed (Failed 1/1 subtests) | 500    |
| /tmp/_W8im6EvA0/Games-Word-Wordlist-SGB-2010091501    | distribution Games-Word-Wordlist-SGB     | PASS                              | 200    |
+-------------------------------------------------------+------------------------------------------+-----------------------------------+--------+

How distribution directory is searched: first, the exact name (My-Perl-Dist) is searched. If not found, then the name with different case (e.g. my-perl-dist) is searched. If not found, a suffix match (e.g. p5-My-Perl-Dist or cpan-My-Perl-Dist) is searched. If not found, a prefix match (e.g. My-Perl-Dist-perl) is searched. If not found, prove-dists will try to download the distribution tarball from local CPAN mirror and extract it to a temporary directory. If --no-dowload is given, the prove-dists will not download from local CPAN mirror and give up for that distribution.

When a distribution cannot be found or downloaded/extracted, this counts as a 412 error (Precondition Failed).

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

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

OPTIONS

* marks required options.

Main options

--dist-pattern=s@*

Distribution name patterns to find.

Can be specified multiple times.

--dist-patterns-json=s

Distribution name patterns to find (JSON-encoded).

See --dist-pattern.

--dists-dir=s@*

Where to find the distributions directories.

Can be specified multiple times.

--dists-dirs-json=s

Where to find the distributions directories (JSON-encoded).

See --dists-dir.

--no-download
--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.

Configuration options

--config-path=s, -c

Set path to configuration file.

--config-profile=s, -P

Set configuration profile to use.

--no-config, -C

Do not use any configuration file.

Environment options

--no-env

Do not read environment for default options.

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-dists prove-dists

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-dists 'p/*/`prove-dists`/'

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.

CONFIGURATION FILE

This script can read configuration files. Configuration files are in the format of IOD, which is basically INI with some extra features.

By default, these names are searched for configuration filenames (can be changed using --config-path): ~/.config/prove-dists.conf, ~/prove-dists.conf, or /etc/prove-dists.conf.

All found files will be read and merged.

To disable searching for configuration files, pass --no-config.

You can put multiple profiles in a single file by using section names like [profile=SOMENAME] or [SOMESECTION profile=SOMENAME]. Those sections will only be read if you specify the matching --config-profile SOMENAME.

You can also put configuration for multiple programs inside a single file, and use filter program=NAME in section names, e.g. [program=NAME ...] or [SOMESECTION program=NAME]. The section will then only be used when the reading program matches.

Finally, you can filter a section by environment variable using the filter env=CONDITION in section names. For example if you only want a section to be read if a certain environment variable is true: [env=SOMEVAR ...] or [SOMESECTION env=SOMEVAR ...]. If you only want a section to be read when the value of an environment variable has value equals something: [env=HOSTNAME=blink ...] or [SOMESECTION env=HOSTNAME=blink ...]. If you only want a section to be read when the value of an environment variable does not equal something: [env=HOSTNAME!=blink ...] or [SOMESECTION env=HOSTNAME!=blink ...]. If you only want a section to be read when an environment variable contains something: [env=HOSTNAME*=server ...] or [SOMESECTION env=HOSTNAME*=server ...]. Note that currently due to simplistic parsing, there must not be any whitespace in the value being compared because it marks the beginning of a new section filter or section name.

List of available configuration parameters:

dist_patterns (see --dist-pattern)
dists_dirs (see --dists-dir)
download (see --no-download)
format (see --format)
log_level (see --log-level)
naked_res (see --naked-res)
prove_opts (see --prove-opt)
summarize_all (see --summarize-all)

ENVIRONMENT

PROVE_DISTS_OPT => str

Specify additional command-line options.

FILES

~/.config/prove-dists.conf

~/prove-dists.conf

/etc/prove-dists.conf

HOMEPAGE

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

SOURCE

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

BUGS

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

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.