beaker 4.26.0 → 4.29.0

data/CODEOWNERS

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

data/LICENSE

@@ -1,8 +1,194 @@
-   beaker - Puppet's system level acceptance test harness
-
    Copyright (C) 2011-2015 Puppet Labs Inc
 
-   Puppet Labs can be contacted at: info@puppetlabs.com
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.

data/Rakefile

@@ -26,11 +26,6 @@ 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
-
 module HarnessOptions
   defaults = {
       :tests  => ['tests'],

data/beaker.gemspec

@@ -7,25 +7,25 @@ Gem::Specification.new do |s|
   s.name        = "beaker"
   s.version     = Beaker::Version::STRING
   s.authors     = ["Puppet"]
-  s.email       = ["delivery@puppet.com"]
-  s.homepage    = "https://github.com/puppetlabs/beaker"
+  s.email       = ["voxpupuli@groups.io"]
+  s.homepage    = "https://github.com/voxpupuli/beaker"
   s.summary     = %q{Let's test Puppet!}
   s.description = %q{Puppet's accceptance testing harness}
-  s.license     = 'Apache2'
+  s.license     = 'Apache-2.0'
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   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.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,14 @@ 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 'rexml'
 
   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/docs/how_to/ssh_connection_preference.md

@@ -30,7 +30,10 @@ HOSTS:
     hypervisor: vmpooler
     platform: ubuntu-16.04-amd64
     template: ubuntu-1604-x86_64
-    ssh_preference: [:vmhostname, :hostname, :ip]
+    ssh_preference:
+    - :vmhostname
+    - :hostname
+    - :ip
     roles:
     - agent
     - default

data/lib/beaker/dsl/helpers/web_helpers.rb

@@ -107,12 +107,11 @@ module Beaker
           logger.notify "  and saving to #{dst}"
           logger.notify "  using command: #{wget_command}"
 
-          #in ruby 1.9+ we can upgrade this to popen3 to gain access to the subprocess pid
-          result = `#{wget_command} 2>&1`
-          result.each_line do |line|
+          stdout_and_stderr_str, status = Open3.capture2e(wget_command)
+          stdout_and_stderr_str.each_line do |line|
             logger.debug(line)
           end
-          if $?.to_i != 0
+          unless status.success?
             raise "Failed to fetch_remote_dir '#{url}' (exit code #{$?})"
           end
           dst

data/lib/beaker/host.rb

@@ -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

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.

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

@@ -16,66 +16,99 @@ module Unix::Exec
 
     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 = Time.parse(original_boot_time_line)
+      original_boot_time_matches = original_boot_time_line.scan(boot_time_regex).last
 
-      exec(Beaker::Command.new('/bin/systemctl reboot -i || reboot || /sbin/shutdown -r now'), :expect_connection_failure => true)
-    rescue Beaker::Host::RebootFailure => e
-      attempts += 1
-      if attempts < uptime_retries
-        @logger.debug("Could not get initial boot time. Will retry #{uptime_retries - attempts} more times.")
-        retry
-      else
-        raise
+      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
-    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}"
+
+      @logger.notify("Sleeping #{reboot_sleep} seconds before rebooting")
+
+      sleep(reboot_sleep)
+
+      exec(Beaker::Command.new('/bin/systemctl reboot -i || reboot || /sbin/shutdown -r now'), :expect_connection_failure => true)
     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
+      # 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::RebootFailure, "Could not find system boot time using 'who -b': '#{current_boot_time_str}'" unless current_boot_time_line
+      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
 
-      current_boot_time = Time.parse(current_boot_time_line)
+      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
 
@@ -423,9 +456,19 @@ module Unix::Exec
   #@example
   #  host.which('ruby')
   def which(command)
-    which_command = "which #{command}"
+    unless @which_command
+      if execute('type -P true', :accept_all_exit_codes => true).empty?
+        if execute('which true', :accept_all_exit_codes => true).empty?
+          raise ArgumentError, "Could not find suitable 'which' command"
+        else
+          @which_command = 'which'
+        end
+      else
+        @which_command = 'type -P'
+      end
+    end
 
-    result = execute(which_command, :accept_all_exit_codes => true)
+    result = execute("#{@which_command} #{command}", :accept_all_exit_codes => true)
     return '' if result.empty?
 
     result