beaker 2.24.0 → 2.25.0

data/lib/beaker/dsl/structure.rb

@@ -36,9 +36,13 @@ module Beaker
       # @param [String] step_name The name of the step to be logged.
       # @param [Proc] block The actions to be performed in this step.
       def step step_name, &block
-        logger.notify "\n  * #{step_name}\n"
+        logger.notify "\n* #{step_name}\n"
         set_current_step_name(step_name)
-        yield if block_given?
+        if block_given?
+          logger.step_in()
+          yield
+          logger.step_out()
+        end
       end
 
       # Provides a method to name tests.
@@ -49,7 +53,11 @@ module Beaker
       def test_name my_name, &block
         logger.notify "\n#{my_name}\n"
         set_current_test_name(my_name)
-        yield if block_given?
+        if block_given?
+          logger.step_in()
+          yield
+          logger.step_out()
+        end
       end
 
       # Declare a teardown process that will be called after a test case is
@@ -170,6 +178,12 @@ module Beaker
       # @example Confining from  an already defined subset of hosts
       #     confine :except, {}, agents
       #
+      # @example Confining to all ubuntu agents + all non-agents
+      #     confine :to, { :platform => 'ubuntu' }, agents
+      #
+      # @example Confining to any non-windows agents + all non-agents
+      #     confine :except, { :platform => 'windows' }, agents
+      #
       #
       # @return [Array<Host>] Returns an array of hosts that are still valid
       #   targets for this tests case.
@@ -177,17 +191,18 @@ module Beaker
       #   this test case after confinement.
       def confine(type, criteria, host_array = nil, &block)
         hosts_to_modify = Array( host_array || hosts )
+        hosts_not_modified = hosts - hosts_to_modify #we aren't examining these hosts
         case type
         when :except
           if criteria and ( not criteria.empty? )
-            hosts_to_modify = hosts_to_modify - select_hosts(criteria, hosts_to_modify, &block)
+            hosts_to_modify = hosts_to_modify - select_hosts(criteria, hosts_to_modify, &block) + hosts_not_modified
           else
             # confining to all hosts *except* provided array of hosts
-            hosts_to_modify = hosts - host_array
+            hosts_to_modify = hosts_not_modified
           end
         when :to
           if criteria and ( not criteria.empty? )
-            hosts_to_modify = select_hosts(criteria, hosts_to_modify, &block)
+            hosts_to_modify = select_hosts(criteria, hosts_to_modify, &block) + hosts_not_modified
           else
             # confining to only hosts in provided array of hosts
           end
@@ -214,7 +229,13 @@ module Beaker
 
         yield
 
-      rescue Beaker::DSL::Outcomes::SkipTest
+      rescue Beaker::DSL::Outcomes::SkipTest => e
+        # I don't like this much, but adding options to confine is a breaking change
+        # to the DSL that would involve a major version bump
+        if e.message !~ /No suitable hosts found/
+          # a skip generated from the provided block, pass it up the chain
+          raise e
+        end
       ensure
         self.hosts = original_hosts
       end

data/lib/beaker/host.rb

@@ -274,9 +274,11 @@ module Beaker
         # and they shouldn't be ssh specific
         result = nil
 
+        @logger.step_in()
         seconds = Benchmark.realtime {
           result = connection.execute(cmdline, options, output_callback)
         }
+        @logger.step_out()
 
         if not options[:silent]
           @logger.debug "\n#{log_prefix} executed in %0.2f seconds" % seconds

data/lib/beaker/host_prebuilt_steps.rb

@@ -160,7 +160,7 @@ module Beaker
     # @return [String, String, String] The URL, arch  and package name for EPL for the provided host
     # @param [Hash{Symbol=>String}] opts Options to alter execution.
     # @option opts [String] :epel_url Link to download
-    # @option opts [String] :epel_arch Architecture to download (i386, x86_64, etc), defaults to i386
+    # @option opts [String] :epel_arch Architecture to download (i386, x86_64, etc), defaults to i386 for 5 and 6, x86_64 for 7
     # @option opts [String] :epel_6_pkg Package to download from provided link for el-6
     # @option opts [String] :epel_5_pkg Package to download from provided link for el-5
     # @raise [Exception] Raises an error if the host provided's platform != /el-(5|6)/
@@ -170,16 +170,23 @@ module Beaker
       end
 
       version = host['platform'].version
-      if version == '6'
-        url = "#{host[:epel_url] || opts[:epel_url]}/#{version}"
+      url = "#{host[:epel_url] || opts[:epel_url]}/#{version}"
+      if version == '7'
+        if opts[:epel_7_arch] == 'i386'
+          raise ArgumentError.new("epel-7 does not provide packages for i386")
+        end
+        pkg = host[:epel_pkg] || opts[:epel_7_pkg]
+        arch = opts[:epel_7_arch] || 'x86_64'
+      elsif version == '6'
         pkg = host[:epel_pkg] || opts[:epel_6_pkg]
+        arch = host[:epel_arch] || opts[:epel_6_arch] || 'i386'
       elsif version == '5'
-        url = "#{host[:epel_url] || opts[:epel_url]}/#{version}"
         pkg = host[:epel_pkg] || opts[:epel_5_pkg]
+        arch = host[:epel_arch] || opts[:epel_5_arch] || 'i386'
       else
-        raise "epel_info_for does not support el version #{version}, on #{host.name}"
+        raise ArgumentError.new("epel_info_for does not support el version #{version}, on #{host.name}")
       end
-      return url, host[:epel_arch] || opts[:epel_arch] || 'i386', pkg
+      return url, arch, pkg
     end
 
     # Run 'apt-get update' on the provided host or hosts.
@@ -237,7 +244,7 @@ module Beaker
       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.
+    #Install EPEL on host or hosts with platform = /el-(5|6|7)/.  Do nothing on host or hosts of other platforms.
     # @param [Host, Array<Host>] host One or more hosts to act upon.  Will use individual host epel_url, epel_arch
     #                                 and epel_pkg before using defaults provided in opts.
     # @param [Hash{Symbol=>String}] opts Options to alter execution.
@@ -245,6 +252,7 @@ module Beaker
     # @option opts [Beaker::Logger] :logger A {Beaker::Logger} object
     # @option opts [String] :epel_url Link to download from
     # @option opts [String] :epel_arch Architecture of epel to download (i386, x86_64, etc)
+    # @option opts [String] :epel_7_pkg Package to download from provided link for el-7
     # @option opts [String] :epel_6_pkg Package to download from provided link for el-6
     # @option opts [String] :epel_5_pkg Package to download from provided link for el-5
     def add_el_extras( host, opts )
@@ -254,11 +262,15 @@ module Beaker
       debug_opt = opts[:debug] ? 'vh' : ''
       block_on host do |host|
         case
-        when el_based?(host) && ['5','6'].include?(host['platform'].version)
+        when el_based?(host) && ['5','6','7'].include?(host['platform'].version)
           result = host.exec(Command.new('rpm -qa | grep epel-release'), :acceptable_exit_codes => [0,1])
           if result.exit_code == 1
             url, arch, pkg = epel_info_for host, opts
-            host.exec(Command.new("rpm -i#{debug_opt} #{url}/#{arch}/#{pkg}"))
+            if host['platform'].version == '7'
+              host.exec(Command.new("rpm -i#{debug_opt} #{url}/#{arch}/e/#{pkg}"))
+            else
+              host.exec(Command.new("rpm -i#{debug_opt} #{url}/#{arch}/#{pkg}"))
+            end
             #update /etc/yum.repos.d/epel.repo for new baseurl
             host.exec(Command.new("sed -i -e 's;#baseurl.*$;baseurl=#{Regexp.escape(url)}/\$basearch;' /etc/yum.repos.d/epel.repo"))
             #remove mirrorlist

data/lib/beaker/hypervisor/aws_sdk.rb

@@ -92,6 +92,7 @@ module Beaker
     def cleanup
       # Provisioning should have set the host 'instance' values.
       kill_instances(@hosts.map{|h| h['instance']}.select{|x| !x.nil?})
+      delete_key_pair_all_regions()
       nil
     end
 
@@ -193,6 +194,7 @@ module Beaker
           end
         end
       end
+      delete_key_pair_all_regions(key_name_prefix)
 
       @logger.notify "#{key}: Killed #{kill_count} instance(s)"
     end
@@ -665,13 +667,23 @@ module Beaker
       File.read(key_file)
     end
 
+    # Generate a key prefix for key pair names
+    #
+    # @note This is the part of the key that will stay static between Beaker
+    #   runs on the same host.
+    #
+    # @return [String] Beaker key pair name based on sanitized hostname
+    def key_name_prefix
+      safe_hostname = Socket.gethostname.gsub('.', '-')
+      "Beaker-#{local_user}-#{safe_hostname}"
+    end
+
     # Generate a reusable key name from the local hosts hostname
     #
     # @return [String] safe key name for current host
     # @api private
     def key_name
-      safe_hostname = Socket.gethostname.gsub('.', '-')
-      "Beaker-#{local_user}-#{safe_hostname}"
+      "#{key_name_prefix}-#{@options[:timestamp].strftime("%F_%H_%M_%S")}"
     end
 
     # Returns the local user running this tool
@@ -682,22 +694,86 @@ module Beaker
       ENV['USER']
     end
 
-    # Returns the KeyPair for this host, creating it if needed
+    # Creates the KeyPair for this test run
     #
     # @param region [AWS::EC2::Region] region to create the key pair in
     # @return [AWS::EC2::KeyPair] created key_pair
     # @api private
     def ensure_key_pair(region)
-      @logger.notify("aws-sdk: Ensure key pair exists, create if not")
-      key_pairs = region.key_pairs
       pair_name = key_name()
-      kp = key_pairs[pair_name]
-      unless kp.exists?
-        ssh_string = public_key()
-        kp = key_pairs.import(pair_name, ssh_string)
+      delete_key_pair(region, pair_name)
+      create_new_key_pair(region, pair_name)
+    end
+
+    # Deletes key pairs from all regions
+    #
+    # @param [String] keypair_name_filter if given, will get all keypairs that match
+    #   a simple {::String#start_with?} filter. If no filter is given, the basic key
+    #   name returned by {#key_name} will be used.
+    #
+    # @return nil
+    # @api private
+    def delete_key_pair_all_regions(keypair_name_filter=nil)
+      region_keypairs_hash = my_key_pairs(keypair_name_filter)
+      region_keypairs_hash.each_pair do |region, keypair_name_array|
+        keypair_name_array.each do |keypair_name|
+          delete_key_pair(region, keypair_name)
+        end
+      end
+    end
+
+    # Gets the Beaker user's keypairs by region
+    #
+    # @param [String] name_filter if given, will get all keypairs that match
+    #   a simple {::String#start_with?} filter. If no filter is given, the basic key
+    #   name returned by {#key_name} will be used.
+    #
+    # @return [Hash{AWS::EC2::Region=>Array[String]}] a hash of region instance to
+    #   an array of the keypair names that match for the filter
+    # @api private
+    def my_key_pairs(name_filter=nil)
+      keypairs_by_region = {}
+      keyname_default = key_name()
+      keyname_filtered = "#{name_filter}-*"
+      @ec2.regions.each do |region|
+        if name_filter
+          aws_name_filter = keyname_filtered
+        else
+          aws_name_filter = keyname_default
+        end
+        keypair_collection = region.key_pairs.filter('key-name', aws_name_filter)
+        keypair_collection.each do |keypair|
+          keypairs_by_region[region] ||= []
+          keypairs_by_region[region] << keypair.name
+        end
       end
+      keypairs_by_region
+    end
 
-      kp
+    # Deletes a given key pair
+    #
+    # @param [AWS::EC2::Region] region the region the key belongs to
+    # @param [String] pair_name the name of the key to be deleted
+    #
+    # @api private
+    def delete_key_pair(region, pair_name)
+      kp = region.key_pairs[pair_name]
+      if kp.exists?
+        @logger.debug("aws-sdk: delete key pair in region: #{region.name}")
+        kp.delete()
+      end
+    end
+
+    # Create a new key pair for a given Beaker run
+    #
+    # @param [AWS::EC2::Region] region the region the key pair will be imported into
+    # @param [String] pair_name the name of the key to be created
+    #
+    # @return [AWS::EC2::KeyPair] key pair created
+    def create_new_key_pair(region, pair_name)
+      @logger.debug("aws-sdk: generating new key pair: #{pair_name}")
+      ssh_string = public_key()
+      region.key_pairs.import(pair_name, ssh_string)
     end
 
     # Return a reproducable security group identifier based on input ports

data/lib/beaker/logger.rb

@@ -8,6 +8,9 @@ module Beaker
     #The results of the most recently run command
     attr_accessor :last_result
 
+    #Determines the spacing that happens before an output line
+    attr_accessor :line_prefix
+
     NORMAL         = "\e[00;00m"
     BRIGHT_NORMAL  = "\e[00;01m"
     BLACK          = "\e[00;30m"
@@ -75,6 +78,8 @@ module Beaker
       end
 
       @last_result = nil
+      @line_prefix_length = 0
+      @line_prefix = ''
 
       @destinations = []
 
@@ -176,6 +181,47 @@ module Beaker
       end
     end
 
+    # Prefixes a log line with the appropriate amount of whitespace for the level
+    # of test that's running.
+    #
+    # @param [String] line the line to prefix
+    #
+    # @return [String] the prefixed line
+    def prefix_log_line line
+      if line.kind_of?(Array)
+        line.map do |s|
+          prefix_log_line s
+        end
+      else
+        line.gsub!(/\r/, '')
+        has_ending_newline = line.end_with?("\n")
+        actual_lines = line.split("\n")
+        actual_lines.map! do |actual_line|
+          @line_prefix + actual_line
+        end
+        new_line = actual_lines.join("\n")
+        new_line << "\n" if has_ending_newline
+        new_line
+      end
+    end
+
+    # Sets the step level appropriately for logging to be indented correctly
+    #
+    # @return nil
+    def step_in
+      @line_prefix_length += 2
+      @line_prefix = ' ' * @line_prefix_length
+    end
+
+    # Sets the step level appropriately for logging to be indented correctly
+    #
+    # @return nil
+    def step_out
+      @line_prefix_length -= 2
+      @line_prefix_length = 0 if @line_prefix_length < 0
+      @line_prefix = ' ' * @line_prefix_length
+    end
+
     # Custom reporting for messages generated by host SUTs.
     # Will not print unless we are at {LOG_LEVELS} 'verbose' or higher.
     # Strips any color codes already in the provided messages, then adds logger color codes before reporting
@@ -278,9 +324,11 @@ module Beaker
     # @param [Boolean] add_newline (true) Add newlines between the color codes and the message
     def optionally_color color_code, msg, add_newline = true
       print_statement = add_newline ? :puts : :print
+      msg = convert(msg)
+      msg = prefix_log_line(msg)
       @destinations.each do |to|
         to.print color_code if @color
-        to.send print_statement, convert( msg )
+        to.send print_statement, msg
         to.print NORMAL if @color unless color_code == NONE
       end
     end

data/lib/beaker/options/presets.rb

@@ -165,6 +165,7 @@ module Beaker
           :add_el_extras          => false,
           :epel_url               => "http://mirrors.kernel.org/fedora-epel",
           :epel_arch              => "i386",
+          :epel_7_pkg             => "epel-release-7-5.noarch.rpm",
           :epel_6_pkg             => "epel-release-6-8.noarch.rpm",
           :epel_5_pkg             => "epel-release-5-4.noarch.rpm",
           :consoleport            => 443,

data/lib/beaker/version.rb

@@ -1,5 +1,5 @@
 module Beaker
   module Version
-    STRING = '2.24.0'
+    STRING = '2.25.0'
   end
 end

data/spec/beaker/dsl/install_utils/foss_utils_spec.rb

@@ -1048,10 +1048,10 @@ describe ClassMixedWithDSLInstallUtils do
       allow( subject ).to receive( :configure_foss_defaults_on ).and_return( true )
     end
 
-    def test_fetch_http_file()
+    def test_fetch_http_file(agent_version = '1.0.0')
       expect( subject ).to receive( :configure_type_defaults_on ).with(host)
       expect( subject ).to receive( :fetch_http_file ).with( /[^\/]\z/, anything, anything )
-      subject.install_puppet_agent_dev_repo_on( host, opts.merge({ :puppet_agent_version => '1.0.0' }) )
+      subject.install_puppet_agent_dev_repo_on( host, opts.merge({ :puppet_agent_version => agent_version }) )
     end
 
     context 'on windows' do
@@ -1084,20 +1084,31 @@ describe ClassMixedWithDSLInstallUtils do
         @platform = 'solaris-10-x86_64'
       end
 
-      it "copies package to the root directory and installs it" do
-        expect( subject ).to receive( :link_exists? ).with(/puppet-agent-1\.0\.0-1\.i386\.pkg\.gz/).and_return( true )
-        expect( subject ).to receive( :scp_to ).with( host, /\/puppet-agent-1\.0\.0\-1.i386\.pkg\.gz/, '/' )
-        expect( subject ).to receive( :create_remote_file ).with( host, '/noask', /noask file/m )
-        expect( subject ).to receive( :on ).with( host, 'gunzip -c puppet-agent-1.0.0-1.i386.pkg.gz | pkgadd -d /dev/stdin -a noask -n all' )
-        test_fetch_http_file
-      end
+      [
+          ['1.0.1.786.477', '1.0.1.786.477'],
+          ['1.0.1.786.a477', '1.0.1.786.a477'],
+          ['1.0.1.786.477-', '1.0.1.786.477-'],
+          ['1.0.1.0000786.477', '1.0.1.0000786.477'],
+          ['1.000000.1.786.477', '1.000000.1.786.477'],
+          ['-1.0.1.786.477', '-1.0.1.786.477'],
+          ['1.2.5.38.6813', '1.2.5.38.6813']
+      ].each do |val, expected|
+
+        it "copies package to the root directory and installs it" do
+          expect( subject ).to receive( :link_exists? ).with(/puppet-agent-#{expected}-1\.i386\.pkg\.gz/).and_return( true )
+          expect( subject ).to receive( :scp_to ).with( host, /\/puppet-agent-#{expected}-1.i386\.pkg\.gz/, '/' )
+          expect( subject ).to receive( :create_remote_file ).with( host, '/noask', /noask file/m )
+          expect( subject ).to receive( :on ).with( host, "gunzip -c puppet-agent-#{expected}-1.i386.pkg.gz | pkgadd -d /dev/stdin -a noask -n all" )
+          test_fetch_http_file(val)
+        end
 
-      it "copies old package to the root directory and installs it" do
-        expect( subject ).to receive( :link_exists? ).with(/puppet-agent-1\.0\.0-1\.i386\.pkg\.gz/).and_return( false )
-        expect( subject ).to receive( :scp_to ).with( host, /\/puppet-agent-1\.0\.0\.i386\.pkg\.gz/, '/' )
-        expect( subject ).to receive( :create_remote_file ).with( host, '/noask', /noask file/m )
-        expect( subject ).to receive( :on ).with( host, 'gunzip -c puppet-agent-1.0.0.i386.pkg.gz | pkgadd -d /dev/stdin -a noask -n all' )
-        test_fetch_http_file
+        it "copies old package to the root directory and installs it" do
+          expect( subject ).to receive( :link_exists? ).with(/puppet-agent-#{expected}-1\.i386\.pkg\.gz/).and_return( false )
+          expect( subject ).to receive( :scp_to ).with( host, /\/puppet-agent-#{expected}.i386\.pkg\.gz/, '/' )
+          expect( subject ).to receive( :create_remote_file ).with( host, '/noask', /noask file/m )
+          expect( subject ).to receive( :on ).with( host, "gunzip -c puppet-agent-#{expected}.i386.pkg.gz | pkgadd -d /dev/stdin -a noask -n all" )
+          test_fetch_http_file(val)
+        end
       end
     end
 
@@ -1106,20 +1117,30 @@ describe ClassMixedWithDSLInstallUtils do
         @platform = 'solaris-11-x86_64'
       end
 
-      it "copies package to the root user directory and installs it" do
-        expect( subject ).to receive( :link_exists? ).with(/puppet-agent-1\.0\.0-1\.i386\.pkg\.gz/).and_return( true )
-        expect( subject ).to receive( :scp_to ).with( host, /\/puppet-agent-1\.0\.0-1\.i386\.pkg\.gz/, '/root' )
-        expect( subject ).to receive( :create_remote_file ).with( host, '/root/noask', /noask file/m )
-        expect( subject ).to receive( :on ).with( host, 'gunzip -c puppet-agent-1.0.0-1.i386.pkg.gz | pkgadd -d /dev/stdin -a noask -n all' )
-        test_fetch_http_file
-      end
+      [
+          ['1.0.1.786.477', '1.0.1.786.477'],
+          ['1.0.1.786.a477', '1.0.1.786.477'],
+          ['1.0.1.786.477-', '1.0.1.786.477'],
+          ['1.0.1.0000786.477', '1.0.1.786.477'],
+          ['1.000000.1.786.477', '1.0.1.786.477'],
+          ['-1.0.1.786.477', '1.0.1.786.477'],
+          ['1.2.5.38.6813', '1.2.5.38.6813']
+      ].each do |val, expected|
+
+        it "copies package to the root user directory and installs it" do
+          # version = 1.0.0
+          expect( subject ).to receive( :link_exists? ).with(/puppet-agent@#{expected},5\.11-1\.i386\.p5p/).and_return( true )
+          expect( subject ).to receive( :scp_to ).with( host, /\/puppet-agent@#{expected},5\.11-1\.i386\.p5p/, '/root' )
+          expect( subject ).to receive( :on ).with( host, "pkg install -g puppet-agent@#{expected},5.11-1.i386.p5p puppet-agent" )
+          test_fetch_http_file(val)
+        end
 
-      it "copies old package to the root directory and installs it" do
-        expect( subject ).to receive( :link_exists? ).with(/puppet-agent-1\.0\.0-1\.i386\.pkg\.gz/).and_return( false )
-        expect( subject ).to receive( :scp_to ).with( host, /\/puppet-agent-1\.0\.0\.i386\.pkg\.gz/, '/root' )
-        expect( subject ).to receive( :create_remote_file ).with( host, '/root/noask', /noask file/m )
-        expect( subject ).to receive( :on ).with( host, 'gunzip -c puppet-agent-1.0.0.i386.pkg.gz | pkgadd -d /dev/stdin -a noask -n all' )
-        test_fetch_http_file
+        it "copies old package to the root directory and installs it" do
+          expect( subject ).to receive( :link_exists? ).with(/puppet-agent@#{expected},5\.11-1\.i386\.p5p/).and_return( false )
+          expect( subject ).to receive( :scp_to ).with( host, /\/puppet-agent@#{expected},5\.11\.i386\.p5p/, '/root' )
+          expect( subject ).to receive( :on ).with( host, "pkg install -g puppet-agent@#{expected},5.11.i386.p5p puppet-agent" )
+          test_fetch_http_file(val)
+        end
       end
     end
   end