beaker 4.38.1 → 5.0.0

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

@@ -4,7 +4,6 @@ module Beaker
       # Methods that help you interact and manage the state of your Beaker SUTs, these
       # methods do not require puppet to be installed to execute correctly
       module HostHelpers
-
         # @!macro [new] common_opts
         #   @param [Hash{Symbol=>String}] opts Options to alter execution.
         #   @option opts [Boolean] :silent (false) Do not produce log output
@@ -60,13 +59,11 @@ module Beaker
         # @return [Result]   An object representing the outcome of *command*.
         # @raise  [FailTest] Raises an exception if *command* obviously fails.
         def on(host, command, opts = {}, &block)
-          block_on host, opts do | host |
+          block_on host, opts do |host|
             if command.is_a? String
               cmd_opts = {}
-              #add any additional environment variables to the command
-              if opts[:environment]
-                cmd_opts['ENV'] = opts[:environment]
-              end
+              # add any additional environment variables to the command
+              cmd_opts['ENV'] = opts[:environment] if opts[:environment]
               command_object = Command.new(command.to_s, [], cmd_opts)
             elsif command.is_a? Command
               if opts[:environment]
@@ -80,20 +77,20 @@ module Beaker
               msg << " object as the command parameter, not #{command.class}."
               raise ArgumentError, msg
             end
-            @result = host.exec(command_object, opts)
+            result = host.exec(command_object, opts)
 
             # Also, let additional checking be performed by the caller.
-            if block_given?
+            if block
               case block.arity
-                #block with arity of 0, just hand back yourself
-                when 0
-                  yield self
-                #block with arity of 1 or greater, hand back the result object
-                else
-                  yield @result
+                # block with arity of 0, just hand back yourself
+              when 0
+                yield self
+                # block with arity of 1 or greater, hand back the result object
+              else
+                yield result
               end
             end
-            @result
+            result
           end
         end
 
@@ -125,36 +122,6 @@ module Beaker
           on(default, command, opts, &block)
         end
 
-        # @deprecated
-        # An proxy for the last {Beaker::Result#stdout} returned by
-        # a method that makes remote calls.  Use the {Beaker::Result}
-        # object returned by the method directly instead. For Usage see
-        # {Beaker::Result}.
-        def stdout
-          return nil if @result.nil?
-          @result.stdout
-        end
-
-        # @deprecated
-        # An proxy for the last {Beaker::Result#stderr} returned by
-        # a method that makes remote calls.  Use the {Beaker::Result}
-        # object returned by the method directly instead. For Usage see
-        # {Beaker::Result}.
-        def stderr
-          return nil if @result.nil?
-          @result.stderr
-        end
-
-        # @deprecated
-        # An proxy for the last {Beaker::Result#exit_code} returned by
-        # a method that makes remote calls.  Use the {Beaker::Result}
-        # object returned by the method directly instead. For Usage see
-        # {Beaker::Result}.
-        def exit_code
-          return nil if @result.nil?
-          @result.exit_code
-        end
-
         # Move a file from a remote to a local path
         # @note If using {Beaker::Host} for the hosts *scp* is not
         #   required on the system as it uses Ruby's net/scp library.  The
@@ -169,10 +136,10 @@ module Beaker
         #
         # @return [Result] Returns the result of the SCP operation
         def scp_from host, from_path, to_path, opts = {}
-          block_on host do | host |
-            @result = host.do_scp_from(from_path, to_path, opts)
-            @result.log logger
-            @result
+          block_on host do |host|
+            result = host.do_scp_from(from_path, to_path, opts)
+            result.log logger
+            result
           end
         end
 
@@ -192,14 +159,14 @@ module Beaker
         #
         # @return [Result] Returns the result of the SCP operation
         def scp_to host, from_path, to_path, opts = {}
-          block_on host do | host |
-            if host['platform'] =~ /windows/ && to_path.match('`cygpath')
+          block_on host do |host|
+            if host['platform'].include?('windows') && to_path.match('`cygpath')
               result = on host, "echo #{to_path}"
               to_path = result.raw_output.chomp
             end
-            @result = host.do_scp_to(from_path, to_path, opts)
-            @result.log logger
-            @result
+            result = host.do_scp_to(from_path, to_path, opts)
+            result.log logger
+            result
           end
         end
 
@@ -214,13 +181,12 @@ module Beaker
         #
         # @return [Result] Returns the result of the rsync operation
         def rsync_to host, from_path, to_path, opts = {}
-          block_on host do | host |
-            if host['platform'] =~ /windows/ && to_path.match('`cygpath')
+          block_on host do |host|
+            if host['platform'].include?('windows') && to_path.match('`cygpath')
               result = host.echo "#{to_path}"
               to_path = result.raw_output.chomp
             end
-            @result = host.do_rsync_to(from_path, to_path, opts)
-            @result
+            host.do_rsync_to(from_path, to_path, opts)
           end
         end
 
@@ -268,9 +234,8 @@ module Beaker
           FileUtils.mkdir_p(targetdir)
           scp_from(host, from_path, targetdir, opts)
           # scp_from does succeed on a non-existant file, checking if the file/folder actually exists
-          if not File.exists?(filename)
-            raise IOError, "No such file or directory - #{filename}"
-          end
+          raise IOError, "No such file or directory - #{filename}" if not File.exist?(filename)
+
           create_tarball(archive_root, archive_name)
         end
 
@@ -281,28 +246,6 @@ module Beaker
         end
         private :create_tarball
 
-
-        # Deploy packaging configurations generated by
-        # https://github.com/puppetlabs/packaging to a host.
-        #
-        # @note To ensure the repo configs are available for deployment,
-        #       you should run `rake pl:jenkins:deb_repo_configs` and
-        #       `rake pl:jenkins:rpm_repo_configs` on your project checkout
-        #
-        # @param [Host] host
-        # @param [String] path     The path to the generated repository config
-        #                          files. ex: /myproject/pkg/repo_configs
-        # @param [String] name     A human-readable name for the repository
-        # @param [String] version  The version of the project, as used by the
-        #                          packaging tools. This can be determined with
-        #                          `rake pl:print_build_params` from the packaging
-        #                          repo.
-        # @deprecated no longer used in beaker, beaker-puppet, or beaker-pe
-        # @visibility private
-        def deploy_package_repo host, path, name, version
-          host.deploy_package_repo path, name, version
-        end
-
         # Create a remote file out of a string
         # @note This method uses Tempfile in Ruby's STDLIB as well as {#scp_to}.
         #
@@ -318,17 +261,17 @@ module Beaker
         # @return [Result] Returns the result of the underlying SCP operation.
         def create_remote_file(hosts, file_path, file_content, opts = {})
           Tempfile.open 'beaker' do |tempfile|
-            File.open(tempfile.path, 'w') {|file| file.puts file_content }
+            File.open(tempfile.path, 'w') { |file| file.puts file_content }
 
             opts[:protocol] ||= 'scp'
             case opts[:protocol]
-              when 'scp'
-                scp_to hosts, tempfile.path, file_path, opts
-              when 'rsync'
-                rsync_to hosts, tempfile.path, file_path, opts
-              else
-                logger.debug "Unsupported transfer protocol, returning nil"
-                nil
+            when 'scp'
+              scp_to hosts, tempfile.path, file_path, opts
+            when 'rsync'
+              rsync_to hosts, tempfile.path, file_path, opts
+            else
+              logger.debug "Unsupported transfer protocol, returning nil"
+              nil
             end
           end
         end
@@ -348,10 +291,9 @@ module Beaker
           block_on hosts, opts do |host|
             script_path = "beaker_powershell_script_#{Time.now.to_i}.ps1"
             create_remote_file(host, script_path, powershell_script, opts)
-            native_path = script_path.gsub(/\//, "\\")
-            on host, powershell("", {"File" => native_path }), opts
+            native_path = script_path.tr('/', "\\")
+            on host, powershell("", { "File" => native_path }), opts
           end
-
         end
 
         # Move a local script to a remote host and execute it
@@ -430,13 +372,11 @@ module Beaker
         #
         # @return nil
         def add_system32_hosts_entry(host, opts = {})
-          if host.is_powershell?
-            hosts_file = 'C:\Windows\System32\Drivers\etc\hosts'
-            host_entry = "#{opts['ip']}`t`t#{opts['name']}"
-            on host, powershell("\$text = \\\"#{host_entry}\\\"; Add-Content -path '#{hosts_file}' -value \$text")
-          else
-            raise "nothing to do for #{host.name} on #{host['platform']}"
-          end
+          raise "nothing to do for #{host.name} on #{host['platform']}" unless host.is_powershell?
+
+          hosts_file = 'C:\Windows\System32\Drivers\etc\hosts'
+          host_entry = "#{opts['ip']}`t`t#{opts['name']}"
+          on host, powershell("\$text = \\\"#{host_entry}\\\"; Add-Content -path '#{hosts_file}' -value \$text")
         end
 
         # Back up the given file in the current_dir to the new_dir
@@ -449,12 +389,11 @@ module Beaker
         # @return [String, nil] The path to the file if the file exists, nil if it
         #   doesn't exist.
         def backup_the_file host, current_dir, new_dir, filename = 'puppet.conf'
-
           old_location = current_dir + '/' + filename
           new_location = new_dir + '/' + filename + '.bak'
 
           if host.file_exist? old_location
-            host.exec( Command.new( "cp #{old_location} #{new_location}" ) )
+            host.exec(Command.new("cp #{old_location} #{new_location}"))
             return new_location
           else
             logger.warn "Could not backup file '#{old_location}': no such file"
@@ -471,7 +410,7 @@ module Beaker
         def win_ads_path(file_path)
           ads_path = {
             path: file_path,
-            ads: nil
+            ads: nil,
           }
 
           split_path = file_path.split(':')
@@ -491,7 +430,7 @@ module Beaker
         #
         # @return [Boolean] Whether the file exists on the host (using `test -f`)
         def file_exists_on(host, file_path)
-          if host['platform'] =~ /windows/
+          if host[:platform].include?('windows')
             command = %(Test-Path #{file_path})
 
             if file_path.include?(':')
@@ -506,7 +445,7 @@ module Beaker
             command = %(test -f "#{file_path}")
           end
 
-          return on(host, command, { :accept_all_exit_codes => true}).exit_code.zero?
+          return on(host, command, { :accept_all_exit_codes => true }).exit_code.zero?
         end
 
         # Check whether a directory exists on the host
@@ -516,7 +455,7 @@ module Beaker
         #
         # @return [Boolean] Whether the directory exists on the host (using `test -d`)
         def directory_exists_on(host, dir_path)
-          if host['platform'] =~ /windows/
+          if host[:platform].include?('windows')
             dir_path = "#{dir_path}\\" unless (dir_path[-1].chr == '\\')
 
             command = Command.new(%{IF exist "#{dir_path}" ( exit 0 ) ELSE ( exit 1 )}, [], { :cmdexe => true })
@@ -535,7 +474,7 @@ module Beaker
         # @return [Boolean] Whether the symlink exists on the host (using `test -L`)
         def link_exists_on(host, link_path)
           # Links are weird on windows, fall back to seeing if the file exists
-          return file_exists_on(host, link_path) if host['platform'] =~ /windows/
+          return file_exists_on(host, link_path) if host[:platform].include?('windows')
 
           return on(host, Command.new(%(test -L "#{link_path}"), accept_all_exit_codes: true)).exit_code.zero?
         end
@@ -551,8 +490,8 @@ module Beaker
 
           split_path = win_ads_path(file_path)
           if file_exists_on(host, split_path[:path])
-            if host['platform'] =~ /windows/
-              file_path.gsub!('/', '\\')
+            if host[:platform].include?('windows')
+              file_path.tr!('/', '\\')
 
               command = %{Get-Content -Raw -Path #{file_path}}
               command += %{ -Stream #{split_path[:ads]}} if split_path[:ads]
@@ -580,11 +519,11 @@ module Beaker
           on host, "curl --tlsv1 %s" % cmd, opts, &block
         end
 
-        def curl_with_retries(desc, host, url, desired_exit_codes, max_retries = 60, retry_interval = 1)
+        def curl_with_retries(_desc, host, url, desired_exit_codes, max_retries = 60, retry_interval = 1)
           opts = {
             :desired_exit_codes => desired_exit_codes,
             :max_retries => max_retries,
-            :retry_interval => retry_interval
+            :retry_interval => retry_interval,
           }
           retry_on(host, "curl -m 1 #{url}", opts)
         end
@@ -614,22 +553,22 @@ module Beaker
           option_retry_interval = opts[:retry_interval].to_f
           desired_exit_codes    = option_exit_codes ? [option_exit_codes].flatten : [0]
           desired_exit_codes    = [0] if desired_exit_codes.empty?
-          max_retries           = option_max_retries == 0 ? 60 : option_max_retries  # nil & "" both return 0
+          max_retries           = option_max_retries == 0 ? 60 : option_max_retries # nil & "" both return 0
           retry_interval        = option_retry_interval == 0 ? 1 : option_retry_interval
           verbose               = true.to_s == opts[:verbose]
 
           log_prefix = host.log_prefix
           logger.debug "\n#{log_prefix} #{Time.new.strftime('%H:%M:%S')}$ #{command}"
           logger.debug "  Trying command #{max_retries} times."
-          logger.debug ".", add_newline=false
+          logger.debug ".", add_newline = false
 
-          result = on host, command, {:accept_all_exit_codes => true, :silent => !verbose}, &block
+          result = on host, command, { :accept_all_exit_codes => true, :silent => !verbose }, &block
           num_retries = 0
           until desired_exit_codes.include?(result.exit_code)
             sleep retry_interval
-            result = on host, command, {:accept_all_exit_codes => true, :silent => !verbose}, &block
+            result = on host, command, { :accept_all_exit_codes => true, :silent => !verbose }, &block
             num_retries += 1
-            logger.debug ".", add_newline=false
+            logger.debug ".", add_newline = false
             if (num_retries > max_retries)
               logger.debug "  Command \`#{command}\` failed."
               fail("Command \`#{command}\` failed.")
@@ -641,34 +580,34 @@ module Beaker
 
         # FIX: this should be moved into host/platform
         # @visibility private
-        def run_cron_on(host, action, user, entry="", &block)
-          block_on host do | host |
+        def run_cron_on(host, action, user, entry = "", &block)
+          block_on host do |host|
             platform = host['platform']
             if platform.include?('solaris') || platform.include?('aix') then
               case action
-                when :list   then args = '-l'
-                when :remove then args = '-r'
-                when :add
-                  on( host,
-                     "echo '#{entry}' > /var/spool/cron/crontabs/#{user}",
-                      &block )
+              when :list   then args = '-l'
+              when :remove then args = '-r'
+              when :add
+                on(host,
+                   "echo '#{entry}' > /var/spool/cron/crontabs/#{user}",
+                   &block)
               end
 
             else # default for GNU/Linux platforms
               case action
-                when :list   then args = '-l -u'
-                when :remove then args = '-r -u'
-                when :add
-                   on( host,
-                      "echo '#{entry}' > /tmp/#{user}.cron && " +
-                      "crontab -u #{user} /tmp/#{user}.cron",
-                       &block )
+              when :list   then args = '-l -u'
+              when :remove then args = '-r -u'
+              when :add
+                on(host,
+                   "echo '#{entry}' > /tmp/#{user}.cron && " +
+                   "crontab -u #{user} /tmp/#{user}.cron",
+                   &block)
               end
             end
 
             if args
               case action
-                when :list, :remove then on(host, "crontab #{args} #{user}", &block)
+              when :list, :remove then on(host, "crontab #{args} #{user}", &block)
               end
             end
           end

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

@@ -4,12 +4,11 @@ module Beaker
       # Methods that help you query the state of your tests, these
       # methods do not require puppet to be installed to execute correctly
       module TestHelpers
-
         # Gets the currently executing test's name, which is set in a test
         # using the {Beaker::DSL::Structure#test_name} method.
         #
         # @return [String] Test name, or nil if it hasn't been set
-        def current_test_name()
+        def current_test_name
           metadata[:case] && metadata[:case][:name] ? metadata[:case][:name] : nil
         end
 
@@ -21,7 +20,7 @@ module Beaker
         #   canal
         #
         # @return [String] Test filename, or nil if it hasn't been set
-        def current_test_filename()
+        def current_test_filename
           metadata[:case] && metadata[:case][:file_name] ? metadata[:case][:file_name] : nil
         end
 
@@ -29,7 +28,7 @@ module Beaker
         # This is set using the {Beaker::DSL::Structure#step} method.
         #
         # @return [String] Step name, or nil if it hasn't been set
-        def current_step_name()
+        def current_step_name
           metadata[:step] && metadata[:step][:name] ? metadata[:step][:name] : nil
         end
 
@@ -65,7 +64,6 @@ module Beaker
           metadata[:step] ||= {}
           metadata[:step][:name] = name
         end
-
       end
     end
   end

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

@@ -3,22 +3,21 @@ module Beaker
     module Helpers
       # Convenience methods for checking links and moving web content to hosts
       module WebHelpers
-
         # Blocks until the port is open on the host specified, returns false
         # on failure
-        def port_open_within?( host, port = 8140, seconds = 120 )
-          repeat_for( seconds ) do
-            host.port_open?( port )
+        def port_open_within?(host, port = 8140, seconds = 120)
+          repeat_for(seconds) do
+            host.port_open?(port)
           end
         end
 
-        #Determine is a given URL is accessible
-        #@param [String] link The URL to examine
-        #@param [Integer] limit redirect limit, will follow redirects that many times
-        #@return [Boolean] true if the ultimate URL after following redirects (301&302) has a '200' HTTP response code, false otherwise
-        #@example
+        # Determine is a given URL is accessible
+        # @param [String] link The URL to examine
+        # @param [Integer] limit redirect limit, will follow redirects that many times
+        # @return [Boolean] true if the ultimate URL after following redirects (301&302) has a '200' HTTP response code, false otherwise
+        # @example
         #  extension = link_exists?("#{URL}.tar.gz") ? ".tar.gz" : ".tar"
-        def link_exists?(link, limit=10)
+        def link_exists?(link, limit = 10)
           begin
             require "net/http"
             require "net/https"
@@ -28,7 +27,7 @@ module Beaker
             http.use_ssl = (url.scheme == 'https')
             http.verify_mode = (OpenSSL::SSL::VERIFY_NONE)
             response = http.start { |http| http.head(url.request_uri) }
-            if (['301', '302'].include? response.code) && limit > 0
+            if (%w[301 302].include? response.code) && limit > 0
               logger.debug("#{__method__} following #{response.code} to #{response['location']}")
               link_exists?(response['location'], limit - 1)
             else
@@ -52,28 +51,25 @@ module Beaker
         # @!visibility private
         def fetch_http_file(base_url, file_name, dst_dir)
           require 'open-uri'
-          require 'open_uri_redirections'
           FileUtils.makedirs(dst_dir)
           base_url.chomp!('/')
           src = "#{base_url}/#{file_name}"
           dst = File.join(dst_dir, file_name)
-          if options[:cache_files_locally] && File.exists?(dst)
+          if options[:cache_files_locally] && File.exist?(dst)
             logger.notify "Already fetched #{dst}"
           else
             logger.notify "Fetching: #{src}"
             logger.notify "  and saving to #{dst}"
             begin
-              open(src, :allow_redirections => :all) do |remote|
+              URI.open(src) do |remote|
                 File.open(dst, "w") do |file|
                   FileUtils.copy_stream(remote, file)
                 end
               end
             rescue OpenURI::HTTPError => e
-              if e.message =~ /404.*/
-                raise "Failed to fetch_remote_file '#{src}' (#{e.message})"
-              else
-                raise e
-              end
+              raise "Failed to fetch_remote_file '#{src}' (#{e.message})" if /404.*/.match?(e.message)
+
+              raise e
             end
           end
           return dst
@@ -92,14 +88,12 @@ module Beaker
         # @!visibility private
         def fetch_http_dir(url, dst_dir)
           logger.notify "fetch_http_dir (url: #{url}, dst_dir #{dst_dir})"
-          if url[-1, 1] !~ /\//
-            url += '/'
-          end
+          url += '/' if !url.end_with?('/')
           url = URI.parse(url)
           chunks = url.path.split('/')
           dst = File.join(dst_dir, chunks.last)
-          #determine directory structure to cut
-          #only want to keep the last directory, thus cut total number of dirs - 2 (hostname + last dir name)
+          # determine directory structure to cut
+          # only want to keep the last directory, thus cut total number of dirs - 2 (hostname + last dir name)
           cut = chunks.length - 2
           wget_command = "wget -nv -P #{dst_dir} --reject \"index.html*\",\"*.gif\" --cut-dirs=#{cut} -np -nH --no-check-certificate -r #{url}"
 
@@ -111,12 +105,10 @@ module Beaker
           stdout_and_stderr_str.each_line do |line|
             logger.debug(line)
           end
-          unless status.success?
-            raise "Failed to fetch_remote_dir '#{url}' (exit code #{$?})"
-          end
+          raise "Failed to fetch_remote_dir '#{url}' (exit code #{$?})" unless status.success?
+
           dst
         end
-
       end
     end
   end

data/lib/beaker/dsl/helpers.rb

@@ -1,11 +1,9 @@
-# -*- coding: utf-8 -*-
-[ 'host', 'test', 'web', 'hocon' ].each do |lib|
-      require "beaker/dsl/helpers/#{lib}_helpers"
+%w[host test web hocon].each do |lib|
+  require "beaker/dsl/helpers/#{lib}_helpers"
 end
 
 module Beaker
   module DSL
-
     # Contains methods to help you manage and configure your SUTs.
 
     # Extensions, available in separate modules, enable you to configure and interact with puppet, facter

data/lib/beaker/dsl/outcomes.rb

@@ -15,33 +15,31 @@ module Beaker
     # designed to allow some degree of freedom from the individual third
     # party test runners that could be used.
     module Outcomes
-
       # Raise this class if it is determined that a test case should not
       # be executed because the feature in question is still a
       # "Work in Progress"
-      class PendingTest < Exception; end
+      class PendingTest < RuntimeError; end
 
       # Raise this class if execution should be stopped because the test
       # is not applicable within a given environment.
-      class SkipTest    < Exception; end
+      class SkipTest    < RuntimeError; end
 
       # Raise this class if some criteria has been met that proves a failure.
-      class FailTest    < Exception; end
+      class FailTest    < RuntimeError; end
 
       # Raise this class if execution should stop because enough criteria has
       # shown itself to pass the test.
-      class PassTest    < Exception; end
-
+      class PassTest    < RuntimeError; end
 
       # Raises FailTest Exception and logs an error message
       #
       # @param [String] msg An optional message to log
       # @raise [FailTest]
       def fail_test msg = nil
-        message = formatted_message( msg, 'Failed' )
-        logger.warn( [message, logger.pretty_backtrace].join("\n") )
+        message = formatted_message(msg, 'Failed')
+        logger.warn([message, logger.pretty_backtrace].join("\n"))
 
-        raise( FailTest, message )
+        raise(FailTest, message)
       end
 
       # Raises PassTest Exception and logs a message
@@ -49,10 +47,10 @@ module Beaker
       # @param [String] msg An optional message to log
       # @raise [PassTest]
       def pass_test msg = nil
-        message = formatted_message( msg, 'Passed' )
-        logger.notify( message )
+        message = formatted_message(msg, 'Passed')
+        logger.notify(message)
 
-        raise( PassTest, message )
+        raise(PassTest, message)
       end
 
       # Raises PendingTest Exception and logs an error message
@@ -60,10 +58,10 @@ module Beaker
       # @param [String] msg An optional message to log
       # @raise [PendingTest]
       def pending_test msg = nil
-        message = formatted_message( msg, 'is Pending' )
-        logger.warn( message )
+        message = formatted_message(msg, 'is Pending')
+        logger.warn(message)
 
-        raise( PendingTest, message )
+        raise(PendingTest, message)
       end
 
       # Raises SkipTest Exception and logs a message
@@ -71,10 +69,10 @@ module Beaker
       # @param [String] msg An optional message to log
       # @raise [SkipTest]
       def skip_test msg = nil
-        message = formatted_message( msg, 'was Skipped' )
-        logger.notify( message )
+        message = formatted_message(msg, 'was Skipped')
+        logger.notify(message)
 
-        raise( SkipTest, message )
+        raise(SkipTest, message)
       end
 
       # populate a TestCase's @exports[] with structured_data
@@ -93,7 +91,7 @@ module Beaker
       #
       # @return [String] A prettier string with helpful info
       # @!visibility private
-      def formatted_message(message, default_str )
+      def formatted_message(message, default_str)
         msg = message ? "\n#{message}\n" : "\n#{self} #{default_str}.\n"
         return msg
       end