Workaround libaugeas save/load issue

[h-haaks]

Pull Request (PR) description

hercules-team/augeas#691 introduced a bug in libaugeas bundled with puppet 7.
The bug manifests it self in this modules augsave! method when invoked with reload=true.
A workaround is to invoke aug.load! twice after an aug.save!
See voxpupuli/puppet-augeasproviders_sysctl#65

[h-haaks]

Should resolve the test issues in voxpupuli/puppet-augeasproviders_sysctl#65

[ekohl]

This depends on the Augeas version, not Puppet. So I'd prefer to use aug_version instead. So something like:

Suggested change

	aug.load! if reload && Puppet::Util::Package.versioncmp(Puppet.version, '7.0.0') >= 0
	aug.load! if reload && Puppet::Util::Package.versioncmp(aug_version, '1.13.0') >= 0

[h-haaks]

Hmm, I tried this but then my test broke ....
puts "Puppet version: #{Puppet.version}, Augeas version: #{aug_version}" says

Puppet version: 6.29.0, Augeas version: 1.12.0
Puppet version: 7.24.0, Augeas version: 1.12.0

[ekohl]

Oh that's weird. On my Fedora with system Ruby:

$ pry
[1] pry(main)> require 'augeas'
=> true
[2] pry(main)> Augeas.open(nil, nil, Augeas::NO_MODL_AUTOLOAD) { |aug| aug.get('/augeas/version') }
=> "1.13.0"

On my EL8 AIO:

$ rpm -qv puppet-agent
puppet-agent-7.24.0-1.el8.x86_64
$ /opt/puppetlabs/puppet/bin/ruby 
require 'augeas'
puts Augeas.open(nil, nil, Augeas::NO_MODL_AUTOLOAD) { |aug| aug.get('/augeas/version') }

1.13.0

On a Debian 11 machine with puppet-agent-7.24.0-1bullseye:

# /opt/puppetlabs/puppet/bin/ruby
require 'augeas'
puts Augeas.open(nil, nil, Augeas::NO_MODL_AUTOLOAD) { |aug| aug.get('/augeas/version') }
1.13.0

[h-haaks]

Ah, unit tests does not use puppet agent, and on my rockylinux-8 vagrant box augeas-lib 1.12.0 is installed.
Should I just drop the unit test I added then?

[h-haaks]

Figured out how to stub it :)

[ekohl]

And it would also be good to verify if hercules-team/augeas#810 solves it.

[ekohl]

Thanks!

[h-haaks]

And it would also be good to verify if hercules-team/augeas#810 solves it.

Verified on

[root@localhost ~]# cat /etc/os-release 
NAME="CentOS Stream"
VERSION="8"
ID="centos"
ID_LIKE="rhel fedora"
VERSION_ID="8"
PLATFORM_ID="platform:el8"
PRETTY_NAME="CentOS Stream 8"
ANSI_COLOR="0;31"
CPE_NAME="cpe:/o:centos:centos:8"
HOME_URL="https://centos.org/"
BUG_REPORT_URL="https://bugzilla.redhat.com/"
REDHAT_SUPPORT_PRODUCT="Red Hat Enterprise Linux 8"
REDHAT_SUPPORT_PRODUCT_VERSION="CentOS Stream"

[root@localhost vagrant]# ruby --version
ruby 2.5.9p229 (2021-04-05 revision 67939) [x86_64-linux]
[root@localhost vagrant]# gem list augeas

*** LOCAL GEMS ***

ruby-augeas (0.5.0)

verification script

#!/usr/bin/env ruby

require 'augeas'
file = '/etc/sysctl.d/20-fs.conf'

aug = Augeas.open

def augset(aug, file, name, value)
  aug.set("/files/#{file}/#{name}", value) 
  aug.save!
  aug.load!
end

puts aug.get('/augeas/version')
augset(aug, file, 'fs.nr_open', '100001')
augset(aug, file, 'fs.inotify.max_user_watches', '8193')

aug.close

Test with manual build of the release-1.13.0 tag

[root@localhost vagrant]# rm -f /etc/sysctl.d/20-fs.conf
[root@localhost vagrant]# LD_LIBRARY_PATH=/usr/local/lib ~/broken_sysctl.rb 
1.13.0
[root@localhost vagrant]# cat /etc/sysctl.d/20-fs.conf
fs.inotify.max_user_watches = 8193

Test with manual build of fix_691_modified branch

[root@localhost vagrant]# rm -f /etc/sysctl.d/20-fs.conf
[root@localhost vagrant]# LD_LIBRARY_PATH=/usr/local/lib ~/broken_sysctl.rb 
1.14.0
[root@localhost vagrant]# cat /etc/sysctl.d/20-fs.conf
fs.nr_open = 100001
fs.inotify.max_user_watches = 8193