beaker 4.38.1 → 5.0.0

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

@@ -1,11 +1,11 @@
 module Unix::User
   include Beaker::CommandFactory
 
-  def user_list(&block)
+  def user_list
     execute("getent passwd") do |result|
       users = []
       result.stdout.each_line do |line|
-        users << (line.match( /^([^:]+)/) or next)[1]
+        users << (line.match(/^([^:]+)/) or next)[1]
       end
 
       yield result if block_given?
@@ -14,9 +14,9 @@ module Unix::User
     end
   end
 
-  def user_get(name, &block)
+  def user_get(name)
     execute("getent passwd #{name}") do |result|
-      fail_test "failed to get user #{name}" unless result.stdout =~  /^#{name}:/
+      fail_test "failed to get user #{name}" unless /^#{name}:/.match?(result.stdout)
 
       yield result if block_given?
       result

data/lib/beaker/host/unix.rb

@@ -1,11 +1,11 @@
-[ 'host', 'command_factory', 'command', 'options' ].each do |lib|
-      require "beaker/#{lib}"
+%w[host command_factory command options].each do |lib|
+  require "beaker/#{lib}"
 end
 
 module Unix
   class Host < Beaker::Host
-    [ 'user', 'group', 'exec', 'pkg', 'file' ].each do |lib|
-          require "beaker/host/unix/#{lib}"
+    %w[user group exec pkg file].each do |lib|
+      require "beaker/host/unix/#{lib}"
     end
 
     include Unix::User
@@ -17,10 +17,10 @@ module Unix
     def platform_defaults
       h = Beaker::Options::OptionsHash.new
       h.merge({
-        'user'             => 'root',
-        'group'            => 'root',
-        'pathseparator'    => ':',
-      })
+                'user' => 'root',
+                'group' => 'root',
+                'pathseparator' => ':',
+              })
     end
 
     # Determines which SSH Server is in use on this host
@@ -35,12 +35,14 @@ module Unix
     end
 
     def external_copy_base
-      return @external_copy_base if @external_copy_base
-      @external_copy_base = '/root'
-      variant, version, arch, codename = self['platform'].to_array
-      # Solaris 10 uses / as the root user directory. Solaris 11 uses /root (like most).
-      @external_copy_base = '/' if variant == 'solaris' && version == '10'
-      @external_copy_base
+      @external_copy_base ||= begin
+        if self['platform'].variant == 'solaris' && self['platform'].version == '10'
+          # Solaris 10 uses / as the root user directory. Solaris 11 uses /root (like most).
+          '/'
+        else
+          '/root'
+        end
+      end
     end
 
     # Tells you whether a host platform supports beaker's
@@ -49,12 +51,9 @@ module Unix
     # @return [String,nil] Reason message if set_env should be skipped,
     #   nil if it should run.
     def skip_set_env?
-      variant, version, arch, codename = self['platform'].to_array
-      case variant
+      case self['platform'].variant
       when /^(f5|netscaler)$/
-        "no puppet-agent package for network device platform '#{variant}'"
-      else
-        nil
+        "no puppet-agent package for network device platform '#{self['platform'].variant}'"
       end
     end
 
@@ -72,6 +71,5 @@ module Unix
 
       @external_copy_base = nil
     end
-
   end
 end

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

@@ -11,11 +11,11 @@ module Windows::Exec
   ABS_CMD = 'c:\\\\windows\\\\system32\\\\cmd.exe'
   CMD = 'cmd.exe'
 
-  def echo(msg, abs=true)
+  def echo(msg, abs = true)
     (abs ? ABS_CMD : CMD) + " /c echo #{msg}"
   end
 
-  def touch(file, abs=true)
+  def touch(file, abs = true)
     (abs ? ABS_CMD : CMD) + " /c echo. 2> #{file}"
   end
 
@@ -35,8 +35,10 @@ module Windows::Exec
     ips.each_line do |line|
       matches = line.split('=')
       next if matches.length <= 1
+
       matches = matches[1].match(/^{"(.*?)"/)
       next if matches.nil? || matches.captures.nil? || matches.captures.empty?
+
       ip = matches.captures[0] if matches && matches.captures
       break if ip != ''
     end
@@ -48,14 +50,13 @@ module Windows::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 -n 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
@@ -67,10 +68,10 @@ module Windows::Exec
     command_result = nil
     # we get periodic failures to restart the service, so looping these with re-attempts
     repeat_fibonacci_style_for(5) do
-      0 == exec(Beaker::Command.new("cygrunsrv -E sshd"), :acceptable_exit_codes => [0, 1] ).exit_code
+      0 == exec(Beaker::Command.new("cygrunsrv -E sshd"), :acceptable_exit_codes => [0, 1]).exit_code
     end
     repeat_fibonacci_style_for(5) do
-      command_result = exec(Beaker::Command.new("cygrunsrv -S sshd"), :acceptable_exit_codes => [0, 1] )
+      command_result = exec(Beaker::Command.new("cygrunsrv -S sshd"), :acceptable_exit_codes => [0, 1])
       0 == command_result.exit_code
     end
     command_result
@@ -83,7 +84,7 @@ module Windows::Exec
   #   (from {#ssh_service_restart}).
   def ssh_permit_user_environment
     exec(Beaker::Command.new("echo '\nPermitUserEnvironment yes' >> /etc/sshd_config"))
-    ssh_service_restart()
+    ssh_service_restart
   end
 
   # Gets the specific prepend commands as needed for this host
@@ -94,9 +95,9 @@ module Windows::Exec
   # @option opts [Boolean] :cmd_exe whether cmd.exe should be used
   #
   # @return [String] Command string as needed for this host
-  def prepend_commands(command = '', user_pc = nil, opts = {})
+  def prepend_commands(_command = '', user_pc = nil, opts = {})
     cygwin_prefix = (self.is_cygwin? and opts[:cmd_exe]) ? 'cmd.exe /c' : ''
-    spacing = (user_pc && !cygwin_prefix.empty?) ? ' ' : ''
+    spacing = user_pc && !cygwin_prefix.empty? ? ' ' : ''
     "#{cygwin_prefix}#{spacing}#{user_pc}"
   end
 
@@ -107,15 +108,15 @@ module Windows::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
 
-  # Checks if selinux is enabled
+  #  Checks if selinux is enabled
   # selinux is not available on Windows
   #
   # @return [Boolean] false
-  def selinux_enabled?()
+  def selinux_enabled?
     false
   end
 
@@ -138,20 +139,19 @@ module Windows::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
 
-
   # Determine if cygwin is actually installed on the SUT. Differs from
   # is_cygwin?, which is just a type check for a Windows::Host.
   #
   # @return [Boolean]
   def cygwin_installed?
     output = exec(Beaker::Command.new('cygcheck --check-setup cygwin'), :accept_all_exit_codes => true).stdout
-    return true if output.match(/cygwin/) && output.match(/OK/)
+    return true if output.include?('cygwin') && output.include?('OK')
+
     false
   end
-
 end

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

@@ -12,7 +12,7 @@ module Windows::File
   def system_temp_path
     # under CYGWIN %TEMP% may not be set
     tmp_path = execute('ECHO %SYSTEMROOT%', :cmdexe => true)
-    tmp_path.gsub(/\n/, '') + '\\TEMP'
+    tmp_path.delete("\n") + '\\TEMP'
   end
 
   # (see {Beaker::Host::Unix::File#chown})
@@ -20,7 +20,7 @@ module Windows::File
   #   windows-, DOS-, or mixed-style paths, only UNIX/POSIX-style.
   #   This method simply wraps the normal Host#chown call with
   #   a call to cygpath to sanitize input.
-  def chown(user, path, recursive=false)
+  def chown(user, path, recursive = false)
     cygpath = execute("cygpath -u #{path}")
     super(user, cygpath, recursive)
   end
@@ -30,13 +30,13 @@ module Windows::File
   #   windows-, DOS-, or mixed-style paths, only UNIX/POSIX-style.
   #   This method simply wraps the normal Host#chgrp call with
   #   a call to cygpath to sanitize input.
-  def chgrp(group, path, recursive=false)
+  def chgrp(group, path, recursive = false)
     cygpath = execute("cygpath -u #{path}")
     super(group, cygpath, recursive)
   end
 
   # Not needed on windows
-  def chmod(mod, path, recursive=false); end
+  def chmod(mod, path, recursive = false); end
 
   # (see {Beaker::Host::Unix::File#ls_ld})
   # @note Cygwin's `ls_ld` implementation does not support
@@ -63,7 +63,7 @@ module Windows::File
     when :openssh
       path
     when :win32_openssh
-      path.gsub('\\', '/')
+      path.tr('\\', '/')
     else
       raise ArgumentError, "windows/file.rb:scp_path: ssh server not recognized: '#{determine_ssh_server}'"
     end

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

@@ -1,7 +1,7 @@
 module Windows::Group
   include Beaker::CommandFactory
 
-  def group_list(&block)
+  def group_list
     execute('cmd /c echo "" | wmic group where localaccount="true" get name /format:value') do |result|
       groups = []
       result.stdout.each_line do |line|
@@ -14,7 +14,7 @@ module Windows::Group
     end
   end
 
-  def group_get(name, &block)
+  def group_get(name)
     execute("net localgroup \"#{name}\"") do |result|
       fail_test "failed to get group #{name}" if result.exit_code != 0
 
@@ -23,15 +23,15 @@ module Windows::Group
     end
   end
 
-  def group_gid(name)
+  def group_gid(_name)
     raise NotImplementedError, "Can't retrieve group gid on a Windows host"
   end
 
   def group_present(name, &block)
-    execute("net localgroup /add \"#{name}\"", {:acceptable_exit_codes => [0,2]}, &block)
+    execute("net localgroup /add \"#{name}\"", { :acceptable_exit_codes => [0, 2] }, &block)
   end
 
   def group_absent(name, &block)
-    execute("net localgroup /delete \"#{name}\"", {:acceptable_exit_codes => [0,2]}, &block)
+    execute("net localgroup /delete \"#{name}\"", { :acceptable_exit_codes => [0, 2] }, &block)
   end
 end

data/lib/beaker/host/windows/pkg.rb

@@ -17,7 +17,7 @@ module Windows::Pkg
     if arch == '64'
       rootdir = "c:\\\\cygwin64"
       cygwin = "setup-x86_64.exe"
-    else #32 bit version
+    else # 32 bit version
       rootdir = "c:\\\\cygwin"
       cygwin = "setup-x86.exe"
     end
@@ -25,71 +25,20 @@ module Windows::Pkg
     execute("#{cygwin} -q -n -N -d -R #{rootdir} -s http://cygwin.osuosl.org -P #{name} #{cmdline_args}")
   end
 
-  def uninstall_package(name, cmdline_args = '')
+  def uninstall_package(name, _cmdline_args = '')
     raise "Package #{name} cannot be uninstalled on #{self}"
   end
 
-  #Examine the host system to determine the architecture, overrides default host determine_if_x86_64 so that wmic is used
-  #@return [Boolean] true if x86_64, false otherwise
+  # Examine the host system to determine the architecture, overrides default host determine_if_x86_64 so that wmic is used
+  # @return [Boolean] true if x86_64, false otherwise
   def determine_if_x86_64
-    (identify_windows_architecture =~ /64/) == 0
-  end
-
-  # Gets the path & file name for the puppet agent dev package on Windows
-  #
-  # @param [String] puppet_collection Name of the puppet collection to use
-  # @param [String] puppet_agent_version Version of puppet agent to get
-  # @param [Hash{Symbol=>String}] opts Options hash to provide extra values
-  #
-  # @note Windows only uses the 'install_32' option of the opts hash at this
-  #   time. Note that it will not fail if not provided, however
-  #
-  # @return [String, String] Path to the directory and filename of the package, respectively
-  def puppet_agent_dev_package_info( puppet_collection = nil, puppet_agent_version = nil, opts = {} )
-    release_path_end = 'windows'
-    is_config_32 = self['ruby_arch'] == 'x86' || self['install_32'] || opts['install_32']
-    should_install_64bit = self.is_x86_64? && !is_config_32
-    # only install 64bit builds if
-    # - we do not have install_32 set on host
-    # - we do not have install_32 set globally
-    arch_suffix = should_install_64bit ? '64' : '86'
-    # If a version was specified, use it; otherwise fall back to a default name.
-    # Avoid when puppet_agent_version is set to a SHA, which isn't used in package names.
-    if puppet_agent_version =~ /^\d+\.\d+\.\d+/
-      release_file = "puppet-agent-#{puppet_agent_version}-x#{arch_suffix}.msi"
-    else
-      release_file = "puppet-agent-x#{arch_suffix}.msi"
-    end
-    return release_path_end, release_file
-  end
-
-  # Gets host-specific information for PE promoted puppet-agent packages
-  #
-  # @param [String] puppet_collection Name of the puppet collection to use
-  # @param [Hash{Symbol=>String}] opts Options hash to provide extra values
-  #
-  # @return [String, String, String] Host-specific information for packages
-  #   1. release_path_end Suffix for the release_path
-  #   2. release_file Path to the file on release build servers
-  #   3. download_file Filename for the package itself
-  def pe_puppet_agent_promoted_package_info( puppet_collection = nil, opts = {} )
-    is_config_32 = self['ruby_arch'] == 'x86' || self['install_32'] || self['install_32']
-    should_install_64bit = self.is_x86_64? && !is_config_32
-    # only install 64bit builds if
-    # - we do not have install_32 set on host
-    # - we do not have install_32 set globally
-    arch_suffix = should_install_64bit ? '64' : '86'
-    release_path_end = "/windows"
-    release_file = "/puppet-agent-x#{arch_suffix}.msi"
-    download_file = "puppet-agent-x#{arch_suffix}.msi"
-    return release_path_end, release_file, download_file
+    identify_windows_architecture.include?('64')
   end
 
   private
 
   # @api private
   def identify_windows_architecture
-    platform.arch =~ /64/ ? '64' : '32'
+    platform.arch.include?('64') ? '64' : '32'
   end
-
 end

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

@@ -1,7 +1,7 @@
 module Windows::User
   include Beaker::CommandFactory
 
-  def user_list(&block)
+  def user_list
     execute('cmd /c echo "" | wmic useraccount where localaccount="true" get name /format:value') do |result|
       users = []
       result.stdout.each_line do |line|
@@ -14,7 +14,7 @@ module Windows::User
     end
   end
 
-  def user_get(name, &block)
+  def user_get(name)
     execute("net user \"#{name}\"") do |result|
       fail_test "failed to get user #{name}" if result.exit_code != 0
 
@@ -24,10 +24,10 @@ module Windows::User
   end
 
   def user_present(name, &block)
-    execute("net user /add \"#{name}\"", {:acceptable_exit_codes => [0,2]}, &block)
+    execute("net user /add \"#{name}\"", { :acceptable_exit_codes => [0, 2] }, &block)
   end
 
   def user_absent(name, &block)
-    execute("net user /delete \"#{name}\"", {:acceptable_exit_codes => [0,2]}, &block)
+    execute("net user /delete \"#{name}\"", { :acceptable_exit_codes => [0, 2] }, &block)
   end
 end

data/lib/beaker/host/windows.rb

@@ -1,12 +1,12 @@
-[ 'host', 'command_factory', 'command', 'options' ].each do |lib|
-      require "beaker/#{lib}"
+%w[host command_factory command options].each do |lib|
+  require "beaker/#{lib}"
 end
 
 module Windows
   # A windows host with cygwin tools installed
   class Host < Unix::Host
-    [ 'user', 'group', 'exec', 'pkg', 'file' ].each do |lib|
-          require "beaker/host/windows/#{lib}"
+    %w[user group exec pkg file].each do |lib|
+      require "beaker/host/windows/#{lib}"
     end
 
     include Windows::User
@@ -18,14 +18,15 @@ module Windows
     def platform_defaults
       h = Beaker::Options::OptionsHash.new
       h.merge({
-        'user'          => 'Administrator',
-        'group'         => 'Administrators',
-        'pathseparator' => ';',
-      })
+                'user' => 'Administrator',
+                'group' => 'Administrators',
+                'pathseparator' => ';',
+              })
     end
 
     def external_copy_base
       return @external_copy_base if @external_copy_base
+
       @external_copy_base = execute('echo `cygpath -smF 35`/')
       @external_copy_base
     end
@@ -36,20 +37,20 @@ module Windows
     #   (:bitvise or :openssh at this point).
     def determine_ssh_server
       return @ssh_server if @ssh_server
+
       @ssh_server = :openssh
       status = execute('cmd.exe /c sc query BvSshServer', :accept_all_exit_codes => true)
-      if status =~ /4  RUNNING/
+      if status&.include?('4  RUNNING')
         @ssh_server = :bitvise
       else
         status = execute('cmd.exe /c sc qc sshd', :accept_all_exit_codes => true)
-        if status =~ /C:\\Windows\\System32\\OpenSSH\\sshd\.exe/
-          @ssh_server = :win32_openssh
-        end
+        @ssh_server = :win32_openssh if status&.include?('C:\\Windows\\System32\\OpenSSH\\sshd.exe')
       end
       @ssh_server
     end
 
     attr_reader :scp_separator
+
     def initialize name, host_hash, options
       super
 
@@ -57,6 +58,5 @@ module Windows
       @scp_separator      = '\\'
       @external_copy_base = nil
     end
-
   end
 end