beaker 2.10.0 → 2.11.0

data/lib/beaker/host/mac.rb

@@ -3,19 +3,15 @@
 end
 
 module Mac
-  class Host < Beaker::Host
+    class Host < Unix::Host
 
-    [ 'exec', 'file' ].each do |lib|
-      require "beaker/host/unix/#{lib}"
-    end
-    [ 'user', 'group' ].each do |lib|
+    [ 'user', 'group', 'pkg' ].each do |lib|
       require "beaker/host/mac/#{lib}"
     end
 
     include Mac::User
     include Mac::Group
-    include Unix::File
-    include Unix::Exec
+    include Mac::Pkg
 
     def self.pe_defaults
       h = Beaker::Options::OptionsHash.new

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

@@ -0,0 +1,43 @@
+module Mac::Pkg
+  include Beaker::CommandFactory
+
+  def check_for_package(name)
+    raise "Package #{name} cannot be queried on #{self}"
+  end
+
+  def install_package(name, cmdline_args = '', version = nil)
+    raise "Package #{name} cannot be installed on #{self}"
+  end
+
+  def uninstall_package(name, cmdline_args = '')
+    raise "Package #{name} cannot be installed on #{self}"
+  end
+
+  # Upgrade an installed package to the latest available version
+  #
+  # @param [String] name          The name of the package to update
+  # @param [String] cmdline_args  Additional command line arguments for
+  #                               the package manager
+  def upgrade_package(name, cmdline_args = '')
+      raise "Package #{name} cannot be upgraded on #{self}"
+  end
+
+  # Deploy configuration generated by the packaging tooling to this host.
+  #
+  # This method calls one of #deploy_apt_repo, #deploy_yum_repo, or
+  # #deploy_zyp_repo depending on the platform of this Host.
+  #
+  # @note See {Beaker::DSL::Helpers::HostHelpers#deploy_package_repo} for info on
+  #       params
+  def deploy_package_repo(path, name, version)
+    raise "Package repo cannot be deployed on #{self}; the platform is not supported"
+  end
+
+  #Examine the host system to determine the architecture
+  #@return [Boolean] true if x86_64, false otherwise
+  def determine_if_x86_64
+    result = exec(Beaker::Command.new("uname -a | grep x86_64"), :expect_all_exit_codes => true)
+    result.exit_code == 0
+  end
+
+end

data/lib/beaker/host/pswindows.rb

@@ -1,4 +1,4 @@
-[ 'host', 'command_factory', 'command', 'options' ].each do |lib|
+[ 'host', 'command_factory', 'command', 'options', 'dsl/wrappers' ].each do |lib|
   require "beaker/#{lib}"
 end
 

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

@@ -1,5 +1,6 @@
 module PSWindows::Exec
   include Beaker::CommandFactory
+  include Beaker::DSL::Wrappers
 
   def reboot
     exec(Beaker::Command.new("shutdown /r /t 0"), :expect_connection_failure => true)
@@ -25,13 +26,93 @@ module PSWindows::Exec
   end
 
   def get_ip
-    ip = execute("for /f \"tokens=14\" %f in ('ipconfig ^| find \"IP Address\"') do @echo %f").strip
+    ip = execute("for /f \"tokens=14\" %f in ('ipconfig ^| find \"IP Address\"') do @echo %f", :accept_all_exit_codes => true).strip
     if ip == ''
-      ip = execute("for /f \"tokens=14\" %f in ('ipconfig ^| find \"IPv4 Address\"') do @echo %f").strip
+      ip = execute("for /f \"tokens=14\" %f in ('ipconfig ^| find \"IPv4 Address\"') do @echo %f", :accept_all_exit_codes => true).strip
     end
     if ip == ''
       ip = execute("for /f \"tokens=14\" %f in ('ipconfig ^| find \"IPv6 Address\"') do @echo %f").strip
     end
     ip
   end
+
+  # Create the provided directory structure on the host
+  # @param [String] dir The directory structure to create on the host
+  # @return [Boolean] True, if directory construction succeeded, otherwise False
+  def mkdir_p dir
+    windows_dirstring = dir.gsub('/','\\')
+    cmd = "if not exist #{windows_dirstring} (md #{windows_dirstring})"
+    result = exec(Beaker::Command.new(cmd), :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
+  #  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)
+    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
+      exec(powershell("[Environment]::SetEnvironmentVariable('#{key}', '#{val};#{cur_val}', 'Machine')"))
+      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
+  #  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)
+    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
+  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
+  #  host.get_env_var('path')
+  def get_env_var key, clean = false
+    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 ''
+    else
+      if clean
+        val.gsub(/#{key}=/,'')
+      else
+        val
+      end
+    end
+  end
+
+  #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
+  end
+
 end

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

@@ -2,7 +2,7 @@ module PSWindows::Pkg
   include Beaker::CommandFactory
 
   def check_for_command(name)
-    result = exec(Beaker::Command.new("where #{name}"), :acceptable_exit_codes => (0...127))
+    result = exec(Beaker::Command.new("where #{name}"), :accept_all_exit_codes => true)
     result.exit_code == 0
   end
 
@@ -24,14 +24,18 @@ module PSWindows::Pkg
     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
+  def determine_if_x86_64
+    (identify_windows_architecture =~ /64/) == 0
+  end
+
   private
 
   # @api private
   def identify_windows_architecture
     arch = nil
-    execute("wmic os get osarchitecture",
-    :acceptable_exit_codes => (0...127)) do |result|
-
+    execute("wmic os get osarchitecture", :accept_all_exit_codes => true) do |result|
       arch = if result.exit_code == 0
         result.stdout =~ /64/ ? '64' : '32'
       else
@@ -44,8 +48,7 @@ module PSWindows::Pkg
   # @api private
   def identify_windows_architecture_from_os_name_for_win2003
     arch = nil
-    execute("wmic os get name",
-    :acceptable_exit_codes => (0...127)) do |result|
+    execute("wmic os get name", :accept_all_exit_codes => true) do |result|
       arch = result.stdout =~ /64/ ? '64' : '32'
     end
     arch

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

@@ -28,4 +28,109 @@ module Unix::Exec
       execute("ip a|awk '/global/{print$2}' | cut -d/ -f1 | head -1").strip
     end
   end
+
+  # Create the provided directory structure on the host
+  # @param [String] dir The directory structure to create on the host
+  # @return [Boolean] True, if directory construction succeeded, otherwise False
+  def mkdir_p dir
+    cmd = "mkdir -p #{dir}"
+    result = exec(Beaker::Command.new(cmd), :acceptable_exit_codes => [0, 1])
+    result.exit_code == 0
+  end
+
+  # Recursively remove the path provided
+  # @param [String] path The path to remove
+  def rm_rf path
+    exec(Beaker::Command.new("rm -rf #{path}"))
+  end
+
+  # Converts the provided environment file to a new shell script in /etc/profile.d, then sources that file.
+  # 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] =~ /sles-/
+      @logger.debug("mirroring environment to /etc/profile.d on 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
+      exec(Beaker::Command.new("cat << EOF > #{self[:profile_d_env_file]}\n#{shell_env}EOF"))
+      #set permissions
+      exec(Beaker::Command.new("chmod +x #{self[:profile_d_env_file]}"))
+      #keep it current
+      exec(Beaker::Command.new("source #{self[:profile_d_env_file]}"))
+    else
+      #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
+  #  host.add_env_var('PATH', '/usr/bin:PATH')
+  def add_env_var key, val
+    key = key.to_s.upcase
+    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
+      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
+    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
+  #  host.delete_env_var('PATH', '/usr/bin:PATH')
+  def delete_env_var key, val
+    key = key.to_s.upcase
+    env_file = self[:ssh_env_file]
+    val = Regexp.escape(val).gsub('/', '\/').gsub(';', '\;')
+    #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
+    exec(Beaker::SedCommand.new(self['platform'], "s/#{key}=\\(.*\\)[;:]#{val}/#{key}=\\1/", env_file))
+    #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
+    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
+  #  host.get_env_var('path')
+  def get_env_var key
+    key = key.to_s.upcase
+    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
+  #  host.clear_env_var('PATH')
+  def clear_env_var key
+    key = key.to_s.upcase
+    env_file = self[:ssh_env_file]
+    #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
+    mirror_env_to_profile_d(env_file)
+  end
+
 end

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

@@ -8,7 +8,7 @@ module Unix::Pkg
   end
 
   def check_for_command(name)
-    result = exec(Beaker::Command.new("which #{name}"), :acceptable_exit_codes => (0...127))
+    result = exec(Beaker::Command.new("which #{name}"), :accept_all_exit_codes => true)
     case self['platform']
     when /solaris-10/
       result.stdout =~ %r|/.*/#{name}|
@@ -20,25 +20,25 @@ module Unix::Pkg
   def check_for_package(name)
     case self['platform']
       when /sles-10/
-        result = exec(Beaker::Command.new("zypper se -i --match-exact #{name}"), :acceptable_exit_codes => (0...127))
+        result = exec(Beaker::Command.new("zypper se -i --match-exact #{name}"), :accept_all_exit_codes => true)
         result.stdout =~ /No packages found/ ? (return false) : (return result.exit_code == 0)
       when /sles-/
-        result = exec(Beaker::Command.new("zypper se -i --match-exact #{name}"), :acceptable_exit_codes => (0...127))
+        result = exec(Beaker::Command.new("zypper se -i --match-exact #{name}"), :accept_all_exit_codes => true)
       when /el-4/
         @logger.debug("Package query not supported on rhel4")
         return false
       when /fedora|centos|eos|el-/
-        result = exec(Beaker::Command.new("rpm -q #{name}"), :acceptable_exit_codes => (0...127))
+        result = exec(Beaker::Command.new("rpm -q #{name}"), :accept_all_exit_codes => true)
       when /ubuntu|debian|cumulus/
-        result = exec(Beaker::Command.new("dpkg -s #{name}"), :acceptable_exit_codes => (0...127))
+        result = exec(Beaker::Command.new("dpkg -s #{name}"), :accept_all_exit_codes => true)
       when /solaris-11/
-        result = exec(Beaker::Command.new("pkg info #{name}"), :acceptable_exit_codes => (0...127))
+        result = exec(Beaker::Command.new("pkg info #{name}"), :accept_all_exit_codes => true)
       when /solaris-10/
-        result = exec(Beaker::Command.new("pkginfo #{name}"), :acceptable_exit_codes => (0...127))
+        result = exec(Beaker::Command.new("pkginfo #{name}"), :accept_all_exit_codes => true)
       when /freebsd-9/
-        result = exec(Beaker::Command.new("pkg_info #{name}"), :acceptable_exit_codes => (0...127))
+        result = exec(Beaker::Command.new("pkg_info #{name}"), :accept_all_exit_codes => true)
       when /freebsd-10/
-        result = exec(Beaker::Command.new("pkg info #{name}"), :acceptable_exit_codes => (0...127))
+        result = exec(Beaker::Command.new("pkg info #{name}"), :accept_all_exit_codes => true)
       else
         raise "Package #{name} cannot be queried on #{self}"
     end
@@ -211,4 +211,17 @@ module Unix::Pkg
         raise "Package repo cannot be deployed on #{self}; the platform is not supported"
     end
   end
+
+  #Examine the host system to determine the architecture
+  #@return [Boolean] true if x86_64, false otherwise
+  def determine_if_x86_64
+    if self[:platform] =~ /solaris/
+      result = exec(Beaker::Command.new("uname -a | grep x86_64"), :accept_all_exit_codes => true)
+        result.exit_code == 0
+    else
+      result = exec(Beaker::Command.new("arch | grep x86_64"), :accept_all_exit_codes => true)
+      result.exit_code == 0
+    end
+  end
+
 end

data/lib/beaker/host/windows.rb

@@ -3,7 +3,8 @@
 end
 
 module Windows
-  class Host < Beaker::Host
+  # A windows host with cygwin tools installed
+  class Host < Unix::Host
     [ 'user', 'group', 'exec', 'pkg', 'file' ].each do |lib|
           require "beaker/host/windows/#{lib}"
     end

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

@@ -2,7 +2,7 @@ module Windows::Exec
   include Beaker::CommandFactory
 
   def reboot
-    exec(Beaker::Command.new("shutdown /r /t 0"), :expect_connection_failure => true)
+    exec(Beaker::Command.new('shutdown /r /t 0 /d p:4:1 /c "Beaker::Host reboot command issued"'), :expect_connection_failure => true)
   end
 
   ABS_CMD = 'c:\\\\windows\\\\system32\\\\cmd.exe'

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

@@ -2,12 +2,12 @@ module Windows::Pkg
   include Beaker::CommandFactory
 
   def check_for_command(name)
-    result = exec(Beaker::Command.new("which #{name}"), :acceptable_exit_codes => (0...127))
+    result = exec(Beaker::Command.new("which #{name}"), :accept_all_exit_codes => true)
     result.exit_code == 0
   end
 
   def check_for_package(name)
-    result = exec(Beaker::Command.new("cygcheck #{name}"), :acceptable_exit_codes => (0...127))
+    result = exec(Beaker::Command.new("cygcheck #{name}"), :accept_all_exit_codes => true)
     result.exit_code == 0
   end
 
@@ -46,9 +46,7 @@ module Windows::Pkg
   # @api private
   def identify_windows_architecture
     arch = nil
-    execute("echo '' | wmic os get osarchitecture",
-            :acceptable_exit_codes => (0...127)) do |result|
-
+    execute("echo '' | wmic os get osarchitecture", :accept_all_exit_codes => true) do |result|
       arch = if result.exit_code == 0
         result.stdout =~ /64/ ? '64' : '32'
       else
@@ -61,8 +59,7 @@ module Windows::Pkg
   # @api private
   def identify_windows_architecture_from_os_name_for_win2003
     arch = nil
-    execute("echo '' | wmic os get name | grep x64",
-            :acceptable_exit_codes => (0...127)) do |result|
+    execute("echo '' | wmic os get name | grep x64", :accept_all_exit_codes => true) do |result|
       arch = result.exit_code == 0 ? '64' : '32'
     end
     arch

data/lib/beaker/host_prebuilt_steps.rb

@@ -19,7 +19,7 @@ module Beaker
     SLES10_PACKAGES = ['curl']
     SLES_PACKAGES = ['curl', 'ntp']
     DEBIAN_PACKAGES = ['curl', 'ntpdate', 'lsb-release']
-    CUMULUS_PACKAGES = ['addons', 'ntpdate', 'lsb-release']
+    CUMULUS_PACKAGES = ['curl', 'ntpdate']
     ETC_HOSTS_PATH = "/etc/hosts"
     ETC_HOSTS_PATH_SOLARIS = "/etc/inet/hosts"
     ROOT_KEYS_SCRIPT = "https://raw.githubusercontent.com/puppetlabs/puppetlabs-sshkeys/master/templates/scripts/manage_root_authorized_keys"
@@ -55,7 +55,7 @@ module Beaker
           try = 0
           until try >= TRIES do
             try += 1
-            if host.exec(Command.new(ntp_command), :acceptable_exit_codes => (0..255)).exit_code == 0
+            if host.exec(Command.new(ntp_command), :accept_all_exit_codes => true).exit_code == 0
               success=true
               break
             end
@@ -139,9 +139,9 @@ module Beaker
       logger.notify "Sync root authorized_keys from github on #{host.name}"
         # Allow all exit code, as this operation is unlikely to cause problems if it fails.
         if host['platform'] =~ /solaris|eos/
-          host.exec(Command.new(ROOT_KEYS_SYNC_CMD % "bash"), :acceptable_exit_codes => (0..255))
+          host.exec(Command.new(ROOT_KEYS_SYNC_CMD % "bash"), :accept_all_exit_codes => true)
         else
-          host.exec(Command.new(ROOT_KEYS_SYNC_CMD % "env PATH=/usr/gnu/bin:$PATH bash"), :acceptable_exit_codes => (0..255))
+          host.exec(Command.new(ROOT_KEYS_SYNC_CMD % "env PATH=/usr/gnu/bin:$PATH bash"), :accept_all_exit_codes => true)
         end
       end
     rescue => e
@@ -359,7 +359,7 @@ module Beaker
           host.exec(Command.new("sudo sed -i '' 's/#PermitRootLogin yes/PermitRootLogin Yes/g' /etc/sshd_config"))
         elsif host['platform'] =~ /freebsd/
           host.exec(Command.new("sudo sed -i -e 's/#PermitRootLogin no/PermitRootLogin yes/g' /etc/ssh/sshd_config"), {:pty => true} )
-        elsif host.is_cygwin?
+        elsif not host.is_powershell?
           host.exec(Command.new("sudo su -c \"sed -ri 's/^#?PermitRootLogin no|^#?PermitRootLogin yes/PermitRootLogin yes/' /etc/ssh/sshd_config\""), {:pty => true})
         else
           logger.warn("Attempting to enable root login non-supported platform: #{host.name}: #{host['platform']}")
@@ -368,7 +368,7 @@ module Beaker
         if host['platform'] =~ /debian|ubuntu|cumulus/
           host.exec(Command.new("sudo su -c \"service ssh restart\""), {:pty => true})
         elsif host['platform'] =~ /centos-7|el-7|redhat-7/
-          host.exec(Command.new("sudo -E systemctl restart sshd.service"), {:ptry => true})
+          host.exec(Command.new("sudo -E systemctl restart sshd.service"), {:pty => true})
         elsif host['platform'] =~ /centos|el-|redhat|fedora|eos/
           host.exec(Command.new("sudo -E /sbin/service sshd reload"), {:pty => true})
         elsif host['platform'] =~ /freebsd/
@@ -461,10 +461,10 @@ module Beaker
     # @param [String] val The string to 'echo' on the host
     def echo_on_host host, val
       #val = val.gsub(/"/, "\"").gsub(/\(/, "\(")
-      if host.is_cygwin?
-        host.exec(Command.new("echo \"#{val}\"")).stdout.chomp
-      else
+      if host.is_powershell?
         host.exec(Command.new("echo #{val}")).stdout.chomp
+      else
+        host.exec(Command.new("echo \"#{val}\"")).stdout.chomp
       end
     end
 
@@ -488,7 +488,7 @@ module Beaker
 
       env.each_key do |key|
         separator = host['pathseparator']
-        if key == 'PATH' && host.is_cygwin?
+        if key == 'PATH' && (not host.is_powershell?)
           separator = ':'
         end
         env[key] = env[key].join(separator)
@@ -548,7 +548,7 @@ module Beaker
           host.exec(Command.new("sudo /etc/rc.d/sshd restart"))
         end
 
-        if host['platform'] !~ /windows/ or (host['platform'] =~ /windows/ and host.is_cygwin?)
+        if not host.is_powershell?
           #ensure that ~/.ssh/environment exists
           host.exec(Command.new("mkdir -p #{Pathname.new(host[:ssh_env_file]).dirname}"))
           host.exec(Command.new("chmod 0600 #{Pathname.new(host[:ssh_env_file]).dirname}"))
@@ -565,10 +565,10 @@ module Beaker
         host.close
 
         # print out the working env
-        if host.is_cygwin?
-          host.exec(Command.new("cat #{host[:ssh_env_file]}"))
-        else
+        if host.is_powershell?
           host.exec(Command.new("SET"))
+        else
+          host.exec(Command.new("cat #{host[:ssh_env_file]}"))
         end
 
       end