prove-mods - Prove Perl modules' distributions
This document describes version 0.001 of prove-mods (from Perl distribution App-ProveMods), released on 2020-03-07.
Usage:
% prove-mods [options] <module> ...
To use this utility, first create ~/.config/prove-mods.conf:
~/.config/prove-mods.conf
dists_dirs = ~/repos dists_dirs = ~/repos-other
The above tells prove-mods where to look for Perl distributions. Then:
% prove-mods '^Regexp::Pattern.*'
This will search local CPAN mirror for all modules 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.
cd
prove
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:
--dry-run
-n
% prove-mods '^Regexp::Pattern' -n prove-mods: Found module: Regexp::Pattern (dist=Regexp-Pattern) prove-mods: Found module: Regexp::Pattern::CPAN (dist=Regexp-Pattern-CPAN) prove-mods: Found module: Regexp::Pattern::Example (dist=Regexp-Pattern) prove-mods: Found module: Regexp::Pattern::Git (dist=Regexp-Pattern-Git) prove-mods: Found module: Regexp::Pattern::JSON (dist=Regexp-Pattern-JSON) prove-mods: Found module: Regexp::Pattern::License (dist=Regexp-Pattern-License) prove-mods: Found module: Regexp::Pattern::License::Parts (dist=Regexp-Pattern-License) prove-mods: Found module: Regexp::Pattern::Net (dist=Regexp-Pattern-Net) prove-mods: Found module: Regexp::Pattern::OS (dist=Regexp-Pattern-OS) prove-mods: Found module: Regexp::Pattern::Path (dist=Regexp-Pattern-Path) prove-mods: Found module: Regexp::Pattern::RegexpCommon (dist=Regexp-Pattern-RegexpCommon) prove-mods: Found module: Regexp::Pattern::Test::re_engine (dist=Regexp-Pattern-Test-re_engine) prove-mods: Found module: Regexp::Pattern::Twitter (dist=Regexp-Pattern-Twitter) prove-mods: Found module: Regexp::Pattern::YouTube (dist=Regexp-Pattern-YouTube) prove-mods: Found dist: Regexp-Pattern prove-mods: Found dist: Regexp-Pattern-CPAN prove-mods: Found dist: Regexp-Pattern-Git prove-mods: Found dist: Regexp-Pattern-JSON prove-mods: Found dist: Regexp-Pattern-License prove-mods: Found dist: Regexp-Pattern-Net prove-mods: Found dist: Regexp-Pattern-OS prove-mods: Found dist: Regexp-Pattern-Path prove-mods: Found dist: Regexp-Pattern-RegexpCommon prove-mods: Found dist: Regexp-Pattern-Test-re_engine prove-mods: Found dist: Regexp-Pattern-Twitter prove-mods: Found dist: Regexp-Pattern-YouTube prove-mods: [DRY] [1/12] Running prove for distribution Regexp-Pattern (directory /home/u1/repos/perl-Regexp-Pattern) ... prove-mods: [DRY] [2/12] Running prove for distribution Regexp-Pattern-CPAN (directory /home/u1/repos/perl-Regexp-Pattern-CPAN) ... prove-mods: [DRY] [3/12] Running prove for distribution Regexp-Pattern-Git (directory /home/u1/repos/perl-Regexp-Pattern-Git) ... prove-mods: [DRY] [4/12] Running prove for distribution Regexp-Pattern-JSON (directory /home/u1/repos/perl-Regexp-Pattern-JSON) ... prove-mods: [DRY] [5/12] Running prove for distribution Regexp-Pattern-License (directory /tmp/hEa7jnla5M/Regexp-Pattern-License-v3.2.0) ... prove-mods: [DRY] [6/12] Running prove for distribution Regexp-Pattern-Net (directory /home/u1/repos/perl-Regexp-Pattern-Net) ... prove-mods: [DRY] [7/12] Running prove for distribution Regexp-Pattern-OS (directory /home/u1/repos/perl-Regexp-Pattern-OS) ... prove-mods: [DRY] [8/12] Running prove for distribution Regexp-Pattern-Path (directory /home/u1/repos/perl-Regexp-Pattern-Path) ... prove-mods: [DRY] [9/12] Running prove for distribution Regexp-Pattern-RegexpCommon (directory /home/u1/repos/perl-Regexp-Pattern-RegexpCommon) ... prove-mods: [DRY] [10/12] Running prove for distribution Regexp-Pattern-Test-re_engine (directory /home/u1/repos/perl-Regexp-Pattern-Test-re_engine) ... prove-mods: [DRY] [11/12] Running prove for distribution Regexp-Pattern-Twitter (directory /home/u1/repos/perl-Regexp-Pattern-Twitter) ... prove-mods: [DRY] [12/12] Running prove for distribution Regexp-Pattern-YouTube (directory /home/u1/repos/perl-Regexp-Pattern-YouTube) ...
The above example shows that I have the distribution directories locally on my ~/repos, except for one 'Regexp::Pattern::License'.
~/repos
If we reinvoke the above command without the -n, prove-rdeps will actually run prove on each directory and provide a summary at the end. Example output:
% prove-mods '^Regexp::Pattern' ... +-----------------------------------------------+-------------------------------------+-----------------------------------+--------+ | dir | label | reason | status | +-----------------------------------------------+-------------------------------------+-----------------------------------+--------+ | /tmp/2GOBZuxird/Regexp-Pattern-License-v3.2.0 | distribution Regexp-Pattern-License | Test failed (Failed 1/2 subtests) | 500 | +-----------------------------------------------+-------------------------------------+-----------------------------------+--------+
The above example shows that one distribution failed testing. You can scroll up for the detailed prove output to see the details of failure failed, fix things, and re-run.
How distribution directory is searched: see App::ProveDists documentation.
When a dependent 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-rdeps 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.
* marks required options.
*
Where to find the distributions directories.
Can be specified multiple times.
Where to find the distributions directories (JSON-encoded).
See --dists-dir.
--dists-dir
Module names to prove.
Module names to prove (JSON-encoded).
See --module.
--module
Options to pass to the prove command.
Default value:
["-l"]
Options to pass to the prove command (JSON-encoded).
See --prove-opt.
--prove-opt
If true, also summarize successes in addition to failures.
Set path to configuration file.
Set configuration profile to use.
Do not use any configuration file.
Do not read environment for default options.
Shortcut for --log-level=debug.
Set log level.
Shortcut for --log-level=error.
Shortcut for --log-level=trace.
Shortcut for --log-level=info.
Choose output format, e.g. json, text.
undef
Set output format to json.
When outputing as JSON, strip result envelope.
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]
Filter output through a pager.
Run in simulation mode (also via DRY_RUN=1).
""
Display help message and exit.
Display program's version and exit.
This script has shell tab completion capability with support for several shells.
To activate bash completion for this script, put:
complete -C prove-mods prove-mods
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.
To activate tcsh completion for this script, put:
complete prove-mods 'p/*/`prove-mods`/'
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).
For fish and zsh, install shcompgen as described above.
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-mods.conf, ~/prove-mods.conf, or /etc/prove-mods.conf.
--config-path
All found files will be read and merged.
To disable searching for configuration files, pass --no-config.
--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.
[profile=SOMENAME]
[SOMESECTION profile=SOMENAME]
--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.
program=NAME
[program=NAME ...]
[SOMESECTION program=NAME]
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.
env=CONDITION
[env=SOMEVAR ...]
[SOMESECTION env=SOMEVAR ...]
[env=HOSTNAME=blink ...]
[SOMESECTION env=HOSTNAME=blink ...]
[env=HOSTNAME!=blink ...]
[SOMESECTION env=HOSTNAME!=blink ...]
[env=HOSTNAME*=server ...]
[SOMESECTION env=HOSTNAME*=server ...]
List of available configuration parameters:
dists_dirs (see --dists-dir) download (see --no-download) format (see --format) log_level (see --log-level) modules (see --module) naked_res (see --naked-res) prove_opts (see --prove-opt) summarize_all (see --summarize-all)
Specify additional command-line options.
~/prove-mods.conf
/etc/prove-mods.conf
Please visit the project's homepage at https://metacpan.org/release/App-ProveMods.
Source repository is at https://github.com/perlancar/perl-App-ProveMods.
Please report any bugs or feature requests on the bugtracker website https://rt.cpan.org/Public/Dist/Display.html?Name=App-ProveMods
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.
perlancar <perlancar@cpan.org>
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.
To install App::ProveMods, copy and paste the appropriate command in to your terminal.
cpanm
cpanm App::ProveMods
CPAN shell
perl -MCPAN -e shell install App::ProveMods
For more information on module installation, please visit the detailed CPAN module installation guide.