beaker 4.23.2 → 4.27.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d7a6dab8f2bbd3711c1807aa31ef4947cfffb0c80cfe291dfc3261a677c9d618
-  data.tar.gz: 16dc6decc29e71095f4525b7aa3f301bda493a4cf124695bebeefa6cb695f3fa
+  metadata.gz: f1708680196db2be9b63b514162605faa19df47fb2b8f13bfd336af02b464118
+  data.tar.gz: 8ea244f5c438736aa003db09aa4d6f8bd7b96f3f99988c5bad0f6302a88f598c
 SHA512:
-  metadata.gz: 1ad64e24fd5672ff23b86fc601b7a50d0b1f7b048fde2c8f2af5eb45699ab22bbce0dac53ea1dc8ab4bd887279079a6689f74a1748e03206234f100f5ce08b88
-  data.tar.gz: 5d32208fd3bff7fe6cc06482ccbb7407318a54dafc3141765e32baf726913c9f7b9af4421e30217642fa993cbc1bdef239afe530b35cb3986017a5bef346f696
+  metadata.gz: f3811e71f7e592d024150b6470610df72dbc466cc8bdfeea50e9eb4cd57227892d6bd005e071a710516992a4dc94e5a2c0009970674a8bc0ffd998f494ada76f
+  data.tar.gz: cce923c69673ab3e5aea1a7022a2b94ee9e5205b700885cf389b5734f71b60d78c617d4b44214ea8a3fc93614ff1be3f4d580d61e8381afe03d01dcb462d8c15

data/.github/dependabot.yml

@@ -0,0 +1,8 @@
+version: 2
+updates:
+- package-ecosystem: bundler
+  directory: "/"
+  schedule:
+    interval: daily
+    time: "13:00"
+  open-pull-requests-limit: 10

data/.rspec

@@ -1,3 +1,4 @@
 --format documentation
 --color
 --tty
+--fail-fast

data/.travis.yml

@@ -1,5 +1,5 @@
 before_install:
-  - gem update --system 2.2.1
+  - gem update
   - gem --version
 language: ruby
 script: "bundle exec rake travis"
@@ -7,6 +7,4 @@ notifications:
   email: false
 rvm:
   - 2.6
-  - 2.0.0
-  - 1.9.3
-  - 1.8.7-p374
+  - 2.4

data/CHANGELOG.md

@@ -20,13 +20,67 @@ The headers used in [Keep a Changelog](http://keepachangelog.com) are:
 - Fixed - for any bug fixes.
 - Security - in case of vulnerabilities.
 
-# [Unreleased](https://github.com/puppetlabs/beaker/compare/4.23.2...master)
+# [Unreleased](https://github.com/puppetlabs/beaker/compare/4.27.0...master)
+
+# [4.27.1](https://github.com/puppetlabs/beaker/compare/4.27.0...4.27.1) - 09-29-2020
+
+### Changed
+
+- Update net-scp requirement from "~> 1.2" to ">= 1.2, < 4.0"
+
+### Fixed
+
+- Handle systems going back in time after reboot
+- Enhanced error handling during the reboot sequence
+- Fixed time check logic during reboot
+- Wrap paths around "" on pswindows
+
+# [4.27.0](https://github.com/puppetlabs/beaker/compare/4.26.0...4.27.0) - 07-24-2020
+
+### Changed
+
+- Updated dependency versions and minimum Ruby version in gemspec to Ruby 2.4, which is the minimum
+  version Beaker will run with.
+- Added Travis unit testing and disabled Jenkins integrations in preparation for transferring the
+  repo to Vox Pupuli
+
+
+# [4.26.0](https://github.com/puppetlabs/beaker/compare/4.25.0...4.26.0)
+
+### Changed
+
+- Fixed deprecated SSH option handling for `verify_ssh_key` being passed into Net::SSH. #1655
+
+### Removed
+
+- Removed deprecated use of `paranoid` flag with Net::SSH. #1655
+
+# [4.25.0](https://github.com/puppetlabs/beaker/compare/4.24.0...4.25.0)
+
+### Added
+
+- Execution of Beaker directly through ruby on localhost #1637 ([#1637](https://github.com/puppetlabs/beaker/pull/1637))
+
+### Fixed
+
+- Reliability improvements to the `Host#reboot` method ([#1656](https://github.com/puppetlabs/beaker/pull/1656)) ([#1659](https://github.com/puppetlabs/beaker/pull/1659))
+
+# [4.24.0](https://github.com/puppetlabs/beaker/compare/4.23.0...4.24.0) - 2020-06-05
+
+### Added
+
+- Host method which ([#1651](https://github.com/puppetlabs/beaker/pull/1651))
+
+### Fixed
+
+- Fixed implementation for cat and file_exists? host methods for PSWindows ([#1654](https://github.com/puppetlabs/beaker/pull/1654))
+- Fixed implementation for mkdir_p host method for PSWindows ([#1657](https://github.com/puppetlabs/beaker/pull/1657))
 
 # [4.23.2](https://github.com/puppetlabs/beaker/compare/4.23.1...4.23.2)
 
 ### Fixed
 
-- Fixed Beaker's behavior when the `strict_host_key_checking` option is 
+- Fixed Beaker's behavior when the `strict_host_key_checking` option is
   provided in the SSH config and Net-SSH > 5 is specified. (#1652)
 
 # [4.23.1](https://github.com/puppetlabs/beaker/compare/4.23.0...4.23.1)

data/CODEOWNERS

@@ -1,2 +0,0 @@
-* @puppetlabs/beaker
-* @puppetlabs/dio

data/Rakefile

@@ -26,10 +26,7 @@ task :history do
   Rake::Task['history:gen'].invoke
 end
 
-task :travis do
-  Rake::Task['yard'].invoke if !Beaker::Shared::Semvar.version_is_less(RUBY_VERSION, '2.0.0')
-  Rake::Task['spec'].invoke
-end
+task travis: [:yard, :test]
 
 module HarnessOptions
   defaults = {

data/beaker.gemspec

@@ -18,14 +18,14 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
 
-  s.required_ruby_version = Gem::Requirement.new('>= 2.1.8')
+  s.required_ruby_version = Gem::Requirement.new('>= 2.4')
 
   # Testing dependencies
   s.add_development_dependency 'rspec', '~> 3.0'
   s.add_development_dependency 'rspec-its'
-  s.add_development_dependency 'fakefs', '~> 0.6', '< 0.14.0'
+  s.add_development_dependency 'fakefs', '~> 1.2', '< 1.3.0'
   s.add_development_dependency 'simplecov'
-  s.add_development_dependency 'rake', '~> 12.0'
+  s.add_development_dependency 'rake', '~> 13.0'
 
   # Provisioner dependencies - needed for acceptance tests
   # TODO: figure out how to remove these
@@ -39,13 +39,13 @@ Gem::Specification.new do |s|
   # Run time dependencies
   s.add_runtime_dependency 'minitest', '~> 5.4'
   s.add_runtime_dependency 'minitar', '~> 0.6'
-  s.add_runtime_dependency 'pry-byebug', '~> 3.6'
+  s.add_runtime_dependency 'pry-byebug', '~> 3.9'
   # pry-byebug can have issues with native readline libs so add rb-readline
   s.add_runtime_dependency 'rb-readline', '~> 0.5.3'
 
   s.add_runtime_dependency 'hocon', '~> 1.0'
   s.add_runtime_dependency 'net-ssh', '>= 5.0'
-  s.add_runtime_dependency 'net-scp', '~> 1.2'
+  s.add_runtime_dependency 'net-scp', '>= 1.2', '< 4.0'
   s.add_runtime_dependency 'inifile', '~> 3.0'
 
   s.add_runtime_dependency 'rsync', '~> 1.0.9'

data/lib/beaker/host.rb

@@ -6,7 +6,7 @@ require 'rsync'
 require 'beaker/dsl/helpers'
 require 'beaker/dsl/patterns'
 
-[ 'command', 'ssh_connection'].each do |lib|
+[ 'command', 'ssh_connection', 'local_connection' ].each do |lib|
   require "beaker/#{lib}"
 end
 
@@ -19,6 +19,7 @@ module Beaker
 
     class CommandFailure < StandardError; end
     class RebootFailure < CommandFailure; end
+    class RebootWarning < StandardError; end
 
     # This class provides array syntax for using puppet --configprint on a host
     class PuppetConfigReader
@@ -294,6 +295,11 @@ module Beaker
 
     def connection
       # create new connection object if necessary
+      if self['hypervisor'] == 'none' && @name == 'localhost'
+        @connection ||= LocalConnection.connect( { :ssh_env_file => self['ssh_env_file'], :logger => @logger })
+        return @connection
+      end
+
       @connection ||= SshConnection.connect( { :ip => self['ip'], :vmhostname => self['vmhostname'], :hostname => @name },
                                              self['user'],
                                              self['ssh'], { :logger => @logger, :ssh_connection_preference => self[:ssh_connection_preference]} )

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

@@ -22,7 +22,7 @@ module PSWindows::Exec
   def rm_rf path
     # ensure that we have the right slashes for windows
     path = path.gsub(/\//, '\\')
-    execute("del /s /q #{path}")
+    execute(%(del /s /q "#{path}"))
   end
 
   # Move the origin to destination. The destination is removed prior to moving.
@@ -104,9 +104,9 @@ module PSWindows::Exec
   # @param [String] dir The directory structure to create on the host
   # @return [Boolean] True, if directory construction succeeded, otherwise False
   def mkdir_p dir
-    windows_dirstring = dir.gsub('/','\\')
-    cmd = "if not exist #{windows_dirstring} (md #{windows_dirstring})"
-    result = exec(Beaker::Command.new(cmd), :acceptable_exit_codes => [0, 1])
+    normalized_path = dir.gsub('/','\\')
+    result = exec(powershell("New-Item -Path '#{normalized_path}' -ItemType 'directory'"),
+                  :acceptable_exit_codes => [0, 1])
     result.exit_code == 0
   end
 
@@ -237,4 +237,19 @@ module PSWindows::Exec
     end
   end
 
+  #First path it finds for the command executable
+  #@param [String] command The command executable to search for
+  #
+  # @return [String] Path to the searched executable or empty string if not found
+  #
+  #@example
+  #  host.which('ruby')
+  def which(command)
+    where_command = "cmd /C \"where #{command}\""
+
+    result = execute(where_command, :accept_all_exit_codes => true)
+    return '' if result.empty?
+
+    result
+  end
 end

data/lib/beaker/host/pswindows/file.rb

@@ -21,11 +21,11 @@ module PSWindows::File
   end
 
   def cat(path)
-    exec(powershell("type #{path}"))
+    exec(powershell("type #{path}")).stdout
   end
 
   def file_exist?(path)
-    result = exec(Beaker::Command.new("if exist #{path} echo true"), :acceptable_exit_codes => [0, 1])
-    result.stdout =~ /true/
+    result = exec(Beaker::Command.new("if exist #{path} echo true"), accept_all_exit_codes: true)
+    result.stdout.strip == 'true'
   end
 end

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

@@ -14,91 +14,104 @@ module Unix::Exec
   def reboot(wait_time=10, max_connection_tries=9, uptime_retries=18)
     require 'time'
 
+    attempts = 0
+
+    # Some systems don't support 'last -F reboot' but it has second granularity
+    boot_time_cmd = 'last -F reboot || who -b'
+
+    # Try to match all of the common formats for 'last' and 'who'
+    current_year = Time.now.strftime("%Y")
+    boot_time_regex = Regexp.new(%{((?:#{(Date::ABBR_DAYNAMES + Date::ABBR_MONTHNAMES).compact.join('|')}|#{current_year}).+?(\\d+:\\d+)+?(?::(\\d+).+?#{current_year})?)})
+
+    original_boot_time_str = nil
+    original_boot_time_line = nil
     begin
-      original_boot_time_str = exec(Beaker::Command.new('who -b'), {:max_connection_tries => max_connection_tries, :silent => true}).stdout
+      attempts += 1
+      # Number of seconds to sleep before rebooting.
+      reboot_sleep = 1
+
+      original_boot_time_str = exec(Beaker::Command.new(boot_time_cmd), {:max_connection_tries => max_connection_tries, :silent => true}).stdout
       original_boot_time_line = original_boot_time_str.lines.grep(/boot/).first
 
-      raise Beaker::Host::RebootFailure, "Could not find system boot time using 'who -b': #{original_boot_time_str}" unless original_boot_time_line
+      raise Beaker::Host::RebootWarning, "Could not find system boot time using '#{boot_time_cmd}': '#{original_boot_time_str}'" unless original_boot_time_line
+
+      original_boot_time_matches = original_boot_time_line.scan(boot_time_regex).last
+
+      raise Beaker::Host::RebootWarning, "Found no valid times in '#{original_boot_time_line}'" unless original_boot_time_matches
+
+      original_boot_time = Time.parse(original_boot_time_matches.first)
+
+      unless original_boot_time_matches.last
+        reboot_sleep = (61 - Time.now.strftime("%S").to_i)
+      end
+
+      @logger.notify("Sleeping #{reboot_sleep} seconds before rebooting")
 
-      original_boot_time = Time.parse(original_boot_time_line)
+      sleep(reboot_sleep)
 
       exec(Beaker::Command.new('/bin/systemctl reboot -i || reboot || /sbin/shutdown -r now'), :expect_connection_failure => true)
-    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}"
     rescue ArgumentError => e
       raise Beaker::Host::RebootFailure, "Unable to parse time: #{e.message}"
+    rescue Beaker::Host::RebootWarning => e
+      raise if attempts > uptime_retries
+      @logger.warn(e.message)
+      @logger.warn("Retrying #{uptime_retries - attempts} more times.")
+      retry
+    rescue StandardError => e
+      raise if attempts > uptime_retries
+      @logger.warn("Unexpected Exception: #{e.message}")
+      @logger.warn("Retrying #{uptime_retries - attempts} more times.")
+      @logger.warn(e.backtrace[0,3].join("\n"))
+      @logger.debug(e.backtrace.join("\n"))
+      retry
     end
 
     attempts = 0
     begin
+      attempts += 1
+
       # give the host a little time to shutdown
       @logger.debug("Waiting #{wait_time} for host to shut down.")
       sleep wait_time
 
-      current_boot_time_str = exec(Beaker::Command.new('who -b'), {:max_connection_tries => max_connection_tries, :silent => true}).stdout
-      current_boot_time = Time.parse(current_boot_time_str.lines.grep(/boot/).first)
+      # Accept all exit codes because this may fail due to the parallel nature of systemd
+      current_boot_time_str = exec(Beaker::Command.new(boot_time_cmd), {:max_connection_tries => max_connection_tries, :silent => true, :accept_all_exit_codes => true}).stdout
+      current_boot_time_line = current_boot_time_str.lines.grep(/boot/).first
+
+      raise Beaker::Host::RebootWarning, "Could not find system boot time using '#{boot_time_cmd}': '#{current_boot_time_str}'" unless current_boot_time_line
+
+      current_boot_time_matches = current_boot_time_line.scan(boot_time_regex).last
+
+      raise Beaker::Host::RebootWarning, "Found no valid times in '#{current_boot_time_line}'" unless current_boot_time_matches
+
+      current_boot_time = Time.parse(current_boot_time_matches.first)
 
       @logger.debug("Original Boot Time: #{original_boot_time}")
       @logger.debug("Current Boot Time: #{current_boot_time}")
 
-      unless current_boot_time > original_boot_time
+      # If this is *exactly* the same then there is really no good way to detect a reboot
+      if current_boot_time == original_boot_time
         raise Beaker::Host::RebootFailure, "Boot time did not reset. Reboot appears to have failed."
       end
-    rescue Beaker::Host::RebootFailure => e
-      attempts += 1
-      if attempts < uptime_retries
-        @logger.debug("Boot time 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 when attempting to reboot: #{e.message}"
-    rescue RuntimeError => e
-      raise Beaker::Host::RebootFailure, "Unexpected exception in reboot: #{e.message}"
     rescue ArgumentError => e
       raise Beaker::Host::RebootFailure, "Unable to parse time: #{e.message}"
+    rescue Beaker::Host::RebootFailure => e
+      raise
+    rescue Beaker::Host::RebootWarning => e
+      raise if attempts > uptime_retries
+      @logger.warn(e.message)
+      @logger.warn("Retrying #{uptime_retries - attempts} more times.")
+      retry
+    rescue StandardError => e
+      raise if attempts > uptime_retries
+      @logger.warn("Unexpected Exception: #{e.message}")
+      @logger.warn("Retrying #{uptime_retries - attempts} more times.")
+      @logger.warn(e.backtrace[0,3].join("\n"))
+      @logger.debug(e.backtrace.join("\n"))
+      retry
     end
   end
 
-  def uptime_int(uptime_str)
-    time_array = uptime_str.split(", ")
-    accumulated_mins = 0
-    time_array.each do |time_segment|
-      value, unit = time_segment.split
-      if unit.nil?
-        # 20:47 case: hours & mins
-        hours, mins = value.split(":")
-        accumulated_mins += (hours.to_i * 60 + mins.to_i)
-      elsif unit =~ /day(s)?/
-        accumulated_mins += (value.to_i * 1440) # 60 * 24 = 1440
-      elsif unit =~ /min(s)?/
-        accumulated_mins += value.to_i
-      else
-        raise ArgumentError, "can't parse uptime segment: #{time_segment}"
-      end
-    end
-
-    accumulated_mins
-  end
-
-  def parse_uptime(uptime)
-    # get String from up to users
-    # eg 19:52  up 14 mins, 2 users, load averages: 2.95 4.19 4.31
-    # 8:03 up 52 days, 20:47, 3 users, load averages: 1.36 1.42 1.40
-    # 22:19 up 54 days, 1 min, 4 users, load averages: 2.08 2.06 2.27
-    regexp = /.*up (.*)[[:space:]]+[[:digit:]]+ user.*/
-    result = uptime.match regexp
-    if self['platform'] =~ /solaris-/ && result[1].empty?
-      return "0 min"
-    end
-    raise "Couldn't parse uptime: #{uptime}" if result.nil?
-
-    result[1].strip.chomp(",")
-  end
-
   def echo(msg, abs=true)
     (abs ? '/bin/echo' : 'echo') + " #{msg}"
   end
@@ -435,4 +448,19 @@ module Unix::Exec
     true
   end
 
+  #First path it finds for the command executable
+  #@param [String] command The command executable to search for
+  #
+  # @return [String] Path to the searched executable or empty string if not found
+  #
+  #@example
+  #  host.which('ruby')
+  def which(command)
+    which_command = "which #{command}"
+
+    result = execute(which_command, :accept_all_exit_codes => true)
+    return '' if result.empty?
+
+    result
+  end
 end

data/lib/beaker/local_connection.rb

@@ -0,0 +1,86 @@
+require 'open3'
+
+module Beaker
+  class LocalConnection
+
+    attr_accessor :logger, :hostname, :ip
+
+    def initialize options = {}
+      @logger = options[:logger]
+      @ssh_env_file = File.expand_path(options[:ssh_env_file])
+      @hostname = 'localhost'
+      @ip = '127.0.0.1'
+      @options = options
+    end
+
+    def self.connect options = {}
+      connection = new options
+      connection.connect
+      connection
+    end
+
+    def connect options = {}
+      @logger.debug "Local connection, no connection to start"
+    end
+
+    def close
+      @logger.debug "Local connection, no connection to close"
+    end
+
+    def with_env(env)
+      backup = ENV.to_hash
+      ENV.replace(env)
+      yield
+    ensure
+      ENV.replace(backup)
+    end
+
+    def execute command, options = {}, stdout_callback = nil, stderr_callback = stdout_callback
+      result = Result.new(@hostname, command)
+      envs = {}
+      if File.readable?(@ssh_env_file)
+        File.foreach(@ssh_env_file) do |line|
+          key, value = line.split('=')
+          envs[key] = value
+        end
+      end
+
+      begin
+        clean_env = ENV.reject{ |k| k =~ /^BUNDLE|^RUBY|^GEM/ }
+
+        with_env(clean_env) do
+          std_out, std_err, status = Open3.capture3(envs, command)
+          result.stdout << std_out
+          result.stderr << std_err
+          result.exit_code = status.exitstatus
+        end
+      rescue => e
+        result.stderr << e.inspect
+        result.exit_code = 1
+      end
+
+      result.finalize!
+      @logger.last_result = result
+      result
+    end
+
+    def scp_to(source, target, _options = {})
+
+      result = Result.new(@hostname, [source, target])
+      begin
+        FileUtils.cp_r source, target
+      rescue Errno::ENOENT => e
+        @logger.warn "#{e.class} error in cp'ing. Forcing the connection to close, which should " \
+                        "raise an error."
+      end
+
+      result.stdout << "  CP'ed file #{source} to #{target}"
+      result.exit_code = 0
+      result
+    end
+
+    def scp_from(source, target, options = {})
+      scp_to(target, source, options)
+    end
+  end
+end