beaker 4.18.0 → 4.19.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9a6ffdf30249cf3d13af3ce8bb88668c0c50a06861a43a2c6cf34f026dd937dd
-  data.tar.gz: 9bbedea15bd4815259b9df3ac75e410106d8a052c91bb5aabf6f595d4b327863
+  metadata.gz: 8a1ffd36126ef1c3aa4bc3fc1ad93dab786f7c8a67bc01749020e063c0d6642b
+  data.tar.gz: b4c320f7acf05904d85b899b1d7ea6e51a6097b5dae317eec0f3c4a6df533ac3
 SHA512:
-  metadata.gz: 32ffc2eff47d6233e8176ef570e9fa063620d122b43ff383ad4169de4956ee5e0103fec99d9d1d029b3beae47ba82e5678e34f99cff3a555fd0a033bf7b42bb9
-  data.tar.gz: 27206ea065b9382a9b5e2b85fdb469d7116ec8ee310e881118047886206faecd6987621d3781e827bfddfe7ab5ea7292184bc2608779c21e47ccfe79af9534aa
+  metadata.gz: d9ba01bffcfe9cfe356ff06bc294d32d248283b01e943139582d346fe7566a5ed8b4fe5ae5715ff1de57253f20a44eba3c50649c9876f4399aaf000ef53d64ad
+  data.tar.gz: b48a94b96ed04579fcb27842a69de75a70adf0c9fe93a5210b93a476321ce9139e4d3cb4bf9376f8708e6fd9f170bc83f863c0381a13a393b97d34c35ac37d89

data/CHANGELOG.md

@@ -11,7 +11,35 @@ Tracking in this Changelog began for this project in version 3.25.0.
 If you're looking for changes from before this, refer to the project's
 git logs & PR history.
 
-# [Unreleased](https://github.com/puppetlabs/beaker/compare/4.18.0...master)
+The headers used in [Keep a Changelog](http://keepachangelog.com) are:
+
+- Added - for new features.
+- Changed - for changes in existing functionality.
+- Deprecated - for soon-to-be removed features.
+- Removed - for now removed features.
+- Fixed - for any bug fixes.
+- Security - in case of vulnerabilities.
+
+# [Unreleased](https://github.com/puppetlabs/beaker/compare/4.19.0...master)
+
+# [4.19.0](https://github.com/puppetlabs/beaker/compare/4.18.0...4.19.0)
+
+### Added
+
+- `apt-transport-https` package will now be installed on Debian-based systems as part of the prebuilt process. ([#1631](https://github.com/puppetlabs/beaker/pull/1631))
+- Ubuntu 19.10 and 20.04 code name handling. ([#1632](https://github.com/puppetlabs/beaker/pull/1632))
+
+### Changed
+
+- The `wait_time`, `max_connection_tries`, and `uptime_retries` parameters have been added to `Host::Unix::Exec.reboot`. This allows for more fine-grained control over how the reboot is handled. ([#1625](https://github.com/puppetlabs/beaker/pull/1625)) 
+
+### Fixed
+
+- In `hosts.yml`, `packaging_platform` will now default to `platform` if unspecified. This fixed a bug where beaker would fail unless you specified both values in your config, even if both values were identical. ([#1628](https://github.com/puppetlabs/beaker/pull/1628))
+- `version_is_less` will now correctly handle builds and RCs when used in version numbers. ([#1630](https://github.com/puppetlabs/beaker/pull/1630))
+
+### Security
+- Update `rake` to `~> 12.0`, which currently resolves to `12.3.3` to remediate [CVE-2020-8130](https://nvd.nist.gov/vuln/detail/CVE-2020-8130)
 
 # [4.18.0](https://github.com/puppetlabs/beaker/compare/4.17.0...4.18.0) - 2020-02-26
 ### Changed

data/beaker.gemspec

@@ -1,5 +1,6 @@
 # -*- encoding: utf-8 -*-
-$LOAD_PATH.unshift File.expand_path("../lib", __FILE__)
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'beaker/version'
 
 Gem::Specification.new do |s|
@@ -24,7 +25,7 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'rspec-its'
   s.add_development_dependency 'fakefs', '~> 0.6', '< 0.14.0'
   s.add_development_dependency 'simplecov'
-  s.add_development_dependency 'rake', '~> 10.0'
+  s.add_development_dependency 'rake', '~> 12.0'
 
   # Provisioner dependencies - needed for acceptance tests
   # TODO: figure out how to remove these

data/lib/beaker/host.rb

@@ -70,6 +70,7 @@ module Beaker
     def initialize name, host_hash, options
       @logger = host_hash[:logger] || options[:logger]
       @name, @host_hash, @options = name.to_s, host_hash.dup, options.dup
+      @host_hash['packaging_platform'] ||= @host_hash['platform']
 
       @host_hash = self.platform_defaults.merge(@host_hash)
       pkg_initialize

data/lib/beaker/host/unix/exec.rb

@@ -2,9 +2,16 @@ module Unix::Exec
   include Beaker::CommandFactory
 
   # Reboots the host, comparing uptime values to verify success
+  # @param [Integer] wait_time How long to wait after sending the reboot 
+  #                            command before attempting to check in on the host
+  # @param [Integer] max_connection_tries How many times to retry connecting to 
+  #                            host after reboot. Note that there is an fibbonacci
+  #                            backoff when attempting retries so the time spent
+  #                            waiting on this can grow quickly.
+  # @param [Integer] uptime_retries How many times to check to see if the value of the uptime has reset.
   #
   # Will throw an exception RebootFailure if it fails
-  def reboot
+  def reboot(wait_time=10, max_connection_tries=9, uptime_retries=18)
     begin
       original_uptime = exec(Beaker::Command.new("uptime"))
       original_uptime_str = parse_uptime original_uptime.stdout
@@ -15,20 +22,36 @@ module Unix::Exec
       else
         exec(Beaker::Command.new("/sbin/shutdown -r now"), :expect_connection_failure => true)
       end
+    rescue Beaker::Host::CommandFailure => e
+      raise Beaker::Host::RebootFailure, "Command failed when attempting to reboot: #{e.message}"
+    rescue RuntimeError => e
+      raise Beaker::Host::RebootFailure, "Unexpected exception in reboot: #{e.message}"
+    end
 
+    attempts = 0
+    begin
       # give the host a little time to shutdown
-      sleep 5 
+      @logger.debug("Waiting #{wait_time} for host to shut down.")
+      sleep wait_time
 
       #use uptime to check if the host has rebooted
-      current_uptime_exec = exec(Beaker::Command.new("uptime"), {:max_connection_tries => 9, :silent => true})
+      current_uptime_exec = exec(Beaker::Command.new("uptime"), {:max_connection_tries => max_connection_tries, :silent => true})
       current_uptime = current_uptime_exec.stdout
       current_uptime_str = parse_uptime current_uptime
       current_uptime_int = uptime_int current_uptime_str
       unless original_uptime_int > current_uptime_int
-        raise Beaker::Host::RebootFailure, "Uptime did not reset. Reboot appears to have failed."
+        raise Beaker::Host::RebootFailure, "Uptime did not reset. Reboot appears to have failed." 
+      end
+    rescue Beaker::Host::RebootFailure => e
+      attempts += 1
+      if attempts < uptime_retries
+        @logger.debug("Uptime did not reset. Will retry #{uptime_retries - attempts} more times.")
+        retry
+      else
+        raise
       end
     rescue Beaker::Host::CommandFailure => e
-      raise Beaker::Host::RebootFailure, "Command failed in reboot: #{e.message}"
+      raise Beaker::Host::RebootFailure, "Command failed when attempting to reboot: #{e.message}"
     rescue RuntimeError => e
       raise Beaker::Host::RebootFailure, "Unexpected exception in reboot: #{e.message}"
     end

data/lib/beaker/host_prebuilt_steps.rb

@@ -21,7 +21,7 @@ module Beaker
     PSWINDOWS_PACKAGES = []
     SLES10_PACKAGES = ['curl']
     SLES_PACKAGES = ['curl', 'ntp']
-    DEBIAN_PACKAGES = ['curl', 'ntpdate', 'lsb-release']
+    DEBIAN_PACKAGES = ['curl', 'ntpdate', 'lsb-release', 'apt-transport-https']
     CUMULUS_PACKAGES = ['curl', 'ntpdate']
     SOLARIS10_PACKAGES = ['CSWcurl', 'CSWntp', 'wget']
     SOLARIS11_PACKAGES = ['curl', 'ntp']

data/lib/beaker/platform.rb

@@ -12,7 +12,8 @@ module Beaker
                      "wheezy"  => "7",
                      "squeeze" => "6",
                    },
-        :ubuntu => { "eoan"    => "1910",
+        :ubuntu => { "focal"   => "2004",
+                     "eoan"    => "1910",
                      "disco"   => "1904",
                      "cosmic"  => "1810",
                      "bionic"  => "1804",

data/lib/beaker/shared/semvar.rb

@@ -7,8 +7,11 @@ module Beaker
       #@param [String] b A version of the form '\d.\d.\d.*'
       #@return [Boolean] true if a is less than b, otherwise return false
       #
-      #@note 3.0.0-160-gac44cfb is greater than 3.0.0, and 2.8.2
-      #@note -rc being less than final builds is not yet implemented.
+      #@note This has been updated for our current versioning scheme.
+      #@note 2019.5.0 is greater than 2019.5.0-rc0
+      #@note 2019.5.0-rc0-1-gabc1234 is greater than 2019.5.0-rc0
+      #@note 2019.5.0-rc1 is greater than 2019.5.0-rc0-1-gabc1234
+      #@note 2019.5.0-1-gabc1234 is greater than 2019.5.0
       def version_is_less a, b
         a_nums = a.split('-')[0].split('.')
         b_nums = b.split('-')[0].split('.')
@@ -24,16 +27,45 @@ module Beaker
           end
         end
         #checks all dots, they are equal so examine the rest
-        a_rest = a.split('-', 2)[1]
-        b_rest = b.split('-', 2)[1]
-        if a_rest and b_rest and a_rest < b_rest
-          return false
-        elsif a_rest and not b_rest
+        a_rest = a.split('-').drop(1)
+        a_is_release = a_rest.empty?
+        a_is_rc = !a_is_release && !!(a_rest[0] =~ /rc\d+/)
+        b_rest = b.split('-').drop(1)
+        b_is_release = b_rest.empty?
+        b_is_rc = !b_is_release && !!(b_rest[0] =~ /rc\d+/)
+
+        if a_is_release && b_is_release
+          # They are equal
           return false
-        elsif not a_rest and b_rest
-          return true
+        elsif !a_is_release && !b_is_release
+          a_next = a_rest.shift
+          b_next = b_rest.shift
+          if a_is_rc && b_is_rc
+            a_rc = a_next.gsub('rc','').to_i
+            b_rc = b_next.gsub('rc','').to_i
+            if a_rc < b_rc
+              return true
+            elsif a_rc > b_rc
+              return false
+            else
+              a_next = a_rest.shift
+              b_next = b_rest.shift
+              if a_next && b_next
+                return a_next.to_i < b_next.to_i
+              else
+                # If a has nothing after -rc#, it is a tagged RC and 
+                # b must be a later build after this tag.
+                return a_next.nil?
+              end
+            end
+          else
+            # If one of them is not an rc (and also not a release), 
+            # that one is a post-release build. So if a is the RC, it is less.
+            return a_is_rc
+          end
+        else
+          return (b_is_release && a_is_rc) || (a_is_release && !b_is_rc)
         end
-        return false
       end
 
       # Gets the max semver version from a list of them

data/lib/beaker/version.rb

@@ -1,5 +1,5 @@
 module Beaker
   module Version
-    STRING = '4.18.0'
+    STRING = '4.19.0'
   end
 end

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

@@ -159,36 +159,96 @@ module Beaker
     end
 
     describe '#reboot' do
+      # no-op response
       let (:response) { double( 'response' ) }
+      let (:uptime_initial_response) { double( 'response' ) }
+      let (:uptime_initial_stdout) { '19:52  up 14 mins, 2 users, load averages: 2.95 4.19 4.31' }
+
+      let (:uptime_success_response) { double( 'response' ) }
+      let (:uptime_success_stdout) { '19:52  up 0 mins, 2 users, load averages: 2.95 4.19 4.31' }
+      let (:sleep_time) { 10 }
 
       before :each do
         # stubs enough to survive the first uptime call & output parsing
         #   note: just stubs input-chain between calls, parsing methods still run
-        allow( Beaker::Command ).to receive(:new).with("uptime").and_return(:uptime_command_stub)
-        allow( instance ).to receive( :exec ).with(:uptime_command_stub).and_return(response)
-        allow( response ).to receive(:stdout).and_return('19:52  up 14 mins, 2 users, load averages: 2.95 4.19 4.31')
+        allow(Beaker::Command).to receive(:new).with("uptime").and_return(:uptime_command_stub)
+
+        # mock initial uptime call
+        allow(instance).to receive( :exec ).with(:uptime_command_stub).and_return(uptime_initial_response).once
+        allow(uptime_initial_response).to receive(:stdout).and_return(uptime_initial_stdout)
+
+        allow(uptime_success_response).to receive(:stdout).and_return(uptime_success_stdout)
 
-        allow( Beaker::Command ).to receive(:new).with("/sbin/shutdown -r now").and_return(:shutdown_command_stub)
+        allow(instance).to receive(:sleep)
+
+        allow(Beaker::Command).to receive(:new).with("/sbin/shutdown -r now").and_return(:shutdown_command_stub)
       end
 
       it 'raises a reboot failure when command fails' do
-        expect(instance).to receive(:exec).with(:shutdown_command_stub, anything).and_raise(Host::CommandFailure)
-        expect{ instance.reboot }.to raise_error(Beaker::Host::RebootFailure, /Command failed in reboot: .*/)
+        expect(instance).not_to receive(:sleep)
+        expect(instance).to receive(:exec).with(:shutdown_command_stub, anything).and_raise(Host::CommandFailure).once
+        expect{ instance.reboot }.to raise_error(Beaker::Host::RebootFailure, /Command failed when attempting to reboot: .*/)
       end
 
       it 'raises a reboot failure when we receive an unexpected error' do
-        expect(instance).to receive(:exec).with(:shutdown_command_stub, anything).and_raise(Net::SSH::HostKeyError)
-        expect{ instance.reboot }.to raise_error(Beaker::Host::RebootFailure, /Unexpected exception in reboot: .*/)
+        expect(instance).not_to receive(:sleep)
+        expect(instance).to receive(:exec).with(:shutdown_command_stub, anything).and_raise(Net::SSH::HostKeyError).once
+        expect { instance.reboot }.to raise_error(Beaker::Host::RebootFailure, /Unexpected exception in reboot: .*/)
       end
 
       it 'raises RebootFailure if new uptime is never less than old uptime' do
+        expect(instance).to receive(:sleep).with(sleep_time)
         # bypass shutdown command itself
-        allow( instance ).to receive( :exec ).with(:shutdown_command_stub, anything).and_return(response)
-        # allow the second uptime and the hash arguments in exec
-        allow( instance ).to receive( :exec ).with(:uptime_command_stub, anything).and_return(response)
+        expect(instance).to receive( :exec ).with(:shutdown_command_stub, anything).and_return(response).once
+        # allow the second uptime and the hash arguments in exec, repeated 18 times by default in order to replicate the previous behavior of the ping based Host.down?
+        expect(instance).to receive( :exec ).with(:uptime_command_stub, anything).and_return(uptime_initial_response).exactly(18).times
 
         expect { instance.reboot }.to raise_error(Beaker::Host::RebootFailure, /Uptime did not reset/)
       end
+
+      it 'raises RebootFailure if new uptime is never less than old uptime when the number of retries is changed' do
+        expect(instance).to receive(:sleep).with(sleep_time)
+        # bypass shutdown command itself
+        expect(instance).to receive( :exec ).with(:shutdown_command_stub, anything).and_return(response).once
+        # allow the second uptime and the hash arguments in exec, repeated 10 times by default
+        expect(instance).to receive( :exec ).with(:uptime_command_stub, anything).and_return(uptime_initial_response).exactly(10).times
+
+        expect { instance.reboot(wait_time=sleep_time, max_connection_tries=9, uptime_retries=10) }.to raise_error(Beaker::Host::RebootFailure, /Uptime did not reset/)
+      end
+
+      it 'passes if new uptime is less than old uptime' do
+        expect(instance).to receive(:sleep).with(sleep_time)
+        # bypass shutdown command itself
+        expect(instance).to receive( :exec ).with(:shutdown_command_stub, anything).and_return(response).once
+        # allow the second uptime and the hash arguments in exec
+        expect(instance).to receive( :exec ).with(:uptime_command_stub, anything).and_return(uptime_success_response).once
+
+        expect(instance.reboot).to be(nil)
+      end
+
+      context 'with wait_time_parameter' do
+        it 'passes if new uptime is less than old uptime' do
+          expect(instance).to receive(:sleep).with(10)
+          # bypass shutdown command itself
+          expect(instance).to receive( :exec ).with(:shutdown_command_stub, anything).and_return(response).once
+          # allow the second uptime and the hash arguments in exec
+          expect(instance).to receive( :exec ).with(:uptime_command_stub, anything).and_return(uptime_success_response).once
+
+          expect(instance.reboot(10)).to be(nil)
+        end
+      end
+
+      context 'with max_connection_tries parameter' do
+        it 'passes if new uptime is less than old uptime' do
+          expect(instance).to receive(:sleep).with(sleep_time)
+          # bypass shutdown command itself
+          expect(instance).to receive( :exec ).with(:shutdown_command_stub, anything).and_return(response).once
+          # allow the second uptime and the hash arguments in exec
+          expect(instance).to receive( :exec ).with(:uptime_command_stub, hash_including(:max_connection_tries => 20)).and_return(uptime_success_response).once
+
+          expect(instance.reboot(sleep_time, 20)).to be(nil)
+        end
+      end
     end
 
     describe '#enable_remote_rsyslog' do

data/spec/beaker/platform_spec.rb

@@ -77,6 +77,11 @@ module Beaker
         expect( platform.with_version_codename ).to be === 'debian-squeeze-xxx'
       end
 
+      it "can convert unbuntu-2004-xxx to ubuntu-focal-xxx" do
+        @name = 'ubuntu-2004-xxx'
+        expect( platform.with_version_codename ).to be === 'ubuntu-focal-xxx'
+      end
+
       it "can convert unbuntu-1604-xxx to ubuntu-xenial-xxx" do
         @name = 'ubuntu-1604-xxx'
         expect( platform.with_version_codename ).to be === 'ubuntu-xenial-xxx'

data/spec/beaker/shared/semvar_spec.rb

@@ -10,8 +10,24 @@ module Beaker
           expect( subject.version_is_less( '2015.3.0-rc0-8-gf80879a', '2016' ) ).to be === true
         end
 
-        it 'reports 2015.3.0-rc0-8-gf80879a is not less than 2015.3.0' do
-          expect( subject.version_is_less( '2015.3.0-rc0-8-gf80879a', '2015.3.0' ) ).to be === false
+        it 'reports 2015.3.0-rc0-8-gf80879a is less than 2015.3.0' do
+          expect( subject.version_is_less( '2015.3.0-rc0-8-gf80879a', '2015.3.0' ) ).to be === true
+        end
+
+        it 'reports that 2015.3.0-rc0 is less than 2015.3.0-rc0-8-gf80879a' do
+          expect( subject.version_is_less( '2015.3.0-rc0', '2015.3.0-rc0-8-gf80879a' ) ).to be === true
+        end
+
+        it 'reports that 2015.3.0-rc2 is less than 2015.3.0-rc10 (not using string comparison)' do
+          expect( subject.version_is_less( '2015.3.0-rc2', '2015.3.0-rc10' ) ).to be === true
+        end
+
+        it 'reports that 2015.3.0 is less than 2015.3.0-1-gabc1234' do
+          expect( subject.version_is_less( '2015.3.0', '2015.3.0-1-gabc1234' ) ).to be === true
+        end
+
+        it 'reports that 2015.3.0-rc2 is less than 2015.3.0-1-gabc1234' do 
+          expect( subject.version_is_less( '2015.3.0-rc2', '2015.3.0-1-gabc1234' ) ).to be === true
         end
 
         it 'reports 2015.3.0-rc0-8-gf80879a is not less than 3.0.0' do
@@ -41,6 +57,10 @@ module Beaker
         it 'reports 2.8 is less than 2.9' do
           expect( subject.version_is_less( '2.8', '2.9' ) ).to be === true
         end
+
+        it 'reports that 2015.3.0 is not less than 2015.3.0' do
+          expect( subject.version_is_less( '2015.3.0', '2015.3.0' ) ).to be == false
+        end
       end
 
       describe 'max_version' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: beaker
 version: !ruby/object:Gem::Version
-  version: 4.18.0
+  version: 4.19.0
 platform: ruby
 authors:
 - Puppet
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-02-26 00:00:00.000000000 Z
+date: 2020-03-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -78,14 +78,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.0'
 - !ruby/object:Gem::Dependency
   name: beaker-aws
   requirement: !ruby/object:Gem::Requirement