beaker 4.39.0 → 5.1.0

data/lib/beaker/options/parser.rb

@@ -2,18 +2,18 @@ require 'yaml'
 
 module Beaker
   module Options
-    #An Object that parses, merges and normalizes all supported Beaker options and arguments
+    # An Object that parses, merges and normalizes all supported Beaker options and arguments
     class Parser
       GITREPO      = 'git://github.com/puppetlabs'
-      #These options can have the form of arg1,arg2 or [arg] or just arg,
-      #should default to []
-      LONG_OPTS    = [:helper, :load_path, :tests, :pre_suite, :post_suite, :install, :pre_cleanup, :modules]
-      #These options expand out into an array of .rb files
-      RB_FILE_OPTS = [:tests, :pre_suite, :post_suite, :pre_cleanup]
+      # These options can have the form of arg1,arg2 or [arg] or just arg,
+      # should default to []
+      LONG_OPTS    = %i[helper load_path tests pre_suite post_suite install pre_cleanup modules]
+      # These options expand out into an array of .rb files
+      RB_FILE_OPTS = %i[tests pre_suite post_suite pre_cleanup]
 
       PARSE_ERROR = Psych::SyntaxError
 
-      #The OptionsHash of all parsed options
+      # The OptionsHash of all parsed options
       attr_accessor :options
       attr_reader :attribution
 
@@ -68,10 +68,10 @@ module Beaker
             path_files = []
             if File.file?(root)
               path_files << root
-            elsif File.directory?(root) #expand and explore
+            elsif File.directory?(root) # expand and explore
               path_files = Dir.glob(File.join(root, '**/*.rb'))
-                               .select { |f| File.file?(f) }
-                               .sort_by { |file| [file.count('/'), file] }
+                              .select { |f| File.file?(f) }
+                              .sort_by { |file| [file.count('/'), file] }
             end
 
             @validator.validate_files(path_files, root)
@@ -91,51 +91,51 @@ module Beaker
       # @return nil
       # @api public
       def resolve_symlinks!
-        if @options[:hosts_file] && !@options[:hosts_file_generated]
-          @options[:hosts_file] = File.realpath(@options[:hosts_file])
-        end
+        return unless @options[:hosts_file] && !@options[:hosts_file_generated]
+
+        @options[:hosts_file] = File.realpath(@options[:hosts_file])
       end
 
-      #Converts array of paths into array of fully qualified git repo URLS with expanded keywords
+      # Converts array of paths into array of fully qualified git repo URLS with expanded keywords
       #
-      #Supports the following keywords
+      # Supports the following keywords
       #  PUPPET
       #  FACTER
       #  HIERA
       #  HIERA-PUPPET
-      #@example
+      # @example
       #  opts = ["PUPPET/3.1"]
       #  parse_git_repos(opts) == ["#{GITREPO}/puppet.git#3.1"]
-      #@param [Array] git_opts An array of paths
-      #@return [Array] An array of fully qualified git repo URLs with expanded keywords
+      # @param [Array] git_opts An array of paths
+      # @return [Array] An array of fully qualified git repo URLs with expanded keywords
       def parse_git_repos(git_opts)
-        git_opts.map! { |opt|
+        git_opts.map! do |opt|
           case opt
-            when /^PUPPET\//
-              opt = "#{repo}/puppet.git##{opt.split('/', 2)[1]}"
-            when /^FACTER\//
-              opt = "#{repo}/facter.git##{opt.split('/', 2)[1]}"
-            when /^HIERA\//
-              opt = "#{repo}/hiera.git##{opt.split('/', 2)[1]}"
-            when /^HIERA-PUPPET\//
-              opt = "#{repo}/hiera-puppet.git##{opt.split('/', 2)[1]}"
+          when /^PUPPET\//
+            opt = "#{repo}/puppet.git##{opt.split('/', 2)[1]}"
+          when /^FACTER\//
+            opt = "#{repo}/facter.git##{opt.split('/', 2)[1]}"
+          when /^HIERA\//
+            opt = "#{repo}/hiera.git##{opt.split('/', 2)[1]}"
+          when /^HIERA-PUPPET\//
+            opt = "#{repo}/hiera-puppet.git##{opt.split('/', 2)[1]}"
           end
           opt
-        }
+        end
         git_opts
       end
 
-      #Add the 'default' role to the host determined to be the default.  If a host already has the role default then
-      #do nothing.  If more than a single host has the role 'default', raise error.
-      #Default host determined to be 1) the only host in a single host configuration, 2) the host with the role 'master'
-      #defined.
-      #@param [Hash] hosts A hash of hosts, each identified by a String name.  Each named host will have an Array of roles
+      # Add the 'default' role to the host determined to be the default.  If a host already has the role default then
+      # do nothing.  If more than a single host has the role 'default', raise error.
+      # Default host determined to be 1) the only host in a single host configuration, 2) the host with the role 'master'
+      # defined.
+      # @param [Hash] hosts A hash of hosts, each identified by a String name.  Each named host will have an Array of roles
       def set_default_host!(hosts)
         default           = []
         master            = []
         default_host_name = nil
 
-        #look through the hosts and find any hosts with role 'default' and any hosts with role 'master'
+        # look through the hosts and find any hosts with role 'default' and any hosts with role 'master'
         hosts.each_key do |name|
           host = hosts[name]
           if host[:roles].include?('default')
@@ -147,20 +147,20 @@ module Beaker
 
         # default_set? will throw an error if length > 1
         # and return false if no default is set.
-        if !@validator.default_set?(default)
-          #no default set, let's make one
-          if not master.empty? and master.length == 1
-            default_host_name = master[0]
-          elsif hosts.length == 1
-            default_host_name = hosts.keys[0]
-          end
-          if default_host_name
-            hosts[default_host_name][:roles] << 'default'
-          end
+        return if @validator.default_set?(default)
+
+        # no default set, let's make one
+        if not master.empty? and master.length == 1
+          default_host_name = master[0]
+        elsif hosts.length == 1
+          default_host_name = hosts.keys[0]
         end
+        return unless default_host_name
+
+        hosts[default_host_name][:roles] << 'default'
       end
 
-      #Constructor for Parser
+      # Constructor for Parser
       #
       def initialize
         @command_line_parser = Beaker::Options::CommandLineParser.new
@@ -177,16 +177,16 @@ module Beaker
       def tag_sources(options_hash, source)
         hash = Beaker::Options::OptionsHash.new
         options_hash.each do |key, value|
-          if value.is_a?(Hash)
-            hash[key] = tag_sources(value, source)
-          else
-            hash[key] = source
-          end
+          hash[key] = if value.is_a?(Hash)
+                        tag_sources(value, source)
+                      else
+                        source
+                      end
         end
         hash
       end
 
-      # Update the @option hash with a value and the @attribution hash with a source
+      #  Update the @option hash with a value and the @attribution hash with a source
       #
       # @param [String] key The key to update in both hashes
       # @param [Object] value The value to set in the @options hash
@@ -212,7 +212,7 @@ module Beaker
       # @param [Array] args ARGV or a provided arguments array
       # @raise [ArgumentError] Raises error on bad input
       def parse_args(args = ARGV)
-        @options                        = @presets.presets
+        @options = @presets.presets
         @attribution = @attribution.merge(tag_sources(@presets.presets, "preset"))
         cmd_line_options                = @command_line_parser.parse(args)
         cmd_line_options[:command_line] = ([$0] + args).join(' ')
@@ -224,7 +224,7 @@ module Beaker
         subcommand_options_file = Beaker::Subcommands::SubcommandUtil::SUBCOMMAND_OPTIONS
         {
           "project" => ".beaker.yml",
-          "homedir" => "#{ENV['HOME']}/#{subcommand_options_file}",
+          "homedir" => "#{ENV.fetch('HOME', nil)}/#{subcommand_options_file}",
           "subcommand" => subcommand_options_file,
         }.each_pair do |src, path|
           opts = if src == "project"
@@ -236,7 +236,7 @@ module Beaker
           @options.merge!(opts)
         end
 
-        file_options                    = Beaker::Options::OptionsFileParser.parse_options_file(cmd_line_options[:options_file] || options[:options_file])
+        file_options = Beaker::Options::OptionsFileParser.parse_options_file(cmd_line_options[:options_file] || options[:options_file])
         @attribution = @attribution.merge(tag_sources(file_options, "options_file"))
 
         # merge together command line and file_options
@@ -252,17 +252,17 @@ module Beaker
 
           # merge in host file vars
           #   overwrite options (default, file options, command line) with host file options
-          @options      = @options.merge(hosts_options)
+          @options = @options.merge(hosts_options)
           @attribution = @attribution.merge(tag_sources(hosts_options, "host_file"))
 
           # re-merge the command line options
           #   overwrite options (default, file options, hosts file ) with command line arguments
-          @options      = @options.merge(cmd_line_options)
+          @options = @options.merge(cmd_line_options)
           @attribution = @attribution.merge(tag_sources(cmd_line_options, "cmd"))
 
           # merge in env vars
           #   overwrite options (default, file options, command line, hosts file) with env
-          env_vars      = @presets.env_vars
+          env_vars = @presets.env_vars
 
           @options = @options.merge(env_vars)
           @attribution = @attribution.merge(tag_sources(env_vars, "env"))
@@ -282,7 +282,7 @@ module Beaker
       #   be read by the HostsFileParser
       def parse_hosts_options
         if @options[:hosts_file].nil? || File.exist?(@options[:hosts_file])
-          #read the hosts file that contains the node configuration and hypervisor info
+          # read the hosts file that contains the node configuration and hypervisor info
           return Beaker::Options::HostsFileParser.parse_hosts_file(@options[:hosts_file])
         end
 
@@ -291,14 +291,13 @@ module Beaker
         $stdout.puts dne_message
         require 'beaker-hostgenerator'
 
-        host_generator_options = [ @options[:hosts_file] ]
-        host_generator_options += [ '--hypervisor', ENV['BEAKER_HYPERVISOR'] ] if ENV['BEAKER_HYPERVISOR']
+        host_generator_options = [@options[:hosts_file]]
+        host_generator_options += ['--hypervisor', ENV['BEAKER_HYPERVISOR']] if ENV['BEAKER_HYPERVISOR']
 
         hosts_file_content = begin
           bhg_cli = BeakerHostGenerator::CLI.new(host_generator_options)
           bhg_cli.execute
-        rescue BeakerHostGenerator::Exceptions::Error,
-          BeakerHostGenerator::Exceptions::InvalidNodeSpecError => e
+        rescue BeakerHostGenerator::Exceptions::Error => e
           error_message = "\nbeaker-hostgenerator was not able to use this value as input."
           error_message << "\nExiting with an Error.\n\n"
           $stderr.puts error_message
@@ -306,12 +305,12 @@ module Beaker
         end
 
         @options[:hosts_file_generated] = true
-        Beaker::Options::HostsFileParser.parse_hosts_string( hosts_file_content )
+        Beaker::Options::HostsFileParser.parse_hosts_string(hosts_file_content)
       end
 
-      #Validate all merged options values for correctness
+      # Validate all merged options values for correctness
       #
-      #Currently checks:
+      # Currently checks:
       #  - each host has a valid platform
       #  - if a keyfile is provided then use it
       #  - paths provided to --test, --pre-suite, --post-suite provided lists of .rb files for testing
@@ -323,30 +322,23 @@ module Beaker
       #  - sets the default host based upon machine definitions
       #  - if an ssh user has been defined make it the host user
       #
-      #@raise [ArgumentError] Raise if argument/options values are invalid
+      # @raise [ArgumentError] Raise if argument/options values are invalid
       def normalize_args
-
         @options['HOSTS'].each_key do |name|
           @validator.validate_platform(@options['HOSTS'][name], name)
           @options['HOSTS'][name]['platform'] = Platform.new(@options['HOSTS'][name]['platform'])
         end
 
-        #use the keyfile if present
-        if @options.has_key?(:keyfile)
-          @options[:ssh][:keys] = [@options[:keyfile]]
-        end
+        # use the keyfile if present
+        @options[:ssh][:keys] = [@options[:keyfile]] if @options.has_key?(:keyfile)
 
-        #split out arguments - these arguments can have the form of arg1,arg2 or [arg] or just arg
-        #will end up being normalized into an array
+        # split out arguments - these arguments can have the form of arg1,arg2 or [arg] or just arg
+        # will end up being normalized into an array
         LONG_OPTS.each do |opt|
           if @options.has_key?(opt)
             update_option(opt, split_arg(@options[opt]), 'runtime')
-            if RB_FILE_OPTS.include?(opt) && (not @options[opt] == [])
-              update_option(opt, file_list(@options[opt]), 'runtime')
-            end
-            if opt == :install
-              update_option(:install, parse_git_repos(@options[:install]), 'runtime')
-            end
+            update_option(opt, file_list(@options[opt]), 'runtime') if RB_FILE_OPTS.include?(opt) && (not @options[opt] == [])
+            update_option(:install, parse_git_repos(@options[:install]), 'runtime') if opt == :install
           else
             update_option(opt, [], 'runtime')
           end
@@ -355,13 +347,13 @@ module Beaker
         @validator.validate_fail_mode(@options[:fail_mode])
         @validator.validate_preserve_hosts(@options[:preserve_hosts])
 
-        #check for config files necessary for different hypervisors
+        # check for config files necessary for different hypervisors
         hypervisors = get_hypervisors(@options[:HOSTS])
         hypervisors.each do |visor|
           check_hypervisor_config(visor)
         end
 
-        #check that roles of hosts make sense
+        # check that roles of hosts make sense
         # - must be one and only one master
         master = 0
         roles  = get_roles(@options[:HOSTS])
@@ -372,17 +364,13 @@ module Beaker
 
         @validator.validate_master_count(master)
 
-        #check that windows/el-4 boxes are only agents (solaris can be a master in foss cases)
+        # check that windows/el-4 boxes are only agents (solaris can be a master in foss cases)
         @options[:HOSTS].each_key do |name|
           host = @options[:HOSTS][name]
-          if /windows|el-4/.match?(host[:platform])
-            test_host_roles(name, host)
-          end
+          test_host_roles(name, host) if /windows|el-4/.match?(host[:platform])
 
-          #check to see if a custom user account has been provided, if so use it
-          if host[:ssh] && host[:ssh][:user]
-            host[:user] = host[:ssh][:user]
-          end
+          # check to see if a custom user account has been provided, if so use it
+          host[:user] = host[:ssh][:user] if host[:ssh] && host[:ssh][:user]
 
           # merge host tags for this host with the global/preset host tags
           host[:host_tags] = @options[:host_tags].merge(host[:host_tags] || {})
@@ -392,13 +380,12 @@ module Beaker
         @validator.validate_test_tags(
           @options[:test_tag_and],
           @options[:test_tag_or],
-          @options[:test_tag_exclude]
+          @options[:test_tag_exclude],
         )
         resolve_symlinks!
 
-        #set the default role
+        # set the default role
         set_default_host!(@options[:HOSTS])
-
       end
 
       # Get an array containing lists of roles by parsing each host in hosts.
@@ -429,13 +416,11 @@ module Beaker
       # @return [nil] no return
       # @raise [ArgumentError] Raises error if config file does not exist or is not valid YAML
       def check_hypervisor_config(visor)
-        if ['blimpy'].include?(visor)
-          @validator.check_yaml_file(@options[:ec2_yaml], "required by #{visor}")
-        end
+        @validator.check_yaml_file(@options[:ec2_yaml], "required by #{visor}") if ['blimpy'].include?(visor)
 
-        if %w(aix solaris vcloud).include?(visor)
-          @validator.check_yaml_file(@options[:dot_fog], "required by #{visor}")
-        end
+        return unless %w(aix solaris vcloud).include?(visor)
+
+        @validator.check_yaml_file(@options[:dot_fog], "required by #{visor}")
       end
 
       # Normalize include and exclude tags. This modifies @options.
@@ -460,11 +445,10 @@ module Beaker
       def test_host_roles(host_name, host_hash)
         exclude_roles = %w(master database dashboard)
         host_roles    = host_hash[:roles]
-        unless (host_roles & exclude_roles).empty?
-          @validator.parser_error "#{host_hash[:platform]} box '#{host_name}' may not have roles: #{exclude_roles.join(', ')}."
-        end
-      end
+        return if (host_roles & exclude_roles).empty?
 
+        @validator.parser_error "#{host_hash[:platform]} box '#{host_name}' may not have roles: #{exclude_roles.join(', ')}."
+      end
     end
   end
 end