beaker 1.16.0 → 1.17.0

data/lib/beaker/host_prebuilt_steps.rb

@@ -1,16 +1,19 @@
-[ 'command' ].each do |lib|
+[ 'command', "dsl/patterns" ].each do |lib|
   require "beaker/#{lib}"
 end
 
 module Beaker
   #Provides convienience methods for commonly run actions on hosts
   module HostPrebuiltSteps
+    include Beaker::DSL::Patterns
+
     NTPSERVER = 'pool.ntp.org'
     SLEEPWAIT = 5
     TRIES = 5
     UNIX_PACKAGES = ['curl', 'ntpdate']
     WINDOWS_PACKAGES = ['curl']
     SLES_PACKAGES = ['curl', 'ntp']
+    DEBIAN_PACKAGES = ['curl', 'ntpdate', 'lsb-release']
     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"
@@ -19,14 +22,12 @@ module Beaker
     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 [Host, Array<Host>] 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
+      block_on host do |host|
         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
@@ -68,16 +69,19 @@ module Beaker
 
     #Validate that hosts are prepared to be used as SUTs, if packages are missing attempt to
     #install them.  Verifies the presence of #{HostPrebuiltSteps::UNIX_PACKAGES} on unix platform hosts,
-    #{HostPrebuiltSteps::SLES_PACKAGES} on SUSE platform hosts and {HostPrebuiltSteps::WINDOWS_PACKAGES} on windows
+    #{HostPrebuiltSteps::SLES_PACKAGES} on SUSE platform hosts, #{HostPrebuiltSteps::DEBIAN_PACKAGES on debian platform
+    #hosts and {HostPrebuiltSteps::WINDOWS_PACKAGES} on windows
     #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 [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
+      if opts[:collect_perf_data]
+        UNIX_PACKAGES << "sysstat" if !UNIX_PACKAGES.include? "sysstat"
+        SLES_PACKAGES << "sysstat" if !SLES_PACKAGES.include? "sysstat"
+      end
+      block_on host do |host|
         case
         when host['platform'] =~ /sles-/
           SLES_PACKAGES.each do |pkg|
@@ -85,13 +89,19 @@ module Beaker
               host.install_package pkg
             end
           end
+        when host['platform'] =~ /debian/
+          DEBIAN_PACKAGES.each do |pkg|
+            if not host.check_for_package pkg
+              host.install_package pkg
+            end
+          end
         when host['platform'] =~ /windows/
           WINDOWS_PACKAGES.each do |pkg|
             if not host.check_for_package pkg
               host.install_package pkg
             end
           end
-        when host['platform'] !~ /aix|solaris|windows|sles-|osx-/
+        when host['platform'] !~ /debian|aix|solaris|windows|sles-|osx-/
           UNIX_PACKAGES.each do |pkg|
             if not host.check_for_package pkg
               host.install_package pkg
@@ -106,7 +116,7 @@ module Beaker
     #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 [Host, Array<Host>] 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
@@ -115,9 +125,7 @@ module Beaker
       # 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
+      block_on host do |host|
       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'
@@ -154,11 +162,9 @@ module Beaker
 
     #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
+    # @param [Host, Array<Host>] hosts One or more hosts to act upon
+    def apt_get_update hosts
+      block_on hosts do |host|
         if host[:platform] =~ /(ubuntu)|(debian)/
           host.exec(Command.new("apt-get update"))
         end
@@ -166,13 +172,11 @@ module Beaker
     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 [Host, Array<Host>] 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
+      block_on host do |host|
         Tempfile.open 'beaker' do |tempfile|
           File.open(tempfile.path, 'w') {|file| file.puts file_content }
 
@@ -185,16 +189,14 @@ module Beaker
     # 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 [Host, Array<Host>] 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
+      block_on host do |host|
         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"))
@@ -216,7 +218,7 @@ module Beaker
     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 [Host, Array<Host>] 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
@@ -225,9 +227,7 @@ module Beaker
       #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
+      block_on host do |host|
         case
         when host['platform'] =~ /el-(5|6)/
           result = host.exec(Command.new('rpm -qa | grep epel-release'), :acceptable_exit_codes => [0,1])
@@ -276,14 +276,12 @@ module Beaker
     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 [Host, Array<Host>] 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
+      block_on host do |host|
         logger.debug "Give root a copy of current user's keys, on #{host.name}"
         if host['platform'] =~ /windows/
           host.exec(Command.new('cp -r .ssh /cygdrive/c/Users/Administrator/.'))
@@ -296,7 +294,7 @@ module Beaker
 
     #Update /etc/hosts to make it possible for each provided host to reach each other host by name.
     #Assumes that each provided host has host[:ip] set.
-    # @param [Host, Array<Host>, String, Symbol] hosts An array of hosts to act upon
+    # @param [Host, Array<Host>] hosts An array of hosts to act upon
     # @param [Hash{Symbol=>String}] opts Options to alter execution.
     # @option opts [Beaker::Logger] :logger A {Beaker::Logger} object
     def hack_etc_hosts hosts, opts
@@ -310,14 +308,12 @@ module Beaker
     end
 
     #Update sshd_config on debian, ubuntu, centos, el, redhat and fedora boxes to allow for root login, does nothing on other platfoms
-    # @param [Host, Array<Host>, String, Symbol] host One or more hosts to act upon
+    # @param [Host, Array<Host>] 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 enable_root_login host, opts
       logger = opts[:logger]
-      if host.is_a? Array
-        host.map { |h| copy_ssh_to_root(h, opts) }
-      else
+      block_on host do |host|
         logger.debug "Update /etc/ssh/sshd_config to allow root login"
         host.exec(Command.new("sudo su -c \"sed -i 's/PermitRootLogin no/PermitRootLogin yes/' /etc/ssh/sshd_config\""), {:pty => true}
   )
@@ -333,14 +329,12 @@ module Beaker
     end
 
     #Disable SELinux on centos, does nothing on other platforms
-    # @param [Host, Array<Host>, String, Symbol] host One or more hosts to act upon
+    # @param [Host, Array<Host>] 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 disable_se_linux host, opts
       logger = opts[:logger]
-      if host.is_a? Array
-        host.map { |h| copy_ssh_to_root(h, opts) }
-      else
+      block_on host do |host|
         if host['platform'] =~ /centos|el-|redhat|fedora/
           @logger.debug("Disabling se_linux on #{host.name}")
           host.exec(Command.new("sudo su -c \"setenforce 0\""), {:pty => true})
@@ -351,14 +345,12 @@ module Beaker
     end
 
     #Disable iptables on centos, does nothing on other platforms
-    # @param [Host, Array<Host>, String, Symbol] host One or more hosts to act upon
+    # @param [Host, Array<Host>] 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 disable_iptables host, opts
       logger = opts[:logger]
-      if host.is_a? Array
-        host.map { |h| copy_ssh_to_root(h, opts) }
-      else
+      block_on host do |host|
         if host['platform'] =~ /centos|el-|redhat|fedora/
           logger.debug("Disabling iptables on #{host.name}")
           host.exec(Command.new("sudo su -c \"/etc/init.d/iptables stop\""), {:pty => true})
@@ -377,9 +369,7 @@ module Beaker
     def package_proxy host, opts
       logger = opts[:logger]
 
-      if host.is_a? Array
-          host.map { |h| package_proxy(h, opts) }
-      else
+      block_on host do |host|
         logger.debug("enabling proxy support on #{host.name}")
         case host['platform']
           when /ubuntu/, /debian/

data/lib/beaker/hypervisor/aws_sdk.rb

@@ -10,6 +10,8 @@ module Beaker
   # It is built for full control, to reduce any other layers beyond the pure
   # vendor API.
   class AwsSdk < Beaker::Hypervisor
+    ZOMBIE = 3 #anything older than 3 hours is considered a zombie
+
     # Initialize AwsSdk hypervisor driver
     #
     # @param [Array<Beaker::Host>] hosts Array of Beaker::Host objects
@@ -47,6 +49,9 @@ module Beaker
       # Wait for each node to reach status :running
       wait_for_status(:running)
 
+      # Add metadata tags to each instance
+      add_tags()
+
       # Grab the ip addresses and dns from EC2 for each instance to use for ssh
       populate_dns()
 
@@ -83,6 +88,43 @@ module Beaker
       nil #void
     end
 
+    #Shutdown and destroy ec2 instances idenfitied by key that have been alive longer than ZOMBIE hours.
+    #@param [Integer] max_age The age in hours that a machine needs to be older than to be considered a zombie
+    #@param [String] key The key_name to match for
+    def kill_zombies(max_age = ZOMBIE, key = key_name)
+      @logger.notify("aws-sdk: Kill Zombies!")
+      #examine all available regions
+      @ec2.regions.each do |region|
+        @logger.debug "Reviewing: #{region.name}"
+        @ec2.regions[region.name].instances.each do |instance|
+          if (instance.key_name =~ /#{key}/) and (instance.launch_time + (ZOMBIE*60*60)) < Time.now and instance.status.to_s !~ /terminated/
+            @logger.debug "Kill! #{instance.id}: #{instance.key_name} (Current status: #{instance.status})"
+            begin
+              instance.terminate()
+            rescue AWS::EC2::Errors => e
+              @logger.debug "Failed to remove instance: #{instance.id}, #{e}"
+            end
+          end
+        end
+        # Occasionaly, tearing down ec2 instances leaves orphaned EBS volumes behind -- these stack up quickly.
+        # This simply looks for EBS volumes that are not in use
+        # Note: don't use volumes.each here as that funtion doesn't allow proper rescue from error states
+        volumes = @ec2.regions[region.name].volumes.map { |vol| vol.id }
+        volumes.each do |vol|
+          begin
+            vol = @ec2.regions[region.name].volumes[vol]
+            if ( vol.status.to_s =~ /available/ )
+              @logger.debug "Tear down available volume: #{vol.id}"
+              vol.delete()
+            end
+          rescue AWS::EC2::Errors::InvalidVolume::NotFound => e
+            @logger.debug "Failed to remove volume: #{vol.id}, #{e}"
+          end
+        end
+      end
+
+    end
+
     # Launch all nodes
     #
     # This is where the main launching work occurs for each node. Here we take
@@ -157,13 +199,6 @@ module Beaker
         # manipulated by 'cleanup' for example.
         host['instance'] = instance
 
-        # Define tags for the instance
-        @logger.notify("aws-sdk: Add tags")
-        instance.add_tag("jenkins_build_url", :value => @options[:jenkins_build_url])
-        instance.add_tag("Name", :value => host.name)
-        instance.add_tag("department", :value => @options[:department])
-        instance.add_tag("project", :value => @options[:project])
-
         @logger.notify("aws-sdk: Launched #{host.name} (#{amitype}:#{amisize}) using snapshot/image_type #{image_type}")
       end
 
@@ -198,23 +233,41 @@ module Beaker
           backoff_sleep(tries)
         end
 
-        # Set the IP to be the dns_name of the host, yes I know its not an IP.
-        host['ip'] = instance.dns_name
       end
     end
 
-    # Populate the hosts IP address and vmhostname entry from the EC2 dns_name
+    #Add metadata tags to all instances
+    #
+    # @return [void]
+    # @api private
+    def add_tags
+      @hosts.each do |host|
+        instance = host['instance']
+
+        # Define tags for the instance
+        @logger.notify("aws-sdk: Add tags for #{host.name}")
+        instance.add_tag("jenkins_build_url", :value => @options[:jenkins_build_url])
+        instance.add_tag("Name", :value => host.name)
+        instance.add_tag("department", :value => @options[:department])
+        instance.add_tag("project", :value => @options[:project])
+      end
+
+      nil
+    end
+
+    # Populate the hosts IP address from the EC2 dns_name
     #
     # @return [void]
     # @api private
     def populate_dns
       # Obtain the IP addresses and dns_name for each host
       @hosts.each do |host|
+        @logger.notify("aws-sdk: Populate DNS for #{host.name}")
         instance = host['instance']
-        host['vmhostname'] = instance.dns_name
         host['ip'] = instance.ip_address
         host['private_ip'] = instance.private_ip_address
-        @logger.notify("aws-sdk: name: #{host.name} vmhostname: #{host['vmhostname']} ip: #{host['ip']} private_ip: #{host['private_ip']}")
+        host['dns_name'] = instance.dns_name
+        @logger.notify("aws-sdk: name: #{host.name} ip: #{host['ip']} private_ip: #{host['private_ip']} dns_name: #{instance.dns_name}")
       end
 
       nil
@@ -225,10 +278,21 @@ module Beaker
     # @return [void]
     # @api private
     def configure_hosts
-      base = "127.0.0.1\tlocalhost localhost.localdomain\n"
       @hosts.each do |host|
-        hn = host.hostname
-        etc_hosts = base + "#{host['private_ip']}\t#{hn} #{hn.split(".")[0]}\n"
+        etc_hosts = "127.0.0.1\tlocalhost localhost.localdomain\n"
+        name = host.name
+        domain = get_domain_name(host)
+        ip = host['private_ip']
+        etc_hosts += "#{ip}\t#{name} #{name}.#{domain} #{host['dns_name']}\n"
+        @hosts.each do |neighbor|
+          if neighbor == host
+            next
+          end
+          name = neighbor.name
+          domain = get_domain_name(neighbor)
+          ip = neighbor['ip']
+          etc_hosts += "#{ip}\t#{name} #{name}.#{domain} #{neighbor['dns_name']}\n"
+        end
         set_etc_hosts(host, etc_hosts)
       end
     end
@@ -240,7 +304,7 @@ module Beaker
     # @api private
     def set_hostnames
       @hosts.each do |host|
-        host.exec(Command.new("hostname #{host['vmhostname']}"))
+        host.exec(Command.new("hostname #{host.name}"))
       end
     end
 

data/lib/beaker/hypervisor/ec2_helper.rb

@@ -7,7 +7,7 @@ module Beaker
     # @return [Array<Number>] array of port numbers
     # @api private
     def self.amiports(roles)
-      ports = [22]
+      ports = [22, 61613, 8139]
 
       if roles.include? 'database'
         ports << 8080

data/lib/beaker/logger.rb

@@ -4,6 +4,10 @@ module Beaker
     # to a given destination (be it a string or file)
     #
   class Logger
+
+    #The results of the most recently run command
+    attr_accessor :last_result
+
     NORMAL         = "\e[00;00m"
     BRIGHT_NORMAL  = "\e[00;01m"
     BLACK          = "\e[00;30m"
@@ -65,6 +69,9 @@ module Beaker
       else
         @log_level = :verbose
       end
+
+      @last_result = nil
+
       @destinations = []
 
       dests = args
@@ -164,6 +171,16 @@ module Beaker
       optionally_color GREY, string, false
     end
 
+    # Custom reporting for performance/sysstat messages
+    # Will not print unless we are at {LOG_LEVELS} 'debug' or higher.
+    # @param args[Array<String>] Strings to be reported
+    def perf_output *args
+      return unless is_debug?
+      strings = strip_colors_from args
+      string = strings.join
+      optionally_color MAGENTA, string, false
+    end
+
     # Report a debug message.
     # Will not print unless we are at {LOG_LEVELS} 'debug' or higher.
     # @param args[Array<String>] Strings to be reported

data/lib/beaker/options/command_line_parser.rb

@@ -201,6 +201,9 @@ module Beaker
             #noop
           end
 
+          opts.on '--collect-perf-data', 'Use sysstat on linux hosts to collect performance and load data' do
+            @cmd_options[:collect_perf_data] = true
+          end
         end
 
       end

data/lib/beaker/options/hosts_file_parser.rb

@@ -12,12 +12,16 @@ module Beaker
       #
       # @return [OptionsHash] The contents of the hosts file as an OptionsHash
       # @raise [ArgumentError] Raises if hosts_file_path is not a path to a file, or is not a valid YAML file
-      def self.parse_hosts_file(hosts_file_path)
+      def self.parse_hosts_file(hosts_file_path = nil)
+        host_options = Beaker::Options::OptionsHash.new
+        host_options['HOSTS'] ||= {}
+        unless hosts_file_path
+           return host_options
+        end
         hosts_file_path = File.expand_path(hosts_file_path)
         unless File.exists?(hosts_file_path)
-          raise ArgumentError, "Required host file '#{hosts_file_path}' does not exist!"
+          raise ArgumentError, "Host file '#{hosts_file_path}' does not exist!"
         end
-        host_options = Beaker::Options::OptionsHash.new
         begin
           host_options = host_options.merge(YAML.load_file(hosts_file_path))
         rescue Psych::SyntaxError => e
@@ -25,7 +29,6 @@ module Beaker
         end
 
         # Make sure the roles array is present for all hosts
-        host_options['HOSTS'] ||= {}
         host_options['HOSTS'].each_key do |host|
           host_options['HOSTS'][host]['roles'] ||= []
         end

data/lib/beaker/options/options_hash.rb

@@ -42,7 +42,7 @@ module Beaker
 
       # Determine if type of ObjectHash is pe, defaults to true
       #
-      # @example Use this method to return the value for a given key
+      # @example Use this method to test if the :type setting is pe
       #     a['type'] = 'pe'
       #     a.is_pe? == true
       #
@@ -98,7 +98,7 @@ module Beaker
       def rmerge base, hash
         return base unless hash.is_a?(Hash) || hash.is_a?(OptionsHash)
         hash.each do |key, v|
-          if (base[key].is_a?(Hash) || base[key].is_a?(OptionsHash)) && (hash[key].is_a?(Hash) || has[key].is_a?(OptionsHash))
+          if (base[key].is_a?(Hash) || base[key].is_a?(OptionsHash)) && (hash[key].is_a?(Hash) || hash[key].is_a?(OptionsHash))
             rmerge(base[key], hash[key])
           elsif hash[key].is_a?(Hash)
             base[key] = OptionsHash.new.merge(hash[key])

data/lib/beaker/options/parser.rb

@@ -149,7 +149,7 @@ module Beaker
           if not master.empty? and master.length == 1
             default_host_name = master[0]
           elsif hosts.length == 1
-            default_host_name = hosts[0].keys[0]
+            default_host_name = hosts.keys[0]
           end
           if default_host_name
             hosts[default_host_name][:roles] << 'default'