lib/Rex/Commands/Service.pm

filter: Statementstmt 22.5% 30 / 133 Branchbran 0.0% 0 / 76 Conditioncond 0.0% 0 / 6 MC/DCmcdc 0.0% 0 / 4 Subroutinesub 64.2% 9 / 14 Podpod 66.6% 2 / 3 totaltotal 17.3% 41 / 236 CC 42 SCAR 61.7
CC
42
Cov
14%
old_service
812.0
service
240.0
__ANON__
2.0
CRAP 479.1
« lib/Rex/Commands/Pkg.pm ↑ Summary lib/Rex/Resource/firewall/Provider/ufw.pm »
1 #
2 # (c) Jan Gehring <jan.gehring@gmail.com>
3 #
4  
5 =head1 NAME
6  
7 Rex::Commands::Service - Manage System Services
8  
9 =head1 DESCRIPTION
10  
11 With this module you can manage Linux services.
12  
13 =head1 SYNOPSIS
14  
15 use Rex::Commands::Service
16  
17 service apache2 => "start";
18  
19 service apache2 => "stop";
20  
21 service apache2 => "restart";
22  
23 service apache2 => "status";
24  
25 service apache2 => "reload";
26  
27 service apache2 => "ensure", "started";
28  
29 service apache2 => "ensure", "stopped";
30  
31 =head1 EXPORTED FUNCTIONS
32  
33 =cut
34  
35 package Rex::Commands::Service;
36  
37 32 ▶use v5.14.4;
Subroutine BEGIN: called CC=1 SCAR=0.0
38 32 ▶use warnings;
Subroutine BEGIN: called CC=1 SCAR=0.0
39  
40 32 our $VERSION = '1.16.1'; # VERSION
41  
42 32 require Rex::Exporter;
43  
44 32 ▶use vars qw(@EXPORT);
Subroutine BEGIN: called CC=1 SCAR=0.0
45 32 ▶use base qw(Rex::Exporter);
Subroutine BEGIN: called CC=1 SCAR=0.0
46  
47 32 ▶use Rex::Service;
Subroutine BEGIN: called CC=1 SCAR=0.0
48 32 ▶use Rex::Logger;
Subroutine BEGIN: called CC=1 SCAR=0.0
49 32 ▶use Rex::Config;
Subroutine BEGIN: called CC=1 SCAR=0.0
50 32 ▶use Rex::Hook;
Subroutine BEGIN: called CC=1 SCAR=0.0
51 32 ▶use Carp;
Subroutine BEGIN: called CC=1 SCAR=0.0
52  
53 32 @EXPORT = qw(service service_provider_for);
54  
55 =head2 service($service, $action, [$option])
56  
57 The service function accepts 2 parameters. The first is the service name and the second the action you want to perform.
58  
59 =over 4
60  
61 =item starting a service
62  
63 task "start-service", "server01", sub {
64 service apache2 => "start";
65 };
66  
67 =item stopping a service
68  
69 task "stop-service", "server01", sub {
70 service apache2 => "stop";
71 };
72  
73 =item restarting a service
74  
75 task "restart-service", "server01", sub {
76 service apache2 => "restart";
77 };
78  
79  
80 =item checking status of a service
81  
82 task "status-service", "server01", sub {
83 if( service apache2 => "status" ) {
84 say "Apache2 is running";
85 }
86 else {
87 say "Apache2 is not running";
88 }
89 };
90  
91 =item reloading a service
92  
93 task "reload-service", "server01", sub {
94 service apache2 => "reload";
95 };
96  
97  
98 =item ensure that a service will started at boot time
99  
100 task "prepare", sub {
101 service "apache2",
102 ensure => "started";
103 };
104  
105 =item ensure that a service will NOT be started.
106  
107 task "prepare", sub {
108 service "apache2",
109 ensure => "stopped";
110 };
111  
112  
113 If you need to define a custom command for start, stop, restart, reload or status you can do this with the corresponding options.
114  
115 task "prepare", sub {
116 service "apache2",
117 ensure => "started",
118 start => "/usr/local/bin/httpd -f /etc/my/httpd.conf",
119 stop => "killall httpd",
120 status => "ps -efww | grep httpd",
121 restart => "killall httpd && /usr/local/bin/httpd -f /etc/my/httpd.conf",
122 reload => "killall httpd && /usr/local/bin/httpd -f /etc/my/httpd.conf";
123 };
124  
125 This function supports the following L<hooks|Rex::Hook>:
126  
127 =over 4
128  
129 =item before_${action}
130  
131 For example: C<before_start>, C<before_stop>, C<before_restart>
132  
133 This gets executed right before the given service action. All original parameters are passed to it.
134  
135 =item after_${action}
136  
137 For example: C<after_start>, C<after_stop>, C<after_restart>
138  
139 This gets executed right after the given service action. All original parameters, and any returned results are passed to it.
140  
141 =back
142  
143 =back
144  
145 =cut
146  
147 0 ▶sub service {
Subroutine service: not called CC=15 SCAR=54.8
Pod documented
148 0 my ( $services, $action, @_options ) = @_;
149  
150 0 my $opt_ref = {};
151 0 ▶ if ( scalar @_options >= 1 ) {
Branch: 1 branch
BranchTrueFalseTotal
if (scalar @_options >= 1) { } 0 0 0
152 0 $opt_ref = { $action, @_options };
153 }
154 else {
155 0 $opt_ref = { ensure => $action, no_boot => 1 };
156 }
157  
158 # $opt_ref = {
159 # ensure => "start(ed)",
160 # no_boot => 1,
161 # ... => ...,
162 # }
163 #######
164  
165 0 ▶ if (wantarray) {
Branch: 1 branch
BranchTrueFalseTotal
if (wantarray) 0 0 0
166  
167 # func-ref zurueckgeben
168 0 ▶ return sub {
Subroutine __ANON__: not called CC=1 SCAR=6.9
169 0 service( $services, $action );
170 0 };
171  
172 }
173  
174 0 my $is_multiple = 1;
175 0 ▶ unless ( ref($services) ) {
Branch: 1 branch
BranchTrueFalseTotal
unless (ref $services) 0 0 0
176 0 $services = [$services];
177 0 $is_multiple = 0;
178 }
179  
180 0 my $srvc = Rex::Service->get;
181  
182 0 my $changed = 0;
183 0 my $return = 1;
184 0 for my $res_service (@$services) {
185  
186 0 my $service = $res_service;
187 0 ▶ if ( exists $opt_ref->{name} ) {
Branch: 1 branch
BranchTrueFalseTotal
if (exists $opt_ref->{"name"}) 0 0 0
188 0 $service = $opt_ref->{name};
189 }
190  
191 0 my $notify = Rex::get_current_connection()->{notify};
192 $notify->add(
193 type => "service",
194 name => $service,
195 postpone => 1,
196 options => {},
197 0 ▶ cb => sub {
Subroutine __ANON__: not called CC=1 SCAR=6.9
198 0 my ($option) = shift;
199 0 Rex::Logger::debug("Restarting notified service: $service");
200 0 service( $service => "restart" );
201 }
202 0 );
203  
204 #### check and run before_$action hook
205 0 Rex::Hook::run_hook( service => "before_$action", @_ );
206 ##############################
207  
208 0 ▶ if ( scalar @_ == 2 ) {
Branch: 1 branch
BranchTrueFalseTotal
if (scalar @_ == 2) 0 0 0
209 0 return old_service( $service, $action );
210 }
211  
212 ####### new service code
213  
214 Rex::get_current_connection()->{reporter}
215 0 ->report_resource_start( type => "service", name => $res_service );
216  
217 0 my $b_status = $srvc->status($service);
218 0 my $return;
219  
220 0 ▶ if ( $opt_ref->{ensure} =~ m/^(start|run|enable)/ ) {
Branch: 2 branches
BranchTrueFalseTotal
if ($opt_ref->{'ensure'} =~ /^(start|run|enable)/u) { } 0 0 0
elsif ($opt_ref->{'ensure'} =~ /^(stop|disable)/u) { } 0 0 0
221 0 ▶ if ( exists $opt_ref->{no_boot} && $opt_ref->{no_boot} ) {
Branch: 1 branch
BranchTrueFalseTotal
if (exists $opt_ref->{'no_boot'} and $opt_ref->{'no_boot'}) { } 0 0 0
Condition0%0/3
exists $opt_ref->{"no_boot"} and $opt_ref->{"no_boot"}
!ll&&!rl&&r
000
MC/DC0%0/2
exists $opt_ref->{"no_boot"} and $opt_ref->{"no_boot"}
exists $opt_ref->{"no_boot"} $opt_ref->{"no_boot"}
Truth table0%0/3
A and B
A= exists $opt_ref->{"no_boot"}B= $opt_ref->{"no_boot"}
ABresult
0X0
100
111
222 0 $return = $srvc->start( $service, $opt_ref );
223 }
224 else {
225 0 $return = $srvc->ensure( $service, $opt_ref );
226 }
227 }
228 elsif ( $opt_ref->{ensure} =~ m/^(stop|disable)/ ) {
229 0 ▶ if ( exists $opt_ref->{no_boot} && $opt_ref->{no_boot} ) {
Branch: 1 branch
BranchTrueFalseTotal
if (exists $opt_ref->{'no_boot'} and $opt_ref->{'no_boot'}) { } 0 0 0
Condition0%0/3
exists $opt_ref->{"no_boot"} and $opt_ref->{"no_boot"}
!ll&&!rl&&r
000
MC/DC0%0/2
exists $opt_ref->{"no_boot"} and $opt_ref->{"no_boot"}
exists $opt_ref->{"no_boot"} $opt_ref->{"no_boot"}
Truth table0%0/3
A and B
A= exists $opt_ref->{"no_boot"}B= $opt_ref->{"no_boot"}
ABresult
0X0
100
111
230 0 $return = $srvc->stop( $service, $opt_ref );
231 }
232 else {
233 0 $return = $srvc->ensure( $service, $opt_ref );
234 }
235 }
236 else {
237 0 Rex::Logger::info( "$opt_ref->{ensure} unknown ensure value.", "error" );
238 0 confess "$opt_ref->{ensure} unknown ensure value.";
239 }
240  
241 0 my $a_status = $srvc->status( $service, $opt_ref );
242  
243 0 $changed = 0;
244 0 ▶ if ( $a_status != $b_status ) {
Branch: 1 branch
BranchTrueFalseTotal
if ($a_status != $b_status) 0 0 0
245 0 $changed = 1;
246 }
247  
248 #### check and run after_$action hook
249 Rex::Hook::run_hook(
250 0 service => "after_$action",
251 @_, { changed => $changed, ret => $return }
252 );
253 ##############################
254  
255 0 ▶ if ($changed) {
Branch: 1 branch
BranchTrueFalseTotal
if ($changed) { } 0 0 0
256 Rex::get_current_connection()->{reporter}->report(
257 0 changed => 1,
258 message => "Service $service changed status to $opt_ref->{ensure}."
259 );
260 }
261 else {
262 0 Rex::get_current_connection()->{reporter}->report( changed => 0, );
263 }
264  
265 Rex::get_current_connection()->{reporter}
266 0 ->report_resource_end( type => "service", name => $res_service );
267 }
268  
269 }
270  
271 0 ▶sub old_service {
Subroutine old_service: not called CC=28 SCAR=67.0
Pod undocumented
272  
273 0 my ( $service, $action, $options ) = @_;
274  
275 0 my $srvc = Rex::Service->get;
276 0 my $changed;
277 0 my $is_multiple = 0;
278 0 my $return;
279  
280 Rex::get_current_connection()->{reporter}
281 0 ->report_resource_start( type => "service", name => $service );
282  
283 0 ▶ if ( $action eq "start" ) {
Branch: 6 branches
BranchTrueFalseTotal
if ($action eq 'start') { } 0 0 0
elsif ($action eq 'restart') { } 0 0 0
elsif ($action eq 'stop') { } 0 0 0
elsif ($action eq 'reload') { } 0 0 0
elsif ($action eq 'status') { } 0 0 0
elsif ($action eq 'ensure') { } 0 0 0
284  
285 0 ▶ unless ( $srvc->status($service) ) {
Branch: 1 branch
BranchTrueFalseTotal
unless ($srvc->status($service)) 0 0 0
286 0 $changed = 1;
287 0 ▶ if ( $srvc->start($service) ) {
Branch: 1 branch
BranchTrueFalseTotal
if ($srvc->start($service)) { } 0 0 0
288 0 Rex::Logger::info("Service $service started.");
289 0 ▶ $return = 1 if !$is_multiple;
Branch: 1 branch
BranchTrueFalseTotal
unless $is_multiple 0 0 0
290 }
291 else {
292 0 Rex::Logger::info( "Error starting $service.", "warn" );
293 0 ▶ $return = 0 if !$is_multiple;
Branch: 1 branch
BranchTrueFalseTotal
unless $is_multiple 0 0 0
294 }
295 }
296  
297 }
298  
299 elsif ( $action eq "restart" ) {
300 0 $changed = 1;
301  
302 0 ▶ if ( $srvc->restart($service) ) {
Branch: 1 branch
BranchTrueFalseTotal
if ($srvc->restart($service)) { } 0 0 0
303 0 Rex::Logger::info("Service $service restarted.");
304 0 ▶ $return = 1 if !$is_multiple;
Branch: 1 branch
BranchTrueFalseTotal
unless $is_multiple 0 0 0
305 }
306 else {
307 0 Rex::Logger::info( "Error restarting $service.", "warn" );
308 0 ▶ $return = 0 if !$is_multiple;
Branch: 1 branch
BranchTrueFalseTotal
unless $is_multiple 0 0 0
309 }
310  
311 }
312  
313 elsif ( $action eq "stop" ) {
314  
315 0 ▶ if ( $srvc->status($service) ) { # it runs
Branch: 1 branch
BranchTrueFalseTotal
if ($srvc->status($service)) 0 0 0
316 0 $changed = 1;
317 0 ▶ if ( $srvc->stop($service) ) {
Branch: 1 branch
BranchTrueFalseTotal
if ($srvc->stop($service)) { } 0 0 0
318 0 Rex::Logger::info("Service $service stopped.");
319 0 ▶ $return = 1 if !$is_multiple;
Branch: 1 branch
BranchTrueFalseTotal
unless $is_multiple 0 0 0
320 }
321 else {
322 0 Rex::Logger::info( "Error stopping $service.", "warn" );
323 0 ▶ $return = 0 if !$is_multiple;
Branch: 1 branch
BranchTrueFalseTotal
unless $is_multiple 0 0 0
324 }
325 }
326  
327 }
328  
329 elsif ( $action eq "reload" ) {
330 0 $changed = 1;
331 0 ▶ if ( $srvc->reload($service) ) {
Branch: 1 branch
BranchTrueFalseTotal
if ($srvc->reload($service)) { } 0 0 0
332 0 Rex::Logger::info("Service $service is reloaded.");
333 0 ▶ $return = 1 if !$is_multiple;
Branch: 1 branch
BranchTrueFalseTotal
unless $is_multiple 0 0 0
334 }
335 else {
336 0 Rex::Logger::info( "Error $service does not support reload", "warn" );
337 0 ▶ $return = 0 if !$is_multiple;
Branch: 1 branch
BranchTrueFalseTotal
unless $is_multiple 0 0 0
338 }
339  
340 }
341  
342 elsif ( $action eq "status" ) {
343  
344 0 $changed = 100;
345 0 ▶ if ( $srvc->status($service) ) {
Branch: 1 branch
BranchTrueFalseTotal
if ($srvc->status($service)) { } 0 0 0
346 0 Rex::Logger::info("Service $service is running.");
347 0 ▶ $return = 1 if !$is_multiple;
Branch: 1 branch
BranchTrueFalseTotal
unless $is_multiple 0 0 0
348 }
349 else {
350 0 Rex::Logger::info("$service is stopped");
351 0 ▶ $return = 0 if !$is_multiple;
Branch: 1 branch
BranchTrueFalseTotal
unless $is_multiple 0 0 0
352 }
353  
354 }
355  
356 elsif ( $action eq "ensure" ) {
357  
358 0 ▶ if ( $srvc->ensure( $service, { ensure => $options } ) ) {
Branch: 1 branch
BranchTrueFalseTotal
if ($srvc->ensure($service, {'ensure', $options})) { } 0 0 0
359 0 $changed = 0;
360 0 ▶ $return = 1 if !$is_multiple;
Branch: 1 branch
BranchTrueFalseTotal
unless $is_multiple 0 0 0
361 }
362 else {
363 0 ▶ $return = 0 if !$is_multiple;
Branch: 1 branch
BranchTrueFalseTotal
unless $is_multiple 0 0 0
364 0 Rex::Logger::info("Error ensuring $service to $options");
365 }
366 }
367  
368 else {
369 0 Rex::Logger::info("Executing action $action on $service.");
370 0 $srvc->action( $service, $action );
371 0 $changed = 100;
372 }
373  
374 0 ▶ if ($changed) {
Branch: 1 branch
BranchTrueFalseTotal
if ($changed) { } 0 0 0
375 Rex::get_current_connection()->{reporter}
376 0 ->report( changed => $changed, message => "Service executed $action." );
377 }
378 else {
379 0 Rex::get_current_connection()->{reporter}->report( changed => 0, );
380 }
381  
382 Rex::get_current_connection()->{reporter}
383 0 ->report_resource_end( type => "service", name => $service );
384  
385 0 return $return;
386 }
387  
388 =head2 service_provider_for $os => $type;
389  
390 To set another service provider as the default, use this function.
391  
392 user "root";
393  
394 group "db" => "db[01..10]";
395 service_provider_for SunOS => "svcadm";
396  
397 task "start", group => "db", sub {
398 service ssh => "restart";
399 };
400  
401 This example will restart the I<ssh> service via svcadm (but only on SunOS, on other operating systems it will use the default).
402  
403 =cut
404  
405 0 ▶sub service_provider_for {
Subroutine service_provider_for: not called CC=1 SCAR=6.9
Pod documented
406 0 my ( $os, $provider ) = @_;
407 0 Rex::Logger::debug("setting service provider for $os to $provider");
408 0 Rex::Config->set( "service_provider", { $os => $provider } );
409 }
410  
411 32 1;
« lib/Rex/Commands/Pkg.pm ↑ Summary lib/Rex/Resource/firewall/Provider/ufw.pm »