test-kitchen-rsync 3.0.0.pre.1

data/lib/kitchen/color.rb

@@ -0,0 +1,63 @@
+#
+# 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/action.rb

@@ -0,0 +1,41 @@
+#
+# 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_relative "../command"
+
+require "benchmark" unless defined?(Benchmark)
+
+module Kitchen
+  module Command
+    # Command to run a single action one or more instances.
+    #
+    # @author Fletcher Nichol <fnichol@nichol.ca>
+    class Action < Kitchen::Command::Base
+      include RunAction
+
+      # Invoke the command.
+      def call
+        banner "Starting Test Kitchen (v#{Kitchen::VERSION})"
+        elapsed = Benchmark.measure do
+          results = parse_subcommand(args.first)
+          run_action(action, results)
+        end
+        banner "Test Kitchen is finished. #{Util.duration(elapsed.real)}"
+      end
+    end
+  end
+end

data/lib/kitchen/command/console.rb

@@ -0,0 +1,54 @@
+#
+# 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_relative "../command"
+
+module Kitchen
+  module Command
+    # Command to launch a Pry-based Kitchen console..
+    #
+    # @author Fletcher Nichol <fnichol@nichol.ca>
+    class Console < Kitchen::Command::Base
+      # Invoke the command.
+      def call
+        require "pry"
+        Pry.start(@config, prompt: [prompt(">"), prompt("*")])
+      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
+
+      private
+
+      # Construct a custom Pry prompt proc.
+      #
+      # @param char [String] prompt character
+      # @return [proc] a prompt proc
+      # @api private
+      def prompt(char)
+        proc do |target_self, nest_level, pry|
+          [
+            "[#{pry.input_ring.size}] ",
+            "kc(#{Pry.view_clip(target_self.class)})",
+            "#{":#{nest_level}" unless nest_level == 0}#{char} ",
+          ].join
+        end
+      end
+    end
+  end
+end

data/lib/kitchen/command/diagnose.rb

@@ -0,0 +1,84 @@
+#
+# 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_relative "../command"
+require_relative "../diagnostic"
+
+autoload :YAML, "yaml"
+
+module Kitchen
+  module Command
+    # Command to log into to instance.
+    #
+    # @author Fletcher Nichol <fnichol@nichol.ca>
+    class Diagnose < Kitchen::Command::Base
+      # Invoke the command.
+      def call
+        instances = record_failure { load_instances }
+
+        loader = record_failure { load_loader }
+
+        puts YAML.dump(Kitchen::Diagnostic.new(
+          loader: loader, instances: instances, plugins: plugins?
+        ).read)
+      end
+
+      private
+
+      def plugins?
+        options[:all] || options[:plugins]
+      end
+
+      # 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)
+        else
+          []
+        end
+      end
+
+      # Loads and returns loader configuration if it is requested.
+      #
+      # @return [Hash,nil] a hash or nil
+      # @api private
+      def load_loader
+        @loader if options[:all] || options[:loader]
+      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
+        {
+          error: {
+            exception: e.inspect,
+            message: e.message,
+            backtrace: e.backtrace,
+          },
+        }
+      end
+    end
+  end
+end

data/lib/kitchen/command/doctor.rb

@@ -0,0 +1,39 @@
+#
+#
+# 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_relative "../command"
+
+module Kitchen
+  module Command
+    # Check for common system or configuration problems.
+    #
+    class Doctor < Kitchen::Command::Base
+      # Invoke the command.
+      def call
+        results = parse_subcommand(args.first)
+        if results.empty?
+          error("No instances configured, cannot check configuration. Please check your .kitchen.yml and confirm it has platform and suites sections.")
+          exit(1)
+        end
+        # By default only doctor the first instance to avoid output spam.
+        results = [results.first] unless options[:all]
+        failed = results.any? do |instance|
+          debug "Doctor on #{instance.name}."
+          instance.doctor_action
+        end
+        exit(1) if failed
+      end
+    end
+  end
+end

data/lib/kitchen/command/exec.rb

@@ -0,0 +1,37 @@
+#
+# 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_relative "../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

@@ -0,0 +1,148 @@
+#
+# 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_relative "../command"
+require "json" unless defined?(JSON)
+
+module Kitchen
+  module Command
+    # Command to list one or more instances.
+    #
+    # @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, " \
+            "please use `kitchen diagnose'."
+        elsif options[:bare]
+          puts Array(result).map(&:name).join("\n")
+        elsif options[:json]
+          puts JSON.pretty_generate(Array(result).map { |r| to_hash(r) })
+        else
+          list_table(result)
+        end
+      end
+
+      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 + 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),
+          color_pad(instance.driver.name),
+          color_pad(instance.provisioner.name),
+          color_pad(instance.verifier.name),
+          color_pad(instance.transport.name),
+          format_last_action(instance.last_action),
+          format_last_error(instance.last_error),
+        ]
+      end
+
+      # Format and color the given last action.
+      #
+      # @param last_action [String] the last action
+      # @return [String] formated last action
+      # @api private
+      def format_last_action(last_action)
+        case last_action
+        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
+
+      # Format and color the given last error.
+      #
+      # @param last_error [String] the last error
+      # @return [String] formated last error
+      # @api private
+      def format_last_error(last_error)
+        case last_error
+        when nil then colorize("<None>", :white)
+        else colorize(last_error, :red)
+        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 = [
+          [
+            colorize("Instance", :green), colorize("Driver", :green),
+            colorize("Provisioner", :green), colorize("Verifier", :green),
+            colorize("Transport", :green), colorize("Last Action", :green),
+            colorize("Last Error", :green)
+          ],
+        ]
+        table += Array(result).map { |i| display_instance(i) }
+        print_table(table)
+      end
+
+      # Constructs a hashtable representation of a single instance.
+      #
+      # @param result [Hash{Symbol => String}] hash of a single instance
+      # @api private
+      def to_hash(result)
+        {
+          instance: result.name,
+          driver: result.driver.name,
+          provisioner: result.provisioner.name,
+          verifier: result.verifier.name,
+          transport: result.transport.name,
+          last_action: result.last_action,
+          last_error: result.last_error,
+        }
+      end
+
+      # Outputs a formatted display table.
+      #
+      # @api private
+      def print_table(*args)
+        shell.print_table(*args)
+      end
+
+      # Colorize a string.
+      #
+      # @return [String] a colorized string
+      # @api private
+      def colorize(*args)
+        shell.set_color(*args)
+      end
+    end
+  end
+end

data/lib/kitchen/command/login.rb

@@ -0,0 +1,39 @@
+#
+# 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_relative "../command"
+
+module Kitchen
+  module Command
+    # Command to log into to instance.
+    #
+    # @author Fletcher Nichol <fnichol@nichol.ca>
+    class Login < Kitchen::Command::Base
+      # Invoke the command.
+      def call
+        results = parse_subcommand(args.first)
+        if results.size > 1
+          die "Argument `#{args.first}' returned multiple results:\n" +
+            results.map { |i| "  * #{i.name}" }.join("\n")
+        end
+        instance = results.pop
+
+        instance.login
+      end
+    end
+  end
+end

data/lib/kitchen/command/package.rb

@@ -0,0 +1,32 @@
+#
+#
+# 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_relative "../command"
+
+module Kitchen
+  module Command
+    # Execute command on remote instance.
+    #
+    class Package < Kitchen::Command::Base
+      # Invoke the command.
+      def call
+        results = parse_subcommand(args.first)
+        results.each do |instance|
+          banner "Package on #{instance.name}."
+          instance.package_action
+        end
+      end
+    end
+  end
+end

data/lib/kitchen/command/sink.rb

@@ -0,0 +1,50 @@
+#
+# 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_relative "../command"
+
+module Kitchen
+  module Command
+    # Command to... include the sink.
+    #
+    # @author Seth Vargo <sethvargo@gmail.com>
+    class Sink < Kitchen::Command::Base
+      # Invoke the command.
+      def call
+        puts [
+          "",
+          "                    ___              ",
+          "                   ' _ '.            ",
+          '                 / /` `\\ \\         ',
+          "                 | |   [__]          ",
+          "                 | |    {{           ",
+          "                 | |    }}           ",
+          "              _  | |  _ {{           ",
+          "  ___________<_>_| |_<_>}}________   ",
+          "      .=======^=(___)=^={{====.      ",
+          '     / .----------------}}---. \\    ',
+          '    / /                 {{    \\ \\  ',
+          '   / /                  }}     \\ \\ ',
+          "  (  '========================='  )  ",
+          "   '-----------------------------'   ",
+          "                                     ", # necessary newline
+          "",
+        ].map(&:rstrip).join("\n")
+      end
+    end
+  end
+end

data/lib/kitchen/command/test.rb

@@ -0,0 +1,47 @@
+#
+# 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_relative "../command"
+
+require "benchmark" unless defined?(Benchmark)
+
+module Kitchen
+  module Command
+    # Command to test one or more instances.
+    #
+    # @author Fletcher Nichol <fnichol@nichol.ca>
+    class Test < Kitchen::Command::Base
+      include RunAction
+
+      # Invoke the command.
+      def call
+        unless %w{passing always never}.include?(options[:destroy])
+          raise ArgumentError, "Destroy mode must be passing, always, or never."
+        end
+
+        banner "Starting Test Kitchen (v#{Kitchen::VERSION})"
+        elapsed = Benchmark.measure do
+          destroy_mode = options[:destroy].to_sym
+          results = parse_subcommand(args.join("|"))
+
+          run_action(:test, results, destroy_mode)
+        end
+        banner "Test Kitchen is finished. #{Util.duration(elapsed.real)}"
+      end
+    end
+  end
+end