blib/lib/Script/Resume.pm

filter: Statementstmt 17.1% 18 / 105 Branchbran 0.0% 0 / 42 Conditioncond 0.0% 0 / 23 MC/DCmcdc 0.0% 0 / 13 Subroutinesub 29.4% 5 / 17 Podpod 63.6% 7 / 11 totaltotal 14.2% 30 / 211 CC 33 SCAR 36.1
CC
33
Cov
11%
new
110.0
addStage
42.0
runStage
30.0
CRAP 36.9
↑ Summary
1 package Script::Resume;
2  
3 1 ▶use strict;
Subroutine BEGIN: called CC=1 SCAR=0.0
4 1 ▶use vars qw($VERSION);
Subroutine BEGIN: called CC=1 SCAR=0.0
5 1 ▶use Data::Dumper;
Subroutine BEGIN: called CC=1 SCAR=0.0
6 1 ▶use File::Basename;
Subroutine BEGIN: called CC=1 SCAR=0.0
7 1 ▶use FileHandle;
Subroutine BEGIN: called CC=1 SCAR=0.0
8  
9 1 $VERSION = '1.0';
10  
11 1 our $NAME = "Script::Resume";
12  
13 # SCRIPT_STATE - Script specific state (ref to a ref to an object or hash or array or scalar)
14 # STATE_FILE - File to store state of everything
15 # RESUME - Continue where left off (default = 1)
16 # DEBUG - Print out debug info
17 # RETAIN_STATE - Keep the state around even after the script finishes
18 # (You'll want to delete this by hand before running the script again)
19 # STAGES - The list of stage names
20 # STOP_AFTER - Stop after state X is run.
21 sub new
22 0 ▶{
Subroutine new: not called CC=10 SCAR=47.0
Pod documented
23 0 my $this = shift;
24 0 ▶ my $class = ref($this) || $this;
Condition0%0/3
ref $this || $this
l!l&&r!l&&!r
000
MC/DC0%0/2
ref $this || $this
ref $this $this
Truth table0%0/3
A || B
A= ref $thisB= $this
ABresult
1X1
011
000
25 0 my %opts = @_;
26 0 ▶ my $tmpdir = $ENV{TEMP} || $ENV{TMP} || "/tmp";
Condition0%0/5
$ENV{'TEMP'} || $ENV{'TMP'} || '/tmp'
l!l
00
$ENV{"TEMP"} or $ENV{"TMP"}
l!l&&r!l&&!r
000
MC/DC0%0/2
$ENV{'TEMP'} || $ENV{'TMP'} || '/tmp'
$ENV{"TEMP"} $ENV{"TMP"}
Truth table0%0/3
A or B
A= $ENV{"TEMP"}B= $ENV{"TMP"}
ABresult
1X1
011
000
27 0 my $def_state_file = "$tmpdir/" . basename($0) . ".state";
28  
29 my $self = { _istate => {ORDER => 0,
30 STOP_AFTER => $opts{STOP_AFTER},
31 SFILE => $opts{STATE_FILE} || $def_state_file,
32 DEBUG => $opts{DEBUG},
33 RETAIN_STATE => $opts{RETAIN_STATE}},
34 0 ▶ _stages => {},
Condition0%0/3
$opts{'STATE_FILE'} || $def_state_file
l!l&&r!l&&!r
000
MC/DC0%0/2
$opts{'STATE_FILE'} || $def_state_file
$opts{'STATE_FILE'} $def_state_file
Truth table0%0/3
A || B
A= $opts{'STATE_FILE'}B= $def_state_file
ABresult
1X1
011
000
35 _estate => {RESULTS => {}}};
36  
37 0 ▶ $self->{_estate}->{SCRIPT} = ${$opts{SCRIPT_STATE}} if $opts{SCRIPT_STATE};
Branch: 1 branch
BranchTrueFalseTotal
if $opts{"SCRIPT_STATE"} 0 0 0
38 0 bless $self, $class;
39  
40 0 ▶ $self->debug("Resume: unlinking file $opts{RESUME}"), unlink($self->{_istate}->{SFILE}) if (defined $opts{RESUME} && $opts{RESUME} == 0);
Branch: 1 branch
BranchTrueFalseTotal
if defined $opts{"RESUME"} and $opts{"RESUME"} == 0 0 0 0
Condition0%0/3
defined $opts{"RESUME"} and $opts{"RESUME"} == 0
!ll&&!rl&&r
000
MC/DC0%0/2
defined $opts{"RESUME"} and $opts{"RESUME"} == 0
defined $opts{"RESUME"} $opts{"RESUME"} == 0
Truth table0%0/3
A and B
A= defined $opts{"RESUME"}B= $opts{"RESUME"} == 0
ABresult
0X0
100
111
41 0 ▶ $self->{_istate}->{SFH} = new FileHandle($self->{_istate}->{SFILE}, O_RDWR|O_CREAT) or die "$NAME: Couldn't open state file $self->{_istate}->{SFILE}: $!\n";
Branch: 1 branch
BranchTrueFalseTotal
$self->{"_istate"}{"SFH"} = "FileHandle"->new($self->{"_istate"}{"SFILE"}, 66) or die qq[$Script::Resume::NAME: Couldn't open state file $self->{"_istate"}{"SFILE"}: $!\n] 0 0 0
42  
43 0 ▶ $self->addStages(@{$opts{STAGES}}) if $opts{STAGES};
Branch: 1 branch
BranchTrueFalseTotal
if $opts{"STAGES"} 0 0 0
44 0 $self->readState($opts{SCRIPT_STATE});
45  
46 0 return $self;
47 }
48  
49 # NAME
50 # FUNC
51 # ALWAYS
52 # ORDER
53 sub addStage
54 0 ▶{
Subroutine addStage: not called CC=6 SCAR=37.4
Pod documented
55 0 my $self = shift;
56 0 my $name = shift;
57 0 my $caller_name = $name;
58 0 ▶ $caller_name = $self->getCallingPackage() . "::$caller_name" unless (index($caller_name, "::") >= 0);
Branch: 1 branch
BranchTrueFalseTotal
unless (index($caller_name, "::") != -1) 0 0 0
59  
60 0 ▶ die "$NAME: addStage: Need a name for the stage" unless $name;
Branch: 1 branch
BranchTrueFalseTotal
unless $name 0 0 0
61 0 %{$self->{_stages}->{$name}} = @_;
62 0 ▶ $self->{_stages}->{$name}->{FUNC} = \&{$caller_name} unless $self->{_stages}->{$name}->{FUNC};
Branch: 1 branch
BranchTrueFalseTotal
unless $self->{"_stages"}{$name}{"FUNC"} 0 0 0
63 0 ▶ $self->{_stages}->{$name}->{ORDER} = ++$self->{_istate}->{ORDER} unless defined $self->{_stages}->{$name}->{ORDER};
Branch: 1 branch
BranchTrueFalseTotal
unless defined $self->{"_stages"}{$name}{"ORDER"} 0 0 0
64 0 $self->debug("Adding stage = $name order = $self->{_stages}->{$name}->{ORDER}");
65 0 ▶ die "$NAME: FUNC for stage $name not defined\n" unless defined &{$self->{_stages}->{$name}->{FUNC}};
Branch: 1 branch
BranchTrueFalseTotal
unless defined &{$self->{"_stages"}{$name}{"FUNC"};} 0 0 0
66 }
67  
68 sub getCallingPackage
69 0 ▶{
Subroutine getCallingPackage: not called CC=2 SCAR=17.9
Pod undocumented
70 0 my $self = shift;
71 0 my $i = 0;
72 0 my $caller;
73 0 ▶ while ( ($caller = (caller($i))[0]) eq $NAME) {
Branch: 1 branch
BranchTrueFalseTotal
if (($caller = (caller $i)[0]) eq $Script::Resume::NAME) 0 0 0
74 0 $i++;
75 }
76
77 0 return $caller;
78 }
79  
80  
81 sub addStages
82 0 ▶{
Subroutine addStages: not called CC=2 SCAR=17.9
Pod documented
83 0 my $self = shift;
84 0 $self->addStage($_) foreach @_;
85 }
86  
87 sub setStageAttributes
88 0 ▶{
Subroutine setStageAttributes: not called CC=4 SCAR=30.0
Pod documented
89 0 my $self = shift;
90 0 my $name = shift;
91 0 my %opts = @_;
92  
93 0 ▶ die "$NAME: addStage: Need a name for the stage" unless $name;
Branch: 1 branch
BranchTrueFalseTotal
unless $name 0 0 0
94 0 ▶ die "$NAME: No such stage $name\n" unless $self->{_stages}->{$name};
Branch: 1 branch
BranchTrueFalseTotal
unless $self->{"_stages"}{$name} 0 0 0
95  
96 0 $self->{_stages}->{$name}->{$_} = $opts{$_} foreach (keys %opts);
97 }
98  
99 sub debug
100 0 ▶{
Subroutine debug: not called CC=2 SCAR=17.9
Pod undocumented
101 0 my $self = shift;
102  
103 0 ▶ return unless $self->{_istate}->{DEBUG};
Branch: 1 branch
BranchTrueFalseTotal
unless $self->{"_istate"}{"DEBUG"} 0 0 0
104 0 my $msg = shift;
105 0 print "$NAME: $msg\n";
106 }
107  
108 sub readState
109 0 ▶{
Subroutine readState: not called CC=4 SCAR=30.0
Pod undocumented
110 0 my $self = shift;
111 0 my $script_state = shift;
112 0 my $fh = $self->{_istate}->{SFH};
113 0 my $dumpy;
114  
115 0 $fh->seek(0,0);
116  
117 0 $dumpy = join("", <$fh>);
118  
119 0 ▶ if ($dumpy) {
Branch: 1 branch
BranchTrueFalseTotal
if ($dumpy) 0 0 0
120 0 my $VAR1;
121 0 $self->{_estate} = eval($dumpy);
122 0 ▶ die "$NAME: Couldn't read in state: $@\n" if $@;
Branch: 1 branch
BranchTrueFalseTotal
if $@ 0 0 0
123 0 ▶ $$script_state = $self->{_estate}->{SCRIPT} if ($script_state);
Branch: 1 branch
BranchTrueFalseTotal
if $script_state 0 0 0
124 0 return 1;
125 }
126 0 return 0;
127 }
128  
129 sub runAllStages
130 0 ▶{
Subroutine runAllStages: not called CC=2 SCAR=17.9
Pod documented
131 0 my $self = shift;
132 0 my $stage;
133 0 foreach $stage (sort {$self->{_stages}->{$a}->{ORDER} <=> $self->{_stages}->{$b}->{ORDER}} keys %{$self->{_stages}}) {
134 0 $self->runStage($stage, @_);
135 }
136 }
137  
138 sub runStage
139 0 ▶{
Subroutine runStage: not called CC=5 SCAR=34.0
Pod documented
140 0 my $self = shift;
141 0 my $name = shift;
142  
143 0 ▶ $self->debug("Running Stage: $name"), $self->{_estate}->{RESULTS}->{$name} = [&{$self->{_stages}->{$name}->{FUNC}}(@_)] if ($self->{_stages}->{$name}->{ALWAYS} || ! defined $self->{_estate}->{RESULTS}->{$name}); # RJP: remove the "defined" and replace RESULTS with RUN
Branch: 1 branch
BranchTrueFalseTotal
if $self->{"_stages"}{$name}{"ALWAYS"} or not defined $self->{"_estate"}{"RESULTS"}{$name} 0 0 0
Condition0%0/3
$self->{"_stages"}{$name}{"ALWAYS"} or not defined $self->{"_estate"}{"RESULTS"}{$name}
l!l&&r!l&&!r
000
MC/DC0%0/2
$self->{"_stages"}{$name}{"ALWAYS"} or not defined $self->{"_estate"}{"RESULTS"}{$name}
$self->{"_stages"}{$name}{"ALWAYS"} not defined $self->{"_estate"}{"RESULTS"}{$name}
Truth table0%0/3
A or not(B)
A= $self->{"_stages"}{$name}{"ALWAYS"}B= not defined $self->{"_estate"}{"RESULTS"}{$name}
ABresult
1X1
011
000
144 #$self->{_estate}->{RUN}->{$name} = 1; #RJP
145  
146 0 $self->writeState();
147 0 ▶ $self->debug("Stopping after $name because STOP_AFTER = $name"), exit(0) if $self->{_istate}->{STOP_AFTER} eq $name;
Branch: 1 branch
BranchTrueFalseTotal
if $self->{"_istate"}{"STOP_AFTER"} eq $name 0 0 0
148 0 ▶ return wantarray ? @{$self->{_estate}->{RESULTS}->{$name}} : $self->{_estate}->{RESULTS}->{$name}->[0];
Branch: 1 branch
BranchTrueFalseTotal
wantarray ? : 0 0 0
149 }
150  
151 sub writeState
152 0 ▶{
Subroutine writeState: not called CC=2 SCAR=17.9
Pod undocumented
153 0 my $self = shift;
154  
155 0 ▶ return if $self->{_istate}->{DONE};
Branch: 1 branch
BranchTrueFalseTotal
if $self->{"_istate"}{"DONE"} 0 0 0
156 0 my $fh = $self->{_istate}->{SFH};
157 0 $fh->seek(0,0);
158 0 print $fh Dumper($self->{_estate});
159 0 $fh->flush();
160 }
161  
162 sub doneEarly
163 0 ▶{
Subroutine doneEarly: not called CC=1 SCAR=6.9
Pod documented
164 0 my $self = shift;
165 0 $self->{_istate}->{DONE} = 1;
166 }
167  
168 sub DESTROY
169 0 ▶{
Subroutine DESTROY: not called CC=4 SCAR=30.0
170 0 my $self = shift;
171 0 $self->writeState();
172 0 $self->{_istate}->{SFH}->close();
173  
174 0 ▶ unlink $self->{_istate}->{SFILE} if (!$self->{_istate}->{RETAIN_STATE} && ($self->{_istate}->{DONE} || scalar keys %{$self->{_stages}} == scalar keys %{$self->{_estate}->{RESULTS}}));#RUN - RJP
Branch: 1 branch
BranchTrueFalseTotal
if not $self->{"_istate"}{"RETAIN_STATE"} and $self->{"_istate"}{"DONE"} || scalar keys %{$$self{"_stages"};} == scalar keys %{$$self{"_estate"}{"RESULTS"};} 0 0 0
Condition0%0/6
not $self->{"_istate"}{"RETAIN_STATE"} and $self->{"_istate"}{"DONE"} || scalar keys %{$$self{"_stages"};} == scalar keys %{$$self{"_estate"}{"RESULTS"};}
!ll&&!rl&&r
000
$self->{"_istate"}{"DONE"} or scalar keys %{$$self{"_stages"};} == scalar keys %{$$self{"_estate"}{"RESULTS"};}
l!l&&r!l&&!r
000
MC/DC0%0/3
not $self->{"_istate"}{"RETAIN_STATE"} and $self->{"_istate"}{"DONE"} || scalar keys %{$$self{"_stages"};} == scalar keys %{$$self{"_estate"}{"RESULTS"};}
not $self->{"_istate"}{"RETAIN_STATE"} $self->{"_istate"}{"DONE"} scalar keys %{$$self{"_stages"};} == scalar keys %{$$self{"_estate"}{"RESULTS"};}
Truth table0%0/4
not(A) and B or C
A= not $self->{"_istate"}{"RETAIN_STATE"}B= $self->{"_istate"}{"DONE"}C= scalar keys %{$$self{"_stages"};} == scalar keys %{$$self{"_estate"}{"RESULTS"};}
ABCresult
0XX0
1000
11X1
1011
175 }
176  
177 1 1;
178  
179 __END__
↑ Summary