beaker 4.41.2 → 5.0.0

data/lib/beaker/dsl/assertions.rb

@@ -17,7 +17,7 @@ module Beaker
     module Assertions
       include Minitest::Assertions
 
-      #Why do we need this accessor?
+      # Why do we need this accessor?
       # https://github.com/seattlerb/minitest/blob/master/lib/minitest/assertions.rb#L8-L12
       # Protocol: Nearly everything here boils up to +assert+, which
       # expects to be able to increment an instance accessor named
@@ -25,6 +25,7 @@ module Beaker
       # provided by the thing including Assertions. See Minitest::Runnable
       # for an example.
       attr_writer :assertions
+
       def assertions
         @assertions || 0
       end
@@ -71,7 +72,7 @@ module Beaker
       #                         annotated with stream markers.
       # @param [String] msg     An explanatory message about why the test
       #                         failure is relevant.
-      def assert_output(exp_out, msg='Output lines did not match')
+      def assert_output(exp_out, msg = 'Output lines did not match')
         # Remove the minimal consistent indentation from the input;
         # useful for clean HEREDOCs.
         indentation = exp_out.lines.map { |line| line[/^ */].length }.min
@@ -82,7 +83,7 @@ module Beaker
           line !~ /^((STD)?ERR|2)> /
         end
         our_out, our_err, our_output = [
-          out.join, err.join, cleaned_exp
+          out.join, err.join, cleaned_exp,
         ].map do |str|
           str.gsub(/^((STD)?(ERR|OUT)|[12])> /, '')
         end
@@ -90,23 +91,10 @@ module Beaker
         # Exercise assertions about output
         assert_equal our_output, (result.nil? ? '' : result.output), msg
         assert_equal our_out,    (result.nil? ? '' : result.stdout),
-          'The contents of STDOUT did not match expectations'
+                     'The contents of STDOUT did not match expectations'
         assert_equal our_err,    (result.nil? ? '' : result.stderr),
-          'The contents of STDERR did not match expectations'
-      end
-
-      # Assert that the provided string does not match the provided regular expression, can pass optional message
-      # @deprecated This is placed her for backwards compatability for tests that used Test::Unit::Assertions,
-      #             http://apidock.com/ruby/Test/Unit/Assertions/assert_no_match
-      #
-      def assert_no_match(regexp, string, msg=nil)
-        assert_instance_of(Regexp, regexp, "The first argument to assert_no_match should be a Regexp.")
-        msg = message(msg) { "<#{mu_pp(regexp)}> expected to not match\n<#{mu_pp(string)}>" }
-        assert(regexp !~ string, msg)
+                     'The contents of STDERR did not match expectations'
       end
-
-      alias_method :assert_not_match, :assert_no_match
-
     end
   end
 end

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

@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
 require 'hocon/parser/config_document_factory'
 require 'hocon/config_value_factory'
 
@@ -11,7 +10,6 @@ module Beaker
       #   - {https://github.com/puppetlabs/beaker/tree/master/docs/how_to/use_hocon_helpers.md Beaker docs}.
       #   - Beaker acceptance tests in +acceptance/tests/base/dsl/helpers/hocon_helpers_test.rb+
       module HoconHelpers
-
         # Reads the given hocon file from a SUT
         #
         # @param [Host] host Host to get hocon file from.
@@ -20,9 +18,8 @@ module Beaker
         # @raise ArgumentError if arguments are missing or incorrect
         # @return [Hocon::ConfigValueFactory] parsed hocon file
         def hocon_file_read_on(host, filename)
-          if filename.nil? || filename.empty?
-            raise ArgumentError, '#hocon_file_edit_on requires a filename'
-          end
+          raise ArgumentError, '#hocon_file_edit_on requires a filename' if filename.nil? || filename.empty?
+
           file_contents = on(host, "cat #{filename}").stdout
           Hocon::Parser::ConfigDocumentFactory.parse_string(file_contents)
         end
@@ -59,7 +56,7 @@ module Beaker
             msg << ' a hocon file to edit. No block was provided.'
             raise ArgumentError, msg
           end
-          block_on hosts, {} do | host |
+          block_on hosts, {} do |host|
             doc = hocon_file_read_on(host, filename)
             yield host, doc
           end
@@ -86,7 +83,6 @@ module Beaker
             create_remote_file(host, filename, content_doc.render)
           end
         end
-
       end
     end
   end

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
               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 |
+          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 |
+          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.exist?(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
@@ -349,9 +292,8 @@ module Beaker
             script_path = "beaker_powershell_script_#{Time.now.to_i}.ps1"
             create_remote_file(host, script_path, powershell_script, opts)
             native_path = script_path.tr('/', "\\")
-            on host, powershell("", {"File" => native_path }), opts
+            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(':')
@@ -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
@@ -584,7 +523,7 @@ module Beaker
           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
@@ -62,34 +61,19 @@ module Beaker
             logger.notify "Fetching: #{src}"
             logger.notify "  and saving to #{dst}"
             begin
-              uri_open(src) 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 /404.*/.match?(e.message)
-                raise "Failed to fetch_remote_file '#{src}' (#{e.message})"
-              else
-                raise e
-              end
-            end
-          end
-          return dst
-        end
+              raise "Failed to fetch_remote_file '#{src}' (#{e.message})" if /404.*/.match?(e.message)
 
-        def uri_open(src)
-          if RUBY_VERSION.to_f < 2.5
-            URI.send(:open, src) do |remote|
-              yield remote
-            end
-          else
-            URI.open(src) do |remote|
-              yield remote
+              raise e
             end
           end
+          return dst
         end
-        private :uri_open
 
         # Recursively fetch the contents of the given http url, ignoring
         # `index.html` and `*.gif` files.
@@ -104,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.end_with?('/')
-            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}"
 
@@ -123,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