beaker 4.38.1 → 5.0.0

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

@@ -11,7 +11,7 @@ module Unix::Exec
   # @param [Integer] uptime_retries How many times to check to see if the value of the uptime has reset.
   #
   # Will throw an exception RebootFailure if it fails
-  def reboot(wait_time=10, max_connection_tries=9, uptime_retries=18)
+  def reboot(wait_time = 10, max_connection_tries = 9, uptime_retries = 18)
     require 'time'
 
     attempts = 0
@@ -30,7 +30,7 @@ module Unix::Exec
       # Number of seconds to sleep before rebooting.
       reboot_sleep = 1
 
-      original_boot_time_str = exec(Beaker::Command.new(boot_time_cmd), {:max_connection_tries => max_connection_tries, :silent => true}).stdout
+      original_boot_time_str = exec(Beaker::Command.new(boot_time_cmd), { :max_connection_tries => max_connection_tries, :silent => true }).stdout
       original_boot_time_line = original_boot_time_str.lines.grep(/boot/).first
 
       raise Beaker::Host::RebootWarning, "Could not find system boot time using '#{boot_time_cmd}': '#{original_boot_time_str}'" unless original_boot_time_line
@@ -41,9 +41,7 @@ module Unix::Exec
 
       original_boot_time = Time.parse(original_boot_time_matches.first)
 
-      unless original_boot_time_matches.last
-        reboot_sleep = (61 - Time.now.strftime("%S").to_i)
-      end
+      reboot_sleep = (61 - Time.now.strftime("%S").to_i) unless original_boot_time_matches.last
 
       @logger.notify("Sleeping #{reboot_sleep} seconds before rebooting")
 
@@ -54,14 +52,16 @@ module Unix::Exec
       raise Beaker::Host::RebootFailure, "Unable to parse time: #{e.message}"
     rescue Beaker::Host::RebootWarning => e
       raise if attempts > uptime_retries
+
       @logger.warn(e.message)
       @logger.warn("Retrying #{uptime_retries - attempts} more times.")
       retry
     rescue StandardError => e
       raise if attempts > uptime_retries
+
       @logger.warn("Unexpected Exception: #{e.message}")
       @logger.warn("Retrying #{uptime_retries - attempts} more times.")
-      @logger.warn(e.backtrace[0,3].join("\n"))
+      @logger.warn(e.backtrace[0, 3].join("\n"))
       @logger.debug(e.backtrace.join("\n"))
       retry
     end
@@ -75,7 +75,7 @@ module Unix::Exec
       sleep wait_time
 
       # Accept all exit codes because this may fail due to the parallel nature of systemd
-      current_boot_time_str = exec(Beaker::Command.new(boot_time_cmd), {:max_connection_tries => max_connection_tries, :silent => true, :accept_all_exit_codes => true}).stdout
+      current_boot_time_str = exec(Beaker::Command.new(boot_time_cmd), { :max_connection_tries => max_connection_tries, :silent => true, :accept_all_exit_codes => true }).stdout
       current_boot_time_line = current_boot_time_str.lines.grep(/boot/).first
 
       raise Beaker::Host::RebootWarning, "Could not find system boot time using '#{boot_time_cmd}': '#{current_boot_time_str}'" unless current_boot_time_line
@@ -90,33 +90,33 @@ module Unix::Exec
       @logger.debug("Current Boot Time: #{current_boot_time}")
 
       # If this is *exactly* the same then there is really no good way to detect a reboot
-      if current_boot_time == original_boot_time
-        raise Beaker::Host::RebootFailure, "Boot time did not reset. Reboot appears to have failed."
-      end
+      raise Beaker::Host::RebootFailure, "Boot time did not reset. Reboot appears to have failed." if current_boot_time == original_boot_time
     rescue ArgumentError => e
       raise Beaker::Host::RebootFailure, "Unable to parse time: #{e.message}"
     rescue Beaker::Host::RebootFailure => e
       raise
     rescue Beaker::Host::RebootWarning => e
       raise if attempts > uptime_retries
+
       @logger.warn(e.message)
       @logger.warn("Retrying #{uptime_retries - attempts} more times.")
       retry
     rescue StandardError => e
       raise if attempts > uptime_retries
+
       @logger.warn("Unexpected Exception: #{e.message}")
       @logger.warn("Retrying #{uptime_retries - attempts} more times.")
-      @logger.warn(e.backtrace[0,3].join("\n"))
+      @logger.warn(e.backtrace[0, 3].join("\n"))
       @logger.debug(e.backtrace.join("\n"))
       retry
     end
   end
 
-  def echo(msg, abs=true)
+  def echo(msg, abs = true)
     (abs ? '/bin/echo' : 'echo') + " #{msg}"
   end
 
-  def touch(file, abs=true)
+  def touch(file, abs = true)
     (abs ? '/bin/touch' : 'touch') + " #{file}"
   end
 
@@ -163,7 +163,7 @@ module Unix::Exec
   # @param [String] orig The origin path
   # @param [String] dest the destination path
   # @param [Boolean] rm Remove the destination prior to move
-  def mv orig, dest, rm=true
+  def mv orig, dest, rm = true
     rm_rf dest unless !rm
     execute("mv #{orig} #{dest}")
   end
@@ -172,14 +172,13 @@ module Unix::Exec
   # @param [String] target The hostname to ping
   # @param [Integer] attempts Amount of times to attempt ping before giving up
   # @return [Boolean] true of ping successful, overwise false
-  def ping target, attempts=5
+  def ping target, attempts = 5
     try = 0
-    while try < attempts do
+    while try < attempts
       result = exec(Beaker::Command.new("ping -c 1 #{target}"), :accept_all_exit_codes => true)
-      if result.exit_code == 0
-        return true
-      end
-      try+=1
+      return true if result.exit_code == 0
+
+      try += 1
     end
     result.exit_code == 0
   end
@@ -188,88 +187,89 @@ module Unix::Exec
   # This is for sles based hosts.
   # @param [String] env_file The ssh environment file to read from
   def mirror_env_to_profile_d env_file
-    if self[:platform] =~ /opensuse|sles-/
+    if /opensuse|sles-/.match?(self[:platform])
       @logger.debug("mirroring environment to /etc/profile.d on opensuse/sles platform host")
       cur_env = exec(Beaker::Command.new("cat #{env_file}")).stdout
       shell_env = ''
       cur_env.each_line do |env_line|
         shell_env << "export #{env_line}"
       end
-      #here doc it over
+      # here doc it over
       exec(Beaker::Command.new("cat << EOF > #{self[:profile_d_env_file]}\n#{shell_env}EOF"))
-      #set permissions
+      # set permissions
       exec(Beaker::Command.new("chmod +x #{self[:profile_d_env_file]}"))
-      #keep it current
+      # keep it current
       exec(Beaker::Command.new("source #{self[:profile_d_env_file]}"))
     else
-      #noop
+      # noop
       @logger.debug("will not mirror environment to /etc/profile.d on non-sles platform host")
     end
   end
 
-  #Add the provided key/val to the current ssh environment
-  #@param [String] key The key to add the value to
-  #@param [String] val The value for the key
-  #@example
+  # Add the provided key/val to the current ssh environment
+  # @param [String] key The key to add the value to
+  # @param [String] val The value for the key
+  # @example
   #  host.add_env_var('PATH', '/usr/bin:PATH')
   def add_env_var key, val
     key = key.to_s
     env_file = self[:ssh_env_file]
     escaped_val = Regexp.escape(val).gsub('/', '\/').gsub(';', '\;')
-    #see if the key/value pair already exists
-    if exec(Beaker::Command.new("grep ^#{key}=.*#{escaped_val} #{env_file}"), :accept_all_exit_codes => true ).exit_code == 0
-      return #nothing to do here, key value pair already exists
-    #see if the key already exists
-    elsif exec(Beaker::Command.new("grep ^#{key}= #{env_file}"), :accept_all_exit_codes => true ).exit_code == 0
+    # see if the key/value pair already exists
+    if exec(Beaker::Command.new("grep ^#{key}=.*#{escaped_val} #{env_file}"), :accept_all_exit_codes => true).exit_code == 0
+      return # nothing to do here, key value pair already exists
+    # see if the key already exists
+    elsif exec(Beaker::Command.new("grep ^#{key}= #{env_file}"), :accept_all_exit_codes => true).exit_code == 0
       exec(Beaker::SedCommand.new(self['platform'], "s/^#{key}=/#{key}=#{escaped_val}:/", env_file))
     else
       exec(Beaker::Command.new("echo \"#{key}=#{val}\" >> #{env_file}"))
     end
-    #update the profile.d to current state
-    #match it to the contents of ssh_env_file
+
+    # update the profile.d to current state
+    # match it to the contents of ssh_env_file
     mirror_env_to_profile_d(env_file)
   end
 
-  #Delete the provided key/val from the current ssh environment
-  #@param [String] key The key to delete the value from
-  #@param [String] val The value to delete for the key
-  #@example
+  # Delete the provided key/val from the current ssh environment
+  # @param [String] key The key to delete the value from
+  # @param [String] val The value to delete for the key
+  # @example
   #  host.delete_env_var('PATH', '/usr/bin:PATH')
   def delete_env_var key, val
     key = key.to_s
     env_file = self[:ssh_env_file]
     val = Regexp.escape(val).gsub('/', '\/').gsub(';', '\;')
-    #if the key only has that single value remove the entire line
+    # if the key only has that single value remove the entire line
     exec(Beaker::SedCommand.new(self['platform'], "/#{key}=#{val}$/d", env_file))
-    #value in middle of list
+    # value in middle of list
     exec(Beaker::SedCommand.new(self['platform'], "s/#{key}=\\(.*\\)[;:]#{val}/#{key}=\\1/", env_file))
-    #value in start of list
+    # value in start of list
     exec(Beaker::SedCommand.new(self['platform'], "s/#{key}=#{val}[;:]/#{key}=/", env_file))
-    #update the profile.d to current state
-    #match it to the contents of ssh_env_file
+    # update the profile.d to current state
+    # match it to the contents of ssh_env_file
     mirror_env_to_profile_d(env_file)
   end
 
-  #Return the value of a specific env var
-  #@param [String] key The key to look for
-  #@example
+  # Return the value of a specific env var
+  # @param [String] key The key to look for
+  # @example
   #  host.get_env_var('path')
   def get_env_var key
     key = key.to_s
     exec(Beaker::Command.new("env | grep ^#{key}="), :accept_all_exit_codes => true).stdout.chomp
   end
 
-  #Delete the environment variable from the current ssh environment
-  #@param [String] key The key to delete
-  #@example
+  # Delete the environment variable from the current ssh environment
+  # @param [String] key The key to delete
+  # @example
   #  host.clear_env_var('PATH')
   def clear_env_var key
     key = key.to_s
     env_file = self[:ssh_env_file]
-    #remove entire line
+    # remove entire line
     exec(Beaker::SedCommand.new(self['platform'], "/^#{key}=.*$/d", env_file))
-    #update the profile.d to current state
-    #match it to the contents of ssh_env_file
+    # update the profile.d to current state
+    # match it to the contents of ssh_env_file
     mirror_env_to_profile_d(env_file)
   end
 
@@ -303,17 +303,17 @@ module Unix::Exec
   def ssh_permit_user_environment
     case self['platform']
     when /debian|ubuntu|cumulus|huaweios|archlinux|el-|centos|fedora|redhat|oracle|scientific|eos|opensuse|sles|solaris/
-      directory = tmpdir()
+      directory = tmpdir
       exec(Beaker::Command.new("echo 'PermitUserEnvironment yes' | cat - /etc/ssh/sshd_config > #{directory}/sshd_config.permit"))
       exec(Beaker::Command.new("mv #{directory}/sshd_config.permit /etc/ssh/sshd_config"))
-      exec(Beaker::Command.new("echo '' >/etc/environment")) if self['platform'] =~ /ubuntu-2(0|2).04/
+      exec(Beaker::Command.new("echo '' >/etc/environment")) if /ubuntu-2(0|2).04/.match?(self['platform'])
     when /(free|open)bsd/
-      exec(Beaker::Command.new("sudo perl -pi -e 's/^#?PermitUserEnvironment no/PermitUserEnvironment yes/' /etc/ssh/sshd_config"), {:pty => true} )
+      exec(Beaker::Command.new("sudo perl -pi -e 's/^#?PermitUserEnvironment no/PermitUserEnvironment yes/' /etc/ssh/sshd_config"), { :pty => true })
     else
       raise ArgumentError, "Unsupported Platform: '#{self['platform']}'"
     end
 
-    ssh_service_restart()
+    ssh_service_restart
   end
 
   # Construct the environment string for this command
@@ -329,7 +329,8 @@ module Unix::Exec
   #                  given host.
   def environment_string env
     return '' if env.empty?
-    env_array = self.environment_variable_string_pair_array( env )
+
+    env_array = self.environment_variable_string_pair_array(env)
     environment_string = env_array.join(' ')
     "env #{environment_string}"
   end
@@ -338,11 +339,11 @@ module Unix::Exec
     env_array = []
     env.each_key do |key|
       val = env[key]
-      if val.is_a?(Array)
-        val = val.join(':')
-      else
-        val = val.to_s
-      end
+      val = if val.is_a?(Array)
+              val.join(':')
+            else
+              val.to_s
+            end
       # doing this for the key itself & the upcase'd version allows us to remain
       # backwards compatible
       # TODO: (Next Major Version) get rid of upcase'd version
@@ -363,7 +364,7 @@ module Unix::Exec
   # @param [Hash] opts optional parameters
   #
   # @return [String] Command string as needed for this host
-  def prepend_commands(command = '', user_pc = '', opts = {})
+  def prepend_commands(_command = '', user_pc = '', _opts = {})
     user_pc
   end
 
@@ -374,7 +375,7 @@ module Unix::Exec
   # @param [Hash] opts optional parameters
   #
   # @return [String] Command string as needed for this host
-  def append_commands(command = '', user_ac = '', opts = {})
+  def append_commands(_command = '', user_ac = '', _opts = {})
     user_ac
   end
 
@@ -387,44 +388,42 @@ module Unix::Exec
   # @api private
   # @return nil
   def ssh_set_user_environment(env)
-    #ensure that ~/.ssh/environment exists
+    # ensure that ~/.ssh/environment exists
     ssh_env_file_dir = Pathname.new(self[:ssh_env_file]).dirname
     mkdir_p(ssh_env_file_dir)
     exec(Beaker::Command.new("chmod 0600 #{ssh_env_file_dir}"))
     exec(Beaker::Command.new("touch #{self[:ssh_env_file]}"))
-    #add the constructed env vars to this host
+    # add the constructed env vars to this host
     add_env_var('PATH', '$PATH')
-    # FIXME
-    if self['platform'] =~ /openbsd-(\d)\.?(\d)-(.+)/
-      version = "#{$1}.#{$2}"
-      arch = $3
-      arch = 'amd64' if ['x64', 'x86_64'].include?(arch)
-      add_env_var('PKG_PATH', "http://ftp.openbsd.org/pub/OpenBSD/#{version}/packages/#{arch}/")
-    elsif self['platform'] =~ /solaris-10/
+    if self['platform'].variant == 'openbsd'
+      arch = self['platform'].arch
+      arch = 'amd64' if %w[x64 x86_64].include?(arch)
+      add_env_var('PKG_PATH', "http://ftp.openbsd.org/pub/OpenBSD/#{self['platform'].version}/packages/#{arch}/")
+    elsif self['platform'].include?('solaris-10')
       add_env_var('PATH', '/opt/csw/bin')
     end
 
-    #add the env var set to this test host
+    # add the env var set to this test host
     env.each_pair do |var, value|
       add_env_var(var, value)
     end
   end
 
-  # Checks if selinux is enabled
+  #  Checks if selinux is enabled
   #
   # @return [Boolean] true if selinux is enabled, false otherwise
-  def selinux_enabled?()
+  def selinux_enabled?
     exec(Beaker::Command.new("sudo selinuxenabled"), :accept_all_exit_codes => true).exit_code == 0
   end
 
   def enable_remote_rsyslog(server = 'rsyslog.ops.puppetlabs.net', port = 514)
-    if self['platform'] !~ /ubuntu/
+    if !self['platform'].include?('ubuntu')
       @logger.warn "Enabling rsyslog is only implemented for ubuntu hosts"
       return
     end
     commands = [
       "echo '*.* @#{server}:#{port}' >> /etc/rsyslog.d/51-sendrsyslogs.conf",
-      'systemctl restart rsyslog'
+      'systemctl restart rsyslog',
     ]
     commands.each do |command|
       exec(Beaker::Command.new(command))
@@ -432,21 +431,20 @@ module Unix::Exec
     true
   end
 
-  #First path it finds for the command executable
-  #@param [String] command The command executable to search for
+  # First path it finds for the command executable
+  # @param [String] command The command executable to search for
   #
   # @return [String] Path to the searched executable or empty string if not found
   #
-  #@example
+  # @example
   #  host.which('ruby')
   def which(command)
     unless @which_command
       if execute('type -P true', :accept_all_exit_codes => true).empty?
-        if execute('which true', :accept_all_exit_codes => true).empty?
-          raise ArgumentError, "Could not find suitable 'which' command"
-        else
-          @which_command = 'which'
-        end
+        raise ArgumentError, "Could not find suitable 'which' command" if execute('which true', :accept_all_exit_codes => true).empty?
+
+        @which_command = 'which'
+
       else
         @which_command = 'type -P'
       end

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

@@ -26,11 +26,11 @@ module Unix::File
   # @param [Boolean] recursive Whether to pass the recursive flag
   #
   # @return [Beaker::Result] result of command execution
-  def chown(user, path, recursive=false)
+  def chown(user, path, recursive = false)
     execute("chown #{recursive ? '-R ' : ''}#{user} #{path}")
   end
 
-  def chmod(mod, path, recursive=false)
+  def chmod(mod, path, recursive = false)
     execute("chmod #{recursive ? '-R ' : ''}#{mod} #{path}")
   end
 
@@ -43,7 +43,7 @@ module Unix::File
   # @param [Boolean] recursive Whether to pass the recursive flag
   #
   # @return [Beaker::Result] result of command execution
-  def chgrp(group, path, recursive=false)
+  def chgrp(group, path, recursive = false)
     execute("chgrp #{recursive ? '-R ' : ''}#{group} #{path}")
   end
 
@@ -110,13 +110,13 @@ module Unix::File
   # @return [String] Filename of the repo
   def repo_filename(package_name, build_version)
     variant, version, arch, codename = self['platform'].to_array
-    repo_filename = "pl-%s-%s-" % [ package_name, build_version ]
+    repo_filename = format("pl-%s-%s-", package_name, build_version)
 
     case variant
     when /fedora|el|redhat|centos|cisco_nexus|cisco_ios_xr|opensuse|sles/
-      variant = 'el' if ['centos', 'redhat'].include?(variant)
+      variant = 'el' if %w[centos redhat].include?(variant)
 
-      variant = 'redhatfips' if self['packaging_platform'] =~ /redhatfips/
+      variant = 'redhatfips' if self['packaging_platform']&.include?('redhatfips')
 
       if variant == 'cisco_nexus'
         variant = 'cisco-wrlinux'
@@ -126,19 +126,14 @@ module Unix::File
         variant = 'cisco-wrlinux'
         version = '7'
       end
-      fedora_prefix = ((variant == 'fedora') ? 'f' : '')
+      fedora_prefix = (variant == 'fedora' ? 'f' : '')
 
       pattern = "%s-%s%s-%s.repo"
 
-      repo_filename << pattern % [
-        variant,
-        fedora_prefix,
-        version,
-        arch
-      ]
+      repo_filename << (format(pattern, variant, fedora_prefix, version, arch))
     when /debian|ubuntu|cumulus|huaweios/
       codename = variant if variant == 'cumulus' || variant == 'huaweios'
-      repo_filename << "%s.list" % [ codename ]
+      repo_filename << (format("%s.list", codename))
     else
       msg = "#repo_filename: repo filename pattern not known for platform '#{self['platform']}'"
       raise ArgumentError, msg
@@ -170,38 +165,37 @@ module Unix::File
   #
   # @return [String] the text of the noask file
   def noask_file_text
-    variant, version, arch, codename = self['platform'].to_array
-    if variant == 'solaris' && version == '10'
-      noask = <<NOASK
-# Write the noask file to a temporary directory
-# please see man -s 4 admin for details about this file:
-# http://www.opensolarisforum.org/man/man4/admin.html
-#
-# The key thing we don't want to prompt for are conflicting files.
-# The other nocheck settings are mostly defensive to prevent prompts
-# We _do_ want to check for available free space and abort if there is
-# not enough
-mail=
-# Overwrite already installed instances
-instance=overwrite
-# Do not bother checking for partially installed packages
-partial=nocheck
-# Do not bother checking the runlevel
-runlevel=nocheck
-# Do not bother checking package dependencies (We take care of this)
-idepend=nocheck
-rdepend=nocheck
-# DO check for available free space and abort if there isn't enough
-space=quit
-# Do not check for setuid files.
-setuid=nocheck
-# Do not check if files conflict with other packages
-conflict=nocheck
-# We have no action scripts.  Do not check for them.
-action=nocheck
-# Install to the default base directory.
-basedir=default
-NOASK
+    if self['platform'].variant == 'solaris' && self['platform'].version == '10'
+      noask = <<~NOASK
+        # Write the noask file to a temporary directory
+        # please see man -s 4 admin for details about this file:
+        # http://www.opensolarisforum.org/man/man4/admin.html
+        #
+        # The key thing we don't want to prompt for are conflicting files.
+        # The other nocheck settings are mostly defensive to prevent prompts
+        # We _do_ want to check for available free space and abort if there is
+        # not enough
+        mail=
+        # Overwrite already installed instances
+        instance=overwrite
+        # Do not bother checking for partially installed packages
+        partial=nocheck
+        # Do not bother checking the runlevel
+        runlevel=nocheck
+        # Do not bother checking package dependencies (We take care of this)
+        idepend=nocheck
+        rdepend=nocheck
+        # DO check for available free space and abort if there isn't enough
+        space=quit
+        # Do not check for setuid files.
+        setuid=nocheck
+        # Do not check if files conflict with other packages
+        conflict=nocheck
+        # We have no action scripts.  Do not check for them.
+        action=nocheck
+        # Install to the default base directory.
+        basedir=default
+      NOASK
     else
       msg = "noask file text unknown for platform '#{self['platform']}'"
       raise ArgumentError, msg
@@ -217,7 +211,7 @@ NOASK
   # @param [String] scp_file_target File path to target SCP location on host
   #
   # @return nil
-  def scp_post_operations(scp_file_actual, scp_file_target)
+  def scp_post_operations(_scp_file_actual, _scp_file_target)
     nil
   end
 end

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

@@ -1,7 +1,7 @@
 module Unix::Group
   include Beaker::CommandFactory
 
-  def group_list(&block)
+  def group_list
     execute("getent group") do |result|
       groups = []
       result.stdout.each_line do |line|
@@ -14,9 +14,9 @@ module Unix::Group
     end
   end
 
-  def group_get(name, &block)
+  def group_get(name)
     execute("getent group #{name}") do |result|
-      fail_test "failed to get group #{name}" unless result.stdout =~ /^#{name}:.*:[0-9]+:/
+      fail_test "failed to get group #{name}" unless /^#{name}:.*:[0-9]+:/.match?(result.stdout)
 
       yield result if block_given?
       result