beaker 4.39.0 → 5.0.0

data/lib/beaker/network_manager.rb

@@ -1,14 +1,13 @@
-[ 'hypervisor' ].each do |lib|
+['hypervisor'].each do |lib|
   require "beaker/#{lib}"
 end
 
 module Beaker
-  #Object that holds all the provisioned and non-provisioned virtual machines.
-  #Controls provisioning, configuration, validation and cleanup of those virtual machines.
+  # Object that holds all the provisioned and non-provisioned virtual machines.
+  # Controls provisioning, configuration, validation and cleanup of those virtual machines.
   class NetworkManager
-
-    #Determine if a given host should be provisioned.
-    #Provision if:
+    # Determine if a given host should be provisioned.
+    # Provision if:
     # - only if we are running with ---provision
     # - only if we have a hypervisor
     # - only if either the specific hosts has no specification or has 'provision' in its config
@@ -32,12 +31,12 @@ module Beaker
       # user provided prefix has top priority
       if not @options[:log_prefix]
         # name it after the hosts file
-        if @options[:hosts_file]
-          @options[:log_prefix] = File.basename(@options[:hosts_file], '.yml')
-        else
-          #here be the default
-          @options[:log_prefix] = @options[:default_log_prefix]
-        end
+        @options[:log_prefix] = if @options[:hosts_file]
+                                  File.basename(@options[:hosts_file], '.yml')
+                                else
+                                  # here be the default
+                                  @options[:default_log_prefix]
+                                end
       end
       @options[:timestamp]      = Time.now unless @options.has_key?(:timestamp)
       @options[:xml_dated_dir]  = Beaker::Logger.generate_dated_log_folder(@options[:xml_dir], @options[:log_prefix], @options[:timestamp])
@@ -45,15 +44,13 @@ module Beaker
       @options[:logger_sut]     = Beaker::Logger.new(File.join(@options[:log_dated_dir], @options[:log_sut_event]), { :quiet => true })
     end
 
-    #Provision all virtual machines.  Provision machines according to their set hypervisor, if no hypervisor
-    #is selected assume that the described hosts are already up and reachable and do no provisioning.
+    # Provision all virtual machines.  Provision machines according to their set hypervisor, if no hypervisor
+    # is selected assume that the described hosts are already up and reachable and do no provisioning.
     def provision
-      if @hypervisors
-        cleanup
-      end
+      cleanup if @hypervisors
       @hypervisors = {}
-      #sort hosts by their hypervisor, use hypervisor 'none' if no hypervisor is specified
-      hostless_options = Beaker::Options::OptionsHash.new.merge(@options.select{ |k,_v| !k.to_s.include?('HOSTS')})
+      # sort hosts by their hypervisor, use hypervisor 'none' if no hypervisor is specified
+      hostless_options = Beaker::Options::OptionsHash.new.merge(@options.select { |k, _v| !k.to_s.include?('HOSTS') })
       @options['HOSTS'].each_key do |name|
         host_hash = @options['HOSTS'][name]
         hypervisor = host_hash['hypervisor']
@@ -62,7 +59,7 @@ module Beaker
         end
         @logger.debug "Hypervisor for #{name} is #{hypervisor}"
         @machines[hypervisor] = [] unless @machines[hypervisor]
-        hostless_options[:timesync] = host_hash[:timesync] if host_hash[:timesync]!=nil
+        hostless_options[:timesync] = host_hash[:timesync] if host_hash[:timesync] != nil
         host_itself = Beaker::Host.create(name, host_hash, hostless_options)
         host_itself.validate_setup
         @machines[hypervisor] << host_itself
@@ -79,41 +76,41 @@ module Beaker
       @hosts
     end
 
-    #Validate all provisioned machines, ensure that required packages are installed - if they are missing
-    #attempt to add them.
-    #@raise [Exception] Raise an exception if virtual machines fail to be validated
+    # Validate all provisioned machines, ensure that required packages are installed - if they are missing
+    # attempt to add them.
+    # @raise [Exception] Raise an exception if virtual machines fail to be validated
     def validate
-      if @hypervisors
-        @hypervisors.each_key do |type|
-          @hypervisors[type].validate
-        end
+      return unless @hypervisors
+
+      @hypervisors.each_key do |type|
+        @hypervisors[type].validate
       end
     end
 
-    #Configure all provisioned machines, adding any packages or settings required for SUTs
-    #@raise [Exception] Raise an exception if virtual machines fail to be configured
+    # Configure all provisioned machines, adding any packages or settings required for SUTs
+    # @raise [Exception] Raise an exception if virtual machines fail to be configured
     def configure
-      if @hypervisors
-        @hypervisors.each_key do |type|
-          @hypervisors[type].configure
-        end
+      return unless @hypervisors
+
+      @hypervisors.each_key do |type|
+        @hypervisors[type].configure
       end
     end
 
     # configure proxy on all provioned machines
-    #@raise [Exception] Raise an exception if virtual machines fail to be configured
+    # @raise [Exception] Raise an exception if virtual machines fail to be configured
     def proxy_package_manager
-      if @hypervisors
-        @hypervisors.each_key do |type|
-          @hypervisors[type].proxy_package_manager
-        end
+      return unless @hypervisors
+
+      @hypervisors.each_key do |type|
+        @hypervisors[type].proxy_package_manager
       end
     end
 
-    #Shut down network connections and revert all provisioned virtual machines
+    # Shut down network connections and revert all provisioned virtual machines
     def cleanup
-      #shut down connections
-      @hosts.each {|host| host.close }
+      # shut down connections
+      @hosts.each { |host| host.close }
 
       if @hypervisors
         @hypervisors.each_key do |type|
@@ -134,6 +131,7 @@ module Beaker
     # @return [String] the log line created for this event
     def log_sut_event host, create
       raise ArgumentError.new "log_sut_event called before sut logger created. skipping #{host}, #{create}" unless @options.has_key?(:logger_sut)
+
       sut_logger = @options[:logger_sut]
       time = Time.new
       stamp = time.strftime('%Y-%m-%d %H:%M:%S')
@@ -142,6 +140,5 @@ module Beaker
       sut_logger.notify line
       line
     end
-
   end
 end

data/lib/beaker/options/command_line_parser.rb

@@ -1,8 +1,7 @@
 module Beaker
   module Options
-    #An object that parses arguments in the format ['--option', 'value', '--option2', 'value2', '--switch']
+    # An object that parses arguments in the format ['--option', 'value', '--option2', 'value2', '--switch']
     class CommandLineParser
-
       # @example Create a CommanLineParser
       #   a = CommandLineParser.new
       #
@@ -10,7 +9,7 @@ module Beaker
       def initialize
         @cmd_options = Beaker::Options::OptionsHash.new
 
-        @optparse = OptionParser.new do|opts|
+        @optparse = OptionParser.new do |opts|
           # Set a banner
           opts.banner = "Usage: #{File.basename($0)} [options...]"
 
@@ -27,7 +26,7 @@ module Beaker
                   'Read options from FILE',
                   'This should evaluate to a ruby hash.',
                   'CLI optons are given precedence.' do |file|
-            @cmd_options[:options_file] =  file
+            @cmd_options[:options_file] = file
           end
 
           opts.on '--helper PATH/TO/SCRIPT',
@@ -92,7 +91,7 @@ module Beaker
                   'onfail (keep SUTs alive if failures occur during testing)',
                   'onpass (keep SUTs alive if no failures occur during testing)',
                   'never (cleanup SUTs - shutdown and destroy any changes made during testing)',
-                  '(default: never)'  do |mode|
+                  '(default: never)' do |mode|
             @cmd_options[:preserve_hosts] = mode || 'always'
           end
 
@@ -153,9 +152,7 @@ module Beaker
                   'Ensure SUT colored output is preserved',
                   '(default: false)' do |bool|
             @cmd_options[:color_host_output] = bool
-            if bool
-              @cmd_options[:color_host_output] = true
-            end
+            @cmd_options[:color_host_output] = true if bool
           end
 
           opts.on '--log-level LEVEL',
@@ -191,7 +188,7 @@ module Beaker
                   'slow (attempt to continue run post test failure)',
                   'stop (DEPRECATED, please use fast)',
                   '(default: slow)'  do |mode|
-            @cmd_options[:fail_mode] = mode.include?('stop') ? 'fast' :  mode
+            @cmd_options[:fail_mode] = mode.include?('stop') ? 'fast' : mode
           end
 
           opts.on '--test-results-file /FILE/TO/SAVE/TO.rb',
@@ -212,12 +209,6 @@ module Beaker
             @cmd_options[:repo_proxy] = true
           end
 
-          opts.on '--add-el-extras',
-                  'Add Extra Packages for Enterprise Linux (EPEL) repository to el-* hosts',
-                  '(default: false)' do
-            @cmd_options[:add_el_extras] = true
-          end
-
           opts.on '--package-proxy URL', 'Set proxy url for package managers (yum and apt)' do |value|
             @cmd_options[:package_proxy] = value
           end
@@ -238,15 +229,15 @@ module Beaker
             @cmd_options[:collect_perf_data] = mode || 'normal'
           end
 
-          opts.on('--version', 'Report currently running version of beaker' ) do
+          opts.on('--version', 'Report currently running version of beaker') do
             @cmd_options[:beaker_version_print] = true
           end
 
-          opts.on('--parse-only', 'Display beaker parsed options and exit' ) do
+          opts.on('--parse-only', 'Display beaker parsed options and exit') do
             @cmd_options[:parse_only] = true
           end
 
-          opts.on('--help', 'Display this screen' ) do
+          opts.on('--help', 'Display this screen') do
             @cmd_options[:help] = true
           end
 
@@ -262,12 +253,12 @@ module Beaker
 
           opts.on '-x', '--[no-]xml',
                   'DEPRECATED - JUnit XML now generated by default' do
-            #noop
+            # noop
           end
 
           opts.on '--type TYPE',
                   'DEPRECATED - pe/foss/aio determined during runtime' do |type|
-            #backwards compatability, oh how i hate you
+            # backwards compatability, oh how i hate you
             @cmd_options[:type] = type
           end
 
@@ -298,9 +289,7 @@ module Beaker
                   'Output an additional JUnit XML file, sorted by execution time' do |bool|
             @cmd_options[:xml_time_enabled] = bool
           end
-
         end
-
       end
 
       # Parse an array of arguments into a Hash of options
@@ -312,7 +301,7 @@ module Beaker
       #   parser.parse(args) == {:option => 'value, :options2 => value, :switch => true}
       #
       # @return [Hash] Return the Hash of options
-      def parse( args = ARGV )
+      def parse(args = ARGV)
         @optparse.parse(args)
         @cmd_options
       end

data/lib/beaker/options/hosts_file_parser.rb

@@ -1,6 +1,6 @@
 module Beaker
   module Options
-    #A set of functions to parse hosts files
+    # A set of functions to parse hosts files
     module HostsFileParser
       PERMITTED_YAML_CLASSES = [
         'Beaker',
@@ -36,15 +36,16 @@ module Beaker
 
         host_options = new_host_options
         return host_options unless hosts_file_path
+
         error_message = "#{hosts_file_path} is not a valid YAML file\n\t"
-        host_options = self.merge_hosts_yaml( host_options, error_message ) {
-          hosts_file_path = File.expand_path( hosts_file_path )
+        host_options = self.merge_hosts_yaml(host_options, error_message) do
+          hosts_file_path = File.expand_path(hosts_file_path)
 
           raise "#{hosts_file_path} is not a valid path" unless File.exist?(hosts_file_path)
 
           process_yaml(File.read(hosts_file_path), binding)
-        }
-        fix_roles_array( host_options )
+        end
+        fix_roles_array(host_options)
       end
 
       # Read the contents of a host definition as a string into an OptionsHash
@@ -58,11 +59,12 @@ module Beaker
 
         host_options = new_host_options
         return host_options unless hosts_def_yaml
+
         error_message = "#{hosts_def_yaml}\nis not a valid YAML string\n\t"
-        host_options = self.merge_hosts_yaml( host_options, error_message ) {
+        host_options = self.merge_hosts_yaml(host_options, error_message) do
           process_yaml(hosts_def_yaml, binding)
-        }
-        fix_roles_array( host_options )
+        end
+        fix_roles_array(host_options)
       end
 
       # Convenience method to create new OptionsHashes with a HOSTS section
@@ -76,13 +78,11 @@ module Beaker
 
       # Make sure the roles array is present for all hosts
       #
-      def self.fix_roles_array( host_options )
+      def self.fix_roles_array(host_options)
         host_options['HOSTS'].each_key do |host|
           host_options['HOSTS'][host]['roles'] ||= []
         end
-        if host_options.has_key?('CONFIG')
-          host_options = host_options.merge(host_options.delete('CONFIG'))
-        end
+        host_options = host_options.merge(host_options.delete('CONFIG')) if host_options.has_key?('CONFIG')
         host_options
       end
 
@@ -92,7 +92,7 @@ module Beaker
       # @param [String] error_message Message to print if {::Psych::SyntaxError}
       #   is raised during block execution
       # @return [OptionsHash] Updated host_options with host info merged
-      def self.merge_hosts_yaml( host_options, error_message )
+      def self.merge_hosts_yaml(host_options, error_message)
         begin
           loaded_host_options = yield
         rescue Psych::SyntaxError => e
@@ -100,7 +100,7 @@ module Beaker
           raise ArgumentError, error_message
         end
 
-        host_options.merge( loaded_host_options )
+        host_options.merge(loaded_host_options)
       end
 
       # A helper to parse the YAML file and apply ERB templating
@@ -109,16 +109,8 @@ module Beaker
       # @param [Binding] b The binding to pass to ERB rendering
       # @api private
       def self.process_yaml(template, b)
-        erb_obj = if RUBY_VERSION >= '2.7'
-                     ERB.new(template, trim_mode: '-')
-                   else
-                     ERB.new(template, nil, '-')
-                   end
-        if RUBY_VERSION >= '2.6'
-          YAML.safe_load(erb_obj.result(b), permitted_classes: PERMITTED_YAML_CLASSES, aliases: true)
-        else
-          YAML.load(erb_obj.result(b)) # rubocop:disable Security/YAMLLoad
-        end
+        erb_obj = ERB.new(template, trim_mode: '-')
+        YAML.safe_load(erb_obj.result(b), permitted_classes: PERMITTED_YAML_CLASSES, aliases: true)
       end
     end
   end

data/lib/beaker/options/options_file_parser.rb

@@ -1,9 +1,8 @@
 require 'open-uri'
 module Beaker
   module Options
-    #A set of functions to read options files
+    # A set of functions to read options files
     module OptionsFileParser
-
       # Eval the contents of options_file_path, return as an OptionsHash
       #
       # Options file is assumed to contain extra options stored in a Hash
@@ -28,9 +27,8 @@ module Beaker
         result = Beaker::Options::OptionsHash.new
         if options_file_path
           options_file_path = File.expand_path(options_file_path)
-          unless File.exist?(options_file_path)
-            raise ArgumentError, "Specified options file '#{options_file_path}' does not exist!"
-          end
+          raise ArgumentError, "Specified options file '#{options_file_path}' does not exist!" unless File.exist?(options_file_path)
+
           # This eval will allow the specified options file to have access to our
           #  scope.  It is important that the variable 'options_file_path' is
           #  accessible, because some existing options files (e.g. puppetdb) rely on
@@ -39,7 +37,6 @@ module Beaker
         end
         result
       end
-
     end
   end
 end

data/lib/beaker/options/options_hash.rb

@@ -2,11 +2,9 @@ require 'stringify-hash'
 
 module Beaker
   module Options
-
     # A hash that treats Symbol and String keys interchangeably
     # and recursively merges hashes
     class OptionsHash < StringifyHash
-
       # Determine if type of ObjectHash is pe, defaults to true
       #
       # @example Use this method to test if the :type setting is pe
@@ -38,12 +36,9 @@ module Beaker
 
       def dump_to_file(output_file)
         dirname = File.dirname(output_file)
-        unless File.directory?(dirname)
-          FileUtils.mkdir_p(dirname)
-        end
-        File.open(output_file, 'w+') { |f| f.write(dump)  }
+        FileUtils.mkdir_p(dirname) unless File.directory?(dirname)
+        File.write(output_file, dump)
       end
-
     end
   end
 end