File Coverage

blib/lib/CPAN/Smoker/Utils.pm

Criterion	Covered	Total	%
statement	33	37	89.1
branch	5	8	62.5
condition	1	2	50.0
subroutine	7	7	100.0
pod	2	2	100.0
total	48	56	85.7

package CPAN::Smoker::Utils;

use warnings;
use strict;
use Exporter 'import';
use CPAN;
use CPAN::HandleConfig;

our @EXPORT_OK = qw(is_distro_ok block_distro);

our $VERSION = 'v1.0.1'; # VERSION

=pod

=head1 NAME

CPAN::Smoker::Utils - Set of CLI's to manage a Perl CPAN smoker machine

=head1 DESCRIPTION

This module exports some functions used to manage a smoker testing machine
based on L.

=head2 Command Line Interfaces programs

The following programs are available under this distribution:

=over

=item *

C: blocks a distribution to be tested in the smoker.

=item *

C: further removes spurious files from a local CPAN mirror.

=item *

C: send local stored tests results to a running
L.

=back

You can check each program online documentation by using C,
C and C after installing the
distribution.

=head1 EXPORTS

Only the C C is exported, if explicit requested.

=head2 is_distro_ok

Expects as parameter a string in the format C.

It executes some very basic testing against the string.

Returns true or false depending if the string passes the tests. It will also
C if things are not OK.

=cut

sub is_distro_ok {
    my $distro = shift;

    unless ( defined($distro) ) {
        warn "--distro is a required parameter!\n\n";
        return 0;
    }

    unless ( $distro =~ /^\w+\/[\w-]+$/ ) {
        warn "invalid string '$distro' in --distro!\n\n";
        return 0;
    }
    else {
        return 1;
    }
}

=head2 block_distro

Blocks a distribution to be tested under the smoker by using a distroprefs file.

Expects as parameters:

=over

=item 1.

a distribution name (for example, "JOHNDOE/Some-Distro-Name").

=item 2.

The perl interpreter (which is in execution) configuration.

=item 3.

An comment to include in the distroprefs file.

=back

It returns a hash reference containing keys/values that could be directly
serialized to YAML (or other format) but the C key, that contains
a suggest complete path to the distroprefs file (based on the L
C configuration client.

If there is an already file created as defined in C key, it will
C and return C.

=cut

sub block_distro {
    my ( $distro, $perl_info, $comment ) = @_;
    my $distribution = '^' . $distro;
    my $filename     = "$distro.yml";
    $filename =~ s/\//./;

    my %data = (
        comment => $comment || 'Tests hang smoker',
        match   => {
            distribution => $distribution,
            perlconfig   => $perl_info
        },
        disabled => 1
    );

    CPAN::HandleConfig->load;
    my $prefs_dir = $CPAN::Config->{prefs_dir};
    die "$prefs_dir does not exist or it is not readable\n"
        unless ( -d $prefs_dir );
    my $full_path = File::Spec->catfile( $prefs_dir, $filename );

    if ( -f $full_path ) {
        warn "$full_path already exists, will not overwrite it.";
        return;
    }
    else {
        $data{full_path} = $full_path;
        return \%data;
    }
}

=head1 SEE ALSO

For more details about those programs interact with the smoker and
L, be sure to read the documentation about L client,
specially the part about DistroPrefs.

You will also want to take a look at the following programs documentation:

=over

=item *

C

=item *

C

=item *

C

=back

=head1 AUTHOR

Alceu Rodrigues de Freitas Junior, [e-mail]

=head1 COPYRIGHT AND LICENSE

This software is copyright (c) 2017 of Alceu Rodrigues de Freitas Junior,
[e-mail]

This file is part of CPAN Smoker Utils.

CPAN Smoker Utils is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

CPAN Smoker Utils is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with CPAN Smoker Utils.  If not, see L.

=cut

1;