beaker 1.21.0 → 2.0.0

data/lib/beaker/host.rb

@@ -31,6 +31,8 @@ module Beaker
         Windows::Host.new name, options
       when /aix/
         Aix::Host.new name, options
+      when /osx/
+        Mac::Host.new name, options
       else
         Unix::Host.new name, options
       end
@@ -204,6 +206,38 @@ module Beaker
       @x86_64 ||= determine_if_x86_64
     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
+      escaped_val = Regexp.escape(val).gsub('/', '\/').gsub(';', '\;')
+      #see if the key/value pair already exists
+      if exec(Beaker::Command.new("grep -e #{key}=.*#{escaped_val} #{self[:ssh_env_file]}"), :acceptable_exit_codes => (0..255) ).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} #{self[:ssh_env_file]}"), :acceptable_exit_codes => (0..255) ).exit_code == 0
+        exec(Beaker::Command.new("sed -i -e \"s/#{key}=/#{key}=#{escaped_val}:/\" #{self[:ssh_env_file]}"))
+      else
+        exec(Beaker::Command.new("echo \"#{key}=#{val}\" >> #{self[:ssh_env_file]}"))
+      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
+      val = Regexp.escape(val).gsub('/', '\/').gsub(';', '\;')
+      #if the key only has that single value remove the entire line
+      exec(Beaker::Command.new("sed -i -e \"/#{key}=#{val}$/d\" #{self[:ssh_env_file]}"))
+      #if the key has multiple values and we only need to remove the provided val
+      exec(Beaker::Command.new("sed -i -e \"s/#{key}=\\(.*[:;]*\\)#{val}[:;]*/#{key}=\\1/\" #{self[:ssh_env_file]}"))
+    end
+
     def connection
       @connection ||= SshConnection.connect( reachable_name,
                                              self['user'],
@@ -246,7 +280,7 @@ module Beaker
           # No, TestCase has the knowledge about whether its failed, checking acceptable
           # exit codes at the host level and then raising...
           # is it necessary to break execution??
-          unless result.exit_code_in?(Array(options[:acceptable_exit_codes] || 0))
+          if !options[:accept_all_exit_codes] && !result.exit_code_in?(Array(options[:acceptable_exit_codes] || 0))
             raise CommandFailure, "Host '#{self}' exited with #{result.exit_code} running:\n #{cmdline}\nLast #{@options[:trace_limit]} lines of output were:\n#{result.formatted_output(@options[:trace_limit])}"
           end
         end
@@ -266,7 +300,7 @@ module Beaker
     # scp files from the localhost to this test host, if a directory is provided it is recursively copied
     # @param source [String] The path to the file/dir to upload
     # @param target [String] The destination path on the host
-    # @param [Hash{Symbol=>String}] options Options to alter execution
+    # @param options [Hash{Symbol=>String}] Options to alter execution
     # @option options [Array<String>] :ignore An array of file/dir paths that will not be copied to the host
     def do_scp_to source, target, options
       @logger.notify "localhost $ scp #{source} #{@name}:#{target} {:ignore => #{options[:ignore]}}"
@@ -283,6 +317,9 @@ module Beaker
       end
 
       # either a single file, or a directory with no ignores
+      if not File.file?(source) and not File.directory?(source)
+        raise IOError, "No such file or directory - #{source}"
+      end
       if File.file?(source) or (File.directory?(source) and not has_ignore)
         source_file = source
         if has_ignore and (source =~ ignore_re)
@@ -306,11 +343,10 @@ module Beaker
         @logger.quiet(true)
         required_dirs = (dir_source.map{ | dir | File.dirname(dir) }).uniq
         require 'pathname'
-        source_path = Pathname.new(source)
         required_dirs.each do |dir|
           dir_path = Pathname.new(dir)
           if dir_path.absolute?
-            mkdir_p(File.join(target,dir_path.relative_path_from(source_path)))
+            mkdir_p(File.join(target, dir.gsub(source, '')))
           else
             mkdir_p( File.join(target, dir) )
           end
@@ -321,7 +357,7 @@ module Beaker
         dir_source.each do |s|
           s_path = Pathname.new(s)
           if s_path.absolute?
-            file_path = File.join(target,s_path.relative_path_from(source_path))
+            file_path = File.join(target, s.gsub(source,''))
           else
             file_path = File.join(target, s)
           end
@@ -343,7 +379,7 @@ module Beaker
 
   end
 
-  [ 'windows', 'unix', 'aix' ].each do |lib|
+  [ 'windows', 'unix', 'aix', 'mac' ].each do |lib|
     require "beaker/host/#{lib}"
   end
 end

data/lib/beaker/host/mac.rb

@@ -0,0 +1,62 @@
+[ 'host', 'command_factory', 'command', 'options' ].each do |lib|
+  require "beaker/#{lib}"
+end
+
+module Mac
+  class Host < Beaker::Host
+
+    [ 'exec', 'file' ].each do |lib|
+      require "beaker/host/unix/#{lib}"
+    end
+    [ 'user', 'group' ].each do |lib|
+      require "beaker/host/mac/#{lib}"
+    end
+
+    include Mac::User
+    include Mac::Group
+    include Unix::File
+    include Unix::Exec
+
+    def self.pe_defaults
+      h = Beaker::Options::OptionsHash.new
+      h.merge({
+        'user'          => 'root',
+        'group'         => 'pe-puppet',
+        'puppetserver-confdir' => '/etc/puppetlabs/puppetserver/conf.d',
+        'puppetservice'    => 'pe-httpd',
+        'puppetpath'       => '/etc/puppetlabs/puppet',
+        'puppetbin'        => '/opt/puppet/bin/puppet',
+        'puppetbindir'     => '/opt/puppet/bin',
+        'puppetsbindir'    => '/opt/puppet/sbin',
+        'puppetvardir'     => '/var/opt/lib/pe-puppet',
+        'hieradatadir'     => '/var/lib/hiera',
+        'hieraconf'        => '/etc/puppetlabs/puppet/hiera.yaml',
+        'distmoduledir'    => '/etc/puppetlabs/puppet/modules',
+        'sitemoduledir'    => '/opt/puppet/share/puppet/modules',
+        'pathseparator'    => ':',
+      })
+    end
+
+    def self.foss_defaults
+      h = Beaker::Options::OptionsHash.new
+      h.merge({
+        'user'              => 'root',
+        'group'             => 'puppet',
+        'puppetserver-confdir' => '/etc/puppetserver/conf.d',
+        'puppetservice'     => 'puppetmaster',
+        'puppetpath'        => '/etc/puppet',
+        'puppetvardir'      => '/var/lib/puppet',
+        'puppetbin'         => '/usr/bin/puppet',
+        'puppetbindir'      => '/usr/bin',
+        'hieralibdir'       => '/opt/puppet-git-repos/hiera/lib',
+        'hierapuppetlibdir' => '/opt/puppet-git-repos/hiera-puppet/lib',
+        'hierabindir'       => '/opt/puppet-git-repos/hiera/bin',
+        'hieradatadir'      => '/etc/puppet/hieradata',
+        'hieraconf'         => '/etc/puppet/hiera.yaml',
+        'distmoduledir'     => '/etc/puppet/modules',
+        'sitemoduledir'     => '/usr/share/puppet/modules',
+        'pathseparator'     => ':',
+      })
+    end
+  end
+end

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

@@ -0,0 +1,96 @@
+module Mac::Group
+  include Beaker::CommandFactory
+
+  # Gets a list of group names on the system
+  #
+  # @param [Proc] block Additional actions or insertions
+  #
+  # @return [Array<String>] The list of group names on the system
+  def group_list(&block)
+    execute('dscacheutil -q group') do |result|
+      groups = []
+      result.stdout.each_line do |line|
+        groups << line.split(': ')[1].strip if line =~ /^name:/
+      end
+
+      yield result if block_given?
+
+      groups
+    end
+  end
+
+  # Gets the group information in /etc/group format
+  #
+  # @param [String] name Name of the group you want
+  # @param [Proc] block Additional actions or insertions
+  #
+  # @yield [String] The actual mac dscacheutil output
+  # @return [String] Group information in /etc/group format
+  # @raise [FailTest] Raises an Assertion failure if it can't find the name
+  #                   queried for in the returned block
+  def group_get(name, &block)
+    execute("dscacheutil -q group -a name #{name}") do |result|
+      fail_test "failed to get group #{name}" unless result.stdout =~ /^name: #{name}/
+      gi = Hash.new  # group info
+      result.stdout.each_line { |line|
+        pieces = line.split(': ')
+        gi[pieces[0].to_sym] = pieces[1].strip if pieces[1] != nil
+      }
+      answer = "#{gi[:name]}:#{gi[:password]}:#{gi[:gid]}"
+
+      yield answer if block_given?
+    end
+  end
+
+  # Gets the gid of the given group
+  #
+  # @param [String] name Name of the group
+  #
+  # @return [String] gid of the group
+  def group_gid(name)
+    gid = -1
+    execute("dscacheutil -q group -a name #{name}") do |result|
+      result.stdout.each_line { |line|
+        if line =~ /^gid:/
+          gid = (line[5, line.length - 5]).chomp
+          break
+        end
+      }
+      gid
+    end
+  end
+
+  # Makes sure the group is present, creating it if necessary
+  #
+  # @param [String] name Name of the group
+  # @param [Proc] block Additional actions or insertions
+  def group_present(name, &block)
+    group_exists = false
+    execute("dscacheutil -q user -a name #{name}") do |result|
+      group_exists = result.stdout =~  /^name: #{name}/
+    end
+
+    return if group_exists
+
+    gid = gid_next
+    create_cmd  =     "dscl . create /Groups/#{name}"
+    create_cmd << " && dscl . create /Groups/#{name} PrimaryGroupID #{gid}"
+    execute(create_cmd)
+  end
+
+  # Makes sure the group is absent, deleting it if necessary
+  #
+  # @param [String] name Name of the group
+  # @param [Proc] block Additional actions or insertions
+  def group_absent(name, &block)
+    execute("if dscl . -list /Groups/#{name}; then dscl . -delete /Groups/#{name}; fi", {}, &block)
+  end
+
+  # Gives the next gid not used on the system
+  #
+  # @return [Fixnum] The next gid not used on the system
+  def gid_next
+    gid_last = execute("dscl . -list /Groups PrimaryGroupID | sort -k 2 -g | tail -1 | awk '{print $2}'")
+    gid_last.to_i + 1
+  end
+end

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

@@ -0,0 +1,93 @@
+module Mac::User
+  include Beaker::CommandFactory
+
+  # Gets a list of user names on the system
+  #
+  # @param [Proc] block Additional actions or insertions
+  #
+  # @return [Array<String>] The list of user names on the system
+  def user_list(&block)
+    execute('dscacheutil -q user') do |result|
+      users = []
+      result.stdout.each_line do |line|
+        users << line.split(': ')[1].strip if line =~ /^name:/
+      end
+
+      yield result if block_given?
+
+      users
+    end
+  end
+
+  # Gets the user information in /etc/passwd format
+  #
+  # @param [String] name Name of the user
+  # @param [Proc] block Additional actions or insertions
+  #
+  # @yield [String] The actual mac dscacheutil output
+  # @return [String] User information in /etc/passwd format
+  # @raise [FailTest] Raises an Assertion failure if it can't find the name
+  #                   queried for in the returned block
+  def user_get(name, &block)
+    answer = ""
+    execute("dscacheutil -q user -a name #{name}") do |result|
+      fail_test "failed to get user #{name}" unless result.stdout =~  /^name: #{name}/
+      ui = Hash.new  # user info
+      result.stdout.each_line { |line|
+        pieces = line.split(': ')
+        ui[pieces[0].to_sym] = pieces[1].strip if pieces[1] != nil
+      }
+      answer  = "#{ui[:name]}:#{ui[:password]}:#{ui[:uid]}:#{ui[:gid]}:"
+      answer << "#{ui[:name]}:#{ui[:dir]}:#{ui[:shell]}"
+
+      yield result if block_given?
+    end
+    answer
+  end
+
+  # Makes sure the user is present, creating them if necessary
+  #
+  # @param [String] name Name of the user
+  # @param [Proc] block Additional actions or insertions
+  def user_present(name, &block)
+    user_exists = false
+    execute("dscacheutil -q user -a name #{name}") do |result|
+       user_exists = result.stdout =~  /^name: #{name}/
+    end
+
+    return if user_exists
+
+    uid = uid_next
+    gid = gid_next
+    create_cmd  =     "dscl . create /Users/#{name}"
+    create_cmd << " && dscl . create /Users/#{name} NFSHomeDirectory /Users/#{name}"
+    create_cmd << " && dscl . create /Users/#{name} UserShell /bin/bash"
+    create_cmd << " && dscl . create /Users/#{name} UniqueID #{uid}"
+    create_cmd << " && dscl . create /Users/#{name} PrimaryGroupID #{gid}"
+    execute(create_cmd)
+  end
+
+  # Makes sure the user is absent, deleting them if necessary
+  #
+  # @param [String] name Name of the user
+  # @param [Proc] block Additional actions or insertions
+  def user_absent(name, &block)
+    execute("if dscl . -list /Users/#{name}; then dscl . -delete /Users/#{name}; fi", {}, &block)
+  end
+
+  # Gives the next uid not used on the system
+  #
+  # @return [Fixnum] The next uid not used on the system
+  def uid_next
+    uid_last = execute("dscl . -list /Users UniqueID | sort -k 2 -g | tail -1 | awk '{print $2}'")
+    uid_last.to_i + 1
+  end
+
+  # Gives the next gid not used on the system
+  #
+  # @return [Fixnum] The next gid not used on the system
+  def gid_next
+    gid_last = execute("dscl . -list /Users PrimaryGroupID | sort -k 2 -g | tail -1 | awk '{print $2}'")
+    gid_last.to_i + 1
+  end
+end

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

@@ -14,7 +14,7 @@ module Unix::Exec
   end
 
   def get_ip
-    if self['platform'].include? 'solaris'
+    if self['platform'].include?('solaris') || self['platform'].include?('osx')
       execute("ifconfig -a inet| awk '/broadcast/ {print $2}' | cut -d/ -f1 | head -1").strip
     else
       execute("ip a|awk '/global/{print$2}' | cut -d/ -f1 | head -1").strip

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

@@ -24,9 +24,9 @@ module Unix::Pkg
       when /el-4/
         @logger.debug("Package query not supported on rhel4")
         return false
-      when /fedora|centos|el-/
+      when /fedora|centos|eos|el-/
         result = exec(Beaker::Command.new("rpm -q #{name}"), :acceptable_exit_codes => (0...127))
-      when /ubuntu|debian/
+      when /ubuntu|debian|cumulus/
         result = exec(Beaker::Command.new("dpkg -s #{name}"), :acceptable_exit_codes => (0...127))
       when /solaris-11/
         result = exec(Beaker::Command.new("pkg info #{name}"), :acceptable_exit_codes => (0...127))
@@ -41,7 +41,7 @@ module Unix::Pkg
   # If apt has not been updated since the last repo deployment it is
   # updated. Otherwise this is a noop
   def update_apt_if_needed
-    if self['platform'] =~ /debian|ubuntu/
+    if self['platform'] =~ /debian|ubuntu|cumulus/
       if @apt_needs_update
         execute("apt-get update")
         @apt_needs_update = false
@@ -55,12 +55,12 @@ module Unix::Pkg
         execute("zypper --non-interactive in #{name}")
       when /el-4/
         @logger.debug("Package installation not supported on rhel4")
-      when /fedora|centos|el-/
+      when /fedora|centos|eos|el-/
         if version
           name = "#{name}-#{version}"
         end
         execute("yum -y #{cmdline_args} install #{name}")
-      when /ubuntu|debian/
+      when /ubuntu|debian|cumulus/
         if version
           name = "#{name}=#{version}"
         end
@@ -81,9 +81,9 @@ module Unix::Pkg
         execute("zypper --non-interactive rm #{name}")
       when /el-4/
         @logger.debug("Package uninstallation not supported on rhel4")
-      when /fedora|centos|el-/
+      when /fedora|centos|eos|el-/
         execute("yum -y #{cmdline_args} remove #{name}")
-      when /ubuntu|debian/
+      when /ubuntu|debian|cumulus/
         execute("apt-get purge #{cmdline_args} -y #{name}")
       when /solaris-11/
         execute("pkg #{cmdline_args} uninstall #{name}")
@@ -105,9 +105,9 @@ module Unix::Pkg
         execute("zypper --non-interactive --no-gpg-checks up #{name}")
       when /el-4/
         @logger.debug("Package upgrade is not supported on rhel4")
-      when /fedora|centos|el-/
+      when /fedora|centos|eos|el-/
         execute("yum -y #{cmdline_args} update #{name}")
-      when /ubuntu|debian/
+      when /ubuntu|debian|cumulus/
         update_apt_if_needed
         execute("apt-get install -o Dpkg::Options::='--force-confold' #{cmdline_args} -y --force-yes #{name}")
       when /solaris-11/
@@ -189,9 +189,9 @@ module Unix::Pkg
     case self['platform']
       when /el-4/
         @logger.debug("Package repo deploy is not supported on rhel4")
-      when /fedora|centos|el-/
+      when /fedora|centos|eos|el-/
         deploy_yum_repo(path, name, version)
-      when /ubuntu|debian/
+      when /ubuntu|debian|cumulus/
         deploy_apt_repo(path, name, version)
       when /sles/
         deploy_zyp_repo(path, name, version)

data/lib/beaker/host/windows.rb

@@ -25,8 +25,8 @@ module Windows
         'puppetvardir'  => '`cygpath -smF 35`/PuppetLabs/puppet/var',
         'distmoduledir' => '`cygpath -smF 35`/PuppetLabs/puppet/etc/modules',
         'sitemoduledir' => 'C:/usr/share/puppet/modules',
-        #if an x86 Puppet Labs dir exists then use it, default to non-x86 Program Files directory
-        'puppetbindir'  => '$( [ -d "/cygdrive/c/Program Files (x86)/Puppet Labs/Puppet Enterprise/bin" ] && echo "/cygdrive/c/Program Files (x86)" || echo "/cygdrive/c/Program Files" )/Puppet Labs/Puppet Enterprise/bin',
+        #let's just add both potential bin dirs to the path
+        'puppetbindir'  => '/cygdrive/c/Program Files (x86)/Puppet Labs/Puppet Enterprise/bin:/cygdrive/c/Program Files/Puppet Labs/Puppet Enterprise/bin',
         'pathseparator' => ';',
       })
     end
@@ -43,8 +43,8 @@ module Windows
         'sitemoduledir'     => 'C:/usr/share/puppet/modules',
         'hieralibdir'       => '`cygpath -w /opt/puppet-git-repos/hiera/lib`',
         'hierapuppetlibdir' => '`cygpath -w /opt/puppet-git-repos/hiera-puppet/lib`',
-        # PATH related variables need to be Unix, which cygwin converts
-        'puppetbindir'  => '$( [ -d "/cygdrive/c/Program Files (x86)/Puppet Labs/Puppet/bin" ] && echo "/cygdrive/c/Program Files (x86)" || echo "/cygdrive/c/Program Files" )/Puppet Labs/Puppet/bin',
+        #let's just add both potential bin dirs to the path
+        'puppetbindir'  => '/cygdrive/c/Program Files (x86)/Puppet Labs/Puppet/bin:/cygdrive/c/Program Files/Puppet Labs/Puppet/bin',
         'hierabindir'       => '/opt/puppet-git-repos/hiera/bin',
         'pathseparator'     => ';',
       })