test-kitchen 1.6.0 → 1.7.0

data/lib/kitchen/diagnostic.rb

@@ -1,141 +1,141 @@
-# -*- encoding: utf-8 -*-
-#
-# Author:: Fletcher Nichol (<fnichol@nichol.ca>)
-#
-# Copyright (C) 2013, Fletcher Nichol
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#    http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-require "kitchen/util"
-require "kitchen/version"
-
-module Kitchen
-
-  # Combines and compiles diagnostic information about a Test Kitchen
-  # configuration suitable for support and troubleshooting.
-  #
-  # @author Fletcher Nichol <fnichol@nichol.ca>
-  class Diagnostic
-
-    # Constructs a new Diagnostic object with an optional loader and optional
-    # instances array.
-    #
-    # @param options [Hash] optional configuration
-    # @option options [#diagnose,Hash] :loader a loader instance that responds
-    #   to `#diagnose` or an error Hash
-    # @option options [Array<#diagnose>,Hash] :instances an Array of instances
-    #   that respond to `#diagnose` or an error Hash
-    # @option options [true,false] :plugins whether or not plugins should be
-    #   returned
-    def initialize(options = {})
-      @loader = options.fetch(:loader, nil)
-      @instances = options.fetch(:instances, [])
-      @plugins = options.fetch(:plugins, false)
-      @result = Hash.new
-    end
-
-    # Returns a Hash with stringified keys containing diagnostic information.
-    #
-    # @return [Hash] a configuration Hash
-    def read
-      prepare_common
-      prepare_plugins
-      prepare_loader
-      prepare_instances
-
-      Util.stringified_hash(result)
-    end
-
-    private
-
-    # @return [Hash] a result hash
-    # @api private
-    attr_reader :result
-
-    # @return [#diagnose,Hash] a loader instance that responds to `#diagnose`
-    #   or an error Hash
-    # @api private
-    attr_reader :loader
-
-    # @return [Array<#diagnose>,Hash] an Array of instances that respond to
-    #   `#diagnose` or an error Hash
-    # @api private
-    attr_reader :instances
-
-    # Adds common information to the result Hash.
-    #
-    # @api private
-    def prepare_common
-      result[:timestamp] = Time.now.gmtime.to_s
-      result[:kitchen_version] = Kitchen::VERSION
-    end
-
-    # Adds loader information to the result Hash.
-    #
-    # @api private
-    def prepare_loader
-      if error_hash?(loader)
-        result[:loader] = loader
-      else
-        result[:loader] = loader.diagnose if loader
-      end
-    end
-
-    # Adds plugin information to the result Hash.
-    #
-    # @api private
-    def prepare_plugins
-      return unless @plugins
-
-      if error_hash?(instances)
-        result[:plugins] = { :error => instances[:error] }
-      elsif instances.empty?
-        result[:plugins] = Hash.new
-      else
-        plugins = {
-          :driver => [], :provisioner => [], :transport => [], :verifier => []
-        }
-        instances.map(&:diagnose_plugins).each do |plugin_hash|
-          plugin_hash.each { |type, plugin| plugins[type] << plugin }
-        end
-        plugins.each do |type, list|
-          plugins[type] =
-            Hash[list.uniq.map { |hash| [hash.delete(:name), hash] }]
-        end
-        result[:plugins] = plugins
-      end
-    end
-
-    # Adds instance information to the result Hash.
-    #
-    # @api private
-    def prepare_instances
-      result[:instances] = Hash.new
-      if error_hash?(instances)
-        result[:instances][:error] = instances[:error]
-      else
-        Array(instances).each { |i| result[:instances][i.name] = i.diagnose }
-      end
-    end
-
-    # Determins whether or not the object is an error hash. An error hash is
-    # defined as a Hash containing an `:error` key.
-    #
-    # @param obj [Object] an object
-    # @return [true,false] whether or not the object is an error hash
-    # @api private
-    def error_hash?(obj)
-      obj.is_a?(Hash) && obj.key?(:error)
-    end
-  end
-end
+# -*- encoding: utf-8 -*-
+#
+# Author:: Fletcher Nichol (<fnichol@nichol.ca>)
+#
+# Copyright (C) 2013, Fletcher Nichol
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require "kitchen/util"
+require "kitchen/version"
+
+module Kitchen
+
+  # Combines and compiles diagnostic information about a Test Kitchen
+  # configuration suitable for support and troubleshooting.
+  #
+  # @author Fletcher Nichol <fnichol@nichol.ca>
+  class Diagnostic
+
+    # Constructs a new Diagnostic object with an optional loader and optional
+    # instances array.
+    #
+    # @param options [Hash] optional configuration
+    # @option options [#diagnose,Hash] :loader a loader instance that responds
+    #   to `#diagnose` or an error Hash
+    # @option options [Array<#diagnose>,Hash] :instances an Array of instances
+    #   that respond to `#diagnose` or an error Hash
+    # @option options [true,false] :plugins whether or not plugins should be
+    #   returned
+    def initialize(options = {})
+      @loader = options.fetch(:loader, nil)
+      @instances = options.fetch(:instances, [])
+      @plugins = options.fetch(:plugins, false)
+      @result = Hash.new
+    end
+
+    # Returns a Hash with stringified keys containing diagnostic information.
+    #
+    # @return [Hash] a configuration Hash
+    def read
+      prepare_common
+      prepare_plugins
+      prepare_loader
+      prepare_instances
+
+      Util.stringified_hash(result)
+    end
+
+    private
+
+    # @return [Hash] a result hash
+    # @api private
+    attr_reader :result
+
+    # @return [#diagnose,Hash] a loader instance that responds to `#diagnose`
+    #   or an error Hash
+    # @api private
+    attr_reader :loader
+
+    # @return [Array<#diagnose>,Hash] an Array of instances that respond to
+    #   `#diagnose` or an error Hash
+    # @api private
+    attr_reader :instances
+
+    # Adds common information to the result Hash.
+    #
+    # @api private
+    def prepare_common
+      result[:timestamp] = Time.now.gmtime.to_s
+      result[:kitchen_version] = Kitchen::VERSION
+    end
+
+    # Adds loader information to the result Hash.
+    #
+    # @api private
+    def prepare_loader
+      if error_hash?(loader)
+        result[:loader] = loader
+      else
+        result[:loader] = loader.diagnose if loader
+      end
+    end
+
+    # Adds plugin information to the result Hash.
+    #
+    # @api private
+    def prepare_plugins
+      return unless @plugins
+
+      if error_hash?(instances)
+        result[:plugins] = { :error => instances[:error] }
+      elsif instances.empty?
+        result[:plugins] = Hash.new
+      else
+        plugins = {
+          :driver => [], :provisioner => [], :transport => [], :verifier => []
+        }
+        instances.map(&:diagnose_plugins).each do |plugin_hash|
+          plugin_hash.each { |type, plugin| plugins[type] << plugin }
+        end
+        plugins.each do |type, list|
+          plugins[type] =
+            Hash[list.uniq.map { |hash| [hash.delete(:name), hash] }]
+        end
+        result[:plugins] = plugins
+      end
+    end
+
+    # Adds instance information to the result Hash.
+    #
+    # @api private
+    def prepare_instances
+      result[:instances] = Hash.new
+      if error_hash?(instances)
+        result[:instances][:error] = instances[:error]
+      else
+        Array(instances).each { |i| result[:instances][i.name] = i.diagnose }
+      end
+    end
+
+    # Determins whether or not the object is an error hash. An error hash is
+    # defined as a Hash containing an `:error` key.
+    #
+    # @param obj [Object] an object
+    # @return [true,false] whether or not the object is an error hash
+    # @api private
+    def error_hash?(obj)
+      obj.is_a?(Hash) && obj.key?(:error)
+    end
+  end
+end

data/lib/kitchen/driver.rb

@@ -1,56 +1,56 @@
-# -*- encoding: utf-8 -*-
-#
-# Author:: Fletcher Nichol (<fnichol@nichol.ca>)
-#
-# Copyright (C) 2012, Fletcher Nichol
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#    http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-require "thor/util"
-
-module Kitchen
-
-  # A driver is responsible for carrying out the lifecycle activities of an
-  # instance, such as creating and destroying an instance.
-  #
-  # @author Fletcher Nichol <fnichol@nichol.ca>
-  module Driver
-
-    # Default driver plugin to use
-    DEFAULT_PLUGIN = "dummy".freeze
-
-    # Returns an instance of a driver given a plugin type string.
-    #
-    # @param plugin [String] a driver plugin type, which will be constantized
-    # @param config [Hash] a configuration hash to initialize the driver
-    # @return [Driver::Base] a driver instance
-    # @raise [ClientError] if a driver instance could not be created
-    # @raise [UserError] if the driver's dependencies could not be met
-    def self.for_plugin(plugin, config)
-      first_load = require("kitchen/driver/#{plugin}")
-
-      str_const = Thor::Util.camel_case(plugin)
-      klass = const_get(str_const)
-      object = klass.new(config)
-      object.verify_dependencies if first_load
-      object
-    rescue UserError
-      raise
-    rescue LoadError, NameError
-      raise ClientError,
-        "Could not load the '#{plugin}' driver from the load path." \
-          " Please ensure that your driver is installed as a gem or included" \
-          " in your Gemfile if using Bundler."
-    end
-  end
-end
+# -*- encoding: utf-8 -*-
+#
+# Author:: Fletcher Nichol (<fnichol@nichol.ca>)
+#
+# Copyright (C) 2012, Fletcher Nichol
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require "thor/util"
+
+module Kitchen
+
+  # A driver is responsible for carrying out the lifecycle activities of an
+  # instance, such as creating and destroying an instance.
+  #
+  # @author Fletcher Nichol <fnichol@nichol.ca>
+  module Driver
+
+    # Default driver plugin to use
+    DEFAULT_PLUGIN = "dummy".freeze
+
+    # Returns an instance of a driver given a plugin type string.
+    #
+    # @param plugin [String] a driver plugin type, which will be constantized
+    # @param config [Hash] a configuration hash to initialize the driver
+    # @return [Driver::Base] a driver instance
+    # @raise [ClientError] if a driver instance could not be created
+    # @raise [UserError] if the driver's dependencies could not be met
+    def self.for_plugin(plugin, config)
+      first_load = require("kitchen/driver/#{plugin}")
+
+      str_const = Thor::Util.camel_case(plugin)
+      klass = const_get(str_const)
+      object = klass.new(config)
+      object.verify_dependencies if first_load
+      object
+    rescue UserError
+      raise
+    rescue LoadError, NameError
+      raise ClientError,
+        "Could not load the '#{plugin}' driver from the load path." \
+          " Please ensure that your driver is installed as a gem or included" \
+          " in your Gemfile if using Bundler."
+    end
+  end
+end

data/lib/kitchen/driver/base.rb

@@ -1,134 +1,134 @@
-# -*- encoding: utf-8 -*-
-#
-# Author:: Fletcher Nichol (<fnichol@nichol.ca>)
-#
-# Copyright (C) 2012, Fletcher Nichol
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#    http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-require "kitchen/lazy_hash"
-
-module Kitchen
-
-  module Driver
-
-    # Base class for a driver.
-    #
-    # @author Fletcher Nichol <fnichol@nichol.ca>
-    class Base
-
-      include Configurable
-      include Logging
-
-      # Creates a new Driver object using the provided configuration data
-      # which will be merged with any default configuration.
-      #
-      # @param config [Hash] provided driver configuration
-      def initialize(config = {})
-        init_config(config)
-      end
-
-      # Creates an instance.
-      #
-      # @param state [Hash] mutable instance and driver state
-      # @raise [ActionFailed] if the action could not be completed
-      def create(state) # rubocop:disable Lint/UnusedMethodArgument
-      end
-
-      # Destroys an instance.
-      #
-      # @param state [Hash] mutable instance and driver state
-      # @raise [ActionFailed] if the action could not be completed
-      def destroy(state) # rubocop:disable Lint/UnusedMethodArgument
-      end
-
-      class << self
-        # @return [Array<Symbol>] an array of action method names that cannot
-        #   be run concurrently and must be run in serial via a shared mutex
-        attr_reader :serial_actions
-      end
-
-      # Registers certain driver actions that cannot be safely run concurrently
-      # in threads across multiple instances. Typically this might be used
-      # for create or destroy actions that use an underlying resource that
-      # cannot be used at the same time.
-      #
-      # A shared mutex for this driver object will be used to synchronize all
-      # registered methods.
-      #
-      # @example a single action method that cannot be run concurrently
-      #
-      #   no_parallel_for :create
-      #
-      # @example multiple action methods that cannot be run concurrently
-      #
-      #   no_parallel_for :create, :destroy
-      #
-      # @param methods [Array<Symbol>] one or more actions as symbols
-      # @raise [ClientError] if any method is not a valid action method name
-      def self.no_parallel_for(*methods)
-        action_methods = [:create, :setup, :verify, :destroy]
-
-        Array(methods).each do |meth|
-          next if action_methods.include?(meth)
-
-          raise ClientError, "##{meth} is not a valid no_parallel_for method"
-        end
-
-        @serial_actions ||= []
-        @serial_actions += methods
-      end
-
-      # Sets the API version for this driver. If the driver does not set this
-      # value, then `nil` will be used and reported.
-      #
-      # Sets the API version for this driver
-      #
-      # @example setting an API version
-      #
-      #   module Kitchen
-      #     module Driver
-      #       class NewDriver < Kitchen::Driver::Base
-      #
-      #         kitchen_driver_api_version 2
-      #
-      #       end
-      #     end
-      #   end
-      #
-      # @param version [Integer,String] a version number
-      #
-      def self.kitchen_driver_api_version(version)
-        @api_version = version
-      end
-
-      private
-
-      # Intercepts any bare #puts calls in subclasses and issues an INFO log
-      # event instead.
-      #
-      # @param msg [String] message string
-      def puts(msg)
-        info(msg)
-      end
-
-      # Intercepts any bare #print calls in subclasses and issues an INFO log
-      # event instead.
-      #
-      # @param msg [String] message string
-      def print(msg)
-        info(msg)
-      end
-    end
-  end
-end
+# -*- encoding: utf-8 -*-
+#
+# Author:: Fletcher Nichol (<fnichol@nichol.ca>)
+#
+# Copyright (C) 2012, Fletcher Nichol
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require "kitchen/lazy_hash"
+
+module Kitchen
+
+  module Driver
+
+    # Base class for a driver.
+    #
+    # @author Fletcher Nichol <fnichol@nichol.ca>
+    class Base
+
+      include Configurable
+      include Logging
+
+      # Creates a new Driver object using the provided configuration data
+      # which will be merged with any default configuration.
+      #
+      # @param config [Hash] provided driver configuration
+      def initialize(config = {})
+        init_config(config)
+      end
+
+      # Creates an instance.
+      #
+      # @param state [Hash] mutable instance and driver state
+      # @raise [ActionFailed] if the action could not be completed
+      def create(state) # rubocop:disable Lint/UnusedMethodArgument
+      end
+
+      # Destroys an instance.
+      #
+      # @param state [Hash] mutable instance and driver state
+      # @raise [ActionFailed] if the action could not be completed
+      def destroy(state) # rubocop:disable Lint/UnusedMethodArgument
+      end
+
+      class << self
+        # @return [Array<Symbol>] an array of action method names that cannot
+        #   be run concurrently and must be run in serial via a shared mutex
+        attr_reader :serial_actions
+      end
+
+      # Registers certain driver actions that cannot be safely run concurrently
+      # in threads across multiple instances. Typically this might be used
+      # for create or destroy actions that use an underlying resource that
+      # cannot be used at the same time.
+      #
+      # A shared mutex for this driver object will be used to synchronize all
+      # registered methods.
+      #
+      # @example a single action method that cannot be run concurrently
+      #
+      #   no_parallel_for :create
+      #
+      # @example multiple action methods that cannot be run concurrently
+      #
+      #   no_parallel_for :create, :destroy
+      #
+      # @param methods [Array<Symbol>] one or more actions as symbols
+      # @raise [ClientError] if any method is not a valid action method name
+      def self.no_parallel_for(*methods)
+        action_methods = [:create, :setup, :verify, :destroy]
+
+        Array(methods).each do |meth|
+          next if action_methods.include?(meth)
+
+          raise ClientError, "##{meth} is not a valid no_parallel_for method"
+        end
+
+        @serial_actions ||= []
+        @serial_actions += methods
+      end
+
+      # Sets the API version for this driver. If the driver does not set this
+      # value, then `nil` will be used and reported.
+      #
+      # Sets the API version for this driver
+      #
+      # @example setting an API version
+      #
+      #   module Kitchen
+      #     module Driver
+      #       class NewDriver < Kitchen::Driver::Base
+      #
+      #         kitchen_driver_api_version 2
+      #
+      #       end
+      #     end
+      #   end
+      #
+      # @param version [Integer,String] a version number
+      #
+      def self.kitchen_driver_api_version(version)
+        @api_version = version
+      end
+
+      private
+
+      # Intercepts any bare #puts calls in subclasses and issues an INFO log
+      # event instead.
+      #
+      # @param msg [String] message string
+      def puts(msg)
+        info(msg)
+      end
+
+      # Intercepts any bare #print calls in subclasses and issues an INFO log
+      # event instead.
+      #
+      # @param msg [String] message string
+      def print(msg)
+        info(msg)
+      end
+    end
+  end
+end