Test::RRA::ModuleVersion

(Check Perl module versions for consistency)

Synopsis | Description | Functions | Author | Copyright and License
See Also

SYNOPSIS

    use Test::RRA::ModuleVersion
      qw(test_module_versions update_module_versions);

    # Ensure all modules under perl/lib have a version of v3.1.2.
    test_module_versions('perl/lib', 'v3.1.2');

    # Update the version of those modules to v3.1.2.
    update_module_versions('perl/lib', 'v3.1.2');

DESCRIPTION

This module provides functions to test and update the versions of Perl modules. It helps with enforcing consistency of versioning across all modules in a Perl distribution or embedded in a larger project containing non-Perl code. The calling script provides the version with which to be consistent and the root directory under which modules are found.

FUNCTIONS

None of these functions are imported by default. The ones used by a script should be explicitly imported.

test_module_versions(ROOT, VERSION)

Tests the version of all Perl modules under ROOT to ensure they match VERSION, reporting the results with Test::More. VERSION should include any leading v.

If the test configuration loaded by Test::RRA::Config contains a @MODULE_VERSION_EXCLUDE variable, the module files listed there will be ignored for this test.

This function sets up a plan based on the number of modules, so should be the only testing function called in a test script.

update_module_versions(ROOT, VERSION)

Update the version of all Perl modules found under ROOT to VERSION, except for any listed in a @MODULE_VERSION_EXCLUDE variable set in the test configuration loaded by Test::RRA::Config. VERSION should include any leading v.

AUTHOR

Russ Allbery <eagle@eyrie.org>

COPYRIGHT AND LICENSE

Copyright 2016, 2018-2020, 2022, 2024 Russ Allbery <eagle@eyrie.org>

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

SEE ALSO

Test::More(3), Test::RRA::Config(3)

This module is maintained in the rra-c-util package. The current version is available from <https://www.eyrie.org/~eagle/software/rra-c-util/>.