File Coverage

lib/OpenVZ.pm

Criterion	Covered	Total	%
statement	46	46	100.0
branch	9	10	90.0
condition	4	9	44.4
subroutine	14	14	100.0
pod	2	2	100.0
total	75	81	92.5

package OpenVZ;

# no critic qw( ErrorHandling::RequireUseOfExceptions )

# ABSTRACT: Base class for OpenVZ utilities like vzctl

#XXX: We need to load and parse the VZ system config file.


use 5.006;

use strict;
use warnings;

# This way, we don't need to remember to use autoclean in our submodules.
#use namespace::autoclean ();
#sub import { return namespace::autoclean->import( -cleanee => scalar caller ) }
use namespace::sweep ();
sub import { return namespace::sweep->import( -cleanee => scalar caller, -also => qr/^_\w*$/ ) }

use Carp;

#use Config::NameValue;
#use Regexp::Common qw( URI net );

use File::Which;
use IPC::Run3::Simple;
use Params::Validate qw( validate ARRAYREF );
use Scalar::Util 'blessed';
use Sub::Exporter;
use Sub::Exporter::Util 'curry_method';
use Sub::Exporter::ForMethods 'method_installer';

our $VERSION = '0.01'; # VERSION

############################################################################
# Public Functions


{  # Quick! Hide!!

    my @exports;

    # @exports holds the names of functions to be exported.  The easiest way to
    # maintain this is to push the name of the function right before it is
    # defined.

    #push @exports, 'new';

    my $object; ## no critic qw( Bangs::ProhibitVagueNames )

    sub new { ## no critic qw( Bangs::ProhibitVagueNames Subroutines::RequireArgUnpacking )

        shift if blessed $_[0] or $_[0] eq __PACKAGE__;
        croak 'OpenVZ is designed to be an abstract class' if @_ == 0;
        return bless \$object, ref $_[0] || $_[0]; ## no critic qw( Bangs::ProhibitVagueNames )

    }
    ## use critic

    my %program;

    # Determines if the specified command is installed, what its path is and
    # caches it. Used in execute.

    my $find_command = sub {

        shift if blessed $_[0] or $_[0] eq __PACKAGE__;

        #my ( $pgm, $params ) = @_;
        my $pgm = shift;

        return 1
            if exists $program{ path }{ $pgm };

        $program{ path }{ $pgm } = which( $pgm )
            or croak "Could not find $pgm in path ($ENV{PATH})";

        return 1;

    };

    push @exports, 'execute';

    sub execute { ## no critic qw( Subroutines::RequireArgUnpacking )

        # We're doing the funky twisty stuff here so we can handle either functional or oop style calls.
        # I think this is because of the way Sub::Exporter handles things, but I'm not sure.
        shift if blessed $_[0] or $_[0] eq __PACKAGE__;
        shift if blessed $_[0];

        my %arg = validate(
            @_, {
                'command' => { callbacks => { 'find command path' => $find_command } },
                'params' => { type => ARRAYREF, optional => 1 },
            } );

        # XXX: Need to handle also the case of a hashref

        my @args = $program{ path }{ $arg{ command } };
        push @args, @{ $arg{ params } } if exists $arg{ params };
        return run3( \@args );

    } ## end sub execute

############################################################################
    # Utility Functions - not for general consumption

############################################################################
    # Setup exporter

    my %exports = map { ( $_ => curry_method ) } @exports;

    my $config = {

        exports   => \%exports,
        installer => method_installer,

    };

    Sub::Exporter::setup_exporter( $config );

} ## end hiding

1;

__END__