test-kitchen 1.2.1 → 1.3.0

data/lib/kitchen/collection.rb

@@ -16,7 +16,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require 'delegate'
+require "delegate"
 
 module Kitchen
 
@@ -42,14 +42,14 @@ module Kitchen
     # @return [Kitchen::Config::Collection<Object>] a new collection of
     #   matched objects
     def get_all(regexp)
-      Kitchen::Collection.new(__getobj__.find_all { |i| i.name =~ 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 { |i| i.name }
+      __getobj__.map(&:name)
     end
   end
 end

data/lib/kitchen/color.rb

@@ -33,10 +33,10 @@ module Kitchen
       :bright_cyan => 96, :bright_white => 97
     }.freeze
 
-    COLORS = %w(
+    COLORS = %w[
       cyan yellow green magenta blue bright_cyan bright_yellow
       bright_green bright_magenta bright_blue
-    ).freeze
+    ].freeze
 
     # Returns an ansi escaped string representing a color control sequence.
     #
@@ -46,8 +46,8 @@ module Kitchen
     #   empty string otherwise
     def self.escape(name)
       return "" if name.nil?
-      return "" unless ansi = ANSI[name]
-      "\e[#{ansi}m"
+      return "" unless ANSI[name]
+      "\e[#{ANSI[name]}m"
     end
 
     # Returns a colorized ansi escaped string with the given color.

data/lib/kitchen/command.rb

@@ -16,7 +16,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require 'thread'
+require "thread"
 
 module Kitchen
 
@@ -29,27 +29,71 @@ module Kitchen
 
       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, lambda { "No help provided" })
+        @help = options.fetch(:help, -> { "No help provided" })
         @config = options.fetch(:config, nil)
         @loader = options.fetch(:loader, nil)
         @shell = options.fetch(:shell)
       end
 
-      protected
+      private
 
-      attr_reader :args, :options, :help, :config, :shell, :action
+      # @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
 
-      def get_all_instances
+      # @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?
@@ -59,13 +103,20 @@ module Kitchen
         end
       end
 
-      def get_filtered_instances(regexp)
+      # 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. " +
+          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)
@@ -77,12 +128,21 @@ module Kitchen
         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" ? get_all_instances : get_filtered_instances(arg)
+        arg == "all" ? all_instances : filtered_instances(arg)
       end
     end
 
@@ -91,6 +151,13 @@ module Kitchen
     # @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]
@@ -99,7 +166,7 @@ module Kitchen
         end
 
         queue = Queue.new
-        instances.each {|i| queue << i }
+        instances.each { |i| queue << i }
         concurrency.times { queue << nil }
 
         threads = []
@@ -110,7 +177,7 @@ module Kitchen
             end
           end
         end
-        threads.map { |i| i.join }
+        threads.map(&:join)
       end
     end
   end

data/lib/kitchen/command/action.rb

@@ -16,9 +16,9 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require 'kitchen/command'
+require "kitchen/command"
 
-require 'benchmark'
+require "benchmark"
 
 module Kitchen
 
@@ -31,6 +31,7 @@ module Kitchen
 
       include RunAction
 
+      # Invoke the command.
       def call
         banner "Starting Kitchen (v#{Kitchen::VERSION})"
         elapsed = Benchmark.measure do

data/lib/kitchen/command/console.rb

@@ -16,7 +16,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require 'kitchen/command'
+require "kitchen/command"
 
 module Kitchen
 
@@ -27,20 +27,27 @@ module Kitchen
     # @author Fletcher Nichol <fnichol@nichol.ca>
     class Console < Kitchen::Command::Base
 
+      # Invoke the command.
       def call
-        require 'pry'
+        require "pry"
         Pry.start(@config, :prompt => [prompt(">"), prompt("*")])
-      rescue LoadError => e
+      rescue LoadError
         warn %{Make sure you have the pry gem installed. You can install it with:}
         warn %{`gem install pry` or including 'gem "pry"' in your Gemfile.}
         exit 1
       end
 
-      protected
+      private
 
+      # Construct a custom Pry prompt proc.
+      #
+      # @param char [String] prompt character
+      # @return [proc] a prompt proc
+      # @api private
       def prompt(char)
         proc { |target_self, nest_level, pry|
-          ["[#{pry.input_array.size}] ",
+          [
+            "[#{pry.input_array.size}] ",
             "kc(#{Pry.view_clip(target_self.class)})",
             "#{":#{nest_level}" unless nest_level.zero?}#{char} "
           ].join

data/lib/kitchen/command/diagnose.rb

@@ -16,10 +16,10 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require 'kitchen/command'
-require 'kitchen/diagnostic'
+require "kitchen/command"
+require "kitchen/diagnostic"
 
-require 'yaml'
+require "yaml"
 
 module Kitchen
 
@@ -30,6 +30,7 @@ module Kitchen
     # @author Fletcher Nichol <fnichol@nichol.ca>
     class Diagnose < Kitchen::Command::Base
 
+      # Invoke the command.
       def call
         instances = record_failure { load_instances }
 
@@ -41,6 +42,10 @@ module Kitchen
 
       private
 
+      # Loads and returns instances if they are requested.
+      #
+      # @return [Array<Instance>] an array of instances or an empty array
+      # @api private
       def load_instances
         if options[:all] || options[:instances]
           parse_subcommand(args.first)
@@ -49,6 +54,10 @@ module Kitchen
         end
       end
 
+      # Loads and returns loader configuration if it is requested.
+      #
+      # @return [Hash,nil] a hash or nil
+      # @api private
       def load_loader
         if options[:all] || options[:loader]
           @loader
@@ -57,6 +66,11 @@ module Kitchen
         end
       end
 
+      # Returns a hash with exception detail if an exception is raised in the
+      # yielded block.
+      #
+      # @return [yield,Hash] the result of the yielded block or an error hash
+      # @api private
       def record_failure
         yield
       rescue => e

data/lib/kitchen/command/driver_discover.rb

@@ -16,10 +16,9 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require 'kitchen/command'
+require "kitchen/command"
 
-require 'rubygems/spec_fetcher'
-require 'safe_yaml'
+require "rubygems/spec_fetcher"
 
 module Kitchen
 
@@ -30,6 +29,7 @@ module Kitchen
     # @author Fletcher Nichol <fnichol@nichol.ca>
     class DriverDiscover < Kitchen::Command::Base
 
+      # Invoke the command.
       def call
         specs = fetch_gem_specs.sort { |x, y| x[0] <=> y[0] }
         specs = specs[0, 49].push(["...", "..."]) if specs.size > 49
@@ -37,33 +37,52 @@ module Kitchen
         print_table(specs, :indent => 4)
       end
 
-      protected
+      private
 
+      # Fetches Kitchen-related RubyGems and returns an array of name/version
+      # tuples.
+      #
+      # @return [Array<Array>] an array of name/version tuples
+      # @api private
       def fetch_gem_specs
-        SafeYAML::OPTIONS[:suppress_warnings] = true
         req = Gem::Requirement.default
         dep = Gem::Deprecate.skip_during do
           Gem::Dependency.new(/kitchen-/i, req)
         end
         fetcher = Gem::SpecFetcher.fetcher
 
-        specs = if fetcher.respond_to?(:find_matching)
+        if fetcher.respond_to?(:find_matching)
           fetch_gem_specs_pre_rubygems_2(fetcher, dep)
         else
           fetch_gem_specs_post_rubygems_2(fetcher, dep)
         end
       end
 
+      # Fetches gem specs for RubyGems 2 and later.
+      #
+      # @param fetcher [Gem::SpecFetcher] a gemspec fetcher
+      # @param dep [Gem::Dependency] a gem dependency object
+      # @return [Array<Array>] an array of name/version tuples
+      # @api private
       def fetch_gem_specs_post_rubygems_2(fetcher, dep)
         specs = fetcher.spec_for_dependency(dep, false)
         specs.first.map { |t| [t.first.name, t.first.version] }
       end
 
+      # Fetches gem specs for pre-RubyGems 2.
+      #
+      # @param fetcher [Gem::SpecFetcher] a gemspec fetcher
+      # @param dep [Gem::Dependency] a gem dependency object
+      # @return [Array<Array>] an array of name/version tuples
+      # @api private
       def fetch_gem_specs_pre_rubygems_2(fetcher, dep)
         specs = fetcher.find_matching(dep, false, false, false)
-        specs.map { |t| t.first }.map { |t| t[0, 2] }
+        specs.map(&:first).map { |t| t[0, 2] }
       end
 
+      # Print out a display table.
+      #
+      # @api private
       def print_table(*args)
         shell.print_table(*args)
       end

data/lib/kitchen/command/exec.rb

@@ -0,0 +1,41 @@
+# -*- encoding: utf-8 -*-
+#
+# Author:: SAWANOBORI Yukihiko (<sawanoboriyu@higanworks.com>)
+#
+# Copyright (C) 2014, HiganWorks LLC
+#
+# 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/command"
+
+module Kitchen
+
+  module Command
+
+    # Execute command on remote instance.
+    #
+    # @author SAWANOBORI Yukihiko (<sawanoboriyu@higanworks.com>)
+    class Exec < Kitchen::Command::Base
+
+      # Invoke the command.
+      def call
+        results = parse_subcommand(args.first)
+
+        results.each do |instance|
+          banner "Execute command on #{instance.name}."
+          instance.remote_exec(options[:command])
+        end
+      end
+    end
+  end
+end

data/lib/kitchen/command/list.rb

@@ -16,7 +16,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require 'kitchen/command'
+require "kitchen/command"
 
 module Kitchen
 
@@ -27,24 +27,36 @@ module Kitchen
     # @author Fletcher Nichol <fnichol@nichol.ca>
     class List < Kitchen::Command::Base
 
+      # Invoke the command.
       def call
         result = parse_subcommand(args.first)
         if options[:debug]
-          die "The --debug flag on the list subcommand is deprecated, " +
+          die "The --debug flag on the list subcommand is deprecated, " \
             "please use `kitchen diagnose'."
         elsif options[:bare]
-          puts Array(result).map { |i| i.name }.join("\n")
+          puts Array(result).map(&:name).join("\n")
         else
           list_table(result)
         end
       end
 
-      protected
+      private
 
+      # Add a trailing ansi color escape code to line up columns of colored
+      # output.
+      #
+      # @param string [String] a string
+      # @return [String]
+      # @api private
       def color_pad(string)
-        string + set_color("", :white)
+        string + colorize("", :white)
       end
 
+      # Generate the display rows for an instance.
+      #
+      # @param instance [Instance] an instance
+      # @return [Array<String>]
+      # @api private
       def display_instance(instance)
         [
           color_pad(instance.name),
@@ -54,31 +66,49 @@ module Kitchen
         ]
       end
 
+      # Format and color the given last action.
+      #
+      # @param [String] the last action
+      # @return [String] formated last action
+      # @api private
       def format_last_action(last_action)
         case last_action
-        when 'create' then set_color("Created", :cyan)
-        when 'converge' then set_color("Converged", :magenta)
-        when 'setup' then set_color("Set Up", :blue)
-        when 'verify' then set_color("Verified", :yellow)
-        when nil then set_color("<Not Created>", :red)
-        else set_color("<Unknown>", :white)
+        when "create" then colorize("Created", :cyan)
+        when "converge" then colorize("Converged", :magenta)
+        when "setup" then colorize("Set Up", :blue)
+        when "verify" then colorize("Verified", :yellow)
+        when nil then colorize("<Not Created>", :red)
+        else colorize("<Unknown>", :white)
         end
       end
 
+      # Constructs a list display table and output it to the screen.
+      #
+      # @param result [Array<Instance>] an array of instances
+      # @api private
       def list_table(result)
         table = [
-          [set_color("Instance", :green), set_color("Driver", :green),
-            set_color("Provisioner", :green), set_color("Last Action", :green)]
+          [
+            colorize("Instance", :green), colorize("Driver", :green),
+            colorize("Provisioner", :green), colorize("Last Action", :green)
+          ]
         ]
         table += Array(result).map { |i| display_instance(i) }
         print_table(table)
       end
 
+      # Outputs a formatted display table.
+      #
+      # @api private
       def print_table(*args)
         shell.print_table(*args)
       end
 
-      def set_color(*args)
+      # Colorize a string.
+      #
+      # @return [String] a colorized string
+      # @api private
+      def colorize(*args)
         shell.set_color(*args)
       end
     end