busser 0.2.0 → 0.3.0

data/.travis.yml

@@ -7,8 +7,10 @@ rvm:
 - ruby-head
 
 env:
-  - RUBYGEMS_VERSION=2.0.3
-  - RUBYGEMS_VERSION=1.8.25
+  - RUBYGEMS_VERSION=2.0.3 CHEF_VERSION=11.4.0
+  - RUBYGEMS_VERSION=2.0.3 CHEF_VERSION=10.24.0
+  - RUBYGEMS_VERSION=1.8.25 CHEF_VERSION=11.4.0
+  - RUBYGEMS_VERSION=1.8.25 CHEF_VERSION=10.24.0
 
 before_install:
   - gem update --system $RUBYGEMS_VERSION
@@ -17,3 +19,7 @@ before_install:
 matrix:
   allow_failures:
   - rvm: ruby-head
+  - rvm: 2.0.0
+    env: RUBYGEMS_VERSION=2.0.3 CHEF_VERSION=11.4.0
+  - rvm: 2.0.0
+    env: RUBYGEMS_VERSION=2.0.3 CHEF_VERSION=10.24.0

data/CHANGELOG.md

@@ -1,3 +1,16 @@
+## 0.3.0 / 2013-04-09
+
+### New features
+
+* Add `busser plugin create` command to help create new plugin gem projects. ([@fnichol][])
+* Add #chef_apply to Busser::Helpers; chef-apply inline baby! ([@fnichol][])
+* Implement execution of prepare.sh/prepare_recipe.rb before suite test. ([@fnichol][])
+
+### Improvements
+
+* Add Busser::Helpers.vendor_path helper. ([@fnichol][])
+
+
 ## 0.2.0 / 2013-03-31
 
 ### New features

data/Gemfile

@@ -7,3 +7,8 @@ group :development do
   gem 'rb-fsevent', :require => false
   gem 'rb-fchange', :require => false
 end
+
+group :test do
+  # allow CI to override the version of Chef for matrix testing
+  gem 'chef', (ENV['CHEF_VERSION'] || '>= 0.10.10')
+end

data/busser.gemspec

@@ -22,6 +22,8 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency 'thor'
 
+  spec.add_development_dependency "chef"
+
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
   spec.add_development_dependency 'minitest'

data/features/plugin_create_command.feature

@@ -0,0 +1,72 @@
+Feature: Plugin create command
+  In order to make plugin development a snap
+  As a user of Busser
+  I want a command to run that will give me a plugin gem project scaffold
+
+  Scenario: Running with default values
+    When I run `busser plugin create junit`
+    Then a directory named "busser-junit" should exist
+    And the file "busser-junit/CHANGELOG.md" should contain:
+    """
+    ## 0.1.0 / Unreleased
+    """
+    And the file "busser-junit/Gemfile" should contain "gemspec"
+    And the file "busser-junit/Rakefile" should contain "task :stats"
+    And the file "busser-junit/README.md" should contain:
+    """
+    Busser::RunnerPlugin::Junit
+    """
+    And the file "busser-junit/busser-junit.gemspec" should contain:
+    """
+    require 'busser/junit/version'
+    """
+    And the file "busser-junit/LICENSE" should contain:
+    """
+    Licensed under the Apache License, Version 2.0
+    """
+    And the file "busser-junit/.gitignore" should contain:
+    """
+    Gemfile.lock
+    """
+    And the file "busser-junit/.tailor" should contain:
+    """
+    config.file_set 'lib/**/*.rb'
+    """
+    And the file "busser-junit/.travis.yml" should contain:
+    """
+    language: ruby
+    """
+    And a file named "busser-junit/.cane" should exist
+    And the file "busser-junit/lib/busser/junit/version.rb" should contain:
+    """
+    module Busser
+
+      module Junit
+    """
+    And the file "busser-junit/lib/busser/runner_plugin/junit.rb" should contain:
+    """
+    class Busser::RunnerPlugin::Junit < Busser::RunnerPlugin::Base
+    """
+    And the file "busser-junit/features/support/env.rb" should contain:
+    """
+    require 'busser/cucumber'
+    """
+    And the file "busser-junit/features/plugin_install_command.feature" should contain:
+    """
+    When I run `busser plugin install busser-junit --force-postinstall`
+    """
+    And the file "busser-junit/features/plugin_list_command.feature" should contain:
+    """
+    When I successfully run `busser plugin list`
+    """
+    And the file "busser-junit/features/test_command.feature" should contain:
+    """
+    Given a suite directory named "junit"
+    """
+
+  Scenario: Running with an alternate license
+    When I successfully run `busser plugin create foo --license=reserved`
+    Then the file "busser-foo/LICENSE" should contain:
+    """
+    All rights reserved - Do Not Redistribute
+    """

data/features/plugin_install_command.feature

@@ -6,6 +6,7 @@ Feature: Plugin install command
   Background:
     Given a non bundler environment
     And a sandboxed GEM_HOME directory named "busser-plugin-gem-home"
+    And a test BUSSER_ROOT directory named "busser-plugin-install"
 
   Scenario: Installing a missing plugin
     When I run `busser plugin install busser-bash`
@@ -33,8 +34,8 @@ Feature: Plugin install command
 
   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:
+    Then the suite directory named "dummy" should exist
+    And the suite file "dummy/foobar.txt" should contain exactly:
     """
     The Dummy Driver.
     """

data/lib/busser.rb

@@ -16,7 +16,16 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require "busser/version"
+require 'pathname'
+
+require 'busser/version'
 
 module Busser
+
+  # Returns the root path of the Busser gem source code.
+  #
+  # @return [Pathname] root path of gem
+  def self.source_root
+    @source_root ||= Pathname.new(File.expand_path('../../', __FILE__))
+  end
 end

data/lib/busser/chef_apply.rb

@@ -0,0 +1,108 @@
+# -*- 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/chef_ext'
+
+module Busser
+
+  # A modified re-implementation of chef-apply which ships with Chef 11 gems.
+  #
+  # @author Fletcher Nichol <fnichol@nichol.ca>
+  #
+  class ChefApply
+
+    def initialize(config = {}, &block)
+      @config = { :why_run => false }.merge(config)
+      @apply_block = block
+
+      if ! config.has_key?(:file) && ! block_given?
+        raise ArgumentError, ":file or block must be given"
+      end
+    end
+
+    def converge
+      as_solo do
+        load_recipe
+        Chef::Runner.new(run_context).converge
+      end
+    end
+
+    private
+
+    attr_reader :config, :apply_block
+
+    COOKBOOK_NAME   = "(chef-apply cookbook)".freeze
+    COOKBOOK_RECIPE = "(chef-apply recipe)".freeze
+
+    def as_solo
+      log_level = Chef::Log.level
+      solo_mode = Chef::Config[:solo]
+      why_run   = Chef::Config[:why_run]
+
+      Chef::Log.level         = chef_log_level
+      Chef::Config[:solo]     = true
+      Chef::Config[:why_run]  = config[:why_run]
+      yield
+    ensure
+      Chef::Config[:why_run]  = why_run
+      Chef::Config[:solo]     = solo_mode
+      Chef::Log.level         = log_level
+    end
+
+    def load_recipe
+      recipe = Chef::Recipe.new(COOKBOOK_NAME, COOKBOOK_RECIPE, run_context)
+
+      if config[:file]
+        recipe.from_file(config[:file].to_s)
+      else
+        recipe.instance_eval(&apply_block)
+      end
+    end
+
+    def run_context
+      @run_context ||= begin
+        if client.events.nil?
+          Chef::RunContext.new(client.node, cookbook_collection)
+        else
+          Chef::RunContext.new(client.node, cookbook_collection, client.events)
+        end
+      end
+    end
+
+    def cookbook_collection
+      @cookbook_collection ||= begin
+        cookbook = Chef::CookbookVersion.new(COOKBOOK_NAME)
+        Chef::CookbookCollection.new({ COOKBOOK_NAME => cookbook })
+      end
+    end
+
+    def client
+      @client ||= begin
+        client = Chef::Client.new
+        client.run_ohai
+        client.load_node
+        client.build_node
+        client
+      end
+    end
+
+    def chef_log_level
+      (ENV['BUSSER_LOG_LEVEL'] && ENV['BUSSER_LOG_LEVEL'].to_sym) || :info
+    end
+  end
+end

data/lib/busser/chef_ext.rb

@@ -0,0 +1,52 @@
+# -*- 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 'chef/client'
+require 'chef/providers'
+require 'chef/resources'
+require 'chef/cookbook_version'
+
+# Monkey patches to Chef core classes to allow for chef-apply functionality.
+class Chef
+
+  # Backwards compatible shim for older Chef clients.
+  class Client
+    attr_reader :events
+  end
+
+  # Chef::CookbookVersion, monkey patched to use simpler file source
+  # paths (always uses local files instead of manifest records).
+  #
+  # Implementation from the sandwich project at:
+  # https://github.com/sometimesfood/sandwich
+  #
+  class CookbookVersion
+    # Determines the absolute source filename on disk for various file
+    # resources from their relative path
+    #
+    # @param [Chef::Node] node the node object, ignored
+    # @param [Symbol] segment the segment of the current resource, ignored
+    # @param [String] source the source file path
+    # @param [String] target the target file path, ignored
+    # @return [String] the preferred source filename
+    def preferred_filename_on_disk_location(node, segment, source, target = nil)
+      # keep absolute paths, convert relative paths into absolute paths
+      source.start_with?('/') ? source : File.join(Dir.getwd, source)
+    end
+  end
+end

data/lib/busser/command/plugin.rb

@@ -17,6 +17,7 @@
 # limitations under the License.
 
 require 'busser/thor'
+require 'busser/command/plugin_create'
 require 'busser/command/plugin_install'
 require 'busser/command/plugin_list'
 
@@ -30,6 +31,10 @@ module Busser
     #
     class Plugin < Busser::Thor::Base
 
+      register Busser::Command::PluginCreate, "create",
+        "create [PLUGIN_NAME]", "Creates a new Busser plugin gem project"
+      tasks["create"].options = Busser::Command::PluginCreate.class_options
+
       register Busser::Command::PluginInstall, "install",
         "install PLUGIN [PLUGIN ...]", "Installs one or more plugins"
       tasks["install"].options = Busser::Command::PluginInstall.class_options

data/lib/busser/command/plugin_create.rb

@@ -0,0 +1,174 @@
+# -*- 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'
+require 'busser/thor'
+
+module Busser
+
+  module Command
+
+    # Plugin create command.
+    #
+    # @author Fletcher Nichol <fnichol@nichol.ca>
+    #
+    class PluginCreate < Busser::Thor::BaseGroup
+
+      argument :name, :type => :string
+
+      class_option :type, :aliases => "-t", :type => :string,
+        :default => 'runner', :desc => "Type of plugin (runner)"
+
+      class_option :license, :aliases => "-l", :default => "apachev2",
+        :desc => "License type for gem (apachev2, mit, lgplv3, reserved)"
+
+      def create
+        self.class.source_root(Busser.source_root.join("templates", "plugin"))
+
+        create_core_files
+        create_source_files
+        create_features_files
+        initialize_git
+      end
+
+      private
+
+      def create_core_files
+        empty_directory(target_dir)
+
+        create_template("CHANGELOG.md.erb", "CHANGELOG.md")
+        create_template("Gemfile.erb", "Gemfile")
+        create_template("Rakefile.erb", "Rakefile")
+        create_template("README.md.erb", "README.md")
+        create_template("gemspec.erb", "#{config[:gem_name]}.gemspec")
+        create_template("license_#{config[:license]}.erb", license_filename)
+        create_template("gitignore.erb", ".gitignore")
+        create_template("tailor.erb", ".tailor")
+        create_template("travis.yml.erb", ".travis.yml")
+        create_file(File.join(target_dir, ".cane"))
+      end
+
+      def create_source_files
+        empty_directory(File.join(target_dir, "lib/busser", name))
+        empty_directory(File.join(target_dir, "lib/busser/runner_plugin"))
+
+        create_template(
+          "version.rb.erb",
+          "lib/busser/#{name}/version.rb"
+        )
+        create_template(
+          "runner_plugin.rb.erb",
+          "lib/busser/runner_plugin/#{name}.rb"
+        )
+      end
+
+      def create_features_files
+        empty_directory(File.join(target_dir, "features/support"))
+
+        create_template(
+          "features_env.rb.erb",
+          "features/support/env.rb"
+        )
+        create_template(
+          "features_plugin_install_command.feature.erb",
+          "features/plugin_install_command.feature"
+        )
+        create_template(
+          "features_plugin_list_command.feature.erb",
+          "features/plugin_list_command.feature"
+        )
+        create_template(
+          "features_test_command.feature.erb",
+          "features/test_command.feature"
+        )
+      end
+
+      def initialize_git
+        inside(target_dir) do
+          run("git init")
+          run("git add .")
+        end
+      end
+
+      def create_template(erb, dest)
+        template(erb, File.join(target_dir, dest), config)
+      end
+
+      def target_dir
+        File.join(Dir.pwd, "busser-#{name}")
+      end
+
+      def config
+        @config ||= begin
+          type_klass_name = "#{::Thor::Util.camel_case(options[:type])}Plugin"
+
+          {
+            :name => name,
+            :gem_name => "busser-#{name}",
+            :gemspec => "busser-#{name}.gemspec",
+            :klass_name => ::Thor::Util.camel_case(name),
+            :type => options[:type],
+            :type_klass_name => type_klass_name,
+            :constant_name => ::Thor::Util.snake_case(name).upcase,
+            :author => author,
+            :email => email,
+            :license => options[:license],
+            :license_string => license_string,
+            :year => Time.now.year,
+          }
+        end
+      end
+
+      def author
+        git_user_name = %x{git config user.name}.chomp
+        git_user_name.empty? ? "TODO: Write your name" : git_user_name
+      end
+
+      def email
+        git_user_email = %x{git config user.email}.chomp
+        git_user_email.empty? ? "TODO: Write your email" : git_user_email
+      end
+
+      def license_string
+        case options[:license]
+        when "mit" then "MIT"
+        when "apachev2" then "Apache 2.0"
+        when "lgplv3" then "LGPL 3.0"
+        when "reserved" then "All rights reserved"
+        else
+          raise ArgumentError, "No such license #{options[:license]}"
+        end
+      end
+
+      def license_filename
+        case options[:license]
+        when "mit" then "LICENSE.txt"
+        when "apachev2", "reserved" then "LICENSE"
+        when "lgplv3" then "COPYING"
+        else
+          raise ArgumentError, "No such license #{options[:license]}"
+        end
+      end
+
+      def license_comment
+        @license_comment ||= IO.read(File.join(target_dir, license_filename)).
+          gsub(/^/, '# ').gsub(/\s+$/, '')
+      end
+    end
+  end
+end