busser 0.2.0 → 0.3.0

data/lib/busser/command/plugin_install.rb

@@ -16,7 +16,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require 'rubygems/dependency_installer'
+require 'busser/rubygems'
 require 'busser/thor'
 
 module Busser
@@ -29,14 +29,17 @@ module Busser
     #
     class PluginInstall < Busser::Thor::BaseGroup
 
+      include Busser::RubyGems
+
       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) }
+        silence_gem_ui do
+          plugins.each { |plugin| install(plugin) }
+        end
       end
 
       private
@@ -45,26 +48,21 @@ module Busser
         gem_name, version = plugin.split("@")
         name = gem_name.sub(/^busser-/, '')
 
-        if options[:force_postinstall] || install_gem(gem_name, version, name)
+        new_install = install_plugin_gem(gem_name, version, name)
+
+        if options[:force_postinstall] || new_install
           load_plugin(name)
           run_postinstall(name)
         end
       end
 
-      def install_gem(gem, version, name)
-        install_arg = gem =~ /\.gem$/ ? gem : new_dep(gem, version)
-
+      def install_plugin_gem(gem, version, name)
         if internal_plugin?(name) || gem_installed?(gem, version)
           info "Plugin #{name} already installed"
-
           return false
         else
-          spec = dep_installer.install(install_arg).find do |spec|
-            spec.name == gem
-          end
-          Gem.clear_paths
+          spec = install_gem(gem, version)
           info "Plugin #{name} installed (version #{spec.version})"
-
           return true
         end
       end
@@ -85,44 +83,6 @@ module Busser
         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?
-
-        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/busser/command/test.rb

@@ -39,6 +39,7 @@ module Busser
 
           banner "Running #{runner} test suite"
           Busser::Plugin.require!(runner_path)
+          prepare_suite(runner)
           invoke Busser::Plugin.runner_class(klass)
         end
       end
@@ -48,6 +49,29 @@ module Busser
       def skip_runner?(runner)
         runner == "dummy" && ! Array(plugins).include?("dummy")
       end
+
+      def prepare_suite(runner)
+        run_prepare_sh(runner)
+        run_prepare_recipe(runner)
+      end
+
+      def run_prepare_sh(runner)
+        prepare_sh_script = suite_path(runner).join("prepare.sh")
+
+        if prepare_sh_script.exist?
+          banner "Preparing #{runner} suite with #{prepare_sh_script}"
+          run!("bash #{prepare_sh_script}")
+        end
+      end
+
+      def run_prepare_recipe(runner)
+        prepare_recipe = suite_path(runner).join("prepare_recipe.rb")
+
+        if prepare_recipe.exist?
+          banner "Preparing #{runner} suite with #{prepare_recipe}"
+          chef_apply(:file => prepare_recipe)
+        end
+      end
     end
   end
 end

data/lib/busser/cucumber.rb

@@ -54,11 +54,21 @@ Given(/^a non bundler environment$/) do
   end
 end
 
+Then(/^the suite directory named "(.*?)" should exist$/) do |name|
+  directory = File.join(ENV['BUSSER_ROOT'], "suites", name)
+  check_directory_presence([directory], true)
+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(/^the suite file "(.*?)" should contain exactly:$/) do |file, content|
+  file_name = File.join(ENV['BUSSER_ROOT'], "suites", file)
+  check_exact_file_content(file_name, content)
+end
+
 Then(/^a gem named "(.*?)" is installed with version "(.*?)"$/) do |name, ver|
   unbundlerize do
     run_simple(unescape("gem list #{name} --version #{ver} -i"), true, nil)

data/lib/busser/helpers.rb

@@ -30,8 +30,19 @@ module Busser
       path
     end
 
+    def vendor_path(product = nil)
+      path = root_path + "vendor"
+      path += product if product
+      path
+    end
+
     def root_path
       Pathname.new(ENV['BUSSER_ROOT'] || "/opt/busser")
     end
+
+    def chef_apply(config = {}, &block)
+      require 'busser/chef_apply'
+      ChefApply.new(config, &block).converge
+    end
   end
 end

data/lib/busser/rubygems.rb

@@ -0,0 +1,78 @@
+# -*- 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'
+
+module Busser
+
+  module RubyGems
+
+    module_function
+
+    def gem_installed?(name, version)
+      installed = Array(Gem::Specification.find_all_by_name(name, version))
+      version = latest_gem_version(name) if version.nil?
+
+      installed.find { |spec| spec.version.to_s == version }
+    end
+
+    def install_gem(gem, version)
+      install_arg = gem =~ /\.gem$/ ? gem : new_dep(gem, version)
+      spec = dep_installer.install(install_arg).find { |s| s.name == gem }
+      Gem.clear_paths
+      spec
+    end
+
+    def latest_gem_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
+      interaction = Gem::DefaultUserInteraction.ui
+      Gem::DefaultUserInteraction.ui = Gem::SilentUI.new
+      yield
+    ensure
+      Gem::DefaultUserInteraction.ui = interaction
+    end
+
+    private
+
+    def dep_installer
+      Gem::DependencyInstaller.new
+    end
+
+    def new_dep(name, version = nil)
+      Gem::Dependency.new(name, version)
+    end
+  end
+end

data/lib/busser/runner_plugin/dummy.rb

@@ -24,9 +24,23 @@ require 'busser/runner_plugin'
 #
 class Busser::RunnerPlugin::Dummy < Busser::RunnerPlugin::Base
 
+  # Example postinstall block that will be executed after the plugin is
+  # installed. All Thor actions, and Busser::Helper methods are available for
+  # use.
+  #
   postinstall do
-    empty_directory("dummy")
-    create_file("dummy/foobar.txt", "The Dummy Driver.")
+    # ensure that dummy_path gets pulled into the chef_apply block closure,
+    # otherwise the Chef will not understand dummy_path in its run context
+    dummy_path = suite_path("dummy").to_s
+
+    # expensive operation delegating a directory creation to Chef, but imagine
+    # using resources such as package, remote_file, etc.
+    chef_apply do
+      directory(dummy_path) { recursive true }
+    end
+
+    # create a dummy file
+    create_file("#{dummy_path}/foobar.txt", "The Dummy Driver.")
   end
 
   def test

data/lib/busser/version.rb

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

data/spec/busser/helpers_spec.rb

@@ -8,17 +8,17 @@ describe Busser::Helpers do
 
   describe ".suite_path" do
 
-    it "Returns a Pathname" do
+    it "returns a Pathname" do
       suite_path.must_be_kind_of Pathname
     end
 
     describe "with a default root path" do
 
-      it "Returns a base path if no suite name is given" do
+      it "returns a base path if no suite name is given" do
         suite_path.to_s.must_equal "/opt/busser/suites"
       end
 
-      it "Returns a suite path given a suite name" do
+      it "returns a suite path given a suite name" do
         suite_path("fuzzy").to_s.must_equal "/opt/busser/suites/fuzzy"
       end
     end
@@ -28,15 +28,49 @@ describe Busser::Helpers do
       before  { ENV['_SPEC_BUSSER_ROOT'] = ENV['BUSSER_ROOT'] }
       after   { ENV['BUSSER_ROOT'] = ENV.delete('_SPEC_BUSSER_ROOT') }
 
-      it "Returns a base path if no suite name is given" do
+      it "returns a base path if no suite name is given" do
         ENV['BUSSER_ROOT'] = "/path/to/busser"
         suite_path.to_s.must_equal "/path/to/busser/suites"
       end
 
-      it "Returns a suite path given a suite name" do
+      it "returns a suite path given a suite name" do
         ENV['BUSSER_ROOT'] = "/path/to/busser"
         suite_path("fuzzy").to_s.must_equal "/path/to/busser/suites/fuzzy"
       end
     end
   end
+
+  describe ".vendor_path" do
+
+    it "returns a Pathname" do
+      vendor_path.must_be_kind_of Pathname
+    end
+
+    describe "with a default root path" do
+
+      it "returns a base path if no product name is given" do
+        vendor_path.to_s.must_equal "/opt/busser/vendor"
+      end
+
+      it "returns a vendor path given a product name" do
+        vendor_path("supreme").to_s.must_equal "/opt/busser/vendor/supreme"
+      end
+    end
+
+    describe "with a custom root path" do
+
+      before  { ENV['_SPEC_BUSSER_ROOT'] = ENV['BUSSER_ROOT'] }
+      after   { ENV['BUSSER_ROOT'] = ENV.delete('_SPEC_BUSSER_ROOT') }
+
+      it "returns a base path if no product name is given" do
+        ENV['BUSSER_ROOT'] = "/path/to/busser"
+        vendor_path.to_s.must_equal "/path/to/busser/vendor"
+      end
+
+      it "returns a suite path given a product name" do
+        ENV['BUSSER_ROOT'] = "/path/to/busser"
+        vendor_path("maximal").to_s.must_equal "/path/to/busser/vendor/maximal"
+      end
+    end
+  end
 end

data/templates/plugin/CHANGELOG.md.erb

@@ -0,0 +1,3 @@
+## 0.1.0 / Unreleased
+
+* Initial release

data/templates/plugin/Gemfile.erb

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/templates/plugin/README.md.erb

@@ -0,0 +1,41 @@
+# <a name="title"></a> Busser::<%= config[:type_klass_name] %>::<%= config[:klass_name] %>
+
+A Busser <%= config[:type] %> plugin for <%= config[:klass_name] %>
+
+## <a name="installation"></a> Installation and Setup
+
+Please read the Busser [plugin usage][plugin_usage] page for more details.
+
+## <a name="usage"></a> Usage
+
+**TODO:** Write documentation explaining the structure/format of testing files.
+
+## <a name="development"></a> Development
+
+* Source hosted at [GitHub][repo]
+* Report issues/questions/feature requests on [GitHub Issues][issues]
+
+Pull requests are very welcome! Make sure your patches are well tested.
+Ideally create a topic branch for every separate change you make. For
+example:
+
+1. Fork the repo
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## <a name="authors"></a> Authors
+
+Created and maintained by [<%= config[:author] %>][author] (<<%= config[:email] %>>)
+
+## <a name="license"></a> License
+
+<%= config[:license_string] %> (see [LICENSE][license])
+
+
+[author]:           https://github.com/enter-github-user
+[issues]:           https://github.com/enter-github-user/<%= config[:gem_name] %>/issues
+[license]:          https://github.com/enter-github-user/<%= config[:gem_name] %>/blob/master/LICENSE
+[repo]:             https://github.com/enter-github-user/<%= config[:gem_name] %>
+[plugin_usage]:     http://docs.kitchen-ci.org/busser/plugin-usage

data/templates/plugin/Rakefile.erb

@@ -0,0 +1,31 @@
+require "bundler/gem_tasks"
+require 'cucumber/rake/task'
+require 'cane/rake_task'
+require 'tailor/rake_task'
+
+Cucumber::Rake::Task.new(:features) do |t|
+  t.cucumber_opts = ['features', '-x', '--format progress']
+end
+
+desc "Run all test suites"
+task :test => [:features]
+
+desc "Run cane to check quality metrics"
+Cane::RakeTask.new do |cane|
+  cane.canefile = './.cane'
+end
+
+Tailor::RakeTask.new
+
+desc "Display LOC stats"
+task :stats do
+  puts "\n## Production Code Stats"
+  sh "countloc -r lib"
+  puts "\n## Test Code Stats"
+  sh "countloc -r features"
+end
+
+desc "Run all quality tasks"
+task :quality => [:cane, :tailor, :stats]
+
+task :default => [:test, :quality]