test-kitchen 1.1.1 → 1.2.0

data/lib/kitchen/command.rb

@@ -0,0 +1,117 @@
+# -*- 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
+
+      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" })
+        @config = options.fetch(:config, nil)
+        @loader = options.fetch(:loader, nil)
+        @shell = options.fetch(:shell)
+      end
+
+      protected
+
+      attr_reader :args, :options, :help, :config, :shell, :action
+
+      def die(msg)
+        error "\n#{msg}\n\n"
+        help.call
+        exit 1
+      end
+
+      def get_all_instances
+        result = @config.instances
+
+        if result.empty?
+          die "No instances defined"
+        else
+          result
+        end
+      end
+
+      def get_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
+
+      def logger
+        Kitchen.logger
+      end
+
+      def parse_subcommand(arg = nil)
+        arg == "all" ? get_all_instances : get_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
+
+      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)
+            end
+          end
+        end
+        threads.map { |i| i.join }
+      end
+    end
+  end
+end

data/lib/kitchen/command/action.rb

@@ -0,0 +1,44 @@
+# -*- 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/command'
+
+require '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
+
+      def call
+        banner "Starting Kitchen (v#{Kitchen::VERSION})"
+        elapsed = Benchmark.measure do
+          results = parse_subcommand(args.first)
+          run_action(action, results)
+        end
+        banner "Kitchen is finished. #{Util.duration(elapsed.real)}"
+      end
+    end
+  end
+end

data/lib/kitchen/command/console.rb

@@ -0,0 +1,51 @@
+# -*- 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/command'
+
+module Kitchen
+
+  module Command
+
+    # Command to launch a Pry-based Kitchen console..
+    #
+    # @author Fletcher Nichol <fnichol@nichol.ca>
+    class Console < Kitchen::Command::Base
+
+      def call
+        require 'pry'
+        Pry.start(@config, :prompt => [prompt(">"), prompt("*")])
+      rescue LoadError => e
+        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
+
+      def prompt(char)
+        proc { |target_self, nest_level, pry|
+          ["[#{pry.input_array.size}] ",
+            "kc(#{Pry.view_clip(target_self.class)})",
+            "#{":#{nest_level}" unless nest_level.zero?}#{char} "
+          ].join
+        }
+      end
+    end
+  end
+end

data/lib/kitchen/command/diagnose.rb

@@ -0,0 +1,51 @@
+# -*- 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/command'
+require 'kitchen/diagnostic'
+
+require 'yaml'
+
+module Kitchen
+
+  module Command
+
+    # Command to log into to instance.
+    #
+    # @author Fletcher Nichol <fnichol@nichol.ca>
+    class Diagnose < Kitchen::Command::Base
+
+      def call
+        loader = if options[:all] || options[:loader]
+          @loader
+        else
+          nil
+        end
+
+        instances = if options[:all] || options[:instances]
+          parse_subcommand(args.first)
+        else
+          []
+        end
+
+        puts Kitchen::Diagnostic.new(
+          :loader => loader, :instances => instances).read.to_yaml
+      end
+    end
+  end
+end

data/lib/kitchen/command/driver_discover.rb

@@ -0,0 +1,72 @@
+# -*- 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/command'
+
+require 'rubygems/spec_fetcher'
+require 'safe_yaml'
+
+module Kitchen
+
+  module Command
+
+    # Command to discover drivers published on RubyGems.
+    #
+    # @author Fletcher Nichol <fnichol@nichol.ca>
+    class DriverDiscover < Kitchen::Command::Base
+
+      def call
+        specs = fetch_gem_specs.sort { |x, y| x[0] <=> y[0] }
+        specs = specs[0, 49].push(["...", "..."]) if specs.size > 49
+        specs = specs.unshift(["Gem Name", "Latest Stable Release"])
+        print_table(specs, :indent => 4)
+      end
+
+      protected
+
+      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)
+          fetch_gem_specs_pre_rubygems_2(fetcher, dep)
+        else
+          fetch_gem_specs_post_rubygems_2(fetcher, dep)
+        end
+      end
+
+      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
+
+      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] }
+      end
+
+      def print_table(*args)
+        shell.print_table(*args)
+      end
+    end
+  end
+end

data/lib/kitchen/command/list.rb

@@ -0,0 +1,86 @@
+# -*- 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/command'
+
+module Kitchen
+
+  module Command
+
+    # Command to list one or more instances.
+    #
+    # @author Fletcher Nichol <fnichol@nichol.ca>
+    class List < Kitchen::Command::Base
+
+      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 { |i| i.name }.join("\n")
+        else
+          list_table(result)
+        end
+      end
+
+      protected
+
+      def color_pad(string)
+        string + set_color("", :white)
+      end
+
+      def display_instance(instance)
+        [
+          color_pad(instance.name),
+          color_pad(instance.driver.name),
+          color_pad(instance.provisioner.name),
+          format_last_action(instance.last_action)
+        ]
+      end
+
+      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)
+        end
+      end
+
+      def list_table(result)
+        table = [
+          [set_color("Instance", :green), set_color("Driver", :green),
+            set_color("Provisioner", :green), set_color("Last Action", :green)]
+        ]
+        table += Array(result).map { |i| display_instance(i) }
+        print_table(table)
+      end
+
+      def print_table(*args)
+        shell.print_table(*args)
+      end
+
+      def set_color(*args)
+        shell.set_color(*args)
+      end
+    end
+  end
+end

data/lib/kitchen/command/login.rb

@@ -0,0 +1,42 @@
+# -*- 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/command'
+
+module Kitchen
+
+  module Command
+
+    # Command to log into to instance.
+    #
+    # @author Fletcher Nichol <fnichol@nichol.ca>
+    class Login < Kitchen::Command::Base
+
+      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