beaker 2.18.0 → 2.19.0

data/lib/beaker/options/options_hash.rb

@@ -1,44 +1,11 @@
+require 'stringify-hash'
+
 module Beaker
   module Options
 
     # A hash that treats Symbol and String keys interchangeably
     # and recursively merges hashes
-    class OptionsHash < Hash
-
-      # The dividor between elements when OptionsHash is dumped
-      DIV = '    '
-
-      # The end of line when dumping
-      EOL = "\n"
-
-      # Get value for given key, search for both k as String and k as Symbol,
-      # if not present return nil
-      #
-      # @param [Object] k The key to find, searches for both k as String
-      #                   and k as Symbol
-      #
-      # @example Use this method to return the value for a given key
-      #     a['key'] = 'value'
-      #     a['key'] == a[:key] == 'value'
-      #
-      # @return [nil, Object] Return the Object found at given key,
-      #                       or nil if no Object found
-      def [] k
-        super(k.to_s) || super(k.to_sym)
-      end
-
-      # Set Symbol key to Object value
-      # @param [Object] k The key to associated with the value,
-      #                   converted to Symbol key
-      # @param [Object] v The value to store in the ObjectHash
-      #
-      # @example Use this method to set the value for a key
-      #     a['key'] = 'value'
-      #
-      # @return [Object] Return the Object value just stored
-      def []=k,v
-        super(k.to_sym, v)
-      end
+    class OptionsHash < StringifyHash
 
       # Determine if type of ObjectHash is pe, defaults to true
       #
@@ -66,271 +33,11 @@ module Beaker
           :pe
         when /foss/
           :foss
-        when /aio/
-          :aio
         else
           :foss
         end
       end
 
-      # Determine if key is stored in ObjectHash
-      # @param [Object] k The key to find in ObjectHash, searches for
-      #                   both k as String and k as Symbol
-      #
-      # @example Use this method to set the value for a key
-      #     a['key'] = 'value'
-      #     a.has_key[:key] == true
-      #
-      # @return [Boolean]
-      def has_key? k
-        super(k.to_s) || super(k.to_sym)
-      end
-
-      # Determine key=>value entry in OptionsHash, remove both value at
-      # String key and value at Symbol key
-      #
-      # @param [Object] k The key to delete in ObjectHash,
-      # deletes both k as String and k as Symbol
-      #
-      # @example Use this method to set the value for a key
-      #     a['key'] = 'value'
-      #     a.delete[:key] == 'value'
-      #
-      # @return [Object, nil] The Object deleted at value,
-      # nil if no Object deleted
-      def delete k
-        super(k.to_s) || super(k.to_sym)
-      end
-
-      # Recursively merge and OptionsHash with an OptionsHash or Hash
-      #
-      # @param [OptionsHash]       base The hash to merge into
-      # @param [OptionsHash, Hash] hash The hash to merge from
-      #
-      # @example
-      #   base = { :key => { :subkey1 => 'subval', :subkey2 => 'subval' } }
-      #   hash = { :key => { :subkey1 => 'newval'} }
-      #
-      #   rmerge(base, hash)
-      #   #=>  {:key =>
-      #           {:subkey1 => 'newval',
-      #            :subkey2 => 'subval'}}
-      #
-      # @return [OptionsHash] The combined bash and hash
-      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) || hash[key].is_a?(OptionsHash))
-            rmerge(base[key], hash[key])
-          elsif hash[key].is_a?(Hash)
-            base[key] = OptionsHash.new.merge(hash[key])
-          else
-            base[key]= hash[key]
-          end
-        end
-        base
-      end
-
-      # Create new OptionsHash from recursively merged self with an OptionsHash or Hash
-      #
-      # @param [OptionsHash, Hash] hash The hash to merge from
-      #
-      # @example
-      #   base = { :key => { :subkey1 => 'subval', :subkey2 => 'subval' } }
-      #   hash = { :key => { :subkey1 => 'newval'} }
-      #
-      #   base.merge(hash)
-      #   #=> {:key =>
-      #         {:subkey1 => 'newval',
-      #          :subkey2 => 'subval' }
-      #
-      # @return [OptionsHash] The combined hash
-      def merge hash
-        #make a deep copy into an empty hash object
-        merged_hash = rmerge(OptionsHash.new, self)
-        rmerge(merged_hash, hash)
-      end
-
-      # Recursively merge self with an OptionsHash or Hash
-      #
-      # @param [OptionsHash, Hash] hash The hash to merge from
-      #
-      # @example
-      #   base = { :key => { :subkey1 => 'subval', :subkey2 => 'subval' } }
-      #   hash = { :key => { :subkey1 => 'newval'} }
-      #
-      #   base.merge!(hash)
-      #   #=> {:key =>
-      #         {:subkey1 => 'newval',
-      #          :subkey2 => 'subval' }
-      #
-      # @return [OptionsHash] The combined hash
-      def merge! hash
-        rmerge(self, hash)
-      end
-
-      # Helper for formatting collections
-      # Computes the indentation level for elements of the collection
-      # Yields indentation to block to so the caller can create
-      # map of element strings
-      # Places delimiters in the correct location
-      # Joins everything with correct EOL
-      #
-      #
-      # !@visibility private
-      def as_coll( opening, closing, in_lvl, in_inc, &block )
-        delim_indent = in_inc * in_lvl
-        elem_indent  = in_inc * (in_lvl + 1)
-
-        open_brace  = opening
-        close_brace = delim_indent + closing
-
-        fmtd_coll = block.call( elem_indent )
-        str_coll = fmtd_coll.join( ',' + EOL )
-
-        return open_brace + EOL + str_coll + EOL + close_brace
-      end
-
-      # Pretty prints a collection
-      #
-      # @param [Enumerable] collection The collection to be printed
-      # @param [Integer]    in_lvl     The level of indentation
-      # @param [String]     in_inc     The increment to indent
-      #
-      # @example
-      #   base = {:key => { :subkey1 => 'subval', :subkey2 => ['subval'] }}
-      #   self.fmt_collection( base )
-      #   #=> '{
-      #            "key": {
-      #                "subkey": "subval",
-      #                "subkey2": [
-      #                    "subval"
-      #                ]
-      #            }
-      #        }'
-      #
-      # @return [String] The collection as a pretty JSON object
-      def fmt_collection( collection, in_lvl = 0, in_inc = DIV )
-        if collection.respond_to? :each_pair
-          string = fmt_assoc( collection, in_lvl, in_inc )
-        else
-          string = fmt_list( collection, in_lvl, in_inc )
-        end
-
-        return string
-      end
-
-      # Pretty prints an associative collection
-      #
-      # @param [#each_pair] coll    The collection to be printed
-      # @param [Integer]    in_lvl  The level of indentation
-      # @param [String]     in_inc  The increment to indent
-      #
-      # @example
-      #   base = { :key => 'value', :key2 => 'value' }
-      #   self.fmt_assoc( base )
-      #   #=> '{
-      #            "key": "value",
-      #            "key2": "value"
-      #        }'
-      #
-      # @return [String] The collection as a pretty JSON object
-      def fmt_assoc( coll, in_lvl = 0, in_inc = DIV )
-        if coll.empty?
-          return '{}'
-        else
-          as_coll '{', '}', in_lvl, in_inc do |elem_indent|
-            coll.map do |key, value|
-              assoc_line = elem_indent + '"' + key.to_s + '"' + ': '
-              assoc_line += fmt_value( value, in_lvl, in_inc )
-            end
-          end
-        end
-      end
-
-      # Pretty prints a list collection
-      #
-      # @param [#each]    coll    The collection to be printed
-      # @param [Integer]  in_lvl  The level of indentation
-      # @param [String]   in_inc  The increment to indent
-      #
-      # @example
-      #   base = [ 'first', 'second' ]
-      #   self.fmt_list( base )
-      #   #=> '[
-      #            "first",
-      #            "second"
-      #        ]'
-      #
-      # @return [String] The collection as a pretty JSON object
-      def fmt_list( coll, in_lvl = 0, in_inc = DIV )
-        if coll.empty?
-          return '[]'
-        else
-          as_coll '[', ']', in_lvl, in_inc do |indent|
-            coll.map do |el|
-              indent + fmt_value( el, in_lvl, in_inc )
-            end
-          end
-        end
-      end
-
-      # Chooses between collection and primitive formatting
-      #
-      # !@visibility private
-      def fmt_value( value, in_lvl = 0, in_inc = DIV )
-        if value.kind_of? Enumerable and not value.is_a? String
-          fmt_collection( value, in_lvl + 1, in_inc )
-        else
-          fmt_basic( value )
-        end
-      end
-
-      # Pretty prints primitive JSON values
-      #
-      # @param [Object] value The collection to be printed
-      #
-      # @example
-      #   self.fmt_value( 4 )
-      #   #=> '4'
-      #
-      # @example
-      #   self.fmt_value( true )
-      #   #=> 'true'
-      #
-      # @example
-      #   self.fmt_value( nil )
-      #   #=> 'null'
-      #
-      # @example
-      #   self.fmt_value( 'string' )
-      #   #=> '"string"'
-      #
-      # @return [String] The value as a valid JSON primitive
-      def fmt_basic( value )
-        case value
-        when Numeric, TrueClass, FalseClass then value.to_s
-        when NilClass then "null"
-        else "\"#{value}\""
-        end
-      end
-
-      # Pretty print the options as JSON
-      #
-      # @example
-      #   base = { :key => { :subkey1 => 'subval', :subkey2 => 'subval' } }
-      #   base.dump
-      #   #=>  '{
-      #             "key": {
-      #                 "subkey1": "subval",
-      #                 "subkey2": 2
-      #             }
-      #         }
-      #
-      # @return [String] The description of self
-      def dump
-        fmt_collection( self, 0, DIV )
-      end
     end
   end
 end

data/lib/beaker/options/parser.rb

@@ -328,6 +328,7 @@ module Beaker
         end
 
         normalize_and_validate_tags()
+        resolve_symlinks()
 
         #set the default role
         set_default_host!(@options[:HOSTS])
@@ -365,6 +366,17 @@ module Beaker
         end
       end
 
+      # resolves all file symlinks that require it.
+      #
+      # @note doing it here allows us to not need duplicate logic, which we
+      #   would need if we were doing it in the parser (--hosts & --config)
+      #
+      # @return nil
+      # @api public
+      def resolve_symlinks()
+        @options[:hosts_file] = File.realpath(@options[:hosts_file]) if @options[:hosts_file]
+      end
+
       private
 
       # @api private

data/lib/beaker/options/presets.rb

@@ -178,7 +178,6 @@ module Beaker
           :ssh                    => {
                                      :config                => false,
                                      :paranoid              => false,
-                                     :timeout               => 300,
                                      :auth_methods          => ["publickey"],
                                      :port                  => 22,
                                      :forward_agent         => true,

data/lib/beaker/platform.rb

@@ -3,7 +3,7 @@ module Beaker
   # all String methods while adding several platform-specific use cases.
   class Platform < String
     # Supported platforms
-    PLATFORMS = /^(cisco|freebsd|osx|centos|fedora|debian|oracle|redhat|scientific|sles|ubuntu|windows|solaris|aix|el|eos|cumulus|f5)\-.+\-.+$/
+    PLATFORMS = /^(cisco|(free|open)bsd|osx|centos|fedora|debian|oracle|redhat|scientific|sles|ubuntu|windows|solaris|aix|el|eos|cumulus|f5)\-.+\-.+$/
 
     # Platform version numbers vs. codenames conversion hash
     PLATFORM_VERSION_CODES =
@@ -44,6 +44,8 @@ module Beaker
     # Creates the Platform object.  Checks to ensure that the platform String
     # provided meets the platform formatting rules.  Platforms name must be of
     # the format /^OSFAMILY-VERSION-ARCH.*$/ where OSFAMILY is one of:
+    # * freebsd
+    # * openbsd
     # * osx
     # * centos
     # * fedora

data/lib/beaker/ssh_connection.rb

@@ -6,6 +6,7 @@ module Beaker
   class SshConnection
 
     attr_accessor :logger
+    attr_accessor :ip, :vmhostname, :hostname
 
     RETRYABLE_EXCEPTIONS = [
       SocketError,
@@ -21,41 +22,65 @@ module Beaker
       IOError,
     ]
 
-    def initialize hostname, user = nil, ssh_opts = {}, options = {}
-      @hostname = hostname
+    def initialize name_hash, user = nil, ssh_opts = {}, options = {}
+      @vmhostname = name_hash[:vmhostname]
+      @ip = name_hash[:ip]
+      @hostname = name_hash[:hostname]
       @user = user
       @ssh_opts = ssh_opts
       @logger = options[:logger]
       @options = options
     end
 
-    def self.connect hostname, user = 'root', ssh_opts = {}, options = {}
-      connection = new hostname, user, ssh_opts, options
+    def self.connect name_hash, user = 'root', ssh_opts = {}, options = {}
+      connection = new name_hash, user, ssh_opts, options
       connection.connect
       connection
     end
 
+    def connect_block host, user, ssh_opts
+      try = 1
+      last_wait = 2
+      wait = 3
+      begin
+         @logger.debug "Attempting ssh connection to #{host}, user: #{user}, opts: #{ssh_opts}"
+         Net::SSH.start(host, user, ssh_opts)
+       rescue *RETRYABLE_EXCEPTIONS => e
+         if try <= 8
+           @logger.warn "Try #{try} -- Host #{host} unreachable: #{e.class.name} - #{e.message}"
+           @logger.warn "Trying again in #{wait} seconds"
+           sleep wait
+          (last_wait, wait) = wait, last_wait + wait
+           try += 1
+           retry
+         else
+           @logger.warn "Failed to connect to #{host}, after #{try} attempts"
+           nil
+         end
+       end
+    end
+
     # connect to the host
     def connect
-      try = 1
-      last_wait = 0
-      wait = 1
-      @ssh ||= begin
-                 @logger.debug "Attempting ssh connection to #{@hostname}, user: #{@user}, opts: #{@ssh_opts}"
-                 Net::SSH.start(@hostname, @user, @ssh_opts)
-               rescue *RETRYABLE_EXCEPTIONS => e
-                 if try <= 11
-                   @logger.warn "Try #{try} -- Host #{@hostname} unreachable: #{e.class.name} - #{e.message}"
-                   @logger.warn "Trying again in #{wait} seconds"
-                   sleep wait
-                  (last_wait, wait) = wait, last_wait + wait
-                   try += 1
-                   retry
-                 else
-                   @logger.error "Failed to connect to #{@hostname}"
-                   raise
-                 end
-               end
+      #try three ways to connect to host (ip, vmhostname, hostname)
+      methods = []
+      if @ip
+        @ssh ||= connect_block(@ip, @user, @ssh_opts)
+        methods << "ip (#{@ip})"
+      end
+      if @vmhostname && !@ssh
+        @ssh ||= connect_block(@vmhostname, @user, @ssh_opts)
+        methods << "vmhostname (#{@vmhostname})"
+      end
+      if @hostname && !@ssh
+        @ssh ||= connect_block(@hostname, @user, @ssh_opts)
+        methods << "hostname (#{@hostname})"
+      end
+      if not @ssh
+        @logger.error "Failed to connect to #{@hostname}, attempted #{methods.join(', ')}"
+        raise RuntimeError, "Cannot connect to #{@hostname}"
+      end
+      @ssh
     end
 
     # closes this SshConnection

data/lib/beaker/test_case.rb

@@ -1,4 +1,4 @@
-[ 'host', 'answers', 'dsl' ].each do |lib|
+[ 'host', 'dsl' ].each do |lib|
   require "beaker/#{lib}"
 end
 

data/lib/beaker/version.rb

@@ -1,5 +1,5 @@
 module Beaker
   module Version
-    STRING = '2.18.0'
+    STRING = '2.19.0'
   end
 end

data/spec/beaker/dsl/helpers/puppet_helpers_spec.rb

@@ -394,7 +394,6 @@ describe ClassMixedWithDSLHelpers do
       allow( el_agent ).to receive( :puppet ).and_return( { 'vardir' => vardir } )
 
       expect( el_agent ).to receive( :file_exist? ).with("/var/state/agent_catalog_run.lock").and_return(false)
-      expect( el_agent ).to receive( :file_exist? ).with("/etc/init.d/pe-puppet-agent").and_return(true)
 
       expect( subject ).to receive( :puppet_resource ).with( "service", "puppet", "ensure=stopped").once
       expect( subject ).to receive( :on ).once

data/spec/beaker/dsl/helpers/web_helpers_spec.rb

@@ -29,12 +29,21 @@ describe ClassMixedWithDSLHelpers do
 
       it "returns its second and third arguments concatenated." do
         create_files(['destdir/name'])
-        result = subject.fetch_http_file "http://beaker.tool/", "name", "destdir"
+        result = subject.fetch_http_file "http://beaker.tool", "name", "destdir"
         expect(result).to eq("destdir/name")
       end
 
     end
 
+    describe 'given invalid arguments' do
+
+      it 'chomps correctly when given a URL ending with a / character' do
+        expect( subject ).to receive( :open ).with( 'http://beaker.tool/name', anything )
+        subject.fetch_http_file( "http://beaker.tool/", "name", "destdir" )
+      end
+
+    end
+
   end
 
   describe "#fetch_http_dir" do