File Coverage

blib/lib/HPC/Runner/Command/execute_job/Base.pm

Criterion	Covered	Total	%
statement	12	12	100.0
branch			n/a
condition			n/a
subroutine	4	4	100.0
pod			n/a
total	16	16	100.0

package HPC::Runner::Command::execute_job::Base;

use MooseX::App::Role;
use MooseX::Types::Path::Tiny qw/Path Paths AbsPath AbsFile/;

with 'HPC::Runner::Command::execute_job::Utils::Plugin';
with 'HPC::Runner::Command::execute_job::Utils::Log';
with 'HPC::Runner::Command::execute_job::Logger::JSON';

use Sys::Hostname;
use Archive::Tar;

=head2 Command Line Options

=cut


=head2 Internal Attriutes

=cut

=head3 job_scheduler_id

Job Scheduler ID running the script. Passed to slurm for mail information

=cut

has 'job_scheduler_id' => (
    is      => 'rw',
    isa     => 'Str|Undef',
    default => sub {
        my $self = shift;
        my $scheduler_id =
             $ENV{SLURM_ARRAY_JOB_ID}
          || $ENV{SLURM_JOB_ID}
          || $ENV{SBATCH_JOB_ID}
          || $ENV{PBS_JOBID}
          || $ENV{JOB_ID}
          || '';
        if ( $self->can('task_id') && $self->task_id ) {
            $scheduler_id = $scheduler_id . '_' . $self->task_id;
        }
        return $scheduler_id;
    },
    lazy => 1,
    documentation =>
q{This defaults to your current Job Scheduler ID. Ignore this if running on a single node},
    predicate => 'has_job_scheduler_id',
    clearer   => 'clear_job_scheduler_id',
);

has 'hostname' => (
    is      => 'rw',
    isa     => 'Str|Undef',
    default => sub {
        return hostname;
    },
);

has 'wait' => (
    is      => 'rw',
    isa     => 'Bool',
    default => 0,
);

=head3 counter

This is task_id counter. Batch index start and/or array_id get passed in on the command line
But for instances where we are creating a threadpool of more than 1 task
The counter keeps track

=cut

has 'counter' => (
    traits   => ['Counter'],
    is       => 'rw',
    isa      => 'Num',
    required => 1,
    default  => 1,
    handles  => {
        inc_counter   => 'inc',
        dec_counter   => 'dec',
        reset_counter => 'reset',
    },
);

has 'jobref' => (
    is      => 'rw',
    isa     => 'ArrayRef',
    default => sub { [ [] ] },
);

1;