test-kitchen 1.6.0 → 1.7.0

data/lib/kitchen/collection.rb

@@ -1,55 +1,55 @@
-# -*- 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 "delegate"
-
-module Kitchen
-
-  # Delegate class which adds the ability to find single and multiple
-  # objects by their #name in an Array. Hey, it's better than monkey-patching
-  # Array, right?
-  #
-  # @author Fletcher Nichol <fnichol@nichol.ca>
-  class Collection < SimpleDelegator
-
-    # Returns a single object by its name, or nil if none are found.
-    #
-    # @param name [String] name of object
-    # @return [Object] first match by name, or nil if none are found
-    def get(name)
-      __getobj__.find { |i| i.name == name }
-    end
-
-    # Returns a Collection of all objects whose #name is matched by the
-    # regular expression.
-    #
-    # @param regexp [Regexp] a regular expression pattern
-    # @return [Kitchen::Config::Collection<Object>] a new collection of
-    #   matched objects
-    def get_all(regexp)
-      Kitchen::Collection.new(__getobj__.select { |i| i.name =~ regexp })
-    end
-
-    # Returns an Array of names from the collection as strings.
-    #
-    # @return [Array<String>] array of name strings
-    def as_names
-      __getobj__.map(&:name)
-    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 "delegate"
+
+module Kitchen
+
+  # Delegate class which adds the ability to find single and multiple
+  # objects by their #name in an Array. Hey, it's better than monkey-patching
+  # Array, right?
+  #
+  # @author Fletcher Nichol <fnichol@nichol.ca>
+  class Collection < SimpleDelegator
+
+    # Returns a single object by its name, or nil if none are found.
+    #
+    # @param name [String] name of object
+    # @return [Object] first match by name, or nil if none are found
+    def get(name)
+      __getobj__.find { |i| i.name == name }
+    end
+
+    # Returns a Collection of all objects whose #name is matched by the
+    # regular expression.
+    #
+    # @param regexp [Regexp] a regular expression pattern
+    # @return [Kitchen::Config::Collection<Object>] a new collection of
+    #   matched objects
+    def get_all(regexp)
+      Kitchen::Collection.new(__getobj__.select { |i| i.name =~ regexp })
+    end
+
+    # Returns an Array of names from the collection as strings.
+    #
+    # @return [Array<String>] array of name strings
+    def as_names
+      __getobj__.map(&:name)
+    end
+  end
+end

data/lib/kitchen/color.rb

@@ -1,65 +1,65 @@
-# -*- 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.
-
-module Kitchen
-
-  # Utility methods to help ouput colorized text in a terminal. The
-  # implementation is a compressed mashup of code from the Thor and Foreman
-  # projects.
-  #
-  # @author Fletcher Nichol <fnichol@nichol.ca>
-  module Color
-
-    ANSI = {
-      :reset => 0, :black => 30, :red => 31, :green => 32, :yellow => 33,
-      :blue => 34, :magenta => 35, :cyan => 36, :white => 37,
-      :bright_black => 90, :bright_red => 91, :bright_green => 92,
-      :bright_yellow => 93, :bright_blue => 94, :bright_magenta => 95,
-      :bright_cyan => 96, :bright_white => 97
-    }.freeze
-
-    COLORS = %w[
-      cyan yellow green magenta blue bright_cyan bright_yellow
-      bright_green bright_magenta bright_blue
-    ].freeze
-
-    # Returns an ansi escaped string representing a color control sequence.
-    #
-    # @param name [Symbol] a valid color representation, taken from
-    #   Kitchen::Color::ANSI
-    # @return [String] an ansi escaped string if the color is valid and an
-    #   empty string otherwise
-    def self.escape(name)
-      return "" if name.nil?
-      return "" unless ANSI[name]
-      "\e[#{ANSI[name]}m"
-    end
-
-    # Returns a colorized ansi escaped string with the given color.
-    #
-    # @param str [String] a string to colorize
-    # @param name [Symbol] a valid color representation, taken from
-    #   Kitchen::Color::ANSI
-    # @return [String] an ansi escaped string if the color is valid and an
-    #   unescaped string otherwise
-    def self.colorize(str, name)
-      color = escape(name)
-      color.empty? ? str : "#{color}#{str}#{escape(:reset)}"
-    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.
+
+module Kitchen
+
+  # Utility methods to help ouput colorized text in a terminal. The
+  # implementation is a compressed mashup of code from the Thor and Foreman
+  # projects.
+  #
+  # @author Fletcher Nichol <fnichol@nichol.ca>
+  module Color
+
+    ANSI = {
+      :reset => 0, :black => 30, :red => 31, :green => 32, :yellow => 33,
+      :blue => 34, :magenta => 35, :cyan => 36, :white => 37,
+      :bright_black => 90, :bright_red => 91, :bright_green => 92,
+      :bright_yellow => 93, :bright_blue => 94, :bright_magenta => 95,
+      :bright_cyan => 96, :bright_white => 97
+    }.freeze
+
+    COLORS = %w[
+      cyan yellow green magenta blue bright_cyan bright_yellow
+      bright_green bright_magenta bright_blue
+    ].freeze
+
+    # Returns an ansi escaped string representing a color control sequence.
+    #
+    # @param name [Symbol] a valid color representation, taken from
+    #   Kitchen::Color::ANSI
+    # @return [String] an ansi escaped string if the color is valid and an
+    #   empty string otherwise
+    def self.escape(name)
+      return "" if name.nil?
+      return "" unless ANSI[name]
+      "\e[#{ANSI[name]}m"
+    end
+
+    # Returns a colorized ansi escaped string with the given color.
+    #
+    # @param str [String] a string to colorize
+    # @param name [Symbol] a valid color representation, taken from
+    #   Kitchen::Color::ANSI
+    # @return [String] an ansi escaped string if the color is valid and an
+    #   unescaped string otherwise
+    def self.colorize(str, name)
+      color = escape(name)
+      color.empty? ? str : "#{color}#{str}#{escape(:reset)}"
+    end
+  end
+end

data/lib/kitchen/command.rb

@@ -1,185 +1,185 @@
-# -*- 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 "thread"
-
-module Kitchen
-
-  module Command
-
-    # Base class for CLI commands.
-    #
-    # @author Fletcher Nichol <fnichol@nichol.ca>
-    class Base
-
-      include Logging
-
-      # Contstructs a new Command object.
-      #
-      # @param cmd_args [Array] remainder of the arguments from processed ARGV
-      # @param cmd_options [Hash] hash of Thor options
-      # @param options [Hash] configuration options
-      # @option options [String] :action action to take, usually corresponding
-      #   to the subcommand name (default: `nil`)
-      # @option options [proc] :help a callable that displays help for the
-      #   command
-      # @option options [Config] :config a Config object (default: `nil`)
-      # @option options [Loader] :loader a Loader object (default: `nil`)
-      # @option options [String] :shell a Thor shell object
-      def initialize(cmd_args, cmd_options, options = {})
-        @args = cmd_args
-        @options = cmd_options
-        @action = options.fetch(:action, nil)
-        @help = options.fetch(:help, -> { "No help provided" })
-        @config = options.fetch(:config, nil)
-        @loader = options.fetch(:loader, nil)
-        @shell = options.fetch(:shell)
-      end
-
-      private
-
-      # @return [Array] remainder of the arguments from processed ARGV
-      # @api private
-      attr_reader :args
-
-      # @return [Hash] hash of Thor options
-      # @api private
-      attr_reader :options
-
-      # @return [proc] a callable that displays help for the command
-      # @api private
-      attr_reader :help
-
-      # @return [Config] a Config object
-      # @api private
-      attr_reader :config
-
-      # @return [Thor::Shell] a Thor shell object
-      # @api private
-      attr_reader :shell
-
-      # @return [String] the action to perform
-      # @api private
-      attr_reader :action
-
-      # Emit an error message, display contextual help and then exit with a
-      # non-zero exit code.
-      #
-      # **Note** This method calls exit and will not return.
-      #
-      # @param msg [String] error message
-      # @api private
-      def die(msg)
-        error "\n#{msg}\n\n"
-        help.call
-        exit 1
-      end
-
-      # @return [Array<Instance>] an array of instances
-      # @raise [SystemExit] if no instances are returned
-      # @api private
-      def all_instances
-        result = @config.instances
-
-        if result.empty?
-          die "No instances defined"
-        else
-          result
-        end
-      end
-
-      # Return an array on instances whos name matches the regular expression.
-      #
-      # @param regexp [Regexp] a regular expression matching on instance names
-      # @return [Array<Instance>] an array of instances
-      # @raise [SystemExit] if no instances are returned or the regular
-      #   expression is invalid
-      # @api private
-      def filtered_instances(regexp)
-        result = begin
-          @config.instances.get(regexp) ||
-            @config.instances.get_all(/#{regexp}/)
-        rescue RegexpError => e
-          die "Invalid Ruby regular expression, " \
-            "you may need to single quote the argument. " \
-            "Please try again or consult http://rubular.com/ (#{e.message})"
-        end
-        result = Array(result)
-
-        if result.empty?
-          die "No instances for regex `#{regexp}', try running `kitchen list'"
-        else
-          result
-        end
-      end
-
-      # @return [Logger] the common logger
-      # @api private
-      def logger
-        Kitchen.logger
-      end
-
-      # Return an array on instances whos name matches the regular expression,
-      # the full instance name, or  the `"all"` literal.
-      #
-      # @param arg [String] an instance name, a regular expression, the literal
-      #   `"all"`, or `nil`
-      # @return [Array<Instance>] an array of instances
-      # @api private
-      def parse_subcommand(arg = nil)
-        arg == "all" ? all_instances : filtered_instances(arg)
-      end
-    end
-
-    # Common module to execute a Kitchen action such as create, converge, etc.
-    #
-    # @author Fletcher Nichol <fnichol@nichol.ca>
-    module RunAction
-
-      # Run an instance action (create, converge, setup, verify, destroy) on
-      # a collection of instances. The instance actions will take place in a
-      # seperate thread of execution which may or may not be running
-      # concurrently.
-      #
-      # @param action [String] action to perform
-      # @param instances [Array<Instance>] an array of instances
-      def run_action(action, instances, *args)
-        concurrency = 1
-        if options[:concurrency]
-          concurrency = options[:concurrency] || instances.size
-          concurrency = instances.size if concurrency > instances.size
-        end
-
-        queue = Queue.new
-        instances.each { |i| queue << i }
-        concurrency.times { queue << nil }
-
-        threads = []
-        concurrency.times do
-          threads << Thread.new do
-            while instance = queue.pop
-              instance.public_send(action, *args)
-              instance.cleanup!
-            end
-          end
-        end
-        threads.map(&:join)
-      end
-    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 "thread"
+
+module Kitchen
+
+  module Command
+
+    # Base class for CLI commands.
+    #
+    # @author Fletcher Nichol <fnichol@nichol.ca>
+    class Base
+
+      include Logging
+
+      # Contstructs a new Command object.
+      #
+      # @param cmd_args [Array] remainder of the arguments from processed ARGV
+      # @param cmd_options [Hash] hash of Thor options
+      # @param options [Hash] configuration options
+      # @option options [String] :action action to take, usually corresponding
+      #   to the subcommand name (default: `nil`)
+      # @option options [proc] :help a callable that displays help for the
+      #   command
+      # @option options [Config] :config a Config object (default: `nil`)
+      # @option options [Loader] :loader a Loader object (default: `nil`)
+      # @option options [String] :shell a Thor shell object
+      def initialize(cmd_args, cmd_options, options = {})
+        @args = cmd_args
+        @options = cmd_options
+        @action = options.fetch(:action, nil)
+        @help = options.fetch(:help, -> { "No help provided" })
+        @config = options.fetch(:config, nil)
+        @loader = options.fetch(:loader, nil)
+        @shell = options.fetch(:shell)
+      end
+
+      private
+
+      # @return [Array] remainder of the arguments from processed ARGV
+      # @api private
+      attr_reader :args
+
+      # @return [Hash] hash of Thor options
+      # @api private
+      attr_reader :options
+
+      # @return [proc] a callable that displays help for the command
+      # @api private
+      attr_reader :help
+
+      # @return [Config] a Config object
+      # @api private
+      attr_reader :config
+
+      # @return [Thor::Shell] a Thor shell object
+      # @api private
+      attr_reader :shell
+
+      # @return [String] the action to perform
+      # @api private
+      attr_reader :action
+
+      # Emit an error message, display contextual help and then exit with a
+      # non-zero exit code.
+      #
+      # **Note** This method calls exit and will not return.
+      #
+      # @param msg [String] error message
+      # @api private
+      def die(msg)
+        error "\n#{msg}\n\n"
+        help.call
+        exit 1
+      end
+
+      # @return [Array<Instance>] an array of instances
+      # @raise [SystemExit] if no instances are returned
+      # @api private
+      def all_instances
+        result = @config.instances
+
+        if result.empty?
+          die "No instances defined"
+        else
+          result
+        end
+      end
+
+      # Return an array on instances whos name matches the regular expression.
+      #
+      # @param regexp [Regexp] a regular expression matching on instance names
+      # @return [Array<Instance>] an array of instances
+      # @raise [SystemExit] if no instances are returned or the regular
+      #   expression is invalid
+      # @api private
+      def filtered_instances(regexp)
+        result = begin
+          @config.instances.get(regexp) ||
+            @config.instances.get_all(/#{regexp}/)
+        rescue RegexpError => e
+          die "Invalid Ruby regular expression, " \
+            "you may need to single quote the argument. " \
+            "Please try again or consult http://rubular.com/ (#{e.message})"
+        end
+        result = Array(result)
+
+        if result.empty?
+          die "No instances for regex `#{regexp}', try running `kitchen list'"
+        else
+          result
+        end
+      end
+
+      # @return [Logger] the common logger
+      # @api private
+      def logger
+        Kitchen.logger
+      end
+
+      # Return an array on instances whos name matches the regular expression,
+      # the full instance name, or  the `"all"` literal.
+      #
+      # @param arg [String] an instance name, a regular expression, the literal
+      #   `"all"`, or `nil`
+      # @return [Array<Instance>] an array of instances
+      # @api private
+      def parse_subcommand(arg = nil)
+        arg == "all" ? all_instances : filtered_instances(arg)
+      end
+    end
+
+    # Common module to execute a Kitchen action such as create, converge, etc.
+    #
+    # @author Fletcher Nichol <fnichol@nichol.ca>
+    module RunAction
+
+      # Run an instance action (create, converge, setup, verify, destroy) on
+      # a collection of instances. The instance actions will take place in a
+      # seperate thread of execution which may or may not be running
+      # concurrently.
+      #
+      # @param action [String] action to perform
+      # @param instances [Array<Instance>] an array of instances
+      def run_action(action, instances, *args)
+        concurrency = 1
+        if options[:concurrency]
+          concurrency = options[:concurrency] || instances.size
+          concurrency = instances.size if concurrency > instances.size
+        end
+
+        queue = Queue.new
+        instances.each { |i| queue << i }
+        concurrency.times { queue << nil }
+
+        threads = []
+        concurrency.times do
+          threads << Thread.new do
+            while instance = queue.pop
+              instance.public_send(action, *args)
+              instance.cleanup!
+            end
+          end
+        end
+        threads.map(&:join)
+      end
+    end
+  end
+end