Merge branch 'master' of github.com:giterlizzi/Rex

Author: giterlizzi

.github/workflows/build_and_test.yml

@@ -79,6 +79,8 @@ jobs:
           name: build.tar
       - name: Extract build tarball
         run: tar xvf build.tar
+      - name: Install packages
+        run: sudo apt-get install -y augeas-tools libaugeas-dev
       - name: Setup Perl
         id: perl
         uses: shogo82148/actions-setup-perl@v1
@@ -91,7 +93,7 @@ jobs:
           key: cache-coverage-deps-${{ steps.perl.outputs.perl-hash }}-${{ env.BUILD_TIMESTAMP }}
           restore-keys: cache-coverage-deps-${{ steps.perl.outputs.perl-hash }}-
       - name: Install dependencies
-        run: cpanm --local-lib ${GITHUB_WORKSPACE}/local --installdeps --with-develop --with-all-features --with-suggests .
+        run: cpanm --local-lib ${GITHUB_WORKSPACE}/local --installdeps --with-develop --with-all-features --with-recommends --with-suggests .
       - name: Install coverage dependencies
         run: cpanm --local-lib ${GITHUB_WORKSPACE}/local Devel::Cover::Report::Coveralls Pod::Coverage::CountParents
       - name: Install App::cpanoutdated
@@ -100,7 +102,7 @@ jobs:
         run: cpan-outdated -p | cpanm --local-lib ${GITHUB_WORKSPACE}/local
       - name: Run tests with coverage
         env:
-          HARNESS_PERL_SWITCHES: -MDevel::Cover=+ignore,^local/,^t/
+          HARNESS_PERL_SWITCHES: -MDevel::Cover=+ignore,^local/
         run: prove --timer --lib --recurse --jobs $(nproc) --shuffle t/
       - name: Report coverage info to Coveralls
         env:
@@ -125,7 +127,7 @@ jobs:
       - name: Extract build tarball
         run: tar xvf build.tar
       - name: Install packages
-        run: sudo apt-get install -y aspell
+        run: sudo apt-get install -y aspell libaugeas-dev
       - name: Setup Perl
         id: perl
         uses: shogo82148/actions-setup-perl@v1
@@ -164,6 +166,7 @@ jobs:
           - windows
         perl:
           - latest
+          - '5.38'
           - '5.36'
           - '5.34'
           - '5.32'
@@ -198,15 +201,15 @@ jobs:
         with:
           perl-version: ${{ matrix.perl }}
           distribution: ${{ matrix.os == 'windows' && 'strawberry' || 'default' }}
-      - name: Preinstall IO::Pty for Mac OS X tests
-        run: cpanm IO::Pty~'!=1.18'
-        if: matrix.os == 'macos'
+      - name: Disable LWP for cpanm on older Strawberry Perls
+        run: echo "PERL_CPANM_OPT=$env:PERL_CPANM_OPT --no-lwp" >> $env:GITHUB_ENV
+        if: matrix.os == 'windows' && matrix.perl <= 5.22
       - name: Install dependencies
         uses: carlkidcrypto/[email protected]
         with:
-          macos: cpanm --installdeps --with-all-features .
-          linux: cpanm --installdeps --with-all-features .
-          windows: cpanm --installdeps --with-all-features --without-feature=custom_output --without-feature=rsync .
+          macos: cpanm --installdeps --with-all-features --with-recommends .
+          linux: cpanm --installdeps --with-all-features --with-recommends .
+          windows: cpanm --installdeps --with-all-features --without-feature=custom_output --without-feature=rsync --with-recommends .
       - name: Get number of processors
         id: cores
         uses: SimenB/github-actions-cpu-cores@v2

CONTRIBUTING.md

@@ -78,7 +78,8 @@ On top of the supported minimum version of Perl, the goal is to support the late
 - 5.32.1
 - 5.34.1
 - 5.36.1
-- 5.38.0
+- 5.38.2
+- 5.40.0
 
 ### Backwards compatibility
 

ChangeLog

@@ -18,6 +18,26 @@ Revision history for Rex
 
  [REVISION]
 
+1.15.0 2024-11-05 Ferenc Erki <[email protected]>
+ - No code changes since the 1.14.3.2-TRIAL release
+
+1.14.3.2-TRIAL 2024-11-03 Ferenc Erki <[email protected]>
+ [BUG FIXES]
+ - Fix precedence warning after perl-5.41.4
+ - Fix missing argument warnings from Text::Wrap
+ - Fix memory detection warnings on Solaris
+
+1.14.3.1-TRIAL 2024-10-30 Ferenc Erki <[email protected]>
+ [BUG FIXES]
+ - Return only the first found command
+ - Fix inconsistent augtool wrapper usage
+ - Fix Config::Augeas detection
+ - Fix on_change in update_system command on Redhat
+
+ [NEW FEATURES]
+ - Add config option to prepend Augeas commands
+ - Add config option to control local Augeas backend
+
 1.14.3 2023-08-05 Ferenc Erki <[email protected]>
  - No code changes since the 1.14.2.3-TRIAL release
 

dist.ini

@@ -76,6 +76,7 @@ overwrite = 1
 
 [Prereqs]
 perl = 5.12.5
+Text::Wrap = != 2023.0509
 YAML = != 1.25
 
 [Prereqs / DevelopRequires]
@@ -97,6 +98,12 @@ DBI = 0
 -description = Support describing host groups in XML format
 XML::LibXML = 0
 
+[OptionalFeature / parallel_forkmanager]
+-description = Support Parallel::ForkManager to distribute tasks
+-relationship = recommends
+Parallel::ForkManager = 0
+Moo = >= 1.001000
+
 [OptionalFeature / rsync]
 -description = Support rsync tasks
 Expect = 0
@@ -112,6 +119,12 @@ File::LibMagic = 0
 -relationship = suggests
 -description = Test MySQL commands
 Test::mysqld = 0
+DBD::mysql = 0
+
+[OptionalFeature / use_config_augeas]
+-relationship = suggests
+-description = Run Augeas commands with Config::Augeas
+Config::Augeas = 0
 
 [Test::MinimumVersion]
 max_target_perl = 5.12.5

lib/Rex/Commands/Augeas.pm

@@ -51,17 +51,10 @@ use Rex::Commands::Fs;
 use Rex::Commands::File;
 use Rex::Helper::Path;
 use Rex::Helper::Run;
-use IO::String;
+use Module::Load::Conditional qw(can_load);
 
-my $has_config_augeas = 0;
-
-BEGIN {
-  use Rex::Require;
-  if ( Config::Augeas->is_loadable ) {
-    Config::Augeas->use;
-    $has_config_augeas = 1;
-  }
-}
+my $has_config_augeas =
+  can_load( modules => { 'Config::Augeas' => undef } ) ? 1 : 0;
 
 @EXPORT = qw(augeas);
 
@@ -81,9 +74,15 @@ sub augeas {
 
   my $is_ssh = Rex::is_ssh();
   my $aug; # Augeas object (non-SSH only)
-  if ( !$is_ssh && $has_config_augeas ) {
+
+  my $use_augtool =
+    !$has_config_augeas || Rex::Config->get_local_augeas_backend eq 'augtool';
+
+  if ( !$is_ssh && !$use_augtool ) {
     Rex::Logger::debug("Creating Config::Augeas Object");
     $aug = Config::Augeas->new;
+    my $commands_to_prepend = Rex::Config->get_augeas_commands_prepend();
+    $aug->srun( join qq(\n), @{$commands_to_prepend} );
   }
 
   my $on_change; # Any code to run on change
@@ -107,7 +106,7 @@ This modifies the keys given in @options in $file.
     $on_change = delete $config_option->{on_change}
       if ref $config_option->{on_change} eq 'CODE';
 
-    if ( $is_ssh || !$has_config_augeas ) {
+    if ( $is_ssh || $use_augtool ) {
       my @commands;
       for my $key ( keys %{$config_option} ) {
         Rex::Logger::debug( "modifying $key -> " . $config_option->{$key} );
@@ -152,7 +151,7 @@ Remove an entry.
     for my $aug_key (@options) {
       Rex::Logger::debug("deleting $aug_key");
 
-      if ( $is_ssh || !$has_config_augeas ) {
+      if ( $is_ssh || $use_augtool ) {
         push @commands, "rm $aug_key\n";
       }
       else {
@@ -161,7 +160,7 @@ Remove an entry.
       }
     }
 
-    if ( $is_ssh || !$has_config_augeas ) {
+    if ( $is_ssh || $use_augtool ) {
       my $result = _run_augtool(@commands);
       $ret     = $result->{return};
       $changed = $result->{changed};
@@ -202,7 +201,7 @@ Insert an item into the file. Here, the order of the options is important. If th
       pop @options;
     }
 
-    if ( $is_ssh || !$has_config_augeas ) {
+    if ( $is_ssh || $use_augtool ) {
       my $position = ( exists $opts->{"before"} ? "before" : "after" );
       unless ( exists $opts->{$position} ) {
         Rex::Logger::info(
@@ -271,9 +270,9 @@ Dump the contents of a file to STDOUT.
     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";
+    if ( $is_ssh || $use_augtool ) {
+      my $output = _run_augtool("print $aug_key");
+      say $output->{'return'};
     }
     else {
       $aug->print($aug_key);
@@ -298,7 +297,7 @@ Check if an item exists.
     my $aug_key = $file;
     my $val     = $options[0] || "";
 
-    if ( $is_ssh || !$has_config_augeas ) {
+    if ( $is_ssh || $use_augtool ) {
       my @paths;
       my $result = _run_augtool("match $aug_key");
       for my $line ( split "\n", $result->{return} ) {
@@ -355,7 +354,7 @@ Returns the value of the given item.
   elsif ( $action eq "get" ) {
     my $file = shift @options;
 
-    if ( $is_ssh || !$has_config_augeas ) {
+    if ( $is_ssh || $use_augtool ) {
       my @lines;
       my $result = _run_augtool("get $file");
       for my $line ( split "\n", $result->{return} ) {
@@ -394,8 +393,12 @@ sub _run_augtool {
     unless can_run "augtool";
   my $rnd_file = get_tmp_file;
   my $fh       = Rex::Interface::File->create;
+
+  my $commands_to_prepend = Rex::Config->get_augeas_commands_prepend();
+  unshift @commands, @{$commands_to_prepend};
+
   $fh->open( ">", $rnd_file );
-  $fh->write($_) foreach (@commands);
+  $fh->write( $_ . qq(\n) ) foreach (@commands);
   $fh->close;
   my ( $return, $error ) = i_run "augtool --file $rnd_file --autosave",
     sub { @_ }, fail_ok => 1;

lib/Rex/Config.pm

@@ -73,7 +73,8 @@ our (
   $use_template_ng,             $use_rex_kvm_agent,
   $autodie,                     $task_chaining_cmdline_args,
   $waitpid_blocking_sleep_time, $write_utf8_files,
-  $default_auth,
+  $default_auth,                $augeas_commands_prepend,
+  $local_augeas_backend,
 );
 
 # some defaults
@@ -1632,6 +1633,50 @@ sub get_default_auth {
   return $default_auth // 1;
 }
 
+=head2 set_augeas_commands_prepend
+
+=head2 get_augeas_commands_prepend
+
+Sets and gets the value of the C<$augeas_commands_prepend> configuration variable.
+
+This controls the list of commands Rex should prepend at the beginning of the command file for Augeas operations.
+
+Default is C<[]>.
+
+=cut
+
+sub set_augeas_commands_prepend {
+  my $self = shift;
+  $augeas_commands_prepend = shift;
+  return $augeas_commands_prepend;
+}
+
+sub get_augeas_commands_prepend {
+  return $augeas_commands_prepend // [];
+}
+
+=head2 set_local_augeas_backend
+
+=head2 get_local_augeas_backend
+
+Sets and gets the value of the C<$local_augeas_backend> configuration variable.
+
+This controls which Augeas backend to use for local operations, C<augtool> or C<Config::Augeas>.
+
+Default is C<Config::Augeas>.
+
+=cut
+
+sub set_local_augeas_backend {
+  my $self = shift;
+  $local_augeas_backend = shift;
+  return $local_augeas_backend;
+}
+
+sub get_local_augeas_backend {
+  return $local_augeas_backend // 'Config::Augeas';
+}
+
 =head2 register_set_handler($handler_name, $code)
 
 Register a handler that gets called by I<set>.

lib/Rex/Hardware/Memory.pm

@@ -9,6 +9,7 @@ use warnings;
 
 our $VERSION = '9999.99.99_99'; # VERSION
 
+use English qw(-no_match_vars);
 use Rex::Hardware::Host;
 use Rex::Commands::Run;
 use Rex::Helper::Run;
@@ -54,25 +55,34 @@ sub get {
   elsif ( $os eq "SunOS" ) {
     my @data = i_run "echo ::memstat | mdb -k", fail_ok => 1;
 
-    my ($free_cache) = map { /\D+\d+\s+(\d+)/ } grep { /^Free \(cache/ } @data;
-    my ($free_list)  = map { /\D+\d+\s+(\d+)/ } grep { /^Free \(freel/ } @data;
-    my ($page_cache) = map { /\s+\d+\s+(\d+)/ } grep { /^Page cache/ } @data;
+    if ( $CHILD_ERROR == 0 ) {
+      my ($free_cache) =
+        map { /\D+\d+\s+(\d+)/ } grep { /^Free \(cache/ } @data;
+      my ($free_list) = map { /\D+\d+\s+(\d+)/ } grep { /^Free \(freel/ } @data;
+      my ($page_cache) = map { /\s+\d+\s+(\d+)/ } grep { /^Page cache/ } @data;
 
-    my $free = $free_cache + $free_list;
+      my $free = $free_cache + $free_list;
 
 #my ($total, $total_e) = grep { $_=$1 if /^Memory Size: (\d+) ([a-z])/i } i_run "prtconf";
-    my ($total) = map { /\s+\d+\s+(\d+)/ } grep { /^Total/ } @data;
+      my ($total) = map { /\s+\d+\s+(\d+)/ } grep { /^Total/ } @data;
 
-    &$convert( $free,  "M" );
-    &$convert( $total, "M" );
-    my $used = $total - $free;
-
-    $data = {
-      used  => $used,
-      total => $total,
-      free  => $free,
-    };
+      &$convert( $free,  "M" );
+      &$convert( $total, "M" );
+      my $used = $total - $free;
 
+      $data = {
+        used  => $used,
+        total => $total,
+        free  => $free,
+      };
+    }
+    else {
+      $data = {
+        used  => 0,
+        total => 0,
+        free  => 0,
+      };
+    }
   }
   elsif ( $os eq "OpenBSD" ) {
     my $mem_str   = i_run "top -d1 | grep Memory:", fail_ok => 1;

lib/Rex/Interface/Exec/Base.pm

@@ -65,16 +65,16 @@ sub can_run {
       return $cache->get($cache_key_name);
     }
 
-    my $output = Rex::Helper::Run::i_run "$check_with_command $command",
+    my @output = Rex::Helper::Run::i_run "$check_with_command $command",
       fail_ok => 1;
 
     next if ( $? != 0 );
 
-    next if ( !is_file($output) );
+    next if ( !is_file( $output[0] ) );
 
-    $cache->set( $cache_key_name, $output );
+    $cache->set( $cache_key_name, $output[0] );
 
-    return $output;
+    return $output[0];
   }
 
   return undef;