beaker 4.42.0 → 5.0.0

data/lib/beaker/dsl/outcomes.rb

@@ -15,7 +15,6 @@ 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"
@@ -32,16 +31,15 @@ module Beaker
       # shown itself to pass the test.
       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

data/lib/beaker/dsl/patterns.rb

@@ -10,7 +10,6 @@ module Beaker
     # and #to_s available and provide an array when #[]('roles') is called.
     #
     module Patterns
-
       # Execute a block selecting the hosts that match with the provided criteria
       # @param [Array<Host>, Host, String, Symbol] hosts_or_filter A host role as a String or Symbol that can be
       #                                                used to search for a set of Hosts,  a host name
@@ -23,7 +22,7 @@ module Beaker
       #
       # @return [Array<Result>, Result, nil] An array of results, a result object, or nil.
       #   Check {Beaker::Shared::HostManager#run_block_on} for more details on this.
-      def block_on hosts_or_filter, opts={}, &block
+      def block_on hosts_or_filter, opts = {}, &block
         block_hosts = nil
         if defined? hosts
           block_hosts = hosts
@@ -36,7 +35,6 @@ module Beaker
         end
         run_block_on block_hosts, filter, opts, &block
       end
-
     end
   end
 end

data/lib/beaker/dsl/roles.rb

@@ -14,7 +14,6 @@ module Beaker
     # in error conditions
     #
     module Roles
-
       # The hosts for which ['roles'] include 'agent'
       #
       # @return [Array<Host>] May be empty
@@ -100,7 +99,7 @@ module Beaker
       #     end
       #
       def not_controller(host)
-        controllers = ['dashboard', 'database', 'master', 'console']
+        controllers = %w[dashboard database master console]
         matched_roles = host['roles'].select { |v| controllers.include?(v) }
         matched_roles.length == 0
       end
@@ -116,7 +115,7 @@ module Beaker
       #
       # @return [Boolean]      True if agent-only, false otherwise
       def agent_only(host)
-          host['roles'].length == 1 && host['roles'].include?('agent')
+        host['roles'].length == 1 && host['roles'].include?('agent')
       end
 
       # Determine whether a host has an AIO version or not. If a host :pe_ver or
@@ -134,12 +133,13 @@ module Beaker
       #
       # @return [Boolean] whether or not a host is AIO-capable
       def aio_version?(host)
-        [:pe_ver, :version].each do |key|
+        %i[pe_ver version].each do |key|
           version = host[key]
           return !version_is_less(version, '4.0') if version && !version.empty?
         end
         return true if host[:roles] && host[:roles].include?('aio')
         return true if host[:type] && /(\A|-)aio(\Z|-)/.match(host[:type])
+
         false
       end
 
@@ -160,31 +160,28 @@ module Beaker
         host[:roles] = host[:roles] | [role]
       end
 
-      #Create a new role method for a given arbitrary role name.  Makes it possible to be able to run
-      #commands without having to refer to role by String or Symbol.  Will not add a new method
-      #definition if the name is already in use.
+      # Create a new role method for a given arbitrary role name.  Makes it possible to be able to run
+      # commands without having to refer to role by String or Symbol.  Will not add a new method
+      # definition if the name is already in use.
       # @param [String, Symbol, Array[String,Symbol]] role The role that you wish to create a definition for, either a String
       # Symbol or an Array of Strings or Symbols.
       # @example Basic usage
       #  add_role_def('myrole')
       #  on myrole, "run command"
       def add_role_def role
-        if role.kind_of?(Array)
+        if role.is_a?(Array)
           role.each do |r|
             add_role_def r
           end
-        else
-          if not respond_to? role
-            if !/\A[[:alpha:]]+[a-zA-Z0-9_]*[!?=]?\Z/.match?(role)
-              raise ArgumentError, "Role name format error for '#{role}'.  Allowed characters are: \na-Z\n0-9 (as long as not at the beginning of name)\n'_'\n'?', '!' and '=' (only as individual last character at end of name)"
-            end
-            self.class.send :define_method, role.to_s do
-              hosts_with_role = hosts_as role.to_sym
-              if hosts_with_role.length == 1
-                hosts_with_role = hosts_with_role.pop
-              end
-              hosts_with_role
-            end
+        elsif not respond_to? role
+          if !/\A[[:alpha:]]+[a-zA-Z0-9_]*[!?=]?\Z/.match?(role)
+            raise ArgumentError, "Role name format error for '#{role}'.  Allowed characters are: \na-Z\n0-9 (as long as not at the beginning of name)\n'_'\n'?', '!' and '=' (only as individual last character at end of name)"
+          end
+
+          self.class.send :define_method, role.to_s do
+            hosts_with_role = hosts_as role.to_sym
+            hosts_with_role = hosts_with_role.pop if hosts_with_role.length == 1
+            hosts_with_role
           end
         end
       end

data/lib/beaker/dsl/structure.rb

@@ -37,32 +37,30 @@ module Beaker
       def step step_name, &block
         logger.notify "\n* #{step_name}\n"
         set_current_step_name(step_name)
-        if block
-          begin
-            logger.with_indent do
-              yield
-            end
-          rescue Exception => e
-            if(@options.has_key?(:debug_errors) && @options[:debug_errors] == true)
+        return unless block
+
+        begin
+          logger.with_indent(&block)
+        rescue Exception => e
+          if @options.has_key?(:debug_errors) && @options[:debug_errors] == true
+            begin
+              require 'pry'
+            rescue LoadError
               begin
-                require 'pry'
+                require 'debug'
               rescue LoadError
-                begin
-                  require 'debug'
-                rescue LoadError
-                  logger.exception('Unable to load pry and debug while debug_errors was true')
-                else
-                  logger.info("Exception raised during step execution and debug-errors option is set, entering debug. Exception was: #{e.inspect}")
-                  binding.break
-                end
+                logger.exception('Unable to load pry and debug while debug_errors was true')
               else
-                logger.info("Exception raised during step execution and debug-errors option is set, entering pry. Exception was: #{e.inspect}")
-                logger.info("HINT: Use the pry 'backtrace' and 'up' commands to navigate to the test code")
-                binding.pry # rubocop:disable Lint/Debugger
+                logger.info("Exception raised during step execution and debug-errors option is set, entering debug. Exception was: #{e.inspect}")
+                binding.break # rubocop:disable Lint/Debugger
               end
+            else
+              logger.info("Exception raised during step execution and debug-errors option is set, entering pry. Exception was: #{e.inspect}")
+              logger.info("HINT: Use the pry 'backtrace' and 'up' commands to navigate to the test code")
+              binding.pry # rubocop:disable Lint/Debugger
             end
-            raise e
           end
+          raise e
         end
       end
 
@@ -72,7 +70,7 @@ module Beaker
       def manual_step step_name
         require 'readline'
         logger.notify "\n* #{step_name}\n"
-        if(!@options.has_key?(:exec_manual_tests))
+        if !@options.has_key?(:exec_manual_tests)
           # if the option -exec-manual-tests is not set then this has executed outside of a manual tests
           # so we raise an error to avoid issues
           raise('--exec-manual-tests option not set, this means a manual_step was used outside a manual_test')
@@ -90,12 +88,10 @@ module Beaker
             fail_message = ''
             loop do
               fail_message = Readline.readline('What was the reason for failure? ', true).squeeze(" ").strip
-              if fail_message == ''
-                # if nothing is entered we tell the user to enter something
-                puts "No reason for failure given, please enter reason for failure."
-              else
-                break
-              end
+              break unless fail_message == ''
+
+              # if nothing is entered we tell the user to enter something
+              puts "No reason for failure given, please enter reason for failure."
             end
             raise Beaker::DSL::FailTest, fail_message
           else
@@ -112,14 +108,14 @@ module Beaker
       # @param [Proc] block The actions to be performed during this test.
       #
       def manual_test manual_test_name, &block
-        if(@options.has_key?(:exec_manual_tests) && @options[:exec_manual_tests] == true)
+        if @options.has_key?(:exec_manual_tests) && @options[:exec_manual_tests] == true
           # here the option is set so we run the test as normal
           test_name manual_test_name, &block
         else
           # here no option was set so we log the test name and skip it
           test_name manual_test_name
-          raise( Beaker::DSL::SkipTest,
-                 '--exec-manual-tests option not set, so skipping manual test' )
+          raise(Beaker::DSL::SkipTest,
+                '--exec-manual-tests option not set, so skipping manual test')
         end
       end
 
@@ -128,14 +124,12 @@ module Beaker
       # @param [String] my_name The name of the test to be logged.
       # @param [Proc] block The actions to be performed during this test.
       #
-      def test_name my_name
+      def test_name my_name, &block
         logger.notify "\n#{my_name}\n"
         set_current_test_name(my_name)
-        if block_given?
-          logger.with_indent do
-            yield
-          end
-        end
+        return unless block
+
+        logger.with_indent(&block)
       end
 
       # Declare a teardown process that will be called after a test case is
@@ -192,15 +186,15 @@ module Beaker
       # @author Chris Cowell-Shah (<tt>ccs@puppetlabs.com</tt>)
       def expect_failure(explanation)
         begin
-          yield if block_given?  # code block should contain an assert that you expect to fail
+          yield if block_given? # code block should contain an assert that you expect to fail
         rescue Beaker::DSL::Assertions, Minitest::Assertion => e
           # Yay! The assert in the code block failed, as expected.
           # Swallow the failure so the test passes.
           logger.notify 'An assertion was expected to fail, and did. ' +
-                          'This is probably due to a known product bug, ' +
-                          'and is probably not a problem. ' +
-                          "Additional info: '#{explanation}' " +
-                          "Failed assertion: '#{e}'"
+                        'This is probably due to a known product bug, ' +
+                        'and is probably not a problem. ' +
+                        "Additional info: '#{explanation}' " +
+                        "Failed assertion: '#{e}'"
           return
         end
         # Uh-oh! The assert in the code block unexpectedly passed.
@@ -268,22 +262,22 @@ module Beaker
       # @raise [SkipTest] Raises skip test if there are no valid hosts for
       #   this test case after confinement.
       def confine(type, criteria, host_array = nil, &block)
-        hosts_to_modify = Array( host_array || hosts )
-        hosts_not_modified = hosts - hosts_to_modify #we aren't examining these hosts
+        hosts_to_modify = Array(host_array || hosts)
+        hosts_not_modified = hosts - hosts_to_modify # we aren't examining these hosts
         case type
         when :except
-          if criteria and ( not criteria.empty? )
-            hosts_to_modify = hosts_to_modify - select_hosts(criteria, hosts_to_modify, &block) + hosts_not_modified
-          else
-            # confining to all hosts *except* provided array of hosts
-            hosts_to_modify = hosts_not_modified
-          end
+          hosts_to_modify = if criteria and (not criteria.empty?)
+                              hosts_to_modify - select_hosts(criteria, hosts_to_modify, &block) + hosts_not_modified
+                            else
+                              # confining to all hosts *except* provided array of hosts
+                              hosts_not_modified
+                            end
           if hosts_to_modify.empty?
             logger.warn "No suitable hosts without: #{criteria.inspect}"
             skip_test "No suitable hosts found without #{criteria.inspect}"
           end
         when :to
-          if criteria and ( not criteria.empty? )
+          if criteria and (not criteria.empty?)
             hosts_to_modify = select_hosts(criteria, hosts_to_modify, &block) + hosts_not_modified
           else
             # confining to only hosts in provided array of hosts
@@ -305,12 +299,11 @@ module Beaker
       #
       # @see #confine
       def confine_block(type, criteria, host_array = nil)
-        host_array = Array( host_array || hosts )
+        host_array = Array(host_array || hosts)
         original_hosts = self.hosts.dup
         confine(type, criteria, host_array)
 
         yield
-
       rescue Beaker::DSL::Outcomes::SkipTest => e
         # I don't like this much, but adding options to confine is a breaking change
         # to the DSL that would involve a major version bump
@@ -322,7 +315,7 @@ module Beaker
         self.hosts = original_hosts
       end
 
-      #Return a set of hosts that meet the given criteria
+      # Return a set of hosts that meet the given criteria
       # @param [Hash{Symbol,String=>String,Regexp,Array<String,Regexp>}]
       #   criteria Specify the criteria with which a host should be
       #   considered for inclusion.  The key is any attribute
@@ -340,33 +333,28 @@ module Beaker
       #   should return true if the host matches this additional criteria.
       #
       # @return [Array<Host>] Returns an array of hosts that meet the provided criteria
-      def select_hosts(criteria, host_array = nil)
+      def select_hosts(criteria, host_array = nil, &block)
         hosts_to_select_from = host_array || hosts
         criteria.each_pair do |property, value|
           hosts_to_select_from = hosts_to_select_from.select do |host|
             inspect_host host, property, value
           end
         end
-        if block_given?
-          hosts_to_select_from = hosts_to_select_from.select do |host|
-            yield host
-          end
-        end
+        hosts_to_select_from = hosts_to_select_from.select(&block) if block
         hosts_to_select_from
       end
 
       # @!visibility private
       def inspect_host(host, property, one_or_more_values)
-        values = Array(one_or_more_values)
-        return values.any? do |value|
-          true_false = false
+        Array(one_or_more_values).any? do |value|
           case value
           when String
-            true_false = host[property.to_s].include? value
+            host[property.to_s].include? value
           when Regexp
-            true_false = value.match?(host[property.to_s])
+            value.match?(host[property.to_s])
+          else
+            false
           end
-          true_false
         end
       end
     end

data/lib/beaker/dsl/test_tagging.rb

@@ -12,7 +12,6 @@ module Beaker
     #   - {Beaker::Options::Validator#validate_tags} ensures test tag CLI params
     #     are valid for use by this module
     module TestTagging
-
       # Sets tags on the current {Beaker::TestCase}, and skips testing
       # if necessary after checking this case's tags against the ones that are
       # being included or excluded.
@@ -65,22 +64,21 @@ module Beaker
       # @!visibility private
       def platform_specific_tag_confines
         @options[:platform_tag_confines_object] ||= PlatformTagConfiner.new(
-          @options[:platform_tag_confines]
+          @options[:platform_tag_confines],
         )
         confines = @options[:platform_tag_confines_object].confine_details(
-          metadata[:case][:tags]
+          metadata[:case][:tags],
         )
         confines.each do |confine_details|
-          logger.notify( confine_details[:log_message] )
+          logger.notify(confine_details[:log_message])
           confine(
             confine_details[:type],
-            :platform => confine_details[:platform_regex]
+            :platform => confine_details[:platform_regex],
           )
         end
       end
 
       class PlatformTagConfiner
-
         # Constructs the PlatformTagConfiner, transforming the user format
         #   into the internal structure for use by Beaker itself.
         #
@@ -122,7 +120,7 @@ module Beaker
               @tag_confine_details_hash[tag] << {
                 :platform_regex => entry[:platform],
                 :log_message => log_msg,
-                :type => :except
+                :type => :except,
               }
             end
           end
@@ -143,7 +141,7 @@ module Beaker
             tag_confine_array = @tag_confine_details_hash[tag]
             next if tag_confine_array.nil?
 
-            details.push( *tag_confine_array )
+            details.push(*tag_confine_array)
             # tag_confine_array.each do |confine_details|
             #   details << confine_details
             # end
@@ -151,7 +149,6 @@ module Beaker
           details
         end
       end
-
     end
   end
-end
+end

data/lib/beaker/dsl/wrappers.rb

@@ -8,7 +8,6 @@ module Beaker
     # I find most of these adapters of suspicious value and have deprecated
     # many of them.
     module Wrappers
-
       # @param [String] command_string A string of to be interpolated
       #                                within the context of a host in
       #                                question
@@ -36,13 +35,13 @@ module Beaker
       #     powershell("", {'-File' => '/path/to/file'})
       #
       # @return [Command]
-      def powershell(command, args={})
+      def powershell(command, args = {})
         ps_opts = {
           'ExecutionPolicy' => 'Bypass',
-          'InputFormat'     => 'None',
-          'NoLogo'          => '',
-          'NoProfile'       => '',
-          'NonInteractive'  => ''
+          'InputFormat' => 'None',
+          'NoLogo' => '',
+          'NoProfile' => '',
+          'NonInteractive' => '',
         }
         encoded = false
         ps_opts.merge!(args)
@@ -56,20 +55,20 @@ module Beaker
         end
 
         ps_opts.each do |k, v|
-          if v.eql?('') or v.nil?
-            ps_args << "-#{k}"
-          else
-            ps_args << "-#{k} #{v}"
-          end
+          ps_args << if v.eql?('') or v.nil?
+                       "-#{k}"
+                     else
+                       "-#{k} #{v}"
+                     end
         end
 
         # may not have a command if executing a file
         if command && !command.empty?
-          if encoded
-            ps_args << "-EncodedCommand #{encode_command(command)}"
-          else
-            ps_args << "-Command #{command}"
-          end
+          ps_args << if encoded
+                       "-EncodedCommand #{encode_command(command)}"
+                     else
+                       "-Command #{command}"
+                     end
         end
 
         Command.new("powershell.exe", ps_args)

data/lib/beaker/dsl.rb

@@ -1,5 +1,4 @@
-[ 'install_utils', 'roles', 'outcomes', 'assertions', 'patterns',
-  'structure', 'helpers', 'wrappers', 'test_tagging' ].each do |lib|
+%w[install_utils roles outcomes assertions patterns structure helpers wrappers test_tagging].each do |lib|
   require "beaker/dsl/#{lib}"
 end
 
@@ -69,7 +68,7 @@ module Beaker
   #       end
   #     end
   #
-  #@api dsl
+  # @api dsl
   module DSL
     include Beaker::DSL::Roles
     include Beaker::DSL::Outcomes

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

@@ -24,6 +24,6 @@ module Aix::Exec
   #   (from {#ssh_service_restart}).
   def ssh_permit_user_environment
     exec(Beaker::Command.new("echo '\nPermitUserEnvironment yes' >> /etc/ssh/sshd_config"))
-    ssh_service_restart()
+    ssh_service_restart
   end
 end

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

@@ -12,5 +12,4 @@ module Aix::File
   def path_split(paths)
     paths.split(':')
   end
-
 end

data/lib/beaker/host/aix/group.rb

@@ -1,7 +1,7 @@
 module Aix::Group
   include Beaker::CommandFactory
 
-  def group_list()
+  def group_list
     execute("lsgroup -a ALL") do |result|
       yield result if block_given?
 

data/lib/beaker/host/aix/user.rb

@@ -1,7 +1,7 @@
 module Aix::User
   include Beaker::CommandFactory
 
-  def user_list()
+  def user_list
     execute("lsuser ALL") do |result|
       users = []
       result.stdout.each_line do |line|

data/lib/beaker/host/aix.rb

@@ -1,17 +1,16 @@
-[ 'host', 'command_factory' ].each do |lib|
+%w[host command_factory].each do |lib|
   require "beaker/#{lib}"
 end
 
 module Aix
   class Host < Unix::Host
-    [ 'user', 'group', 'file', 'exec' ].each do |lib|
-        require "beaker/host/aix/#{lib}"
+    %w[user group file exec].each do |lib|
+      require "beaker/host/aix/#{lib}"
     end
 
     include Aix::User
     include Aix::Group
     include Aix::File
     include Aix::Exec
-
   end
 end