beaker 2.7.1 → 2.8.0

data/lib/beaker/dsl/outcomes.rb

@@ -37,7 +37,6 @@ module Beaker
       #
       # @param [String] msg An optional message to log
       # @raise [FailTest]
-      # @api dsl
       def fail_test msg = nil
         message = formatted_message( msg, 'Failed' )
         logger.warn( [message, logger.pretty_backtrace].join("\n") )
@@ -49,7 +48,6 @@ module Beaker
       #
       # @param [String] msg An optional message to log
       # @raise [PassTest]
-      # @api dsl
       def pass_test msg = nil
         message = formatted_message( msg, 'Passed' )
         logger.notify( message )
@@ -61,7 +59,6 @@ module Beaker
       #
       # @param [String] msg An optional message to log
       # @raise [PendingTest]
-      # @api dsl
       def pending_test msg = nil
         message = formatted_message( msg, 'is Pending' )
         logger.warn( message )
@@ -73,7 +70,6 @@ module Beaker
       #
       # @param [String] msg An optional message to log
       # @raise [SkipTest]
-      # @api dsl
       def skip_test msg = nil
         message = formatted_message( msg, 'was Skipped' )
         logger.notify( message )

data/lib/beaker/dsl/roles.rb

@@ -13,7 +13,6 @@ module Beaker
     # Also the constant {FailTest} needs to be defined it will be raised
     # in error conditions
     #
-    # @api dsl
     module Roles
 
       # The hosts for which ['roles'] include 'agent'
@@ -127,7 +126,6 @@ module Beaker
       #   puts "master is defined"
       # end
       #
-      # @api public
       def any_hosts_as?(role)
         hosts_as(role).length > 0
       end
@@ -144,7 +142,6 @@ module Beaker
       #       on yak, 'shave'
       #     end
       #
-      # @api public
       def hosts_as(desired_role = nil)
         hosts_with_role(hosts, desired_role)
       end

data/lib/beaker/dsl/structure.rb

@@ -35,7 +35,6 @@ module Beaker
       # Provides a method to help structure tests into coherent steps.
       # @param [String] step_name The name of the step to be logged.
       # @param [Proc] block The actions to be performed in this step.
-      # @api dsl
       def step step_name, &block
         logger.notify "\n  * #{step_name}\n"
         yield if block_given?
@@ -46,7 +45,6 @@ module Beaker
       # @param [String] my_name The name of the test to be logged.
       # @param [Proc] block The actions to be performed during this test.
       #
-      # @api dsl
       def test_name my_name, &block
         logger.notify "\n#{my_name}\n"
         yield if block_given?
@@ -61,7 +59,6 @@ module Beaker
       #     on(master, puppet_resource('file', '/etc/puppet/modules',
       #       'ensure=absent', 'purge=true'))
       #   end
-      # @api dsl
       def teardown &block
         @teardown_procs << block
       end
@@ -105,7 +102,6 @@ module Beaker
       #                       a {Beaker::Assertions} (i.e., if the assert
       #                       passes)
       # @author Chris Cowell-Shah (<tt>ccs@puppetlabs.com</tt>)
-      # @api dsl
       def expect_failure(explanation, &block)
         begin
           yield if block_given?  # code block should contain an assert that you expect to fail
@@ -125,6 +121,133 @@ module Beaker
                  '"expect_failure()" needs to be removed from this test. ' +
                  "Additional info: '#{explanation}'")
       end
+
+      # Limit the hosts a test case is run against
+      # @note This will modify the {Beaker::TestCase#hosts} member
+      #   in place unless an array of hosts is passed into it and
+      #   {Beaker::TestCase#logger} yielding an object that responds
+      #   like {Beaker::Logger#warn}, as well as
+      #   {Beaker::DSL::Outcomes#skip_test}, and optionally
+      #   {Beaker::TestCase#hosts}.
+      #
+      # @param [Symbol] type The type of confinement to do. Valid parameters
+      #                      are *:to* to confine the hosts to only those that
+      #                      match *criteria* or *:except* to confine the test
+      #                      case to only those hosts that do not match
+      #                      criteria.
+      # @param [Hash{Symbol,String=>String,Regexp,Array<String,Regexp>}]
+      #   criteria Specify the criteria with which a host should be
+      #   considered for inclusion or exclusion.  The key is any attribute
+      #   of the host that will be yielded by {Beaker::Host#[]}.
+      #   The value can be any string/regex or array of strings/regexp.
+      #   The values are compared using [Enumerable#any?] so that if one
+      #   value of an array matches the host is considered a match for that
+      #   criteria.
+      # @param [Array<Host>] host_array This creatively named parameter is
+      #   an optional array of hosts to confine to.  If not passed in, this
+      #   method will modify {Beaker::TestCase#hosts} in place.
+      # @param [Proc] block Addition checks to determine suitability of hosts
+      #   for confinement.  Each host that is still valid after checking
+      #   *criteria* is then passed in turn into this block.  The block
+      #   should return true if the host matches this additional criteria.
+      #
+      # @example Basic usage to confine to debian OSes.
+      #     confine :to, :platform => 'debian'
+      #
+      # @example Confining to anything but Windows and Solaris
+      #     confine :except, :platform => ['windows', 'solaris']
+      #
+      # @example Using additional block to confine to Solaris global zone.
+      #     confine :to, :platform => 'solaris' do |solaris|
+      #       on( solaris, 'zonename' ) =~ /global/
+      #     end
+      #
+      # @return [Array<Host>] Returns an array of hosts that are still valid
+      #   targets for this tests case.
+      # @raise [SkipTest] Raises skip test if there are no valid hosts for
+      #   this test case after confinement.
+      def confine(type, criteria, host_array = nil, &block)
+        hosts_to_modify = host_array || hosts
+        case type
+        when :except
+          hosts_to_modify = hosts_to_modify - select_hosts(criteria, hosts_to_modify, &block)
+        when :to
+          hosts_to_modify = select_hosts(criteria, hosts_to_modify, &block)
+        else
+          raise "Unknown option #{type}"
+        end
+        if hosts_to_modify.empty?
+          logger.warn "No suitable hosts with: #{criteria.inspect}"
+          skip_test 'No suitable hosts found'
+        end
+        self.hosts = hosts_to_modify
+        hosts_to_modify
+      end
+
+      # Ensures that host restrictions as specifid by type, criteria and
+      # host_array are confined to activity within the passed block.
+      # TestCase#hosts is reset after block has executed.
+      #
+      # @see #confine
+      def confine_block(type, criteria, host_array = nil, &block)
+        begin
+          original_hosts = self.hosts.dup
+          confine(type, criteria, host_array)
+
+          yield
+
+        ensure
+          self.hosts = original_hosts
+        end
+      end
+
+      #Return a set of hosts that meet the given criteria
+      # @param [Hash{Symbol,String=>String,Regexp,Array<String,Regexp>}]
+      #   criteria Specify the criteria with which a host should be
+      #   considered for inclusion.  The key is any attribute
+      #   of the host that will be yielded by {Beaker::Host#[]}.
+      #   The value can be any string/regex or array of strings/regexp.
+      #   The values are compared using [Enumerable#any?] so that if one
+      #   value of an array matches the host is considered a match for that
+      #   criteria.
+      # @param [Array<Host>] host_array This creatively named parameter is
+      #   an optional array of hosts to confine to.  If not passed in, this
+      #   method will modify {Beaker::TestCase#hosts} in place.
+      # @param [Proc] block Addition checks to determine suitability of hosts
+      #   for selection.  Each host that is still valid after checking
+      #   *criteria* is then passed in turn into this block.  The block
+      #   should return true if the host matches this additional criteria.
+      #
+      # @return [Array<Host>] Returns an array of hosts that meet the provided criteria
+      def select_hosts(criteria, host_array = nil, &block)
+        hosts_to_select_from = host_array || hosts
+        criteria.each_pair do |property, value|
+          hosts_to_select_from = hosts_to_select_from.select do |host|
+            inspect_host host, property, value
+          end
+        end
+        if block_given?
+          hosts_to_select_from = hosts_to_select_from.select do |host|
+            yield host
+          end
+        end
+        hosts_to_select_from
+      end
+
+      # @!visibility private
+      def inspect_host(host, property, one_or_more_values)
+        values = Array(one_or_more_values)
+        return values.any? do |value|
+          true_false = false
+          case value
+          when String
+            true_false = host[property.to_s].include? value
+          when Regexp
+            true_false = host[property.to_s] =~ value
+          end
+          true_false
+        end
+      end
     end
   end
 end

data/lib/beaker/dsl/wrappers.rb

@@ -12,7 +12,6 @@ module Beaker
       # work to disentangle all of the things that are being passed into
       # this catchall param.
       #
-      # @api dsl
       def facter(*args)
         options = args.last.is_a?(Hash) ? args.pop : {}
         options['ENV'] ||= {}
@@ -24,7 +23,6 @@ module Beaker
       # work to disentangle all of the things that are being passed into
       # this catchall param.
       #
-      # @api dsl
       def cfacter(*args)
         options = args.last.is_a?(Hash) ? args.pop : {}
         options['ENV'] ||= {}
@@ -36,7 +34,6 @@ module Beaker
       # work to disentangle all of the things that are being passed into
       # this catchall param.
       #
-      # @api dsl
       def hiera(*args)
         options = args.last.is_a?(Hash) ? args.pop : {}
         options['ENV'] ||= {}
@@ -57,7 +54,6 @@ module Beaker
       # work to disentangle all of the things that are being passed into
       # this catchall param.
       #
-      # @api dsl
       def puppet(*args)
         options = args.last.is_a?(Hash) ? args.pop : {}
         options['ENV'] ||= {}

data/lib/beaker/host.rb

@@ -59,6 +59,26 @@ module Beaker
       pkg_initialize
     end
 
+    # Builds a deprecated keys array, for checking to see if a key is deprecated.
+    # The recommended check after using this method is +result.include?(key)+
+    #
+    # @note an unsupported host type (meaning it has no _aio_defaults_) will return
+    #   an empty hash
+    #
+    # @return [Array<Symbol>] An array of keys that are deprecated for a host
+    def build_deprecated_keys()
+      begin
+        deprecated_keys_hash = self.class.send "foss_defaults".to_sym
+        delete_exceptions_hash = self.class.send "aio_defaults".to_sym
+        deprecated_keys_hash.delete_if do |key, value|
+          delete_exceptions_hash.has_key?(key)
+        end
+      rescue NoMethodError
+        deprecated_keys_hash = {}
+      end
+      deprecated_keys_hash.keys()
+    end
+
     def pkg_initialize
       # This method should be overridden by platform-specific code to
       # handle whatever packaging-related initialization is necessary.
@@ -114,6 +134,9 @@ module Beaker
     end
 
     def [] k
+      @deprecated_keys ||= build_deprecated_keys()
+      deprecation_message = "deprecated host key '#{k}'. Perhaps you can use host.puppet[] to get what you're looking for."
+      @logger.warn( deprecation_message ) if @logger && @deprecated_keys.include?(k.to_sym)
       @defaults[k]
     end
 

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

@@ -138,7 +138,7 @@ module Unix::Pkg
   #       DEBIAN_PLATFORM_CODENAMES map must be kept up-to-date as
   #       support for new versions is added.
   #
-  # @note See {Beaker::DSL::Helpers#deploy_package_repo} for info on
+  # @note See {Beaker::DSL::Helpers::HostHelpers#deploy_package_repo} for info on
   #       params
   def deploy_apt_repo(path, name, version)
     codename = DEBIAN_PLATFORM_CODENAMES[self['platform']]
@@ -154,7 +154,7 @@ module Unix::Pkg
 
   # Deploy yum configuration generated by the packaging tooling
   #
-  # @note See {Beaker::DSL::Helpers#deploy_package_repo} for info on
+  # @note See {Beaker::DSL::Helpers::HostHelpers#deploy_package_repo} for info on
   #       params
   def deploy_yum_repo(path, name, version)
     repo_file = "#{path}/rpm/pl-#{name}-#{version}-repos-pe-#{self['platform']}.repo"
@@ -163,7 +163,7 @@ module Unix::Pkg
 
   # Deploy zypper repo configuration generated by the packaging tooling
   #
-  # @note See {Beaker::DSL::Helpers#deploy_package_repo} for info on
+  # @note See {Beaker::DSL::Helpers::HostHelpers#deploy_package_repo} for info on
   #       params
   def deploy_zyp_repo(path, name, version)
     repo_file = "#{path}/rpm/pl-#{name}-#{version}-repos-pe-#{self['platform']}.repo"
@@ -178,7 +178,7 @@ module Unix::Pkg
   # 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#deploy_package_repo} for info on
+  # @note See {Beaker::DSL::Helpers::HostHelpers#deploy_package_repo} for info on
   #       params
   def deploy_package_repo(path, name, version)
     if not File.exists? path

data/lib/beaker/host_prebuilt_steps.rb

@@ -339,12 +339,13 @@ module Beaker
       logger = opts[:logger]
       block_on host do |host|
         logger.debug "Update /etc/ssh/sshd_config to allow root login"
-        # note: this sed command only works on gnu sed
         if host['platform'] =~ /osx/
           host.exec(Command.new("sudo sed -i '' 's/#PermitRootLogin no/PermitRootLogin Yes/g' /etc/sshd_config"))
           host.exec(Command.new("sudo sed -i '' 's/#PermitRootLogin yes/PermitRootLogin Yes/g' /etc/sshd_config"))
-        else
+        elsif host.is_cygwin?
           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']}")
         end
         #restart sshd
         if host['platform'] =~ /debian|ubuntu|cumulus/
@@ -352,7 +353,7 @@ module Beaker
         elsif host['platform'] =~ /centos|el-|redhat|fedora|eos/
           host.exec(Command.new("sudo -E /sbin/service sshd reload"), {:pty => true})
         else
-          @logger.warn("Attempting to update ssh on non-supported platform: #{host.name}: #{host['platform']}")
+          logger.warn("Attempting to update ssh on non-supported platform: #{host.name}: #{host['platform']}")
         end
       end
     end
@@ -487,8 +488,13 @@ module Beaker
         when /windows/
           if host.is_cygwin?
             host.exec(Command.new("echo '\nPermitUserEnvironment yes' >> /etc/sshd_config"))
-            host.exec(Command.new("cygrunsrv -E sshd"))
-            host.exec(Command.new("cygrunsrv -S sshd"))
+            # we get periodic failures to restart the service, so looping these with re-attempts
+            repeat_fibonacci_style_for(5) do
+              0 == host.exec(Command.new("cygrunsrv -E sshd"), :acceptable_exit_codes => [0, 1] ).exit_code
+            end
+            repeat_fibonacci_style_for(5) do
+              0 == host.exec(Command.new("cygrunsrv -S sshd"), :acceptable_exit_codes => [0, 1] ).exit_code
+            end
             env['CYGWIN'] = 'nodosfilewarning'
           else
             #nothing to do here

data/lib/beaker/hypervisor/vagrant.rb

@@ -23,6 +23,7 @@ module Beaker
       #generate the VagrantFile
       v_file = "Vagrant.configure(\"2\") do |c|\n"
       v_file << "  c.ssh.forward_agent = true\n" if options[:forward_ssh_agent] == true
+      v_file << "  c.ssh.insert_key = false\n"
       hosts.each do |host|
         host['ip'] ||= randip #use the existing ip, otherwise default to a random ip
         v_file << "  c.vm.define '#{host.name}' do |v|\n"

data/lib/beaker/hypervisor/vmpooler.rb

@@ -106,6 +106,44 @@ module Beaker
       end
 
       @logger.notify 'Spent %.2f seconds grabbing VMs' % (Time.now - start)
+
+      start = Time.now
+      @logger.notify 'Tagging vmpooler VMs'
+
+      tags = {
+        'jenkins_build_url' => @options[:jenkins_build_url],
+        'department' => @options[:department],
+        'project' => @options[:project],
+        'created_by' => @options[:created_by]
+      }
+
+      @hosts.each_with_index do |h, i|
+        begin
+          uri = URI.parse(@options[:pooling_api] + '/vm/' + h['vmhostname'].split('.')[0])
+
+          http = Net::HTTP.new(uri.host, uri.port)
+          request = Net::HTTP::Put.new(uri.request_uri)
+
+          request.body = { 'tags' => tags }.to_json
+
+          response = http.request(request)
+        rescue RuntimeError, Error::EINVAL, Errno::ECONNRESET, EOFError,
+               Net::HTTPBadResponse, Net::HTTPHeaderSyntaxError, *SSH_EXCEPTIONS => e
+          @logger.notify "Failed to connect to vmpooler for tagging!"
+        end
+
+        begin
+          parsed_response = JSON.parse(response.body)
+
+          unless parsed_response['ok']
+            @logger.notify "Failed to tag host '#{h['vmhostname']}'!"
+          end
+        rescue JSON::ParserError => e
+            @logger.notify "Failed to tag host '#{h['vmhostname']}'! (failed with #{e.class})"
+        end
+      end
+
+      @logger.notify 'Spent %.2f seconds tagging VMs' % (Time.now - start)
     end
 
     def cleanup

data/lib/beaker/logger.rb

@@ -302,12 +302,18 @@ module Beaker
 
     # Utility method to centralize dated log folder generation
     #
-    # @param [String] base_dir path of the directory for the dated log folder to live in
-    # @param [Time] timestamp the timestamp that should be used to generate the dated log folder
+    # @param [String] base_dir Path of the directory for the dated log folder to live in
+    # @param [String] log_prefix Prefix to use for the log files
+    # @param [Time] timestamp Timestamp that should be used to generate the dated log folder
+    #
+    # @example base_dir = 'junit', log_prefix = 'pants', timestamp = '2015-03-04 10:35:37 -0800'
+    #   returns 'junit/pants/2015-03-04_10_35_37'
+    #
+    # @note since this uses 'mkdir -p', log_prefix can be a number of nested directories
     #
     # @return [String] the path of the dated log folder generated
-    def Logger.generate_dated_log_folder(base_dir, timestamp)
-      log_dir = File.join(base_dir, timestamp.strftime("%F_%H_%M_%S"))
+    def Logger.generate_dated_log_folder(base_dir, log_prefix, timestamp)
+      log_dir = File.join(base_dir, log_prefix, timestamp.strftime("%F_%H_%M_%S"))
       FileUtils.mkdir_p(log_dir) unless File.directory?(log_dir)
       log_dir
     end

data/lib/beaker/network_manager.rb

@@ -26,10 +26,11 @@ module Beaker
       @machines = {}
       @hypervisors = nil
 
-      @options[:timestamp]            = Time.now unless @options.has_key?(:timestamp)
-      @options[:xml_dated_dir]        = Beaker::Logger.generate_dated_log_folder(@options[:xml_dir], @options[:timestamp])
-      @options[:log_dated_dir]        = Beaker::Logger.generate_dated_log_folder(@options[:log_dir], @options[:timestamp])
-      @options[:logger_sut]  = Beaker::Logger.new(File.join(@options[:log_dated_dir], @options[:log_sut_event]), { :quiet => true })
+      @options[:log_prefix]     = File.basename(@options[:hosts_file], '.yml') unless @options[:log_prefix]
+      @options[:timestamp]      = Time.now unless @options.has_key?(:timestamp)
+      @options[:xml_dated_dir]  = Beaker::Logger.generate_dated_log_folder(@options[:xml_dir], @options[:log_prefix], @options[:timestamp])
+      @options[:log_dated_dir]  = Beaker::Logger.generate_dated_log_folder(@options[:log_dir], @options[:log_prefix], @options[:timestamp])
+      @options[:logger_sut]     = Beaker::Logger.new(File.join(@options[:log_dated_dir], @options[:log_sut_event]), { :quiet => true })
     end
 
     #Provision all virtual machines.  Provision machines according to their set hypervisor, if no hypervisor