kb 1.0.0.alpha.0 → 1.0.0.alpha.1

data/.travis.yml

@@ -1,6 +1,7 @@
 language: ruby
 
 rvm:
+- 2.0.0
 - 1.9.3
 - 1.9.2
 - ruby-head

data/features/plugin_install_command.feature

@@ -0,0 +1,26 @@
+Feature: Plugin install command
+  In order to let user test they way they want to test
+  As a user of kb
+  I want the ability to install test runner plugins
+
+  Background:
+    Given a sandboxed GEM_HOME directory named "kb-plugin"
+
+  Scenario: Installing a missing plugin
+    When I run `kb plugin install rack`
+    Then the output should contain "Plugin rack installed"
+    And the exit status should be 0
+    And a gem named "rack" is installed
+
+  Scenario: Installing a missing plugin with a version
+    When I run `kb plugin install rack@1.2.8`
+    Then the output should contain "Plugin rack@1.2.8 installed (version 1.2.8)"
+    And the exit status should be 0
+    And a gem named "rack" is installed with version "1.2.8"
+
+  Scenario: Installing a specfic newer version of an existing plugin
+    When I successfully run `kb plugin install rack@1.2.8`
+    And I run `kb plugin install rack@1.3.10`
+    Then the output should contain "Plugin rack@1.3.10 installed (version 1.3.10)"
+    And the exit status should be 0
+    And a gem named "rack" is installed with version "1.3.10"

data/features/step_definitions/kb_root_steps.rb

@@ -1,10 +1,15 @@
 require 'tmpdir'
+require 'pathname'
 
 Given(/^a KB_ROOT of "(.*?)"$/) do |kb_root|
+  backup_envvar('KB_ROOT')
+
   ENV['KB_ROOT'] = kb_root
 end
 
 Given(/^a test KB_ROOT directory named "(.*?)"$/) do |name|
+  backup_envvar('KB_ROOT')
+
   kb_root = Pathname.new(Dir.mktmpdir(name))
   (kb_root + "suites").mkpath
   ENV['KB_ROOT'] = kb_root.to_s
@@ -19,7 +24,33 @@ Given(/^a suite directory named "(.*?)"$/) do |name|
   FileUtils.mkdir_p(File.join(ENV['KB_ROOT'], "suites", name))
 end
 
+Given(/^a sandboxed GEM_HOME directory named "(.*?)"$/) do |name|
+  backup_envvar('GEM_HOME')
+  backup_envvar('GEM_PATH')
+
+  gem_home = Pathname.new(Dir.mktmpdir(name))
+  ENV['GEM_HOME'] = gem_home.to_s
+  ENV['GEM_PATH'] = [gem_home.to_s, ENV['GEM_PATH']].join(':')
+  @kb_root_dirs << gem_home
+end
+
 Then(/^the suite directory named "(.*?)" should not exist$/) do |name|
   directory = File.join(ENV['KB_ROOT'], "suites", name)
   check_directory_presence([directory], false)
 end
+
+Then(/^a gem named "(.*?)" is installed with version "(.*?)"$/) do |name, version|
+  unbundlerize do
+    run_simple(unescape("gem list #{name} --version #{version} -i"), true, nil)
+  end
+end
+
+Then(/^a gem named "(.*?)" is installed$/) do |name|
+  unbundlerize do
+    run_simple(unescape("gem list #{name} -i"), true, nil)
+  end
+end
+
+Then(/^pry me$/) do
+  require 'pry' ; binding.pry
+end

data/features/support/env.rb

@@ -4,7 +4,7 @@ require 'aruba/cucumber'
 SimpleCov.command_name "features"
 
 Before do
-  @aruba_timeout_seconds = 5
+  @aruba_timeout_seconds = 10
   @kb_root_dirs = []
 end
 
@@ -14,6 +14,27 @@ After do |s|
   # steps are executed and clear it out.
   Cucumber.wants_to_quit = true if s.failed?
 
-  ENV['KB_ROOT'] = ENV.delete('_CUKE_KB_ROOT') if ENV['_CUKE_KB_ROOT']
+  # Restore environment variables to their original settings, if they have
+  # been saved off
+  ENV.keys.select { |key| key =~ /^_CUKE_/ }.each do |backup_key|
+    ENV[backup_key.sub(/^_CUKE_/, '')] = ENV.delete(backup_key)
+  end
+
   @kb_root_dirs.each { |dir| FileUtils.rm_rf(dir) }
 end
+
+def backup_envvar(key)
+  ENV["_CUKE_#{key}"] = ENV[key]
+end
+
+def restore_envvar(key)
+  ENV[key] = ENV.delete("_CUKE_#{key}")
+end
+
+def unbundlerize
+  keys = %w[BUNDLER_EDITOR BUNDLE_BIN_PATH BUNDLE_GEMFILE RUBYOPT]
+
+  keys.each { |key| backup_envvar(key) ; ENV.delete(key) }
+  yield
+  keys.each { |key| restore_envvar(key) }
+end

data/lib/kb/cli.rb

@@ -17,7 +17,9 @@
 # limitations under the License.
 
 require 'kb/thor'
+require 'kb/command/plugin'
 require 'kb/command/suite'
+require 'kb/command/test'
 
 module KB
 
@@ -27,7 +29,11 @@ module KB
   #
   class CLI < Thor::Base
 
+    register KB::Command::Plugin, "plugin",
+      "plugin SUBCOMMAND", "Plugin subcommands"
     register KB::Command::Suite, "suite",
       "suite SUBCOMMAND", "Suite subcommands"
+    register KB::Command::Test, "test",
+      "test [PLUGIN ...]", "Runs test suites"
   end
 end

data/lib/kb/command/plugin.rb

@@ -0,0 +1,39 @@
+# -*- 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 'kb/thor'
+require 'kb/command/plugin_install'
+require 'kb/command/plugin_list'
+
+module KB
+
+  module Command
+
+    # Plugin commands.
+    #
+    # @author Fletcher Nichol <fnichol@nichol.ca>
+    #
+    class Plugin < KB::Thor::Base
+
+      register KB::Command::PluginInstall, "install",
+        "install PLUGIN [PLUGIN ...]", "Installs one or more plugins"
+      register KB::Command::PluginList, "list",
+        "list", "Lists installed plugins"
+    end
+  end
+end

data/lib/kb/command/plugin_install.rb

@@ -0,0 +1,95 @@
+# -*- 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 'rubygems/dependency_installer'
+require 'kb/thor'
+
+module KB
+
+  module Command
+
+    # Plugin install command.
+    #
+    # @author Fletcher Nichol <fnichol@nichol.ca>
+    #
+    class PluginInstall < KB::Thor::BaseGroup
+
+      argument :plugins, :type => :array
+
+      def install_all
+        silence_gem_ui!
+        plugins.each { |plugin| install(plugin) }
+      end
+
+      private
+
+      def install(plugin)
+        install_gem(plugin)
+      end
+
+      def install_gem(plugin)
+        name, version = plugin.split("@")
+
+        if gem_installed?(name, version)
+          info "#{plugin} plugin already installed"
+        else
+          spec = dep_installer.install(new_dep(name, version)).first
+          info "Plugin #{plugin} installed (version #{spec.version})"
+        end
+      end
+
+      def gem_installed?(name, version)
+        installed = Array(Gem::Specification.find_all_by_name(name, version))
+        version = latest_version(name) if version.nil?
+
+        installed.find { |spec| spec.version.to_s == version }
+      end
+
+      def latest_version(name)
+        available_gems = dep_installer.find_gems_with_sources(new_dep(name))
+
+        spec, source = if available_gems.respond_to?(:last)
+          # DependencyInstaller sorts the results such that the last one is
+          # always the one it considers best.
+          spec_with_source = available_gems.last
+          spec_with_source && spec_with_source
+        else
+          # Rubygems 2.0 returns a Gem::Available set, which is a
+          # collection of AvailableSet::Tuple structs
+          available_gems.pick_best!
+          best_gem = available_gems.set.first
+          best_gem && [best_gem.spec, best_gem.source]
+        end
+
+        spec && spec.version && spec.version.to_s
+      end
+
+      def silence_gem_ui!
+        Gem::DefaultUserInteraction.ui = Gem::SilentUI.new
+      end
+
+      def dep_installer
+        Gem::DependencyInstaller.new
+      end
+
+      def new_dep(name, version = nil)
+        Gem::Dependency.new(name, version)
+      end
+    end
+  end
+end

data/lib/kb/command/plugin_list.rb

@@ -0,0 +1,50 @@
+# -*- 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 'kb/plugin'
+require 'kb/thor'
+
+module KB
+
+  module Command
+
+    # Plugin list command.
+    #
+    # @author Fletcher Nichol <fnichol@nichol.ca>
+    #
+    class PluginList < KB::Thor::BaseGroup
+
+      def list
+        if plugin_data.empty?
+          say "No plugins installed yet"
+        else
+          print_table([["Plugin", "Version"]] + plugin_data)
+        end
+      end
+
+      private
+
+      def plugin_data
+        @plugin_data ||= KB::Plugin.runner_plugins.map do |path|
+          spec = KB::Plugin.gem_from_path(path)
+          [File.basename(path), (spec && spec.version)]
+        end
+      end
+    end
+  end
+end

data/lib/kb/command/test.rb

@@ -0,0 +1,46 @@
+# -*- 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 'kb/thor'
+require 'kb/plugin'
+
+module KB
+
+  module Command
+
+    # Test command.
+    #
+    # @author Fletcher Nichol <fnichol@nichol.ca>
+    #
+    class Test < KB::Thor::BaseGroup
+
+      argument :plugins, :type => :array, :required => false
+
+      def perform
+        KB::Plugin.runner_plugins(plugins).each do |runner_path|
+          runner = File.basename(runner_path)
+          klass = ::Thor::Util.camel_case(runner)
+
+          banner "Running #{runner} test suite"
+          KB::Plugin.require!(runner_path)
+          invoke KB::Plugin.runner_class(klass)
+        end
+      end
+    end
+  end
+end

data/lib/kb/plugin.rb

@@ -0,0 +1,63 @@
+# -*- 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 KB
+
+  module RunnerPlugin
+  end
+
+  module Plugin
+
+    module_function
+
+    def runner_plugins(plugin_names = nil)
+      if plugin_names
+        Array(plugin_names).map { |plugin| "kb/runner_plugin/#{plugin}" }
+      else
+        all_runner_plugins
+      end
+    end
+
+    def all_runner_plugins
+      Gem.find_files('kb/runner_plugin/*.rb').map do |file|
+        "kb/runner_plugin/#{File.basename(file).sub(/\.rb$/, '')}"
+      end
+    end
+
+    def require!(plugin_path)
+      require plugin_path
+    rescue LoadError => e
+      die "Could not load #{plugin_path} (#{e.class}: #{e.message})"
+    end
+
+    def runner_class(klass)
+      KB::RunnerPlugin.const_get(klass)
+    end
+
+    def gem_from_path(plugin_path)
+      local_gem_path = "#{File.expand_path(plugin_path, $LOAD_PATH.first)}"
+      local_gemspec = File.join(File.dirname($LOAD_PATH.first), "kb.gemspec")
+
+      if ! Dir.glob("#{local_gem_path}#{Gem.suffix_pattern}").empty?
+        Gem::Specification.load(File.expand_path(local_gemspec))
+      else
+        Gem::Specification.find_by_path(plugin_path)
+      end
+    end
+  end
+end

data/lib/kb/runner_plugin.rb

@@ -0,0 +1,32 @@
+# -*- 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 'kb/thor'
+
+module KB
+
+  module RunnerPlugin
+
+    # Base class for all test runner plugins.
+    #
+    # @author Fletcher Nichol <fnichol@nichol.ca>
+    #
+    class Base < KB::Thor::BaseGroup
+    end
+  end
+end

data/lib/kb/thor.rb

@@ -33,6 +33,7 @@ module KB
 
       include Helpers
       include UI
+      include ::Thor::Actions
     end
 
     # Base class for all Thor Group subclasses which includes useful mixins.
@@ -43,6 +44,7 @@ module KB
 
       include Helpers
       include UI
+      include ::Thor::Actions
     end
   end
 end

data/lib/kb/ui.rb

@@ -33,5 +33,20 @@ module KB
     def warn(msg)
       say(">>>>>> #{msg}")
     end
+
+    def run!(cmd)
+      run(cmd, :capture => false, :verbose => false)
+
+      if $?.success?
+        true
+      else
+        die "Command [#{cmd}] exit code was #{$?.exitstatus}", $?.exitstatus
+      end
+    end
+
+    def die(msg, exitstatus = 1)
+      $stderr.puts(msg)
+      exit(exitstatus)
+    end
   end
 end

data/lib/kb/version.rb

@@ -17,5 +17,5 @@
 # limitations under the License.
 
 module KB
-  VERSION = "1.0.0.alpha.0"
+  VERSION = "1.0.0.alpha.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: kb
 version: !ruby/object:Gem::Version
-  version: 1.0.0.alpha.0
+  version: 1.0.0.alpha.1
   prerelease: 6
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-15 00:00:00.000000000 Z
+date: 2013-03-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -254,6 +254,7 @@ files:
 - README.md
 - Rakefile
 - bin/kb
+- features/plugin_install_command.feature
 - features/step_definitions/kb_root_steps.rb
 - features/suite_cleanup_command.feature
 - features/suite_path_command.feature
@@ -261,10 +262,16 @@ files:
 - kb.gemspec
 - lib/kb.rb
 - lib/kb/cli.rb
+- lib/kb/command/plugin.rb
+- lib/kb/command/plugin_install.rb
+- lib/kb/command/plugin_list.rb
 - lib/kb/command/suite.rb
 - lib/kb/command/suite_cleanup.rb
 - lib/kb/command/suite_path.rb
+- lib/kb/command/test.rb
 - lib/kb/helpers.rb
+- lib/kb/plugin.rb
+- lib/kb/runner_plugin.rb
 - lib/kb/thor.rb
 - lib/kb/ui.rb
 - lib/kb/version.rb
@@ -296,6 +303,7 @@ signing_key:
 specification_version: 3
 summary: Kitchen Busser - Runs tests for projects in test-kitchen
 test_files:
+- features/plugin_install_command.feature
 - features/step_definitions/kb_root_steps.rb
 - features/suite_cleanup_command.feature
 - features/suite_path_command.feature