beaker 4.38.1 → 5.0.0

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

@@ -11,17 +11,17 @@ module PSWindows::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
 
   def rm_rf path
     # ensure that we have the right slashes for windows
-    path = path.gsub(/\//, '\\')
+    path = path.tr('/', '\\')
     execute(%(del /s /q "#{path}"))
   end
 
@@ -29,10 +29,10 @@ module PSWindows::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)
     # ensure that we have the right slashes for windows
-    orig = orig.gsub(/\//,'\\')
-    dest = dest.gsub(/\//,'\\')
+    orig = orig.tr('/', '\\')
+    dest = dest.tr('/', '\\')
     rm_rf dest unless !rm
     execute("move /y #{orig} #{dest}")
   end
@@ -46,17 +46,14 @@ module PSWindows::Exec
 
     result = execute("powershell Test-Path #{file} -PathType Leaf")
 
-    if result.include? 'False'
-      execute("powershell New-Item -ItemType file #{file}")
-    end
+    execute("powershell New-Item -ItemType file #{file}") if result.include? 'False'
     execute("powershell (gci #{file}).LastWriteTime = Get-Date " \
-      "-Year '#{time.year}'" \
-      "-Month '#{time.month}'" \
-      "-Day '#{time.day}'" \
-      "-Hour '#{time.hour}'" \
-      "-Minute '#{time.minute}'" \
-      "-Second '#{time.second}'"
-    )
+            "-Year '#{time.year}'" \
+            "-Month '#{time.month}'" \
+            "-Day '#{time.day}'" \
+            "-Hour '#{time.hour}'" \
+            "-Minute '#{time.minute}'" \
+            "-Second '#{time.second}'")
   end
 
   def path
@@ -75,8 +72,10 @@ module PSWindows::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
@@ -88,14 +87,13 @@ module PSWindows::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
@@ -104,88 +102,87 @@ module PSWindows::Exec
   # @param [String] dir The directory structure to create on the host
   # @return [Boolean] True, if directory construction succeeded, otherwise False
   def mkdir_p dir
-    normalized_path = dir.gsub('/','\\')
+    normalized_path = dir.tr('/', '\\')
     result = exec(powershell("New-Item -Path '#{normalized_path}' -ItemType 'directory'"),
                   :acceptable_exit_codes => [0, 1])
     result.exit_code == 0
   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.upcase
-    #see if the key/value pair already exists
-    cur_val = subbed_val = get_env_var(key, true)
+    # see if the key/value pair already exists
+    cur_val = get_env_var(key, true)
     subbed_val = cur_val.gsub(/#{Regexp.escape(val.gsub(/'|"/, ''))}/, '')
     if cur_val.empty?
       exec(powershell("[Environment]::SetEnvironmentVariable('#{key}', '#{val}', 'Machine')"))
-      self.close #refresh the state
-    elsif subbed_val == cur_val #not present, add it
+      self.close # refresh the state
+    elsif subbed_val == cur_val # not present, add it
       exec(powershell("[Environment]::SetEnvironmentVariable('#{key}', '#{val};#{cur_val}', 'Machine')"))
-      self.close #refresh the state
+      self.close # refresh the state
     end
   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.upcase
-    #get the current value of the key
-    cur_val = subbed_val = get_env_var(key, true)
+    # get the current value of the key
+    cur_val = get_env_var(key, true)
     subbed_val = (cur_val.split(';') - [val.gsub(/'|"/, '')]).join(';')
-    if subbed_val != cur_val
-      #remove the current key value
-      self.clear_env_var(key)
-      #set to the truncated value
-      self.add_env_var(key, subbed_val)
-    end
+    return unless subbed_val != cur_val
+
+    # remove the current key value
+    self.clear_env_var(key)
+    # set to the truncated value
+    self.add_env_var(key, subbed_val)
   end
 
-  #Return the value of a specific env var
-  #@param [String] key The key to look for
-  #@param [Boolean] clean Remove the 'KEY=' and only return the value of the env var
-  #@example
+  # Return the value of a specific env var
+  # @param [String] key The key to look for
+  # @param [Boolean] clean Remove the 'KEY=' and only return the value of the env var
+  # @example
   #  host.get_env_var('path')
   def get_env_var key, clean = false
-    self.close #refresh the state
+    self.close # refresh the state
     key = key.to_s.upcase
     val = exec(Beaker::Command.new("set #{key}"), :accept_all_exit_codes => true).stdout.chomp
-    if val.empty?
-      return ''
+    return '' if val.empty?
+
+    val = val.split("\n")[0] # only take the first result
+    if clean
+      val.gsub(/#{key}=/i, '')
     else
-      val = val.split(/\n/)[0] # only take the first result
-      if clean
-        val.gsub(/#{key}=/i,'')
-      else
-        val
-      end
+      val
     end
   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.upcase
     exec(powershell("[Environment]::SetEnvironmentVariable('#{key}', $null, 'Machine')"))
     exec(powershell("[Environment]::SetEnvironmentVariable('#{key}', $null, 'User')"))
     exec(powershell("[Environment]::SetEnvironmentVariable('#{key}', $null, 'Process')"))
-    self.close #refresh the state
+    self.close # refresh the state
   end
 
   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.each_with_index do |env|
+    env_array.each do |env|
       environment_string += "set \"#{env}\" && "
     end
     environment_string
@@ -195,11 +192,11 @@ module PSWindows::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
@@ -216,8 +213,7 @@ module PSWindows::Exec
   # Overrides the {Windows::Exec#ssh_permit_user_environment} method,
   # since no steps are needed in this setup to allow user ssh environments
   # to work.
-  def ssh_permit_user_environment
-  end
+  def ssh_permit_user_environment; end
 
   # Sets the user SSH environment.
   #
@@ -231,18 +227,18 @@ module PSWindows::Exec
   # @api private
   # @return nil
   def ssh_set_user_environment(env)
-    #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
 
-  #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)
     where_command = "cmd /C \"where #{command}\""

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

@@ -1,17 +1,15 @@
 module PSWindows::File
   include Beaker::CommandFactory
 
-  def tmpfile(name = '')
+  def tmpfile(_name = '')
     result = exec(powershell('[System.IO.Path]::GetTempFileName()'))
-    result.stdout.chomp()
+    result.stdout.chomp
   end
 
   def tmpdir(name = '')
-    tmp_path = exec(powershell('[System.IO.Path]::GetTempPath()')).stdout.chomp()
+    tmp_path = exec(powershell('[System.IO.Path]::GetTempPath()')).stdout.chomp
 
-    if name == ''
-      name = exec(powershell('[System.IO.Path]::GetRandomFileName()')).stdout.chomp()
-    end
+    name = exec(powershell('[System.IO.Path]::GetRandomFileName()')).stdout.chomp if name == ''
     exec(powershell("New-Item -Path '#{tmp_path}' -Force -Name '#{name}' -ItemType 'directory'"))
     File.join(tmp_path, name)
   end

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

@@ -1,7 +1,7 @@
 module PSWindows::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 PSWindows::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 PSWindows::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/pswindows/pkg.rb

@@ -6,28 +6,28 @@ module PSWindows::Pkg
     result.exit_code == 0
   end
 
-  def check_for_package(name)
-    #HACK NOOP
-    #raise "Cannot check for package #{name} on #{self}"
+  def check_for_package(_name)
+    # HACK: NOOP
+    # raise "Cannot check for package #{name} on #{self}"
     0
   end
 
-  def install_package(name, cmdline_args = '')
-    #HACK NOOP
-    #raise "Package #{name} cannot be installed on #{self}"
+  def install_package(_name, _cmdline_args = '')
+    # HACK: NOOP
+    # raise "Package #{name} cannot be installed on #{self}"
     0
   end
 
-  def uninstall_package(name, cmdline_args = '')
-    #HACK NOOP
-    #raise "Package #{name} cannot be uninstalled on #{self}"
+  def uninstall_package(_name, _cmdline_args = '')
+    # HACK: NOOP
+    # raise "Package #{name} cannot be uninstalled on #{self}"
     0
   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
+    identify_windows_architecture.include?('64')
   end
 
   private
@@ -37,10 +37,10 @@ module PSWindows::Pkg
     arch = nil
     execute("wmic os get osarchitecture", :accept_all_exit_codes => true) do |result|
       arch = if result.exit_code == 0
-        result.stdout =~ /64/ ? '64' : '32'
-      else
-        identify_windows_architecture_from_os_name_for_win2003
-      end
+               result.stdout.include?('64') ? '64' : '32'
+             else
+               identify_windows_architecture_from_os_name_for_win2003
+             end
     end
     arch
   end
@@ -49,7 +49,7 @@ module PSWindows::Pkg
   def identify_windows_architecture_from_os_name_for_win2003
     arch = nil
     execute("wmic os get name", :accept_all_exit_codes => true) do |result|
-      arch = result.stdout =~ /64/ ? '64' : '32'
+      arch = result.stdout.include?('64') ? '64' : '32'
     end
     arch
   end

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

@@ -1,7 +1,7 @@
 module PSWindows::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 PSWindows::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 PSWindows::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/pswindows.rb

@@ -1,10 +1,10 @@
-[ 'host', 'command_factory', 'command', 'options', 'dsl/wrappers' ].each do |lib|
+['host', 'command_factory', 'command', 'options', 'dsl/wrappers'].each do |lib|
   require "beaker/#{lib}"
 end
 
 module PSWindows
   class Host < Windows::Host
-    [ 'user', 'group', 'exec', 'pkg', 'file' ].each do |lib|
+    %w[user group exec pkg file].each do |lib|
       require "beaker/host/pswindows/#{lib}"
     end
 
@@ -16,12 +16,14 @@ module PSWindows
 
     def external_copy_base
       return @external_copy_base if @external_copy_base
+
       @external_copy_base = execute('for %I in (%ALLUSERSPROFILE%) do @echo %~I')
       @external_copy_base
     end
 
     # attr_reader :network_separator, :external_copy_base, :system_temp_path
     attr_reader :scp_separator, :system_temp_path
+
     def initialize name, host_hash, options
       super
 
@@ -33,6 +35,5 @@ module PSWindows
       @external_copy_base = nil
       # @external_copy_base = '/programdata'
     end
-
   end
 end