beaker 0.0.0 → 1.0.0

data/lib/beaker/dsl/install_utils.rb

@@ -129,106 +129,159 @@ module Beaker
         end
       end
 
-      def do_install hosts, version, path, pre_30, options = {} 
-        #convenience methods for installation
-        ########################################################
-        def installer_cmd(host, version, installer)
-          if host['platform'] =~ /windows/
-            "cd #{host['working_dir']} && msiexec.exe /qn /i puppet-enterprise-#{version}.msi"
-          else
-            "cd #{host['working_dir']}/#{host['dist']} && ./#{installer}"
-          end
+      #Create the PE install command string based upon the host and options settings
+      # @param [Host] host The host that PE is to be installed on
+      # @param [Hash{Symbol=>String}] options The options
+      # @option options [String] :installer The name of the installer to use for upgrading/installing
+      # @option options [String] :pe_ver_win Default PE version to install or upgrade to on Windows hosts
+      #                          (Othersie uses individual Windows hosts pe_ver)
+      # @option options [String  :pe_ver Default PE version to install or upgrade to
+      #                          (Otherwise uses individual hosts pe_ver)
+      # @example
+      #      on host, "#{installer_cmd(host, options)} -a #{host['working_dir']}/answers"
+      # @api private
+      def installer_cmd(host, options)
+        if host['platform'] =~ /windows/
+          version = options[:pe_ver_win] || host['pe_ver']
+          "cd #{host['working_dir']} && msiexec.exe /qn /i puppet-enterprise-#{version}.msi"
+        else
+          version = options[:pe_ver] || host['pe_ver']
+          "cd #{host['working_dir']}/#{host['dist']} && ./#{options[:installer]}"
         end
-        def link_exists?(link)
-          require "net/http"
-          require "open-uri"
-          url = URI.parse(link)
-          Net::HTTP.start(url.host, url.port) do |http|
-            return http.head(url.request_uri).code == "200"
-          end
+      end
+
+      #Determine is a given URL is accessible 
+      #@param [String] link The URL to examine
+      #@return [Boolean] true if the URL has a '200' HTTP response code, false otherwise
+      #@example
+      #  extension = link_exists?("#{URL}.tar.gz") ? ".tar.gz" : ".tar"
+      # @api private
+      def link_exists?(link)
+        require "net/http"
+        require "open-uri"
+        url = URI.parse(link)
+        Net::HTTP.start(url.host, url.port) do |http|
+          return http.head(url.request_uri).code == "200"
         end
-        def fetch_puppet(hosts, version, path)
+      end
+
+      #Determine the PE package to download/upload per-host, download/upload that package onto the host 
+      #and unpack it.
+      # @param [Array<Host>] hosts The hosts to download/upload and unpack PE onto 
+      # @param  [Hash{Symbol=>Symbol, String}] options The options
+      # @option options [String] :pe_dir Default directory or URL to pull PE package from 
+      #                  (Otherwise uses individual hosts pe_dir)
+      # @option options [String] :pe_ver Default PE version to install or upgrade to
+      #                  (Otherwise uses individual hosts pe_ver)
+      # @option options [String] :pe_ver_win Default PE version to install or upgrade to on Windows hosts
+      #                  (Otherwise uses individual Windows hosts pe_ver)
+      # @api private
+      def fetch_puppet(hosts, options)
+        hosts.each do |host|
+          windows = host['platform'] =~ /windows/
+          path = options[:pe_dir] || host['pe_dir']
           local = File.directory?(path)
-          hosts.each do |host|
-            filename = ""
+          filename = ""
+          extension = ""
+          if windows
+            version = options[:pe_ver_win] || host['pe_ver']
+            filename = "puppet-enterprise-#{version}"
+            extension = ".msi"
+          else
+            filename = "#{host['dist']}"
             extension = ""
-            if host['platform'] =~ /windows/
-              filename = "puppet-enterprise-#{version}"
-              extension = ".msi"
-            else
-              filename = "#{host['dist']}"
-              extension = ""
-              if local
-                extension = File.exists?("#{path}/#{filename}.tar.gz") ? ".tar.gz" : ".tar"
-              else
-                extension = link_exists?("#{path}/#{filename}.tar.gz") ? ".tar.gz" : ".tar"
-              end
-            end
             if local
-               if not File.exists?("#{path}/#{filename}#{extension}")
-                 raise "attempting installation on #{host}, #{path}/#{filename}#{extension} does not exist" 
-               end
-               scp_to host, "#{path}/#{filename}#{extension}", "#{host['working_dir']}/#{filename}#{extension}"
+              extension = File.exists?("#{path}/#{filename}.tar.gz") ? ".tar.gz" : ".tar"
             else
-               if not link_exists?("#{path}/#{filename}#{extension}")
-                 raise "attempting installation on #{host}, #{path}/#{filename}#{extension} does not exist" 
-               end
-               on host, "cd #{host['working_dir']}; curl #{path}/#{filename}#{extension} -o #{filename}#{extension}"
-            end
-            if extension =~ /gz/
-              on host, "cd #{host['working_dir']}; gunzip #{filename}#{extension}"
-            end
-            if extension =~ /tar/
-              on host, "cd #{host['working_dir']}; tar -xvf #{filename}.tar"
+              extension = link_exists?("#{path}/#{filename}.tar.gz") ? ".tar.gz" : ".tar"
             end
           end
+          if local
+             if not File.exists?("#{path}/#{filename}#{extension}")
+               raise "attempting installation on #{host}, #{path}/#{filename}#{extension} does not exist" 
+             end
+             scp_to host, "#{path}/#{filename}#{extension}", "#{host['working_dir']}/#{filename}#{extension}"
+          else
+             if not link_exists?("#{path}/#{filename}#{extension}")
+               raise "attempting installation on #{host}, #{path}/#{filename}#{extension} does not exist" 
+             end
+             on host, "cd #{host['working_dir']}; curl #{path}/#{filename}#{extension} -o #{filename}#{extension}"
+          end
+          if extension =~ /gz/
+            on host, "cd #{host['working_dir']}; gunzip #{filename}#{extension}"
+          end
+          if extension =~ /tar/
+            on host, "cd #{host['working_dir']}; tar -xvf #{filename}.tar"
+          end
         end
-        ########################################################
-        #start installation steps here
-        options[:installer] = 'puppet-enterprise-installer' unless options[:installer]
-        options[:type] = :install unless options[:type] 
+      end
+
+      #Perform a Puppet Enterprise upgrade or install
+      # @param [Array<Host>] hosts The hosts to install or upgrade PE on 
+      # @param  [Hash{Symbol=>Symbol, String}] options The options
+      # @option options [String] :pe_dir Default directory or URL to pull PE package from 
+      #                  (Otherwise uses individual hosts pe_dir)
+      # @option options [String] :pe_ver Default PE version to install or upgrade to
+      #                  (Otherwise uses individual hosts pe_ver)
+      # @option options [String] :pe_ver_win Default PE version to install or upgrade to on Windows hosts
+      #                  (Otherwise uses individual Windows hosts pe_ver)
+      # @option options [String] :installer ('puppet-enterprise-installer') The name of the installer to use for upgrading/installing
+      # @option options [Symbol] :type (:install) One of :upgrade or :install
+      #
+      #                      
+      # @example 
+      #  do_install(hosts, {:type => :upgrade, :pe_dir => path, :pe_ver => version, :pe_ver_win =>  version_win})
+      #
+      # @api private
+      #
+      def do_install hosts, options = {}
+        options[:installer] = options[:installer] || 'puppet-enterprise-installer' 
+        options[:type] = options[:type] || :install 
         hostcert='uname | grep -i sunos > /dev/null && hostname || hostname -s'
         master_certname = on(master, hostcert).stdout.strip
-        answers = Beaker::Answers.answers(version, hosts, master_certname, options)
-        special_nodes = [master, database, dashboard].uniq
-        real_agents = agents - special_nodes
+        pre30database = version_is_less(options[:pe_ver] || database['pe_ver'], '3.0')
+        pre30master = version_is_less(options[:pe_ver] || master['pe_ver'], '3.0')
 
         # Set PE distribution for all the hosts, create working dir
         use_all_tar = ENV['PE_USE_ALL_TAR'] == 'true'
         hosts.each do |host|
-          platform = use_all_tar ? 'all' : host['platform']
-          host['dist'] = "puppet-enterprise-#{version}-#{platform}"
+          if host['platform'] !~ /windows/
+            platform = use_all_tar ? 'all' : host['platform']
+            version = options[:pe_ver] || host['pe_ver']
+            host['dist'] = "puppet-enterprise-#{version}-#{platform}"
+          end
           host['working_dir'] = "/tmp/" + Time.new.strftime("%Y-%m-%d_%H.%M.%S") #unique working dirs make me happy
           on host, "mkdir #{host['working_dir']}"
         end
 
-        fetch_puppet(hosts, version, path)
+        fetch_puppet(hosts, options)
 
         hosts.each do |host|
           # Database host was added in 3.0. Skip it if installing an older version
-          next if host == database and host != master and host != dashboard and pre_30
+          next if host == database and host != master and host != dashboard and pre30database
           if host['platform'] =~ /windows/
-            on host, "#{installer_cmd(host, version, options[:installer])} PUPPET_MASTER_SERVER=#{master} PUPPET_AGENT_CERTNAME=#{host}"
+            on host, "#{installer_cmd(host, options)} PUPPET_MASTER_SERVER=#{master} PUPPET_AGENT_CERTNAME=#{host}"
           else
+            answers = Beaker::Answers.answers(options[:pe_ver] || host['pe_ver'], hosts, master_certname, options)
             create_remote_file host, "#{host['working_dir']}/answers", Beaker::Answers.answer_string(host, answers)
 
-            on host, "#{installer_cmd(host, version, options[:installer])} -a #{host['working_dir']}/answers"
+            on host, "#{installer_cmd(host, options)} -a #{host['working_dir']}/answers"
           end
         end
 
 
-        # If we're installing a version less than 3.0, ignore the database host
+        # If we're installing a database version less than 3.0, ignore the database host
         install_hosts = hosts.dup
-        install_hosts.delete(database) if pre_30 and database != master and database != dashboard
+        install_hosts.delete(database) if pre30database and database != master and database != dashboard
 
         # On each agent, we ensure the certificate is signed then shut down the agent
         install_hosts.each do |host|
-          sign_certificate(host)
-          stop_agent(host)
+          sign_certificate_for(host)
+          stop_agent_on(host)
         end
 
-        # Wait for PuppetDB to be totally up and running
-        sleep_until_puppetdb_started(database) unless pre_30
+        # Wait for PuppetDB to be totally up and running (post 3.0 version of pe only)
+        sleep_until_puppetdb_started(database) unless pre30database
 
         # Run the agent once to ensure everything is in the dashboard
         install_hosts.each do |host|
@@ -239,7 +292,7 @@ module Beaker
           # and would cause puppetdb to be bounced by the agent run. By sleeping
           # again here, we ensure that if that bounce happens during an upgrade
           # test we won't fail early in the install process.
-          if version == '3.0.0' and host == database
+          if host['pe_ver'] == '3.0.0' and host == database
             sleep_until_puppetdb_started(database)
           end
         end 
@@ -248,7 +301,7 @@ module Beaker
           wait_for_host_in_dashboard(host)
         end
 
-        if pre_30
+        if pre30master
           task = 'nodegroup:add_all_nodes group=default'
         else
           task = 'defaultgroup:ensure_default_group'
@@ -260,37 +313,105 @@ module Beaker
         on install_hosts, puppet_agent('-t'), :acceptable_exit_codes => [0,2]
       end
 
-      #is version a < version b
-      #3.0.0-160-gac44cfb is greater than 3.0.0, and 2.8.2
+      #Is PE version a less than PE version b
+      #@param [String] a A PE version of the from '\d.\d.\d.*'
+      #@param [String] b A PE version of the form '\d.\d.\d.*'
+      #@return [Boolean] true if a is less than b, otherwise return false
+      #
+      #@note 3.0.0-160-gac44cfb is greater than 3.0.0, and 2.8.2
+      # @!visibility private
       def version_is_less a, b
-        a = a.split('-')[0].split('.')
-        b = b.split('-')[0].split('.')
-        (0...a.length).each do |i|
-          if i < b.length
-            if a[i] < b[i] 
+        a_nums = a.split('-')[0].split('.')
+        b_nums = b.split('-')[0].split('.')
+        (0...a_nums.length).each do |i|
+          if i < b_nums.length
+            if a_nums[i] < b_nums[i] 
               return true
-            elsif a[i] > b[i]
+            elsif a_nums[i] > b_nums[i]
               return false
             end
           else
             return false
           end
         end
+        #checks all dots, they are equal so examine the rest
+        a_rest = a.split('-', 2)[1]
+        b_rest = b.split('-', 2)[1]
+        if a_rest and b_rest and a_rest < b_rest 
+          return false
+        elsif a_rest and not b_rest
+          return false
+        elsif not a_rest and b_rest
+          return true
+        end
         return false
       end
 
-      def install_pe version, path
-        pre_30 = version_is_less(version, '3.0')
-        step "Install #{version} PE on #{path}"
-        do_install hosts, version, path, pre_30
+      #Sort array of hosts so that it has the correct order for PE installation based upon each host's role
+      # @example 
+      #  h = sorted_hosts
+      #
+      # @note Order for installation should be
+      #        First : master
+      #        Second: database host (if not same as master)
+      #        Third:  dashboard (if not same as master or database)
+      #        Fourth: everything else
+      #
+      # @!visibility private
+      def sorted_hosts
+        special_nodes = [master, database, dashboard].uniq
+        real_agents = agents - special_nodes
+        special_nodes + real_agents
       end
 
-      def upgrade_pe version, path, from 
+      #Install PE based upon host configuration and options
+      # @example 
+      #  install_pe
+      #
+      # @note Either pe_ver and pe_dir should be set in the ENV or each host should have pe_ver and pe_dir set individually.
+      #       Install file names are assumed to be of the format puppet-enterprise-VERSION-PLATFORM.(tar)|(tar.gz)
+      #       for Unix like systems and puppet-enterprise-VERSION.msi for Windows systems.
+      #
+      # @api dsl
+      def install_pe 
+        #process the version files if necessary
+        hosts.each do |host|
+          if host['platform'] =~ /windows/
+            host['pe_ver'] = host['pe_ver'] || 
+              Beaker::Options::PEVersionScraper.load_pe_version(host[:pe_dir] || options[:pe_dir], options[:pe_version_file_win])
+          else
+            host['pe_ver'] = host['pe_ver'] || 
+              Beaker::Options::PEVersionScraper.load_pe_version(host[:pe_dir] || options[:pe_dir], options[:pe_version_file])
+          end
+        end
+        do_install sorted_hosts
+      end
+
+      #Upgrade PE based upon host configuration and options
+      # @param [String] path A path (either local directory or a URL to a listing of PE builds). 
+      #                      Will contain a LATEST file indicating the latest build to install.
+      # @example 
+      #  upgrade_pe("http://neptune.puppetlabs.lan/3.0/ci-ready/")
+      #
+      # @note Install file names are assumed to be of the format puppet-enterprise-VERSION-PLATFORM.(tar)|(tar.gz)
+      #       for Unix like systems and puppet-enterprise-VERSION.msi for Windows systems.
+      # @api dsl
+      def upgrade_pe path 
+        version = Options::PEVersionScraper.load_pe_version(path, options[:pe_version_file])
+        version_win = Options::PEVersionScraper.load_pe_version(path, options[:pe_version_file_win])
         pre_30 = version_is_less(version, '3.0')
         if pre_30
-          do_install(hosts, version, path, pre_30, :type => :upgrade, :installer => 'puppet-enterprise-upgrader', :from => from)
+          do_install(sorted_hosts, {:type => :upgrade, :pe_dir => path, :pe_ver => version, :pe_ver_win => version_win, :installer => 'puppet-enterprise-upgrader'})
         else
-          do_install(hosts, version, path, pre_30, :type => :upgrade, :from => from)
+          do_install(sorted_hosts, {:type => :upgrade, :pe_dir => path, :pe_ver => version, :pe_ver_win =>  version_win})
+        end
+        #at this point we've completed a successful upgrade, update the host pe_ver to reflect that
+        hosts.each do |host|
+          if host['platform'] =~ /windows/
+            host['pe_ver'] = version_win
+          else
+            host['pe_ver'] = version
+          end
         end
       end
 

data/lib/beaker/dsl/roles.rb

@@ -68,6 +68,44 @@ module Beaker
         find_only_one :dashboard
       end
 
+      # The default host
+      #   - if only one host defined, then that host
+      #   OR
+      #   - host with 'default' as a role
+      #   OR
+      #   - host with 'master' as a role
+      #
+      # @return [Array<Host>]
+      # @raise [Beaker::DSL::Outcomes::FailTest] if no default host is found
+      #
+      # @example Basic usage
+      #     on, default, "curl https://#{database}/nodes/#{agent}"
+      #
+      def default
+        if hosts.length == 1
+          return hosts[0]
+        elsif any_hosts_as? :default
+          return find_only_one :default
+        elsif any_hosts_as? :master
+          return find_only_one :master
+        else
+          raise DSL::Outcomes::FailTest, "no default host specified"
+        end
+      end
+
+      # Determine if there is a host or hosts with the given role defined
+      # @return [Boolean] True if there is a host with role, false otherwise
+      #
+      # @example Usage
+      # if any_hosts_as?(:master)
+      #   puts "master is defined"
+      # end
+      #
+      # @api public
+      def any_hosts_as?(role)
+        hosts_as(role).length > 0
+      end
+
       # Select hosts that include a desired role from #hosts
       #
       # @param [String, Symbol] desired_role The role to select for
@@ -91,6 +129,8 @@ module Beaker
       #   the specified role is NOT found.
       def find_only_one role
         only_host_with_role(hosts, role)
+      rescue ArgumentError => e
+        raise DSL::Outcomes::FailTest, e.to_s
       end
     end
   end

data/lib/beaker/host.rb

@@ -1,5 +1,4 @@
 require 'socket'
-require 'timeout'
 
 %w(command ssh_connection).each do |lib|
   begin
@@ -11,6 +10,7 @@ end
 
 module Beaker
   class Host
+    SELECT_TIMEOUT = 30
 
     # This class providers array syntax for using puppet --configprint on a host
     class PuppetConfigReader
@@ -25,34 +25,34 @@ module Beaker
       end
     end
 
-    def self.create name, options, config
-      case config['HOSTS'][name]['platform']
+    def self.create name, options
+      case options['HOSTS'][name]['platform']
       when /windows/
-        Windows::Host.new name, options, config
+        Windows::Host.new name, options
       when /aix/
-        Aix::Host.new name, options, config
+        Aix::Host.new name, options
       else
-        Unix::Host.new name, options, config
+        Unix::Host.new name, options
       end
     end
 
     attr_accessor :logger
     attr_reader :name, :defaults
-    def initialize name, options, config
+    def initialize name, options
       @logger = options[:logger]
-      @name, @options, @config = name, options.dup, config
+      @name, @options = name.to_s, options.dup
 
       # This is annoying and its because of drift/lack of enforcement/lack of having
       # a explict relationship between our defaults, our setup steps and how they're
       # related through 'type' and the differences between the assumption of our two
       # configurations we have for many of our products
       type = is_pe? ? :pe : :foss
-      @defaults = merge_defaults_for_type @config, type
+      @defaults = merge_defaults_for_type @options, type
     end
 
-    def merge_defaults_for_type config, type
+    def merge_defaults_for_type options, type
       defaults = self.class.send "#{type}_defaults".to_sym
-      defaults.merge(config['CONFIG']).merge(config['HOSTS'][name])
+      defaults.merge(options.merge((options['HOSTS'][name])))
     end
 
     def node_name
@@ -63,18 +63,26 @@ module Beaker
     end
 
     def port_open? port
-      Timeout.timeout 1 do
-        begin
-          TCPSocket.new(reachable_name, port).close
-          return true
-        rescue Errno::ECONNREFUSED
-          return false
+      s = Socket.new(Socket::AF_INET, Socket::SOCK_STREAM, 0)
+      sa = Socket.sockaddr_in(port, reachable_name)
+
+      begin
+        s.connect_nonblock(sa)
+      rescue Errno::EINPROGRESS
+        if IO.select(nil, [s], nil, SELECT_TIMEOUT)
+          begin
+            s.connect_nonblock(sa)
+          rescue Errno::EISCONN
+            return true
+          rescue Errno::ECONNREFUSED, Errno::EHOSTUNREACH
+            return false
+          end
         end
       end
+      return false
     end
 
     def up?
-      require 'socket'
       begin
         Socket.getaddrinfo( reachable_name, nil )
         return true
@@ -120,7 +128,7 @@ module Beaker
     end
 
     def is_pe?
-      @config.is_pe?
+      @options.is_pe?
     end
 
     def connection
@@ -161,7 +169,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?(options[:acceptable_exit_codes] || [0])
+          unless result.exit_code_in?(Array(options[:acceptable_exit_codes] || 0))
             limit = 10
             raise "Host '#{self}' exited with #{result.exit_code} running:\n #{cmdline}\nLast #{limit} lines of output were:\n#{result.formatted_output(limit)}"
           end