-
Notifications
You must be signed in to change notification settings - Fork 223
/
Augeas.pm
421 lines (324 loc) · 9.38 KB
/
Augeas.pm
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
#
# (c) Jan Gehring <jan.gehring@gmail.com>
#
=head1 NAME
Rex::Commands::Augeas - An augeas module for (R)?ex
=head1 DESCRIPTION
This is a simple module to manipulate configuration files with the help of augeas.
=head1 SYNOPSIS
my $k = augeas exists => "/files/etc/hosts/*/ipaddr", "127.0.0.1";
augeas insert => "/files/etc/hosts",
label => "01",
after => "/7",
ipaddr => "192.168.2.23",
canonical => "test";
augeas dump => "/files/etc/hosts";
augeas modify =>
"/files/etc/ssh/sshd_config/PermitRootLogin" => "without-password",
on_change => sub {
service ssh => "restart";
};
=head1 EXPORTED FUNCTIONS
=cut
package Rex::Commands::Augeas;
use v5.12.5;
use warnings;
our $VERSION = '9999.99.99_99'; # VERSION
require Exporter;
use base qw(Exporter);
use vars qw(@EXPORT);
use Rex::Logger;
use Rex::Commands;
use Rex::Commands::Run;
use Rex::Commands::Fs;
use Rex::Commands::File;
use Rex::Helper::Path;
use Rex::Helper::Run;
use IO::String;
my $has_config_augeas = 0;
BEGIN {
use Rex::Require;
if ( Config::Augeas->is_loadable ) {
Config::Augeas->use;
$has_config_augeas = 1;
}
}
@EXPORT = qw(augeas);
=head2 augeas($action, @options)
It returns 1 on success and 0 on failure.
Actions:
=over 4
=cut
sub augeas {
my ( $action, @options ) = @_;
my $ret;
my $is_ssh = Rex::is_ssh();
my $aug; # Augeas object (non-SSH only)
if ( !$is_ssh && $has_config_augeas ) {
Rex::Logger::debug("Creating Config::Augeas Object");
$aug = Config::Augeas->new;
}
my $on_change; # Any code to run on change
my $changed; # Whether any changes have taken place
=item modify
This modifies the keys given in @options in $file.
augeas modify =>
"/files/etc/hosts/7/ipaddr" => "127.0.0.2",
"/files/etc/hosts/7/canonical" => "test01",
on_change => sub { say "I changed!" };
=cut
if ( $action eq "modify" ) {
my $config_option = {@options};
# Code to run on a change being made
$on_change = delete $config_option->{on_change}
if ref $config_option->{on_change} eq 'CODE';
if ( $is_ssh || !$has_config_augeas ) {
my @commands;
for my $key ( keys %{$config_option} ) {
Rex::Logger::debug( "modifying $key -> " . $config_option->{$key} );
push @commands, qq(set $key "$config_option->{$key}"\n);
}
my $result = _run_augtool(@commands);
$ret = $result->{return};
$changed = $result->{changed};
}
else {
for my $key ( keys %{$config_option} ) {
Rex::Logger::debug( "modifying $key -> " . $config_option->{$key} );
$aug->set( $key, $config_option->{$key} );
}
$ret = $aug->save;
Rex::Logger::debug("Augeas set status: $ret");
$changed = 1 if $ret && $aug->get('/augeas/events/saved'); # Any files changed?
}
}
=item remove
Remove an entry.
augeas remove => "/files/etc/hosts/2",
on_change => sub { say "I changed!" };
=cut
elsif ( $action eq "remove" ) {
# Code to run on a change being made
if ( $options[-2]
&& $options[-2] eq 'on_change'
&& ref $options[-1] eq 'CODE' )
{
$on_change = pop @options;
pop @options;
}
my @commands;
for my $aug_key (@options) {
Rex::Logger::debug("deleting $aug_key");
if ( $is_ssh || !$has_config_augeas ) {
push @commands, "rm $aug_key\n";
}
else {
my $_r = $aug->remove($aug_key);
Rex::Logger::debug("Augeas delete status: $_r");
}
}
if ( $is_ssh || !$has_config_augeas ) {
my $result = _run_augtool(@commands);
$ret = $result->{return};
$changed = $result->{changed};
}
else {
$ret = $aug->save;
$changed = 1 if $ret && $aug->get('/augeas/events/saved'); # Any files changed?
}
}
=item insert
Insert an item into the file. Here, the order of the options is important. If the order is wrong it won't save your changes.
augeas insert => "/files/etc/hosts",
label => "01",
after => "/7",
ipaddr => "192.168.2.23",
alias => "test02",
on_change => sub { say "I changed!" };
=cut
elsif ( $action eq "insert" ) {
my $file = shift @options;
my $opts = {@options};
my $label = $opts->{"label"};
delete $opts->{"label"};
# Code to run on a change being made
if ( $options[-2]
&& $options[-2] eq 'on_change'
&& ref $options[-1] eq 'CODE' )
{
$on_change = pop @options;
pop @options;
}
if ( $is_ssh || !$has_config_augeas ) {
my $position = ( exists $opts->{"before"} ? "before" : "after" );
unless ( exists $opts->{$position} ) {
Rex::Logger::info(
"Error inserting key. You have to specify before or after.");
return 0;
}
my @commands = ("ins $label $position $file$opts->{$position}\n");
delete $opts->{$position};
for ( my $i = 0 ; $i < @options ; $i += 2 ) {
my $key = $options[$i];
my $val = $options[ $i + 1 ];
next if ( $key eq "after" or $key eq "before" or $key eq "label" );
my $_key = "$file/$label/$key";
Rex::Logger::debug("Setting $_key => $val");
push @commands, qq(set $_key "$val"\n);
}
my $result = _run_augtool(@commands);
$ret = $result->{return};
$changed = $result->{changed};
}
else {
if ( exists $opts->{"before"} ) {
$aug->insert( $label, before => "$file" . $opts->{"before"} );
delete $opts->{"before"};
}
elsif ( exists $opts->{"after"} ) {
my $t = $aug->insert( $label, after => "$file" . $opts->{"after"} );
delete $opts->{"after"};
}
else {
Rex::Logger::info(
"Error inserting key. You have to specify before or after.");
return 0;
}
for ( my $i = 0 ; $i < @options ; $i += 2 ) {
my $key = $options[$i];
my $val = $options[ $i + 1 ];
next if ( $key eq "after" or $key eq "before" or $key eq "label" );
my $_key = "$file/$label/$key";
Rex::Logger::debug("Setting $_key => $val");
$aug->set( $_key, $val );
}
$ret = $aug->save();
$changed = 1 if $ret && $aug->get('/augeas/events/saved'); # Any files changed?
}
}
=item dump
Dump the contents of a file to STDOUT.
augeas dump => "/files/etc/hosts";
=cut
elsif ( $action eq "dump" ) {
my $file = shift @options;
my $aug_key = $file;
if ( $is_ssh || !$has_config_augeas ) {
my @list = i_exec "augtool", "print", $aug_key;
print join( "\n", @list ) . "\n";
}
else {
$aug->print($aug_key);
}
$ret = 0;
}
=item exists
Check if an item exists.
my $exists = augeas exists => "/files/etc/hosts/*/ipaddr" => "127.0.0.1";
if($exists) {
say "127.0.0.1 exists!";
}
=cut
elsif ( $action eq "exists" ) {
my $file = shift @options;
my $aug_key = $file;
my $val = $options[0] || "";
if ( $is_ssh || !$has_config_augeas ) {
my @paths;
my $result = _run_augtool("match $aug_key");
for my $line ( split "\n", $result->{return} ) {
$line =~ s/\s=[^=]+$// or next;
push @paths, $line;
}
if ($val) {
for my $k (@paths) {
my @ret;
my $result = _run_augtool("get $k");
for my $line ( split "\n", $result->{return} ) {
$line =~ s/^[^=]+=\s//;
push @ret, $line;
}
if ( $ret[0] eq $val ) {
return $k;
}
}
}
else {
return @paths;
}
$ret = undef;
}
else {
my @paths = $aug->match($aug_key);
if ($val) {
for my $k (@paths) {
if ( $aug->get($k) eq $val ) {
return $k;
}
}
}
else {
return @paths;
}
$ret = undef;
}
}
=item get
Returns the value of the given item.
my $val = augeas get => "/files/etc/hosts/1/ipaddr";
=cut
elsif ( $action eq "get" ) {
my $file = shift @options;
if ( $is_ssh || !$has_config_augeas ) {
my @lines;
my $result = _run_augtool("get $file");
for my $line ( split "\n", $result->{return} ) {
$line =~ s/^[^=]+=\s//;
push @lines, $line;
}
return $lines[0];
}
else {
return $aug->get($file);
}
}
else {
Rex::Logger::info("Unknown augeas action.");
}
if ( $on_change && $changed ) {
Rex::Logger::debug("Calling on_change hook of augeas");
$on_change->();
}
Rex::Logger::debug("Augeas Returned: $ret") if $ret;
return $ret;
}
=back
=cut
sub _run_augtool {
my (@commands) = @_;
die "augtool is not installed or not executable in the path"
unless can_run "augtool";
my $rnd_file = get_tmp_file;
my $fh = Rex::Interface::File->create;
$fh->open( ">", $rnd_file );
$fh->write($_) foreach (@commands);
$fh->close;
my ( $return, $error ) = i_run "augtool --file $rnd_file --autosave",
sub { @_ }, fail_ok => 1;
my $ret = $? == 0 ? 1 : 0;
if ($ret) {
Rex::Logger::debug("Augeas command return value: $ret");
Rex::Logger::debug("Augeas result: $return");
}
else {
Rex::Logger::info( "Augeas command failed: $error", 'warn' );
}
my $changed = "$return" =~ /Saved/ ? 1 : 0;
unlink $rnd_file;
{
result => $ret,
return => $return || $error,
changed => $changed,
};
}
1;