File Coverage

blib/lib/App/clad.pm

Criterion	Covered	Total	%
statement	225	277	81.2
branch	72	100	72.0
condition	13	21	61.9
subroutine	55	62	88.7
pod	0	37	0.0
total	365	497	73.4

package App::clad;

use strict;
use warnings;
use 5.010;
use Getopt::Long 1.24 qw( GetOptionsFromArray :config pass_through);
use Pod::Usage qw( pod2usage );
use Clustericious::Config 1.03;
use Term::ANSIColor ();
use Sys::Hostname qw( hostname );
use YAML::XS qw( Dump );
use File::Basename qw( basename );
use AE;
use Clustericious::Admin::RemoteHandler;
use Clustericious::Admin::Dump qw( perl_dump );
use File::chdir;
use Path::Class ();

# ABSTRACT: Parallel SSH client
our $VERSION = '1.09'; # VERSION


sub _local_default ($$)
{
  eval { require Clustericious::Admin::ConfigData }
    ? Clustericious::Admin::ConfigData->config($_[0])
    : $_[1];
}

sub main
{
  my $clad = shift->new(@_);
  $clad->run;
}

# this hook is used for testing
# see t/args.t subtest 'color'
our $_stdout_is_terminal = sub { -t STDOUT };

sub new
{
  my $class = shift;

  my $self = bless {
    dry_run    => 0,
    color      => $_stdout_is_terminal->(),
    server     => 0,
    verbose    => 0,
    serial     => 0,
    next_color => -1,
    ret        => 0,
    fat        => 0,
    max        => 0,
    count      => 0,
    summary    => 0,
    files      => [],
    purge      => 0,
    list       => 0,
  }, $class;

  my @argv = @_;

  my $config_name = 'Clad';

  GetOptionsFromArray(
    \@argv,
    'n'         => \$self->{dry_run},
    'a'         => sub { $self->{color} = 0 },
    'l=s'       => \$self->{user},
    'server'    => \$self->{server},
    'verbose'   => \$self->{verbose},
    'serial'    => \$self->{serial},
    'config=s'  => \$config_name,
    'fat'       => \$self->{fat},
    'max=s'     => \$self->{max},
    'file=s'    => $self->{files},
    'dir=s'     => \$self->{dir},
    'summary'   => \$self->{summary},
    'purge'     => \$self->{purge},
    'list'      => \$self->{list},

    'log'       => sub {
      $self->{log_dir} = Path::Class::Dir->new(
        File::HomeDir->my_dist_data('Clustericious-Admin', { create => 1 } ),
        'log',
        sprintf("%08x.%s", time, $$)
      );
    },

    'log-dir=s' => sub { $self->{log_dir} = Path::Class::Dir->new($_[1]) },

    'help|h'    => sub { pod2usage({ -verbose => 2}) },
    'version'   => sub {
      say STDERR 'App::clad version ', ($App::clad::VERSION // 'dev');
      exit 1;
    },
  ) || pod2usage(1);

  $self->log_dir->mkpath(0,0700) if $self->log_dir;

  $self->{config} = Clustericious::Config->new($config_name);

  return $self if $self->server;
  return $self if $self->purge;
  return $self if $self->list;

  # make sure there is at least one cluster specified
  # and that it doesn't look like a command line option
  unless(@argv)
  {
    pod2usage({
      -exitval  => 'NOEXIT',
      -message  => "No clusters specified",
      -sections => [ qw( SYNOPSIS) ],
      -verbose  => 99,
    });
    $self->{list} = 1;
    $self->ret(1);
    return $self;
  }
  pod2usage({ -exitvalue => 1, -message => "Unknown option: $1" })
    if $argv[0] =~ /^--?(.*)$/;

  $self->{clusters} = [ split ',', shift @argv ];

  # make sure there is at least one command argument is specified
  # and that it doesn't look like a command line option
  pod2usage({ -exitval => 1, -message => "No commands specified" })
    unless @argv;
  pod2usage({ -exitvalue => 1, -message => "Unknown option: $1" })
    if $argv[0] =~ /^--?(.*)$/;

  $self->{command}  = [ @argv ];

  if(my $expanded = $self->alias->{$self->command->[0]})
  {
    if(ref $expanded)
    {
      splice @{ $self->command }, 0, 1, @$expanded;
    }
    else
    {
      $self->command->[0] = $expanded;
    }
  }

  if($self->config->script(default => {})->{$self->command->[0]})
  {
    my $name = shift @{ $self->command };
    unshift @{ $self->command }, '$SCRIPT1';
    my $content = $self->config->script(default => {})->{$name};
    $self->{script} = [ $name => $content ];
  }

  my $ok = 1;

  foreach my $cluster (map { "$_" } $self->clusters)
  {
    $cluster =~ s/^.*@//;
    unless($self->cluster_list->{$cluster})
    {
      $self->cluster_list->{$cluster} = [$cluster];
    }
  }

  foreach my $file ($self->files)
  {
    next if -r $file;
    say STDERR "unable to find $file";
    $ok = 0;
  }

  if(defined $self->dir && ! -d $self->dir)
  {
    say STDERR "unable to find @{[ $self->dir ]}";
    $ok = 0;
  }

  unless(-t STDIN)
  {
    $self->{stdin} = do { local $/; <STDIN> };
    delete $self->{stdin}
      unless defined $self->{stdin}
      &&     length $self->{stdin};
  }

  exit 2 unless $ok;

  $self;
}

sub config         { shift->{config}            }
sub dry_run        { shift->{dry_run}           }
sub color          { shift->{color}             }
sub clusters       { @{ shift->{clusters} }     }
sub command        { shift->{command}           }
sub user           { shift->{user}              }
sub server         { shift->{server}            }
sub verbose        { shift->{verbose}           }
sub serial         { shift->{serial}            }
sub max            { shift->{max}               }
sub files          { @{ shift->{files} }        }
sub dir            { shift->{dir}               }
sub script         { @{ shift->{script} // [] } }
sub stdin          { defined shift->{stdin}     }
sub summary        { shift->{summary}           }
sub log_dir        { shift->{log_dir}           }
sub purge          { shift->{purge}             }
sub list           { shift->{list}              }
sub fail_color     { shift->config->fail_color ( default => 'bold red'    ) }
sub err_color      { shift->config->err_color  ( default => 'bold yellow' ) }
sub ssh_command    { shift->config->ssh_command(    default => 'ssh' ) }
sub ssh_options    { shift->config->ssh_options(    default => [ -o => 'StrictHostKeyChecking=no',
                                                                 -o => 'BatchMode=yes',
                                                                 -o => 'PasswordAuthentication=no',
                                                                 '-T', ] ) }
sub ssh_extra      { shift->config->ssh_extra(      default => [] ) }
sub fat            { my $self = shift; $self->{fat} || $self->config->fat( default => _local_default 'clad_fat', 0 ) }

sub server_command
{
  my($self) = @_;

  $self->fat
  ? $self->config->fat_server_command( default => _local_default 'clad_fat_server_command', 'perl' )
  : $self->config->server_command(     default => _local_default 'clad_server_command', 'clad --server' );
}

sub alias
{
  my($self) = @_;
  $self->config->alias( default => sub {
    my %deprecated = $self->config->aliases( default => {} );
    say STDERR "use of aliases key in configuration is deprecated, use alias instead"
        if %deprecated;
    \%deprecated;
  });
}

sub cluster_list
{
  my($self) = @_;
  $self->config->cluster( default => sub {
    my %deprecated = $self->config->clusters( default => {} );
    say STDERR "use of clusters key in configuration is deprecated, use cluster instead"
        if %deprecated;
    \%deprecated;
  });
}

sub ret
{
  my($self, $new) = @_;
  $self->{ret} = $new if defined $new;
  $self->{ret};
}

sub host_length
{
  my($self) = @_;

  unless($self->{host_length})
  {
    my $length = 0;

    foreach my $cluster (map { "$_" } $self->clusters)
    {
      my $user = $cluster =~ s/^(.*)@// ? $1 : $self->user;
      foreach my $host (@{ $self->cluster_list->{$cluster} })
      {
        my $prefix = ($user ? "$user\@" : '') . $host;
        $length = length $prefix if length $prefix > $length;
      }
    }

    $self->{host_length} = $length;
  }

  $self->{host_length};
}

sub next_color
{
  my($self) = @_;
  my @colors = $self->config->colors( default => ['green','cyan'] );
  $colors[ ++$self->{next_color} ] // $colors[ $self->{next_color} = 0 ];
}

sub payload
{
  my($self, $clustername) = @_;

  my %env = $self->config->env( default => {} );
  $env{CLUSTER}      //= $clustername; # deprecate
  $env{CLAD_CLUSTER} //= $clustername;

  my $payload = {
    env     => \%env,
    command => $self->command,
    verbose => $self->verbose,
    version => $App::clad::VERSION // 'dev',
  };

  if($self->files)
  {
    $payload->{require} = '1.01';

    foreach my $filename ($self->files)
    {
      my %h;
      open my $fh, '<', $filename;
      binmode $fh;
      $h{content} = do { local $/; <$fh> };
      close $fh;
      $h{name} = basename $filename;
      $h{mode} = sprintf "%o", (stat $filename)[2] & 0777;
      push @{ $payload->{files} }, \%h;
    }
  }

  if($self->script)
  {
    my($name, $content) = $self->script;
    $payload->{require} = '1.01';

    push @{ $payload->{files} }, {
      name    => $name,
      content => $content,
      mode    => '0700',
      env     => 'SCRIPT1',
    };
  }

  if($self->dir)
  {
    $payload->{require} = '1.02';

    $CWD = $self->dir;

    my $recurse;
    $recurse = sub {
      my($dir) = @_;
      foreach my $child ($dir->children(no_hidden => 1))
      {
        my $key = $child->relative->stringify;
        if($child->is_dir)
        {
          $payload->{dir}->{$key} = {
            is_dir => 1,
          };
          $recurse->($child);
        }
        else
        {
          $payload->{dir}->{$key} = {
            content => scalar $child->slurp(iomode => '<:bytes'),
          };
        }
        $payload->{dir}->{$key}->{mode} = sprintf '%o', $child->stat->mode & 0777;
      }
    };

    $recurse->(Path::Class::Dir->new);
  }

  if($self->stdin)
  {
    $payload->{require} = '1.04';

    # TODO:
    # In Perl 5.22 we could refalias this
    # and save some memory copies.
    $payload->{stdin} = $self->{stdin};
  }

  if($self->fat)
  {
    # Perl on the remote end may not have YAML
    # so we dump as Perl data structure
    # instead.
    $payload = perl_dump($payload);
    require Clustericious::Admin::Server;
    open my $fh, '<', $INC{'Clustericious/Admin/Server.pm'};
    my $code = do { local $/; <$fh> };
    close $fh;
    $code =~ s{\s*$}{"\n"}e;
    $payload = $code . $payload;
  }
  else
  {
    $payload = Dump($payload);
  }

  $payload;
}

sub run
{
  my($self) = @_;

  return $self->run_server if $self->server;
  return $self->run_purge  if $self->purge;
  return $self->run_list   if $self->list;

  my @done;
  my $max = $self->max;


  foreach my $cluster (map { "$_" } $self->clusters)
  {
    my $user = $cluster =~ s/^(.*)@// ? $1 : $self->user;

    my $payload = $self->payload($cluster);

    foreach my $host (@{ $self->cluster_list->{$cluster} })
    {
      my $prefix = ($user ? "$user\@" : '') . $host;
      if($self->dry_run)
      {
        say "$prefix % @{ $self->command }";
      }
      else
      {
        my $remote = Clustericious::Admin::RemoteHandler->new(
          prefix  => $prefix,
          clad    => $self,
          user    => $user,
          host    => $host,
          payload => $payload,
        );

        my $done = $remote->cv;

        $done->cb(sub {
          my $count = --$self->{count};
          $self->{cv}->send if $self->{cv};
        }) if $max;

        if($max)
        {
          my $count = ++$self->{count};
          if($count >= $max)
          {
            $self->{cv} = AE::cv;
            $self->{cv}->recv;
            delete $self->{cv};
          }
        }

        $self->serial ? $done->recv : push @done, $done;
      }
    }
  }

  $_->recv for @done;

  say "See @{[ $self->log_dir ]} for all logs" if $self->log_dir;

  $self->ret;
}

sub run_server
{
  require Clustericious::Admin::Server;
  Clustericious::Admin::Server->_server(*STDIN);
}

sub run_purge
{
  my $log_dir = Path::Class::Dir->new(
    File::HomeDir->my_dist_data('Clustericious-Admin', { create => 1 } ),
    'log',
  );

  return unless -d $log_dir;

  foreach my $path ($log_dir->children)
  {
    if(-d $path)
    {
      say "PURGE DIR  $path";
      $path->rmtree(1, 1);
    }
    else
    {
      say "PURGE FILE $path";
      $path->remove;
    }
  }
}

sub run_list
{
  my($self) = @_;

  my @clusters = sort keys %{ $self->cluster_list };

  my $cluster = shift @clusters;
  if($cluster)
  {
    say "Clusters: $cluster";
    say "          $_" for @clusters;
  }
  else
  {
    say "Clusters: [none]";
  }

  my @alias = sort keys %{ $self->alias };
  my $alias = shift @alias;
  if($alias)
  {
    say "Aliases:  $alias";
    say "          $_" for @alias;
  }
  else
  {
    say "Aliases:  [none]";
  }

  $self->ret;
}

1;

__END__

=pod

=encoding UTF-8

=head1 NAME

App::clad - Parallel SSH client

=head1 VERSION

version 1.09

=head1 SYNOPSIS

 % perldoc clad

=head1 DESCRIPTION

This module provides the implementation for the L<clad> command.  See
the L<clad> command for the public interface.

=head1 SEE ALSO

=over 4

=item L<clad>

=back

=head1 AUTHOR

Graham Ollis <[e-mail]>

=head1 COPYRIGHT AND LICENSE

This software is copyright (c) 2015 by Graham Ollis.

This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.

=cut