blib/lib/NBI/QueuedJob.pm

filter: Statementstmt 83.5% 61 / 73 Branchbran 50.0% 23 / 46 Conditioncond 33.3% 2 / 6 MC/DCmcdc 0.0% 0 / 4 Subroutinesub 100% 9 / 9 Podpod 100% 6 / 6 totaltotal 70.1% 101 / 144 CC 27 SCAR 30.8
CC
27
Cov
69%
new
39.2
status
5.2
jobid
4.8
CRAP 21.7
« bin/runjob ↑ Summary blib/lib/NBI/Test.pl »
1 #ABSTRACT: NBI::QueuedJob, to describe a job from the SLURM queue (squeue)
2 #
3 # NBI::QueuedJob - Represents a single job entry returned by squeue.
4 #
5 # DESCRIPTION:
6 # A lightweight data object populated from one row of squeue output.
7 # Key responsibilities:
8 # - new() : accepts -user, -jobid, -queue, -status, -name, and any
9 # additional valid squeue attribute (validated against
10 # @VALID_ATTR and @VALID_STATUS lists)
11 # - Lvalue accessors: username, queue, name, jobid, status
12 # - $attrs hash: holds any extra squeue fields passed via -<attr> => value
13 # Validation constants:
14 # - @VALID_ATTR : list of valid squeue column names (extended with keys
15 # from %NBI::Slurm::FORMAT_STRINGS)
16 # - @VALID_STATUS : list of valid long-form SLURM job states
17 #
18 # RELATIONSHIPS:
19 # - Instantiated exclusively by NBI::Queue->_squeue() for each output row.
20 # - Depends on %NBI::Slurm::FORMAT_STRINGS for the extended @VALID_ATTR list.
21 # - $NBI::QueuedJob::VERSION is set from $NBI::Slurm::VERSION.
22 #
23 3 ▶use strict;
Subroutine BEGIN: called CC=1 SCAR=0.0
24 3 ▶use warnings;
Subroutine BEGIN: called CC=1 SCAR=0.0
25 package NBI::QueuedJob;
26 3 ▶use Carp qw(confess croak);
Subroutine BEGIN: called CC=1 SCAR=0.0
27 3 require Exporter;
28 3 our @ISA = qw(Exporter);
29  
30  
31 3 $NBI::QueuedJob::VERSION = $NBI::Slurm::VERSION;
32 3 our $VALID_ATTR_STR="ACCOUNT|GRES|MIN_CPUS|MIN_TMP_DISK|END_TIME|FEATURES|GROUP|OVER_SUBSCRIBE|JOBID|NAME|COMMENT|TIME_LIMIT|MIN_MEMORY|REQ_NODES|COMMAND|PRIORITY|QOS|REASON|ST|USER|RESERVATION|WCKEY|EXC_NODES|NICE|S:C:T|JOBID|EXEC_HOST|CPUS|NODES|DEPENDENCY|ARRAY_JOB_ID|GROUP|SOCKETS_PER_NODE|CORES_PER_SOCKET|THREADS_PER_CORE|ARRAY_TASK_ID|TIME_LEFT|TIME|NODELIST|CONTIGUOUS|PARTITION|PRIORITY|NODELIST(REASON)|START_TIME|STATE|USER|SUBMIT_TIME|LICENSES|CORE_SPEC|SCHEDNODES|WORK_DIR";
33 3 our $VALID_STATUS_STR="PENDING,RUNNING,SUSPENDED,COMPLETED,CANCELLED,FAILED,TIMEOUT,NODE_FAIL,PREEMPTED,BOOT_FAIL,DEADLINE,OUT_OF_MEMORY,COMPLETING,CONFIGURING,RESIZING,REVOKED,SPECIAL_EXIT";
34 3 our @VALID_ATTR=split(/\|/,$VALID_ATTR_STR);
35 3 our @VALID_STATUS=split(/,/,$VALID_STATUS_STR);
36  
37 # Append to @VALID_STATUS also @FORMAT_STRINGS
38 3 @VALID_ATTR = (@VALID_ATTR, keys %NBI::Slurm::FORMAT_STRINGS);
39 # make uc all VALID_ATTR
40 3 @VALID_ATTR = map {uc($_)} @VALID_ATTR;
41 2 ▶sub new {
Subroutine new: called CC=18 SCAR=36.7
Pod documented
42 2 my $class = shift @_;
43 2 my $username;
44 my $queue;
45 2 my $name;
46 2 my $jobid;
47 2 my $status;
48 2 my $attrs = {};
49 # Descriptive instantiation with parameters -param => value
50 2 ▶ if (substr($_[0], 0, 1) eq '-') {
Branch: 1 branch
BranchTrueFalseTotal
if (substr($_[0], 0, 1) eq "-") 2 0 2
51 2 my %data = @_;
52 # Try parsing
53 2 for my $i (keys %data) {
54 5 ▶ if ($i =~ /^-user/) {
Branch: 6 branches
BranchTrueFalseTotal
if ($i =~ /^-user/) { } 1 4 5
elsif ($i =~ /^-jobid/) { } 0 4 4
elsif ($i =~ /^-queue/) { } 0 4 4
elsif ($i =~ /^-status/) { } 0 4 4
elsif ($i =~ /^-name/) { } 0 4 4
elsif ($i =~ /^-(\w+)/) { } 4 0 4
55 1 $username = $data{$i};
56 } elsif ($i =~ /^-jobid/) {
57 # Check it's an integer
58 0 ▶ if ($data{$i} =~ /^\d+$/) {
Branch: 1 branch
BranchTrueFalseTotal
if ($data{$i} =~ /^\d+$/) { } 0 0 0
59 0 $jobid = $data{$i};
60 } else {
61 0 confess "ERROR NBI: -threads expects an integer\n";
62 }
63 } elsif ($i =~ /^-queue/) {
64 0 $queue = $data{$i};
65 } elsif ($i =~ /^-status/) {
66 # Check it's a valid status
67 0 ▶ if (grep {$_ eq uc($data{$i})} @VALID_STATUS) {
Branch: 1 branch
BranchTrueFalseTotal
if (grep {$_ eq uc $data{$i};} @NBI::QueuedJob::VALID_STATUS) { } 0 0 0
68 0 $status = uc($data{$i});
69 } else {
70 0 confess "ERROR NBI: -status expects one of the following values: $VALID_STATUS_STR\n";
71 }
72
73 } elsif ($i =~ /^-name/) {
74 0 $name = $data{$i};
75 } elsif ($i =~ /^-(\w+)/) {
76 4 ▶ if (grep {$_ eq uc($1)} @VALID_ATTR) {
Branch: 1 branch
BranchTrueFalseTotal
if (grep {$_ eq uc $1;} @NBI::QueuedJob::VALID_ATTR) { } 3 1 4
77 3 ▶ if (defined $data{$i}) {
Branch: 1 branch
BranchTrueFalseTotal
if (defined $data{$i}) { } 3 0 3
78 3 $attrs->{uc($1)} = $data{$i};
79 } else {
80 0 croak "ERROR NBI: -$1 expects a value\n";
81 }
82 } else {
83 1 confess "ERROR NBI: Unknown parameter -$1\nValid parameters are: ",
84 join("\n -",@VALID_ATTR), "\n";
85 }
86 } else {
87 0 confess "ERROR NBI: Unknown option/parameter $i\n";
88 }
89 }
90 }
91
92 1 my $self = bless {}, $class;
93
94 # Set attributes
95 1 ▶ $self->username = defined $username ? $username : undef;
Branch: 1 branch
BranchTrueFalseTotal
defined $username ? : 1 0 1
96 1 ▶ $self->queue = defined $queue ? $queue : undef;
Branch: 1 branch
BranchTrueFalseTotal
defined $queue ? : 0 1 1
97 1 ▶ $self->name = defined $name ? $name : undef;
Branch: 1 branch
BranchTrueFalseTotal
defined $name ? : 0 1 1
98 1 ▶ $self->jobid = defined $jobid ? $jobid : undef;
Branch: 1 branch
BranchTrueFalseTotal
defined $jobid ? : 0 1 1
99 1 ▶ $self->status = defined $status ? $status : undef;
Branch: 1 branch
BranchTrueFalseTotal
defined $status ? : 0 1 1
100 1 $self->{attrs} = $attrs;
101 1 return $self;
102 }
103  
104 1 ▶sub username : lvalue {
Subroutine username: called CC=2 SCAR=7.1
Pod documented
105 # Update threads
106 1 my ($self, $new_val) = @_;
107 1 ▶ $self->{username} = $new_val if (defined $new_val);
Branch: 1 branch
BranchTrueFalseTotal
if defined $new_val 0 1 1
108 1 return $self->{username};
109 }
110  
111 1 ▶sub queue : lvalue {
Subroutine queue: called CC=2 SCAR=7.1
Pod documented
112 # Update queue
113 1 my ($self, $new_val) = @_;
114 1 ▶ $self->{queue} = $new_val if (defined $new_val);
Branch: 1 branch
BranchTrueFalseTotal
if defined $new_val 0 1 1
115 1 return $self->{queue};
116 }
117  
118 1 ▶sub name : lvalue {
Subroutine name: called CC=2 SCAR=7.1
Pod documented
119 # Update name
120 1 my ($self, $new_val) = @_;
121 1 ▶ $self->{name} = $new_val if (defined $new_val);
Branch: 1 branch
BranchTrueFalseTotal
if defined $new_val 0 1 1
122 1 return $self->{name};
123 }
124  
125 1 ▶sub jobid : lvalue {
Subroutine jobid: called CC=4 SCAR=15.6
Pod documented
126 # Update jobid
127 1 my ($self, $new_val) = @_;
128 1 ▶ confess "ERROR NBI::Queue: jobid must be an integer\n" if (defined $new_val && $new_val !~ /^\d+$/);
Branch: 1 branch
BranchTrueFalseTotal
if defined $new_val and not $new_val =~ /^\d+$/ 0 1 1
Condition33%1/3
defined $new_val and not $new_val =~ /^\d+$/
!ll&&!rl&&r
100
MC/DC0%0/2
defined $new_val and not $new_val =~ /^\d+$/
defined $new_val not $new_val =~ /^\d+$/
Truth table33%1/3
A and not(B)
A= defined $new_valB= not $new_val =~ /^\d+$/
ABresult
0X0
100
111
129 1 ▶ $self->{jobid} = $new_val if (defined $new_val);
Branch: 1 branch
BranchTrueFalseTotal
if defined $new_val 0 1 1
130 1 return $self->{jobid};
131 }
132  
133 1 ▶sub status : lvalue {
Subroutine status: called CC=4 SCAR=16.4
Pod documented
134 # Update status
135 1 my ($self, $new_val) = @_;
136 0 ▶ confess "ERROR NBI::Queue: status must be one of the following values: $VALID_STATUS_STR\n" if (defined $new_val && !grep {$_ eq uc($new_val)} @VALID_STATUS);
Branch: 1 branch
BranchTrueFalseTotal
if defined $new_val and not grep({$_ eq uc $new_val;} @NBI::QueuedJob::VALID_STATUS) 0 1 1
Condition33%1/3
defined $new_val and not grep({$_ eq uc $new_val;} @NBI::QueuedJob::VALID_STATUS)
!ll&&!rl&&r
100
MC/DC0%0/2
defined $new_val and not grep({$_ eq uc $new_val;} @NBI::QueuedJob::VALID_STATUS)
defined $new_val not grep({$_ eq uc $new_val;} @NBI::QueuedJob::VALID_STATUS)
Truth table33%1/3
A and not(B)
A= defined $new_valB= not grep({$_ eq uc $new_val;} @NBI::QueuedJob::VALID_STATUS)
ABresult
0X0
100
111
137 1 ▶ $self->{status} = $new_val if (defined $new_val);
Branch: 1 branch
BranchTrueFalseTotal
if defined $new_val 0 1 1
138 1 return $self->{status};
139 }
140 3 1;
141  
142 __END__
« bin/runjob ↑ Summary blib/lib/NBI/Test.pl »