beaker 4.38.1 → 5.0.0

data/lib/beaker/hypervisor.rb

@@ -1,36 +1,36 @@
-[ 'host_prebuilt_steps' ].each do |lib|
+['host_prebuilt_steps'].each do |lib|
   require "beaker/#{lib}"
 end
 
 module Beaker
-  #The Beaker class that interacts to all the supported hypervisors
+  # The Beaker class that interacts to all the supported hypervisors
   class Hypervisor
     include HostPrebuiltSteps
 
-    #Generates an array with all letters a thru z and numbers 0 thru 9
+    # Generates an array with all letters a thru z and numbers 0 thru 9
     CHARMAP = ('a'..'z').to_a + ('0'..'9').to_a
 
-    #Hypervisor creator method.  Creates the appropriate hypervisor class object based upon
-    #the provided hypervisor type selected, then provisions hosts with hypervisor.
-    #@param [String] type The type of hypervisor to create - one of aix, solaris, vsphere, fusion,
+    # Hypervisor creator method.  Creates the appropriate hypervisor class object based upon
+    # the provided hypervisor type selected, then provisions hosts with hypervisor.
+    # @param [String] type The type of hypervisor to create - one of aix, solaris, vsphere, fusion,
     #                     blimpy, vcloud or vagrant
-    #@param [Array<Host>] hosts_to_provision The hosts to be provisioned with the selected hypervisor
-    #@param [Hash] options options Options to alter execution
-    #@option options [String] :host_name_prefix (nil) Prefix host name if set
+    # @param [Array<Host>] hosts_to_provision The hosts to be provisioned with the selected hypervisor
+    # @param [Hash] options options Options to alter execution
+    # @option options [String] :host_name_prefix (nil) Prefix host name if set
     def self.create(type, hosts_to_provision, options)
       @logger = options[:logger]
       @logger.notify("Beaker::Hypervisor, found some #{type} boxes to create")
 
       hyper_class = case type
-        when /^noop$/
-          Beaker::Noop
-        when /^(default)|(none)$/
-          Beaker::Hypervisor
-        else
-          # Custom hypervisor
-          require "beaker/hypervisor/#{type}"
-          Beaker.const_get(type.split('_').collect(&:capitalize).join)
-        end
+                    when /^noop$/
+                      Beaker::Noop
+                    when /^(default)|(none)$/
+                      Beaker::Hypervisor
+                    else
+                      # Custom hypervisor
+                      require "beaker/hypervisor/#{type}"
+                      Beaker.const_get(type.split('_').collect(&:capitalize).join)
+                    end
 
       hypervisor = hyper_class.new(hosts_to_provision, options)
       self.set_ssh_connection_preference(hosts_to_provision, hypervisor)
@@ -44,19 +44,19 @@ module Beaker
       @options = options
     end
 
-    #Provisioning steps for be run for a given hypervisor.  Default is nil.
+    # Provisioning steps for be run for a given hypervisor.  Default is nil.
     def provision
       nil
     end
 
-    #Cleanup steps to be run for a given hypervisor.  Default is nil.
+    # Cleanup steps to be run for a given hypervisor.  Default is nil.
     def cleanup
       nil
     end
 
-    DEFAULT_CONNECTION_PREFERENCE = [:ip, :vmhostname, :hostname]
+    DEFAULT_CONNECTION_PREFERENCE = %i[ip vmhostname hostname]
     # SSH connection method preference. Can be overwritten by hypervisor to change the order
-    def connection_preference(host)
+    def connection_preference(_host)
       DEFAULT_CONNECTION_PREFERENCE
     end
 
@@ -72,65 +72,48 @@ module Beaker
       end
     end
 
-    #Proxy package managers on tests hosts created by this hypervisor, runs before validation and configuration.
+    # Proxy package managers on tests hosts created by this hypervisor, runs before validation and configuration.
     def proxy_package_manager
-      if @options[:package_proxy]
-        package_proxy(@hosts, @options)
-      end
+      return unless @options[:package_proxy]
+
+      package_proxy(@hosts, @options)
     end
 
-    #Default configuration steps to be run for a given hypervisor.  Any additional configuration to be done
-    #to the provided SUT for test execution to be successful.
+    # Default configuration steps to be run for a given hypervisor.  Any additional configuration to be done
+    # to the provided SUT for test execution to be successful.
     def configure(opts = {})
       begin
         return unless @options[:configure]
+
         run_in_parallel = run_in_parallel? opts, @options, 'configure'
-        block_on @hosts, { :run_in_parallel => run_in_parallel} do |host|
-          if host[:timesync]
-            timesync(host, @options)
-          end
-        end
-        if @options[:root_keys]
-          sync_root_keys(@hosts, @options)
-        end
-        if @options[:add_el_extras]
-          add_el_extras(@hosts, @options)
-        end
-        if @options[:disable_iptables]
-          disable_iptables @hosts, @options
-        end
-        if @options[:set_env]
-          set_env(@hosts, @options)
-        end
-        if @options[:disable_updates]
-          disable_updates(@hosts, @options)
-        end
-      rescue SignalException => ex
-        if ex.signo == 15 #SIGTERM
-          report_and_raise(@logger, ex, "configure")
+        block_on @hosts, { :run_in_parallel => run_in_parallel } do |host|
+          timesync(host, @options) if host[:timesync]
         end
+        sync_root_keys(@hosts, @options) if @options[:root_keys]
+        set_env(@hosts, @options) if @options[:set_env]
+        disable_updates(@hosts, @options) if @options[:disable_updates]
+      rescue SignalException => e
+        report_and_raise(@logger, e, "configure") if e.signo == 15 # SIGTERM
         raise
       end
     end
 
-    #Default validation steps to be run for a given hypervisor.  Ensures that SUTs meet requirements to be
-    #beaker test nodes.
+    # Default validation steps to be run for a given hypervisor.  Ensures that SUTs meet requirements to be
+    # beaker test nodes.
     def validate
-      if @options[:validate]
-        validate_host(@hosts, @options)
-      end
+      return unless @options[:validate]
+
+      validate_host(@hosts, @options)
     end
 
-    #Generate a random string composted of letter and numbers
-    #prefixed with value of {Beaker::Hypervisor::create} option :host_name_prefix
+    # Generate a random string composted of letter and numbers
+    # prefixed with value of {Beaker::Hypervisor::create} option :host_name_prefix
     def generate_host_name
-      n = CHARMAP[rand(25)] + (0...14).map{CHARMAP[rand(CHARMAP.length)]}.join
-      if @options[:host_name_prefix]
-        return @options[:host_name_prefix] + n
-      end
+      n = CHARMAP[rand(25)] + (0...14).map { CHARMAP[rand(CHARMAP.length)] }.join
+      return @options[:host_name_prefix] + n if @options[:host_name_prefix]
+
       n
     end
-
   end
 end
 

data/lib/beaker/local_connection.rb

@@ -2,7 +2,6 @@ require 'open3'
 
 module Beaker
   class LocalConnection
-
     attr_accessor :logger, :hostname, :ip
 
     def initialize options = {}
@@ -19,7 +18,7 @@ module Beaker
       connection
     end
 
-    def connect options = {}
+    def connect _options = {}
       @logger.debug "Local connection, no connection to start"
     end
 
@@ -35,7 +34,7 @@ module Beaker
       ENV.replace(backup)
     end
 
-    def execute command, options = {}, stdout_callback = nil, stderr_callback = stdout_callback
+    def execute command, _options = {}, stdout_callback = nil, _stderr_callback = stdout_callback
       result = Result.new(@hostname, command)
       envs = {}
       if File.readable?(@ssh_env_file)
@@ -46,7 +45,7 @@ module Beaker
       end
 
       begin
-        clean_env = ENV.reject{ |k| k =~ /^BUNDLE|^RUBY|^GEM/ }
+        clean_env = ENV.reject { |k| /^BUNDLE|^RUBY|^GEM/.match?(k) }
 
         with_env(clean_env) do
           std_out, std_err, status = Open3.capture3(envs, command)
@@ -68,13 +67,12 @@ module Beaker
     end
 
     def scp_to(source, target, _options = {})
-
       result = Result.new(@hostname, [source, target])
       begin
         FileUtils.cp_r source, target
       rescue Errno::ENOENT => e
         @logger.warn "#{e.class} error in cp'ing. Forcing the connection to close, which should " \
-                        "raise an error."
+                     "raise an error."
       end
 
       result.stdout << "  CP'ed file #{source} to #{target}"

data/lib/beaker/logger.rb

@@ -1,14 +1,13 @@
 module Beaker
-    # The Beaker Logger class
-    # This class handles message reporting for Beaker, it reports based upon a provided log level
-    # to a given destination (be it a string or file)
-    #
+  # The Beaker Logger class
+  # This class handles message reporting for Beaker, it reports based upon a provided log level
+  # to a given destination (be it a string or file)
+  #
   class Logger
-
-    #The results of the most recently run command
+    # The results of the most recently run command
     attr_accessor :last_result
 
-    #Determines the spacing that happens before an output line
+    # Determines the spacing that happens before an output line
     attr_accessor :line_prefix
 
     NORMAL         = "\e[00;00m"
@@ -21,7 +20,7 @@ module Beaker
     MAGENTA        = "\e[00;35m"
     CYAN           = "\e[00;36m"
     WHITE          = "\e[00;37m"
-    GREY           = "\e[00;00m"  # Some terms can't handle grey, use normal
+    GREY           = "\e[00;00m" # Some terms can't handle grey, use normal
     BRIGHT_RED     = "\e[01;31m"
     BRIGHT_GREEN   = "\e[01;32m"
     BRIGHT_YELLOW  = "\e[01;33m"
@@ -32,13 +31,13 @@ module Beaker
     NONE           = ""
 
     # The defined log levels.  Each log level also reports messages at levels lower than itself
-    LOG_LEVELS      = {
-      :trace   => 6,
-      :debug   => 5,
+    LOG_LEVELS = {
+      :trace => 6,
+      :debug => 5,
       :verbose => 3,
-      :info    => 2,
-      :notify  => 1,
-      :warn    => 0,
+      :info => 2,
+      :notify => 1,
+      :warn => 0,
     }
 
     attr_accessor :color, :log_level, :destinations, :log_colors
@@ -60,29 +59,27 @@ module Beaker
       options = args.last.is_a?(Hash) ? args.pop : {}
       @color = options[:color]
       @sublog = nil
-      case options[:log_level]
-      when /trace/i, :trace
-        @log_level = :trace
-      when /debug/i, :debug
-        @log_level = :debug
-      when /verbose/i, :verbose
-        @log_level = :verbose
-      when /info/i, :info
-        @log_level = :info
-      when /notify/i, :notify
-        @log_level = :notify
-      when /warn/i, :warn
-        @log_level = :warn
-      else
-        @log_level = :verbose
-      end
+      @log_level = case options[:log_level]
+                   when /trace/i, :trace
+                     :trace
+                   when /debug/i, :debug
+                     :debug
+                   when /info/i, :info
+                     :info
+                   when /notify/i, :notify
+                     :notify
+                   when /warn/i, :warn
+                     :warn
+                   else
+                     :verbose
+                   end
 
       @last_result = nil
       @line_prefix = ''
 
       @destinations = []
 
-      @log_colors =  {
+      @log_colors = {
         :error => RED,
         :warn => BRIGHT_RED,
         :success => MAGENTA,
@@ -91,7 +88,7 @@ module Beaker
         :debug => WHITE,
         :trace => BRIGHT_YELLOW,
         :perf => BRIGHT_MAGENTA,
-        :host => YELLOW
+        :host => YELLOW,
       }
 
       @log_colors.merge!(options[:log_colors]) if options[:log_colors]
@@ -114,16 +111,16 @@ module Beaker
       dests = args
       dests << STDOUT unless options[:quiet]
       dests.uniq!
-      dests.each {|dest| add_destination(dest)}
+      dests.each { |dest| add_destination(dest) }
     end
 
     # Turn on/off STDOUT logging
     # @param [Boolean] off If true, disable STDOUT logging, if false enable STDOUT logging
     def quiet(off = true)
       if off
-        remove_destination(STDOUT) #turn off the noise!
+        remove_destination(STDOUT) # turn off the noise!
       else
-        remove_destination(STDOUT) #in case we are calling this in error and we are already noisy
+        remove_destination(STDOUT) # in case we are calling this in error and we are already noisy
         add_destination(STDOUT)
       end
     end
@@ -132,9 +129,7 @@ module Beaker
     # @param [Array<IO, String>] dest Array of strings (each used as a file path) and IO steams that messages will be printed to
     def add_destination(dest)
       case dest
-      when IO
-        @destinations << dest
-      when StringIO
+      when IO, StringIO
         @destinations << dest
       when String
         @destinations << File.open(dest, 'w')
@@ -147,12 +142,10 @@ module Beaker
     # @param [String, IO] dest String representing a file path or IO stream
     def remove_destination(dest)
       case dest
-      when IO
-        @destinations.delete(dest)
-      when StringIO
+      when IO, StringIO
         @destinations.delete(dest)
       when String
-        @destinations.delete_if {|d| d.respond_to?(:path) and d.path == dest}
+        @destinations.delete_if { |d| d.respond_to?(:path) and d.path == dest }
       else
         raise "Unsuitable log destination #{dest.inspect}"
       end
@@ -197,14 +190,14 @@ module Beaker
     # Remove invalid UTF-8 codes from provided string(s)
     # @param [String, Array<String>] string The string(s) to remove invalid codes from
     def convert string
-      if string.kind_of?(Array)
+      if string.is_a?(Array)
         string.map do |s|
           convert s
         end
       else
         # Remove invalid and undefined UTF-8 character encodings
         string = string.to_s.dup.force_encoding('UTF-8')
-        return string.to_s.chars.select{|i| i.valid_encoding?}.join
+        return string.to_s.chars.select { |i| i.valid_encoding? }.join
       end
     end
 
@@ -215,12 +208,12 @@ module Beaker
     #
     # @return [String] the prefixed line
     def prefix_log_line line
-      if line.kind_of?(Array)
+      if line.is_a?(Array)
         line.map do |s|
           prefix_log_line s
         end
       else
-        line.gsub!(/\r/, '')
+        line.delete!("\r")
         has_ending_newline = line.end_with?("\n")
         actual_lines = line.split("\n")
         actual_lines.map! do |actual_line|
@@ -233,7 +226,7 @@ module Beaker
     end
 
     # Indent the step level for the duration of block.
-    def with_indent(&block)
+    def with_indent
       old_line_prefix = self.line_prefix.dup
       self.line_prefix << '  '
       yield
@@ -241,28 +234,13 @@ module Beaker
       self.line_prefix = old_line_prefix
     end
 
-    # Sets the step level appropriately for logging to be indented correctly
-    #
-    # @return nil
-    # @deprecated use {Logger#with_indent}
-    def step_in
-      self.line_prefix = self.line_prefix + '  '
-    end
-
-    # Sets the step level appropriately for logging to be indented correctly
-    #
-    # @return nil
-    # @deprecated use {Logger#with_indent}
-    def step_out
-      self.line_prefix = self.line_prefix.chop.chop
-    end
-
     # Custom reporting for messages generated by host SUTs.
     # Will not print unless we are at {LOG_LEVELS} 'verbose' or higher.
     # Strips any color codes already in the provided messages, then adds logger color codes before reporting
     # @param args[Array<String>] Strings to be reported
     def host_output *args
       return unless is_verbose?
+
       strings = strip_colors_from args
       string = strings.join
       optionally_color @log_colors[:host], string, false
@@ -274,6 +252,7 @@ module Beaker
     # @param args[Array<String>] Strings to be reported
     def color_host_output *args
       return unless is_verbose?
+
       string = args.join
       optionally_color NONE, string, false
     end
@@ -283,6 +262,7 @@ module Beaker
     # @param args[Array<String>] Strings to be reported
     def perf_output *args
       return unless is_debug?
+
       optionally_color @log_colors[:perf], *args
     end
 
@@ -291,6 +271,7 @@ module Beaker
     # @param args[Array<String>] Strings to be reported
     def trace *args
       return unless is_trace?
+
       optionally_color @log_colors[:trace], *args
     end
 
@@ -299,6 +280,7 @@ module Beaker
     # @param args[Array<String>] Strings to be reported
     def debug *args
       return unless is_verbose?
+
       optionally_color @log_colors[:debug], *args
     end
 
@@ -308,7 +290,8 @@ module Beaker
     # @param args[Array<String>] Strings to be reported
     def warn *args
       return unless is_warn?
-      strings = args.map {|msg| "Warning: #{msg}" }
+
+      strings = args.map { |msg| "Warning: #{msg}" }
       optionally_color @log_colors[:warn], strings
     end
 
@@ -317,6 +300,7 @@ module Beaker
     # @param args[Array<String>] Strings to be reported
     def info *args
       return unless is_info?
+
       optionally_color @log_colors[:info], *args
     end
 
@@ -332,6 +316,7 @@ module Beaker
     # @param args[Array<String>] Strings to be reported
     def notify *args
       return unless is_notify?
+
       optionally_color @log_colors[:notify], *args
     end
 
@@ -346,7 +331,7 @@ module Beaker
     # @param [String] lines A single or array of lines to removed color codes from
     # @return [Array<String>] An array of strings that do not have color codes
     def strip_colors_from lines
-      Array( lines ).map do |line|
+      Array(lines).map do |line|
         Logger.strip_color_codes(convert(line))
       end
     end
@@ -362,7 +347,9 @@ module Beaker
       @destinations.each do |to|
         to.print color_code if @color
         to.send print_statement, msg
-        to.print NORMAL if @color unless color_code == NONE
+        unless color_code == NONE
+          to.print NORMAL if @color
+        end
         to.flush
       end
     end
@@ -374,15 +361,13 @@ module Beaker
     # @param [String] backtrace (caller(1)) The backtrace to format
     # @return [String] The formatted backtrace
     def pretty_backtrace backtrace = caller(1)
-      trace = is_debug? ? backtrace : purge_harness_files_from( backtrace )
-      expand_symlinks( trace ).join "\n"
+      trace = is_debug? ? backtrace : purge_harness_files_from(backtrace)
+      expand_symlinks(trace).join "\n"
     end
 
     # Create a new StringIO log to track the current output
     def start_sublog
-      if @sublog
-        remove_destination(@sublog)
-      end
+      remove_destination(@sublog) if @sublog
       @sublog = StringIO.new
       add_destination(@sublog)
     end
@@ -405,28 +390,29 @@ module Beaker
     # @note since this uses 'mkdir -p', log_prefix can be a number of nested directories
     #
     # @return [String] the path of the dated log folder generated
-    def Logger.generate_dated_log_folder(base_dir, log_prefix, timestamp)
+    def self.generate_dated_log_folder(base_dir, log_prefix, timestamp)
       log_dir = File.join(base_dir, log_prefix, timestamp.strftime("%F_%H_%M_%S"))
       FileUtils.mkdir_p(log_dir) unless File.directory?(log_dir)
       log_dir
     end
 
-    #Remove color codes from provided string.  Color codes are of the format /(\e\[\d\d;\d\dm)+/.
-    #@param [String] text The string to remove color codes from
-    #@return [String] The text without color codes
-    def Logger.strip_color_codes(text)
+    # Remove color codes from provided string.  Color codes are of the format /(\e\[\d\d;\d\dm)+/.
+    # @param [String] text The string to remove color codes from
+    # @return [String] The text without color codes
+    def self.strip_color_codes(text)
       text.gsub(/(\e|\^\[)\[(\d*;)*\d*m/, '')
     end
 
     private
+
     # Expand each symlink found to its full path
     # Lines are assumed to be in the format "String : Integer"
     # @param [String] backtrace The string to search and expand symlinks in
     # @return [String] The backtrace with symlinks expanded
     def expand_symlinks backtrace
       backtrace.collect do |line|
-        file_path, line_num = line.split( ":" )
-        expanded_path = expand_symlink File.expand_path( file_path )
+        file_path, line_num = line.split(":")
+        expanded_path = expand_symlink File.expand_path(file_path)
         expanded_path.to_s + ":" + line_num.to_s
       end
     end
@@ -444,7 +430,7 @@ module Beaker
       end
 
       # And remove lines that contain our program name in them
-      completely_purged = mostly_purged.reject {|line| line.include? $0 }
+      mostly_purged.reject { |line| line.include? $0 }
     end
 
     # Utility method that takes a path as input, checks each component
@@ -453,16 +439,16 @@ module Beaker
     # @param [String] file_path The path to be examined
     # @return [String] The fully expanded file_path
     def expand_symlink file_path
-      file_path.split( "/" ).inject do |full_path, next_dir|
+      file_path.split("/").inject do |full_path, next_dir|
         next_path = full_path + "/" + next_dir
         if File.symlink? next_path
           link = File.readlink next_path
           next_path =
-              case link
-                when /^\// then link
-                else
-                  File.expand_path( full_path + "/" + link )
-              end
+            case link
+            when /^\// then link
+            else
+              File.expand_path(full_path + "/" + link)
+            end
         end
         next_path
       end