beaker 4.34.0 → 4.35.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bc022311d195fb3d0b0ff1b9b957272379e6adc5aadb1dfb30e77d89a912872d
-  data.tar.gz: be60dbf2c333ea695d3e6d8b4b8fd5dc6811acbe6489e17cf924b08f24c79b05
+  metadata.gz: 9a6679daffb138ec6bb59a4b06779db93ce4aada9f4213696ccbc1ea00041e3f
+  data.tar.gz: 81d748b81d7ff9ec56e9b7b1309682f38540e0f03c9a861404a2493f592d4313
 SHA512:
-  metadata.gz: '0287d90c4f88b325f104eb4dd36ad8d75f26f070c2851d4bec00c364ee3150fc706902667ecd14f1e127cd5e4030d8a418ce0dccbe9a6ec9f58dbdd08a81a1de'
-  data.tar.gz: 8db6cc489d03e57bf25f373cd20dbc1c99b3d1eebbd7108191bd133e3152f61b8333a8f24667f7ed24c29ba4f29242bfaa5c016c24d380a11c24cb0c3207d942
+  metadata.gz: b631a91707d5b1f6ff2dbb855f0cb67cfe8a693f7923b4e6dbe03eb36e6be6a9f37f56a9886eaa9c371879e3d1e4a7d276404079990e7b60c12614811805ff5c
+  data.tar.gz: 893a6a7616500aba9df72dcaed0305bcd73038178e5b9687b0cbf2313737801e39e11a49b1bc7d836249d34577dde7bc0a79c7841072c3847bcd6255aaf55624

data/.github/workflows/test.yml

@@ -19,6 +19,7 @@ jobs:
           - ruby: "2.6"
           - ruby: "2.7"
           - ruby: "3.0"
+          - ruby: "3.1"
             coverage: "yes"
     env:
       COVERAGE: ${{ matrix.coverage }}
@@ -29,5 +30,7 @@ jobs:
         with:
           ruby-version: ${{ matrix.ruby }}
           bundler-cache: true
+      - name: Build gem
+        run: gem build *.gemspec
       - name: Run tests
         run: bundle exec rake spec

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Changelog
 
+## [4.35.0](https://github.com/voxpupuli/beaker/tree/4.35.0) (2022-05-13)
+
+## Added
+
+- Add Ruby 3.1 support ([#1736](https://github.com/voxpupuli/beaker/pull/1736))
+- Build gem during CI runs ([#1738](https://github.com/voxpupuli/beaker/pull/1738))
+
 ## [4.34.0](https://github.com/voxpupuli/beaker/tree/4.34.0) (2022-01-27)
 
 ### Added

data/Gemfile

@@ -28,3 +28,5 @@ group :coverage, optional: ENV['COVERAGE']!='yes' do
   gem 'simplecov-console', :require => false
   gem 'codecov', :require => false
 end
+
+gem 'rdoc' if RUBY_VERSION >= '3.1'

data/lib/beaker/options/hosts_file_parser.rb

@@ -2,6 +2,7 @@ module Beaker
   module Options
     #A set of functions to parse hosts files
     module HostsFileParser
+      PERMITTED_YAML_CLASSES = [Beaker::Options::OptionsHash, Beaker::Platform, Symbol, Time]
 
       # Read the contents of the hosts.cfg into an OptionsHash, merge the 'CONFIG' section into the OptionsHash, return OptionsHash
       # @param [String] hosts_file_path The path to the hosts file
@@ -24,7 +25,7 @@ module Beaker
 
           raise "#{hosts_file_path} is not a valid path" unless File.exist?(hosts_file_path)
 
-          YAML.load(ERB.new(File.read(hosts_file_path), nil, '-').result(binding))
+          process_yaml(File.read(hosts_file_path), binding)
         }
         fix_roles_array( host_options )
       end
@@ -42,7 +43,7 @@ module Beaker
         return host_options unless hosts_def_yaml
         error_message = "#{hosts_def_yaml}\nis not a valid YAML string\n\t"
         host_options = self.merge_hosts_yaml( host_options, error_message ) {
-          YAML.load(ERB.new(hosts_def_yaml, nil, '-').result(binding))
+          process_yaml(hosts_def_yaml, binding)
         }
         fix_roles_array( host_options )
       end
@@ -85,6 +86,23 @@ module Beaker
         host_options.merge( loaded_host_options )
       end
 
+      # A helper to parse the YAML file and apply ERB templating
+      #
+      # @param [String] path Path to the file to read
+      # @param [Binding] b The binding to pass to ERB rendering
+      # @api private
+      def self.process_yaml(template, b)
+        erb_obj = if RUBY_VERSION >= '2.7'
+                     ERB.new(template, trim_mode: '-')
+                   else
+                     ERB.new(template, nil, '-')
+                   end
+        if RUBY_VERSION >= '2.6'
+          YAML.safe_load(erb_obj.result(b), permitted_classes: PERMITTED_YAML_CLASSES)
+        else
+          YAML.load(erb_obj.result(b))
+        end
+      end
     end
   end
 end

data/lib/beaker/version.rb

@@ -1,5 +1,5 @@
 module Beaker
   module Version
-    STRING = '4.34.0'
+    STRING = '4.35.0'
   end
 end

data/spec/beaker/cli_spec.rb

@@ -1,5 +1,15 @@
 require 'spec_helper'
 
+def load_yaml_file(path)
+  # Ruby 2.x has no safe_load_file
+  if YAML.respond_to?(:safe_load_file)
+    permitted = [Beaker::Options::OptionsHash, Symbol, RSpec::Mocks::Double, Time]
+    YAML.safe_load_file(path, permitted_classes: permitted, aliases: true)
+  else
+    YAML.load_file(path)
+  end
+end
+
 module Beaker
   describe CLI do
 
@@ -361,7 +371,7 @@ module Beaker
           cli.instance_variable_set(:@hosts, hosts)
 
           preserved_file = cli.preserve_hosts_file
-          hosts_yaml = YAML.load_file(preserved_file)
+          hosts_yaml = load_yaml_file(preserved_file)
           expect(hosts_yaml['CONFIG'][:tests]).to be == []
           expect(hosts_yaml['CONFIG'][:pre_suite]).to be == []
           expect(hosts_yaml['CONFIG'][:post_suite]).to be == []
@@ -428,7 +438,7 @@ module Beaker
             cli.execute!
 
             copied_hosts_file = File.join(File.absolute_path(dir), 'hosts_preserved.yml')
-            expect{ YAML.load_file(copied_hosts_file) }.to_not raise_error
+            expect{ load_yaml_file(copied_hosts_file) }.to_not raise_error
           end
         end
 
@@ -440,7 +450,7 @@ module Beaker
             cli.execute!
 
             copied_hosts_file = File.join(File.absolute_path(dir), 'hosts_preserved.yml')
-            yaml_content = YAML.load_file(copied_hosts_file)
+            yaml_content = load_yaml_file(copied_hosts_file)
             expect( yaml_content['CONFIG']['provision'] ).to be_falsy
           end
         end

data/spec/beaker/host/unix/pkg_spec.rb

@@ -106,7 +106,7 @@ module Beaker
         pkg = 'sles_package'
         expect( Beaker::Command ).to receive( :new ).with( /^rpmkeys.*nightlies.puppetlabs.com.*/, anything, anything ).and_return('').ordered.once
         expect( Beaker::Command ).to receive(:new).with("zypper --gpg-auto-import-keys se -i --match-exact #{pkg}", [], {:prepend_cmds=>nil, :cmdexe=>false}).and_return('').ordered.once
-        expect( instance ).to receive(:exec).with('', :accept_all_exit_codes => true).and_return(generate_result("hello", {:exit_code => 0})).exactly(2).times
+        expect( instance ).to receive(:exec).with('', {:accept_all_exit_codes => true}).and_return(generate_result("hello", {:exit_code => 0})).exactly(2).times
         expect( instance.check_for_package(pkg) ).to be === true
       end
       it "checks correctly on opensuse" do
@@ -114,7 +114,7 @@ module Beaker
         pkg = 'sles_package'
         expect( Beaker::Command ).to receive( :new ).with( /^rpmkeys.*nightlies.puppetlabs.com.*/, anything, anything ).and_return('').ordered.once
         expect( Beaker::Command ).to receive(:new).with("zypper --gpg-auto-import-keys se -i --match-exact #{pkg}", [], {:prepend_cmds=>nil, :cmdexe=>false}).and_return('').ordered.once
-        expect( instance ).to receive(:exec).with('', :accept_all_exit_codes => true).and_return(generate_result("hello", {:exit_code => 0})).exactly(2).times
+        expect( instance ).to receive(:exec).with('', {:accept_all_exit_codes => true}).and_return(generate_result("hello", {:exit_code => 0})).exactly(2).times
         expect( instance.check_for_package(pkg) ).to be === true
       end
 
@@ -122,7 +122,7 @@ module Beaker
         @opts = {'platform' => 'fedora-is-me'}
         pkg = 'fedora_package'
         expect( Beaker::Command ).to receive(:new).with("rpm -q #{pkg}", [], {:prepend_cmds=>nil, :cmdexe=>false}).and_return('')
-        expect( instance ).to receive(:exec).with('', :accept_all_exit_codes => true).and_return(generate_result("hello", {:exit_code => 0}))
+        expect( instance ).to receive(:exec).with('', {:accept_all_exit_codes => true}).and_return(generate_result("hello", {:exit_code => 0}))
         expect( instance.check_for_package(pkg) ).to be === true
       end
 
@@ -131,7 +131,7 @@ module Beaker
           @opts = {'platform' => "#{platform}-is-me"}
           pkg = "#{platform}_package"
           expect( Beaker::Command ).to receive(:new).with("rpm -q #{pkg}", [], {:prepend_cmds=>nil, :cmdexe=>false}).and_return('')
-          expect( instance ).to receive(:exec).with('', :accept_all_exit_codes => true).and_return(generate_result("hello", {:exit_code => 0}))
+          expect( instance ).to receive(:exec).with('', {:accept_all_exit_codes => true}).and_return(generate_result("hello", {:exit_code => 0}))
           expect( instance.check_for_package(pkg) ).to be === true
         end
       end
@@ -140,7 +140,7 @@ module Beaker
         @opts = {'platform' => 'eos-is-me'}
         pkg = 'eos-package'
         expect( Beaker::Command ).to receive(:new).with("rpm -q #{pkg}", [], {:prepend_cmds=>nil, :cmdexe=>false}).and_return('')
-        expect( instance ).to receive(:exec).with('', :accept_all_exit_codes => true).and_return(generate_result("hello", {:exit_code => 0}))
+        expect( instance ).to receive(:exec).with('', {:accept_all_exit_codes => true}).and_return(generate_result("hello", {:exit_code => 0}))
         expect( instance.check_for_package(pkg) ).to be === true
       end
 
@@ -148,7 +148,7 @@ module Beaker
         @opts = {'platform' => 'el-is-me'}
         pkg = 'el_package'
         expect( Beaker::Command ).to receive(:new).with("rpm -q #{pkg}", [], {:prepend_cmds=>nil, :cmdexe=>false}).and_return('')
-        expect( instance ).to receive(:exec).with('', :accept_all_exit_codes => true).and_return(generate_result("hello", {:exit_code => 0}))
+        expect( instance ).to receive(:exec).with('', {:accept_all_exit_codes => true}).and_return(generate_result("hello", {:exit_code => 0}))
         expect( instance.check_for_package(pkg) ).to be === true
       end
 
@@ -156,14 +156,14 @@ module Beaker
         @opts = {'platform' => 'huaweios-is-me'}
         pkg = 'debian_package'
         expect( Beaker::Command ).to receive(:new).with("dpkg -s #{pkg}", [], {:prepend_cmds=>nil, :cmdexe=>false}).and_return('')
-        expect( instance ).to receive(:exec).with('', :accept_all_exit_codes => true).and_return(generate_result("hello", {:exit_code => 0}))
+        expect( instance ).to receive(:exec).with('', {:accept_all_exit_codes => true}).and_return(generate_result("hello", {:exit_code => 0}))
         expect( instance.check_for_package(pkg) ).to be === true
       end
       it "checks correctly on debian" do
         @opts = {'platform' => 'debian-is-me'}
         pkg = 'debian_package'
         expect( Beaker::Command ).to receive(:new).with("dpkg -s #{pkg}", [], {:prepend_cmds=>nil, :cmdexe=>false}).and_return('')
-        expect( instance ).to receive(:exec).with('', :accept_all_exit_codes => true).and_return(generate_result("hello", {:exit_code => 0}))
+        expect( instance ).to receive(:exec).with('', {:accept_all_exit_codes => true}).and_return(generate_result("hello", {:exit_code => 0}))
         expect( instance.check_for_package(pkg) ).to be === true
       end
 
@@ -171,7 +171,7 @@ module Beaker
         @opts = {'platform' => 'ubuntu-is-me'}
         pkg = 'ubuntu_package'
         expect( Beaker::Command ).to receive(:new).with("dpkg -s #{pkg}", [], {:prepend_cmds=>nil, :cmdexe=>false}).and_return('')
-        expect( instance ).to receive(:exec).with('', :accept_all_exit_codes => true).and_return(generate_result("hello", {:exit_code => 0}))
+        expect( instance ).to receive(:exec).with('', {:accept_all_exit_codes => true}).and_return(generate_result("hello", {:exit_code => 0}))
         expect( instance.check_for_package(pkg) ).to be === true
       end
 
@@ -179,7 +179,7 @@ module Beaker
         @opts = {'platform' => 'cumulus-is-me'}
         pkg = 'cumulus_package'
         expect( Beaker::Command ).to receive(:new).with("dpkg -s #{pkg}", [], {:prepend_cmds=>nil, :cmdexe=>false}).and_return('')
-        expect( instance ).to receive(:exec).with('', :accept_all_exit_codes => true).and_return(generate_result("hello", {:exit_code => 0}))
+        expect( instance ).to receive(:exec).with('', {:accept_all_exit_codes => true}).and_return(generate_result("hello", {:exit_code => 0}))
         expect( instance.check_for_package(pkg) ).to be === true
       end
 
@@ -187,7 +187,7 @@ module Beaker
         @opts = {'platform' => 'solaris-11-is-me'}
         pkg = 'solaris-11_package'
         expect( Beaker::Command ).to receive(:new).with("pkg info #{pkg}", [], {:prepend_cmds=>nil, :cmdexe=>false}).and_return('')
-        expect( instance ).to receive(:exec).with('', :accept_all_exit_codes => true).and_return(generate_result("hello", {:exit_code => 0}))
+        expect( instance ).to receive(:exec).with('', {:accept_all_exit_codes => true}).and_return(generate_result("hello", {:exit_code => 0}))
         expect( instance.check_for_package(pkg) ).to be === true
       end
 
@@ -195,7 +195,7 @@ module Beaker
         @opts = {'platform' => 'solaris-10-is-me'}
         pkg = 'solaris-10_package'
         expect( Beaker::Command ).to receive(:new).with("pkginfo #{pkg}", [], {:prepend_cmds=>nil, :cmdexe=>false}).and_return('')
-        expect( instance ).to receive(:exec).with('', :accept_all_exit_codes => true).and_return(generate_result("hello", {:exit_code => 0}))
+        expect( instance ).to receive(:exec).with('', {:accept_all_exit_codes => true}).and_return(generate_result("hello", {:exit_code => 0}))
         expect( instance.check_for_package(pkg) ).to be === true
       end
 
@@ -203,7 +203,7 @@ module Beaker
         @opts = {'platform' => 'archlinux-is-me'}
         pkg = 'archlinux_package'
         expect( Beaker::Command ).to receive(:new).with("pacman -Q #{pkg}", [], {:prepend_cmds=>nil, :cmdexe=>false}).and_return('')
-        expect( instance ).to receive(:exec).with('', :accept_all_exit_codes => true).and_return(generate_result("hello", {:exit_code => 0}))
+        expect( instance ).to receive(:exec).with('', {:accept_all_exit_codes => true}).and_return(generate_result("hello", {:exit_code => 0}))
         expect( instance.check_for_package(pkg) ).to be === true
       end
 

data/spec/beaker/options/hosts_file_parser_spec.rb

@@ -66,9 +66,10 @@ module Beaker
           expect( host_options ).to be === parser.new_host_options
         end
 
-        it 'passes a YAML.load call through to #merge_hosts_yaml' do
+        it 'passes a process_yaml call through to #merge_hosts_yaml' do
           yaml_string = 'not actually yaml, but that wont matter'
-          expect( YAML ).to receive( :load ).with( yaml_string )
+          expect(described_class).to receive(:process_yaml).with(yaml_string, instance_of(Binding))
+
           parser.parse_hosts_string( yaml_string )
         end
       end

data/spec/beaker/platform_spec.rb

@@ -150,7 +150,14 @@ module Beaker
         @name = 'ubuntu-14.04-x86_64'
       end
 
-      let(:round_tripped) { YAML.load(YAML.dump(platform)) }
+      let(:round_tripped) do
+        # Ruby 2 has no unsafe_load
+        if YAML.respond_to?(:unsafe_load)
+          YAML.unsafe_load(YAML.dump(platform))
+        else
+          YAML.load(YAML.dump(platform))
+        end
+      end
 
       [:variant, :arch, :version, :codename].each do |field|
         it "deserializes the '#{field}' field" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: beaker
 version: !ruby/object:Gem::Version
-  version: 4.34.0
+  version: 4.35.0
 platform: ruby
 authors:
 - Puppet
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-01-27 00:00:00.000000000 Z
+date: 2022-05-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -676,7 +676,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.32
+rubygems_version: 3.2.33
 signing_key: 
 specification_version: 4
 summary: Let's test Puppet!