busser 0.1.1 → 0.2.0

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+## 0.2.0 / 2013-03-31
+
+### New features
+
+* Add dummy runner internal plugin and skip on plugin install commands. ([@fnichol][])
+* Add postinstall feature to runner plugins & add dummy runner plugin. ([@fnichol][])
+* Move cucumber steps into lib/ for use by plugin authors. ([@fnichol][])
+
+
 ## 0.1.1 / 2013-03-29
 
 ### New features
@@ -8,10 +17,10 @@
 
 * Support installing plugins from local .gem files. ([@fnichol][])
 
+
 ## 0.1.0 / 2013-03-28
 
 * Initial release
 
-[@fnichol]: https://github.com/fnichol
 <!--- The following link definition list is generated by PimpMyChangelog --->
 [@fnichol]: https://github.com/fnichol

data/features/plugin_install_command.feature

@@ -4,23 +4,37 @@ Feature: Plugin install command
   I want the ability to install test runner plugins
 
   Background:
-    Given a sandboxed GEM_HOME directory named "busser-plugin"
+    Given a non bundler environment
+    And a sandboxed GEM_HOME directory named "busser-plugin-gem-home"
 
   Scenario: Installing a missing plugin
-    When I run `busser plugin install rack`
-    Then the output should contain "Plugin rack installed"
+    When I run `busser plugin install busser-bash`
+    Then the output should contain "Plugin bash installed"
     And the exit status should be 0
-    And a gem named "rack" is installed
+    And a gem named "busser-bash" is installed
 
   Scenario: Installing a missing plugin with a version
-    When I run `busser plugin install rack@1.2.8`
-    Then the output should contain "Plugin rack@1.2.8 installed (version 1.2.8)"
+    When I run `busser plugin install busser-bash@0.1.0`
+    Then the output should contain "Plugin bash installed (version 0.1.0)"
     And the exit status should be 0
-    And a gem named "rack" is installed with version "1.2.8"
+    And a gem named "busser-bash" is installed with version "0.1.0"
 
   Scenario: Installing a specfic newer version of an existing plugin
-    When I successfully run `busser plugin install rack@1.2.8`
-    And I run `busser plugin install rack@1.3.10`
-    Then the output should contain "Plugin rack@1.3.10 installed (version 1.3.10)"
+    When I successfully run `busser plugin install busser-bash@0.1.0`
+    And I run `busser plugin install busser-bash@0.1.1`
+    Then the output should contain "Plugin bash installed (version 0.1.1)"
     And the exit status should be 0
-    And a gem named "rack" is installed with version "1.3.10"
+    And a gem named "busser-bash" is installed with version "0.1.1"
+
+  Scenario: Installing an internal plugin
+    When I run `busser plugin install dummy`
+    Then the output should contain "Plugin dummy already installed"
+    And the exit status should be 0
+
+  Scenario: Forcing postinstall script for an internal plugin
+    When I successfully run `busser plugin install dummy --force-postinstall`
+    Then a directory named "dummy" should exist
+    And the file "dummy/foobar.txt" should contain exactly:
+    """
+    The Dummy Driver.
+    """

data/features/support/env.rb

@@ -1,11 +1,12 @@
 require 'simplecov'
 require 'aruba/cucumber'
 
+require 'busser/cucumber'
+
 SimpleCov.command_name "features"
 
 Before do
   @aruba_timeout_seconds = 10
-  @busser_root_dirs = []
 end
 
 After do |s|
@@ -13,28 +14,4 @@ After do |s|
   # This is useful to inspect the 'tmp/aruba' directory before any other
   # steps are executed and clear it out.
   Cucumber.wants_to_quit = true if s.failed?
-
-  # 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
-
-  @busser_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/busser/command/plugin.rb

@@ -32,6 +32,8 @@ module Busser
 
       register Busser::Command::PluginInstall, "install",
         "install PLUGIN [PLUGIN ...]", "Installs one or more plugins"
+      tasks["install"].options = Busser::Command::PluginInstall.class_options
+
       register Busser::Command::PluginList, "list",
         "list", "Lists installed plugins"
     end

data/lib/busser/command/plugin_install.rb

@@ -31,6 +31,9 @@ module Busser
 
       argument :plugins, :type => :array
 
+      class_option :force_postinstall, :type => :boolean, :default => false,
+        :desc => "Run the plugin's postinstall if it is already installed"
+
       def install_all
         silence_gem_ui!
         plugins.each { |plugin| install(plugin) }
@@ -39,21 +42,50 @@ module Busser
       private
 
       def install(plugin)
-        install_gem(plugin)
+        gem_name, version = plugin.split("@")
+        name = gem_name.sub(/^busser-/, '')
+
+        if options[:force_postinstall] || install_gem(gem_name, version, name)
+          load_plugin(name)
+          run_postinstall(name)
+        end
       end
 
-      def install_gem(plugin)
-        name, version = plugin.split("@")
-        install_arg = name =~ /\.gem$/ ? name : new_dep(name, version)
+      def install_gem(gem, version, name)
+        install_arg = gem =~ /\.gem$/ ? gem : new_dep(gem, version)
 
-        if gem_installed?(name, version)
-          info "#{plugin} plugin already installed"
+        if internal_plugin?(name) || gem_installed?(gem, version)
+          info "Plugin #{name} already installed"
+
+          return false
         else
-          spec = dep_installer.install(install_arg).first
-          info "Plugin #{plugin} installed (version #{spec.version})"
+          spec = dep_installer.install(install_arg).find do |spec|
+            spec.name == gem
+          end
+          Gem.clear_paths
+          info "Plugin #{name} installed (version #{spec.version})"
+
+          return true
+        end
+      end
+
+      def load_plugin(name)
+        Busser::Plugin.require!(Busser::Plugin.runner_plugin(name))
+      end
+
+      def run_postinstall(name)
+        klass = Busser::Plugin.runner_class(::Thor::Util.camel_case(name))
+        if klass.respond_to?(:run_postinstall)
+          banner "Running postinstall for #{name} plugin"
+          klass.run_postinstall
         end
       end
 
+      def internal_plugin?(name)
+        spec = Busser::Plugin.gem_from_path(Busser::Plugin.runner_plugin(name))
+        spec && spec.name == "busser"
+      end
+
       def gem_installed?(name, version)
         installed = Array(Gem::Specification.find_all_by_name(name, version))
         version = latest_version(name) if version.nil?

data/lib/busser/command/test.rb

@@ -34,6 +34,7 @@ module Busser
       def perform
         Busser::Plugin.runner_plugins(plugins).each do |runner_path|
           runner = File.basename(runner_path)
+          next if skip_runner?(runner)
           klass = ::Thor::Util.camel_case(runner)
 
           banner "Running #{runner} test suite"
@@ -41,6 +42,12 @@ module Busser
           invoke Busser::Plugin.runner_class(klass)
         end
       end
+
+      private
+
+      def skip_runner?(runner)
+        runner == "dummy" && ! Array(plugins).include?("dummy")
+      end
     end
   end
 end

data/{features/step_definitions/busser_root_steps.rb → lib/busser/cucumber.rb}

@@ -1,3 +1,11 @@
+begin
+  require 'aruba/cucumber'
+rescue LoadError
+  abort "The aruba gem must be in your development dependencies"
+end
+
+require 'busser/cucumber/hooks'
+
 require 'tmpdir'
 require 'pathname'
 
@@ -24,6 +32,11 @@ Given(/^a suite directory named "(.*?)"$/) do |name|
   FileUtils.mkdir_p(File.join(ENV['BUSSER_ROOT'], "suites", name))
 end
 
+Given(/^a file in suite "(.*?)" named "(.*?)" with:$/) do |suite, file, content|
+  file_name = File.join(ENV['BUSSER_ROOT'], "suites", suite, file)
+  write_file(file_name, content)
+end
+
 Given(/^a sandboxed GEM_HOME directory named "(.*?)"$/) do |name|
   backup_envvar('GEM_HOME')
   backup_envvar('GEM_PATH')
@@ -34,14 +47,21 @@ Given(/^a sandboxed GEM_HOME directory named "(.*?)"$/) do |name|
   @busser_root_dirs << gem_home
 end
 
+Given(/^a non bundler environment$/) do
+  %w[BUNDLER_EDITOR BUNDLE_BIN_PATH BUNDLE_GEMFILE RUBYOPT].each do |key|
+    backup_envvar(key)
+    ENV.delete(key)
+  end
+end
+
 Then(/^the suite directory named "(.*?)" should not exist$/) do |name|
   directory = File.join(ENV['BUSSER_ROOT'], "suites", name)
   check_directory_presence([directory], false)
 end
 
-Then(/^a gem named "(.*?)" is installed with version "(.*?)"$/) do |name, version|
+Then(/^a gem named "(.*?)" is installed with version "(.*?)"$/) do |name, ver|
   unbundlerize do
-    run_simple(unescape("gem list #{name} --version #{version} -i"), true, nil)
+    run_simple(unescape("gem list #{name} --version #{ver} -i"), true, nil)
   end
 end
 

data/lib/busser/cucumber/hooks.rb

@@ -0,0 +1,31 @@
+Before do
+  @busser_root_dirs = []
+end
+
+After do
+  @busser_root_dirs.each { |dir| FileUtils.rm_rf(dir) }
+end
+
+# Restore environment variables to their original settings, if they have
+# been saved off
+After do
+  ENV.keys.select { |key| key =~ /^_CUKE_/ }.each do |backup_key|
+    ENV[backup_key.sub(/^_CUKE_/, '')] = ENV.delete(backup_key)
+  end
+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/busser/plugin.rb

@@ -25,9 +25,13 @@ module Busser
 
     module_function
 
+    def runner_plugin(plugin_name)
+      "busser/runner_plugin/#{plugin_name}"
+    end
+
     def runner_plugins(plugin_names = nil)
       if plugin_names
-        Array(plugin_names).map { |plugin| "busser/runner_plugin/#{plugin}" }
+        Array(plugin_names).map { |plugin| runner_plugin(plugin) }
       else
         all_runner_plugins
       end
@@ -42,7 +46,7 @@ module Busser
     def require!(plugin_path)
       require plugin_path
     rescue LoadError => e
-      die "Could not load #{plugin_path} (#{e.class}: #{e.message})"
+      Busser::UI.die "Could not load #{plugin_path} (#{e.class}: #{e.message})"
     end
 
     def runner_class(klass)

data/lib/busser/runner_plugin.rb

@@ -27,6 +27,15 @@ module Busser
     # @author Fletcher Nichol <fnichol@nichol.ca>
     #
     class Base < Busser::Thor::BaseGroup
+
+      def self.postinstall(&block)
+        (class << self; self; end).send(:define_method, :run_postinstall) do
+          klass = Class.new(Busser::Thor::BaseGroup) do
+            define_method(:postinstall, &block)
+          end
+          klass.start
+        end
+      end
     end
   end
 end

data/lib/busser/runner_plugin/dummy.rb

@@ -0,0 +1,40 @@
+# -*- 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 'busser/runner_plugin'
+
+# Dummy runner plugin for Busser.
+#
+# @author Fletcher Nichol <fnichol@nichol.ca>
+#
+class Busser::RunnerPlugin::Dummy < Busser::RunnerPlugin::Base
+
+  postinstall do
+    empty_directory("dummy")
+    create_file("dummy/foobar.txt", "The Dummy Driver.")
+  end
+
+  def test
+    banner "[dummy] Running"
+    if File.exists?(File.join(suite_path("dummy"), "foobar.txt"))
+      info "[dummy] The postinstall script has been called"
+    else
+      warn "[dummy] The postinstall script was not called"
+    end
+  end
+end

data/lib/busser/ui.rb

@@ -22,6 +22,8 @@ module Busser
 
   module UI
 
+    module_function
+
     def banner(msg)
       say("-----> #{msg}")
     end

data/lib/busser/version.rb

@@ -17,5 +17,5 @@
 # limitations under the License.
 
 module Busser
-  VERSION = "0.1.1"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: busser
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-29 00:00:00.000000000 Z
+date: 2013-03-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -260,7 +260,6 @@ files:
 - features/files/base64.txt
 - features/plugin_install_command.feature
 - features/setup_command.feature
-- features/step_definitions/busser_root_steps.rb
 - features/suite_cleanup_command.feature
 - features/suite_path_command.feature
 - features/support/env.rb
@@ -275,9 +274,12 @@ files:
 - lib/busser/command/suite_cleanup.rb
 - lib/busser/command/suite_path.rb
 - lib/busser/command/test.rb
+- lib/busser/cucumber.rb
+- lib/busser/cucumber/hooks.rb
 - lib/busser/helpers.rb
 - lib/busser/plugin.rb
 - lib/busser/runner_plugin.rb
+- lib/busser/runner_plugin/dummy.rb
 - lib/busser/thor.rb
 - lib/busser/ui.rb
 - lib/busser/version.rb
@@ -304,7 +306,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1680018210627822446
+      hash: -4345973046536692272
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24
@@ -316,7 +318,6 @@ test_files:
 - features/files/base64.txt
 - features/plugin_install_command.feature
 - features/setup_command.feature
-- features/step_definitions/busser_root_steps.rb
 - features/suite_cleanup_command.feature
 - features/suite_path_command.feature
 - features/support/env.rb