beaker 1.8.1 → 1.8.2

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    ODYxYzQzYzY0MzQ5MmQ5ZDQ1ODNiMzNjYzhkYmNkNTQ1ZTAxNDIzZg==
+    MmRhZWZiYzAyYjBlYWU1NjQ4ZTJiY2Q2YjY2MjIzZDQ3OTU2ODhjMQ==
   data.tar.gz: !binary |-
-    YzU4NjI5MzAxMWNlOWFlYWMyNzI5YWRiMzEwNjA5YjZhNDFhN2ZmYg==
+    MzY2M2M5M2UxM2U2NmQ3MmI0Y2UwNDk3ZmM0MDYxMjAzZWY2ZjM1Mg==
 SHA512:
   metadata.gz: !binary |-
-    YjUzZjA3MmMwYzU0Njg3MzBjNWZhMGNjZmVmYzRiNzc1MjMxMjQ3Y2ZkZDYz
-    YzgzNGVhNzMzNDQ1ZTkyYTgwNDQ2OGQ0YjVhZTlmZDQ1MTIzODQ5MzEyZmY5
-    YmEwYTExZjk2ZGE0ZjA0NDVhMGNmZmMzZDI0NzM3MTc5ODA3ZDM=
+    OWZhMmJiMTE1NzJiOGQ0YWNhNTAwMDI2NzM2Njc0YTc4MDdhOWNkM2Y2MDRm
+    MjFjYmY3Y2NhZDU5YmZiODAxOWZhMzE2ZDJjMDVkZTAyZjc3YTdhMjZhYjNl
+    ZjcyMDJiNDE2NzBmYzUwYjM3OTY3YjFkODg4ZjM5MjVmNGNkOTk=
   data.tar.gz: !binary |-
-    NzBiMGNmNTMwOGMwMzc5MGMzNWFkZmI0YTIyNjIwMDZlNmQzZWMyZTQyMDMy
-    MTk2NDgwMDkyZDdlZWNhNzkyNmEyNzhlYWE4MWIzZWVkNTFiMjU4OTZlMjMy
-    ZmRlZmE3MTkyNGZkZmJlMzFkNjk3MmQ0NzMwOTU3MjAyODYyYjY=
+    M2Y3MWYwYTBkNWJkMmQ0ZjJiMGUwYWIzNmZiODVlYTFiYTliOTU1MDY5NzRl
+    NmNlMDZjMzNlNjQ1NzM2N2U1NGYxZGFlYTNjY2NkNjA1ODE3YmY3OTMxMWI0
+    NWZjNTBlZjE2ZWRiMGYxODkyNjUyZTUyODA5ZWJlMmZlYTZkNzc=

data/bin/beaker

@@ -5,5 +5,5 @@ require 'beaker'
 
 Beaker::CLI.new.execute!
 
-puts "systest completed successfully, thanks."
+puts "Beaker completed successfully, thanks."
 exit 0

data/lib/beaker.rb

@@ -1,7 +1,7 @@
 require 'rubygems' unless defined?(Gem)
 module Beaker
 
-  %w( version platform utils test_suite result command options network_manager cli ).each do |lib|
+  %w( version platform test_suite result command options network_manager cli ).each do |lib|
     begin
       require "beaker/#{lib}"
     rescue LoadError

data/lib/beaker/cli.rb

@@ -44,48 +44,26 @@ module Beaker
       end
     end
 
+    #Provision, validate and configure all hosts as defined in the hosts file
     def provision
       begin
         @hosts =  []
         @network_manager = Beaker::NetworkManager.new(@options, @logger)
         @hosts = @network_manager.provision
+        @network_manager.validate
+        @network_manager.configure
       rescue => e
         report_and_raise(@logger, e, "CLI.provision")
       end
     end
 
-    def validate
-      begin
-        #validation phase
-        Beaker::Utils::Validator.validate(@hosts, @logger)
-      rescue => e
-        report_and_raise(@logger, e, "CLI.validate")
-      end
-    end
-
-    def setup
-      @ntp_controller = Beaker::Utils::NTPControl.new(@options, @hosts)
-      @setup = Beaker::Utils::SetupHelper.new(@options, @hosts)
-      @repo_controller = Beaker::Utils::RepoControl.new(@options, @hosts)
-      setup_steps = [[:timesync, "Sync time on hosts", Proc.new {@ntp_controller.timesync}],
-                     [:root_keys, "Sync keys to hosts" , Proc.new {@setup.sync_root_keys}],
-                     [:repo_proxy, "Proxy packaging repositories on ubuntu, debian and solaris-11", Proc.new {@repo_controller.proxy_config}],
-                     [:add_el_extras, "Add Extra Packages for Enterprise Linux (EPEL) repository to el-* hosts", Proc.new {@repo_controller.add_el_extras}],
-                     [:add_master_entry, "Update /etc/hosts on master with master's ip", Proc.new {@setup.add_master_entry}]]
-      begin
-        #setup phase
-        setup_steps.each do |step|
-          if (not @options.has_key?(step[0])) or @options[step[0]]
-            @logger.notify ""
-            @logger.notify "Setup: #{step[1]}"
-            step[2].call
-          end
-        end
-      rescue => e
-        report_and_raise(@logger, e, "CLI.setup")
-      end
-    end
-
+    #Run Beaker tests.
+    #
+    # - provision hosts (includes validation and configuration)
+    # - run pre-suite
+    # - run tests
+    # - run post-suite
+    # - cleanup hosts
     def execute!
 
       if !@execute
@@ -98,8 +76,6 @@ module Beaker
         end
 
         provision
-        validate
-        setup
 
         errored = false
 
@@ -142,7 +118,11 @@ module Beaker
       end
     end
 
-    def run_suite(suite_name, failure_strategy = false)
+    #Run the provided test suite
+    #@param [Symbol] suite_name The test suite to execute
+    #@param [String] failure_strategy How to proceed after a test failure, 'fast' = stop running tests immediately, 'slow' =
+    #                                 continue to execute tests.
+    def run_suite(suite_name, failure_strategy = :slow)
       if (@options[suite_name].empty?)
         @logger.notify("No tests to run for suite '#{suite_name.to_s}'")
         return

data/lib/beaker/host_prebuilt_steps.rb

@@ -0,0 +1,335 @@
+%w(command).each do |lib|
+  begin
+    require "beaker/#{lib}"
+  rescue LoadError
+    require File.expand_path(File.join(File.dirname(__FILE__), lib))
+  end
+end
+
+module Beaker
+  #Provides convienience methods for commonly run actions on hosts
+  module HostPrebuiltSteps
+    NTPSERVER = 'pool.ntp.org'
+    SLEEPWAIT = 5
+    TRIES = 5
+    PACKAGES = ['curl']
+    UNIX_PACKAGES = ['ntpdate']
+    SLES_PACKAGES = ['ntp']
+    ETC_HOSTS_PATH = "/etc/hosts"
+    ETC_HOSTS_PATH_SOLARIS = "/etc/inet/hosts"
+    ROOT_KEYS_SCRIPT = "https://raw.github.com/puppetlabs/puppetlabs-sshkeys/master/templates/scripts/manage_root_authorized_keys"
+    ROOT_KEYS_SYNC_CMD = "curl -k -o - #{ROOT_KEYS_SCRIPT} | %s"
+    APT_CFG = %q{ Acquire::http::Proxy "http://proxy.puppetlabs.net:3128/"; }
+    IPS_PKG_REPO="http://solaris-11-internal-repo.delivery.puppetlabs.net"
+
+    #Run timesync on the provided hosts
+    # @param [Host, Array<Host>, String, Symbol] host One or more hosts to act upon
+    # @param [Hash{Symbol=>String}] opts Options to alter execution.
+    # @option opts [Beaker::Logger] :logger A {Beaker::Logger} object
+    def timesync host, opts
+      logger = opts[:logger]
+      if host.is_a? Array
+        host.map { |h| timesync(h, opts) }
+      else
+        logger.notify "Update system time sync for '#{host.name}'"
+        if host['platform'].include? 'windows'
+          # The exit code of 5 is for Windows 2008 systems where the w32tm /register command
+          # is not actually necessary.
+          host.exec(Command.new("w32tm /register"), :acceptable_exit_codes => [0,5])
+          host.exec(Command.new("net start w32time"), :acceptable_exit_codes => [0,2])
+          host.exec(Command.new("w32tm /config /manualpeerlist:#{NTPSERVER} /syncfromflags:manual /update"))
+          host.exec(Command.new("w32tm /resync"))
+          logger.notify "NTP date succeeded on #{host}"
+        else
+          case
+            when host['platform'] =~ /solaris-10/
+              ntp_command = "sleep 10 && ntpdate -w #{NTPSERVER}"
+            when host['platform'] =~ /sles-/
+              ntp_command = "sntp #{NTPSERVER}"
+            else
+              ntp_command = "ntpdate -t 20 #{NTPSERVER}"
+          end
+          success=false
+          try = 0
+          until try >= TRIES do
+            try += 1
+            if host.exec(Command.new(ntp_command), :acceptable_exit_codes => (0..255)).exit_code == 0
+              success=true
+              break
+            end
+            sleep SLEEPWAIT
+          end
+          if success
+            logger.notify "NTP date succeeded on #{host} after #{try} tries"
+          else
+            raise "NTP date was not successful after #{try} tries"
+          end
+        end
+      end
+    rescue => e
+      report_and_raise(logger, e, "timesync (--ntp)")
+    end
+
+    #Validate that hosts are prepared to be used as SUTs, if packages are missing attempt to
+    #install them.  Verifies the presence of {HostPrebuiltSteps::PACKAGES} on all hosts and 
+    #{HostPrebuiltSteps::UNIX_PACKAGES} on unix platform hosts.
+    # @param [Host, Array<Host>, String, Symbol] host One or more hosts to act upon
+    # @param [Hash{Symbol=>String}] opts Options to alter execution.
+    # @option opts [Beaker::Logger] :logger A {Beaker::Logger} object
+    def validate_host host, opts
+      logger = opts[:logger]
+      if host.is_a? Array
+        host.map { |h| validate_host(h, opts) }
+      else
+        PACKAGES.each do |pkg|
+          if not host.check_for_package pkg
+            host.install_package pkg
+          end
+        end
+        case
+          when host['platform'] =~ /sles-/
+            SLES_PACKAGES.each do |pkg|
+              if not host.check_for_package pkg
+                host.install_package pkg
+              end
+            end
+
+          when host['platform'] !~ /(windows)|(aix)|(solaris)/
+            UNIX_PACKAGES.each do |pkg|
+              if not host.check_for_package pkg
+                host.install_package pkg
+              end
+            end
+        end
+      end
+    rescue => e
+      report_and_raise(logger, e, "validate")
+    end
+
+    #Update /etc/hosts on the master node to include a rule for lookup of the master by name/ip.
+    # @param [Host, Array<Host>, String, Symbol] host One or more hosts to act upon
+    # @param [Hash{Symbol=>String}] opts Options to alter execution.
+    # @option opts [Beaker::Logger] :logger A {Beaker::Logger} object
+    def add_master_entry hosts, opts
+      logger = opts[:logger]
+      master = only_host_with_role(hosts, :master)
+      logger.notify "Add Master entry to /etc/hosts on #{master.name}"
+      if master["hypervisor"] and master["hypervisor"] =~ /vagrant/
+        logger.debug "Don't update master entry on vagrant masters"
+        return
+      end
+      logger.debug "Get ip address of Master #{master}"
+      if master['platform'].include? 'solaris'
+        stdout = master.exec(Command.new("ifconfig -a inet| awk '/broadcast/ {print $2}' | cut -d/ -f1 | head -1")).stdout
+      else
+        stdout = master.exec(Command.new("ip a|awk '/global/{print$2}' | cut -d/ -f1 | head -1")).stdout
+      end
+      ip=stdout.chomp
+
+      path = ETC_HOSTS_PATH
+      if master['platform'].include? 'solaris'
+        path = ETC_HOSTS_PATH_SOLARIS
+      end
+
+      logger.debug "Update %s on #{master}" % path
+      # Preserve the mode the easy way...
+      master.exec(Command.new("cp %s %s.old" % [path, path]))
+      master.exec(Command.new("cp %s %s.new" % [path, path]))
+      master.exec(Command.new("grep -v '#{ip} #{master}' %s > %s.new" % [path, path]))
+      master.exec(Command.new("echo '#{ip} #{master}' >> %s.new" % path))
+      master.exec(Command.new("mv %s.new %s" % [path, path]))
+    rescue => e
+      report_and_raise(logger, e, "add_master_entry")
+    end
+
+    #Install a set of authorized keys using {HostPrebuiltSteps::ROOT_KEYS_SCRIPT}.  This is a 
+    #convenience method to allow for easy login to hosts after they have been provisioned with 
+    #Beaker.
+    # @param [Host, Array<Host>, String, Symbol] host One or more hosts to act upon
+    # @param [Hash{Symbol=>String}] opts Options to alter execution.
+    # @option opts [Beaker::Logger] :logger A {Beaker::Logger} object
+    def sync_root_keys host, opts
+      # JJM This step runs on every system under test right now.  We're anticipating
+      # issues on Windows and maybe Solaris.  We will likely need to filter this step
+      # but we're deliberately taking the approach of "assume it will work, fix it
+      # when reality dictates otherwise"
+      logger = opts[:logger]
+      if host.is_a? Array
+        host.map { |h| sync_root_keys(h, opts) }
+      else
+      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'].include? 'solaris'
+          host.exec(Command.new(ROOT_KEYS_SYNC_CMD % "bash"), :acceptable_exit_codes => (0..255))
+        else
+          host.exec(Command.new(ROOT_KEYS_SYNC_CMD % "env PATH=/usr/gnu/bin:$PATH bash"), :acceptable_exit_codes => (0..255))
+        end
+      end
+    rescue => e
+      report_and_raise(logger, e, "sync_root_keys")
+    end
+
+    #Determine the Extra Packages for Enterprise Linux URL for the provided Enterprise Linux host.
+    # @param [Host] host One host to act upon
+    # @return [String] The URL for EPL for the provided host
+    # @raise [Exception] Raises an error if the host provided's platform != /el-(5|6)/
+    def epel_info_for! host
+      version = host['platform'].match(/el-(\d+)/)
+      if not version
+        raise "epel_info_for! not available for #{host.name} on platform #{host['platform']}"
+      end
+      version = version[1]
+      if version == '6'
+        pkg = 'epel-release-6-8.noarch.rpm'
+        url = "http://mirror.itc.virginia.edu/fedora-epel/6/i386/#{pkg}"
+      elsif version == '5'
+        pkg = 'epel-release-5-4.noarch.rpm'
+        url = "http://archive.linux.duke.edu/pub/epel/5/i386/#{pkg}"
+      else
+        raise "epel_info_for! does not support el version #{version}, on #{host.name}"
+      end
+      return url
+    end
+
+    #Run 'apt-get update' on the provided host or hosts.  If the platform of the provided host is not
+    #ubuntu or debian do nothing.
+    # @param [Host, Array<Host>, String, Symbol] host One or more hosts to act upon
+    def apt_get_update host
+      if host.is_a? Array
+        host.map { |h| apt_get_update(h) }
+      else
+        if host[:platform] =~ /(ubuntu)|(debian)/ 
+          host.exec(Command.new("apt-get -y -f -m update"))
+        end
+      end
+    end
+
+    #Create a file on host or hosts at the provided file path with the provided file contents.
+    # @param [Host, Array<Host>, String, Symbol] host One or more hosts to act upon
+    # @param [String] file_path The path at which the new file will be created on the host or hosts.
+    # @param [String] file_content The contents of the file to be created on the host or hosts.
+    def copy_file_to_remote(host, file_path, file_content)
+      if host.is_a? Array
+        host.map { |h| copy_file_to_remote(h, file_path, file_contents) }
+      else
+        Tempfile.open 'beaker' do |tempfile|
+          File.open(tempfile.path, 'w') {|file| file.puts file_content }
+
+          host.do_scp_to(tempfile.path, file_path, @options)
+        end
+      end
+    end
+
+    #Alter apt configuration on ubuntu and debian host or hosts to internal Puppet Labs
+    # proxy {HostPrebuiltSteps::APT_CFG} proxy, alter pkg on solaris-11 host or hosts 
+    # to point to interal Puppetlabs proxy {HostPrebuiltSteps::IPS_PKG_REPO}. Do nothing
+    # on non-ubuntu, debian or solaris-11 platform host or hosts.
+    # @param [Host, Array<Host>, String, Symbol] host One or more hosts to act upon
+    # @param [Hash{Symbol=>String}] opts Options to alter execution.
+    # @option opts [Beaker::Logger] :logger A {Beaker::Logger} object
+    def proxy_config( host, opts )
+      # repo_proxy
+      # supports ubuntu, debian and solaris platforms
+      logger = opts[:logger]
+      if host.is_a? Array
+        host.map { |h| proxy_config(h, opts) }
+      else
+        case
+        when host['platform'] =~ /ubuntu/
+          host.exec(Command.new("if test -f /etc/apt/apt.conf; then mv /etc/apt/apt.conf /etc/apt/apt.conf.bk; fi"))
+          copy_file_to_remote(host, '/etc/apt/apt.conf', APT_CFG)
+          apt_get_update(host)
+        when host['platform'] =~ /debian/
+          host.exec(Command.new("if test -f /etc/apt/apt.conf; then mv /etc/apt/apt.conf /etc/apt/apt.conf.bk; fi"))
+          copy_file_to_remote(host, '/etc/apt/apt.conf', APT_CFG)
+          apt_get_update(host)
+        when host['platform'] =~ /solaris-11/
+          host.exec(Command.new("/usr/bin/pkg unset-publisher solaris || :"))
+          host.exec(Command.new("/usr/bin/pkg set-publisher -g %s solaris" % IPS_PKG_REPO))
+        else
+          logger.debug "#{host}: repo proxy configuration not modified"
+        end
+      end
+    rescue => e
+      report_and_raise(logger, e, "proxy_config")
+    end
+
+    #Install EPEL on host or hosts with platform = /el-(5|6)/.  Do nothing on host or hosts of other platforms.
+    # @param [Host, Array<Host>, String, Symbol] host One or more hosts to act upon
+    # @param [Hash{Symbol=>String}] opts Options to alter execution.
+    # @option opts [Boolean] :debug If true, print verbose rpm information when installing EPEL
+    # @option opts [Beaker::Logger] :logger A {Beaker::Logger} object
+    def add_el_extras( host, opts )
+      #add_el_extras
+      #only supports el-* platforms
+      logger = opts[:logger]
+      debug_opt = opts[:debug] ? 'vh' : ''
+      if host.is_a? Array
+        host.map { |h| add_el_extras(h, opts) }
+      else
+        case
+        when host['platform'] =~ /el-(5|6)/
+          result = host.exec(Command.new('rpm -qa | grep epel-release'), :acceptable_exit_codes => [0,1])
+          if result.exit_code == 1
+            url = epel_info_for! host
+            host.exec(Command.new("rpm -i#{debug_opt} #{url}"))
+            host.exec(Command.new('yum clean all && yum makecache'))
+          end
+        else
+          logger.debug "#{host}: package repo configuration not modified"
+        end
+      end
+    rescue => e
+      report_and_raise(logger, e, "add_repos")
+    end
+
+    #Determine the domain name of the provided host from its /etc/resolv.conf
+    # @param [Host] host the host to act upon
+    def get_domain_name(host)
+      domain = nil
+      search = nil
+      resolv_conf = host.exec(Command.new("cat /etc/resolv.conf")).stdout
+      resolv_conf.each_line { |line|
+        if line =~ /^\s*domain\s+(\S+)/
+          domain = $1
+        elsif line =~ /^\s*search\s+(\S+)/
+          search = $1
+        end
+      }
+      return domain if domain
+      return search if search
+    end
+
+    #Determine the ip address of the provided host 
+    # @param [Host] host the host to act upon
+    def get_ip(host)
+      host.exec(Command.new("ip a|awk '/global/{print$2}' | cut -d/ -f1 | head -1")).stdout.chomp
+    end
+
+    #Append the provided string to the /etc/hosts file of the provided host
+    # @param [Host] host the host to act upon
+    # @param [String] etc_hosts The string to append to the /etc/hosts file
+    def set_etc_hosts(host, etc_hosts)
+      host.exec(Command.new("echo '#{etc_hosts}' > /etc/hosts"))
+    end
+
+    #Make it possible to log in as root by copying the current users ssh keys to the root account
+    # @param [Host, Array<Host>, String, Symbol] host One or more hosts to act upon
+    # @param [Hash{Symbol=>String}] opts Options to alter execution.
+    # @option opts [Beaker::Logger] :logger A {Beaker::Logger} object
+    def copy_ssh_to_root host, opts
+      logger = opts[:logger]
+      if host.is_a? Array
+        host.map { |h| copy_ssh_to_root(h, opts) }
+      else
+        logger.debug "Give root a copy of current user's keys, on #{host.name}"
+        if host['platform'] =~ /windows/
+          host.exec(Command.new('sudo su -c "cp -r .ssh /home/Administrator/."'))
+        else
+          host.exec(Command.new('sudo su -c "cp -r .ssh /root/."'))
+        end
+      end
+    end
+
+  end
+end