jamie 0.1.0.alpha13 → 0.1.0.alpha14

data/lib/jamie/cli.rb

@@ -1,5 +1,7 @@
 # -*- encoding: utf-8 -*-
 
+require 'erb'
+require 'ostruct'
 require 'thor'
 
 require 'jamie'
@@ -47,31 +49,18 @@ module Jamie
       exit 1
     end
 
-    desc "init", "does the world"
+    desc "init", "Adds some configuration to your cookbook so Jamie can rock"
     def init
-      create_file ".jamie.yml", default_yaml
-      append_to_file("Rakefile", <<-RAKE.gsub(/ {8}/, '')) if init_rakefile?
-
-        begin
-          require 'jamie/rake_tasks'
-          Jamie::RakeTasks.new
-        rescue LoadError
-          puts ">>>>> Jamie gem not loaded, omitting tasks" unless ENV['CI']
-        end
-      RAKE
-      append_to_file("Thorfile", <<-THOR.gsub(/ {8}/, '')) if init_thorfile?
+      InitGenerator.new.init
+    end
 
-        begin
-          require 'jamie/thor_tasks'
-          Jamie::ThorTasks.new
-        rescue LoadError
-          puts ">>>>> Jamie gem not loaded, omitting tasks" unless ENV['CI']
-        end
-      THOR
-      empty_directory "test/integration/standard" if init_test_dir?
-      append_to_gitignore(".jamie/")
-      append_to_gitignore(".jamie.local.yml")
-      add_plugins
+    desc "new_plugin [NAME]", "Generate a new Jamie Driver plugin gem project"
+    method_option :license, :aliases => "-l", :default => "apachev2",
+      :desc => "Type of license for gem (apachev2, mit, gplv3, gplv2, reserved)"
+    def new_plugin(name)
+      g = NewPluginGenerator.new
+      g.options = options
+      g.new_plugin(name)
     end
 
     private
@@ -143,6 +132,42 @@ module Jamie
         }
       ]
     end
+  end
+
+  # A project initialization generator, to help prepare a cookbook project for
+  # testing with Jamie.
+  class InitGenerator < Thor
+
+    include Thor::Actions
+
+    desc "init", "Adds some configuration to your cookbook so Jamie can rock"
+    def init
+      create_file ".jamie.yml", default_yaml
+      append_to_file("Rakefile", <<-RAKE.gsub(/ {8}/, '')) if init_rakefile?
+
+        begin
+          require 'jamie/rake_tasks'
+          Jamie::RakeTasks.new
+        rescue LoadError
+          puts ">>>>> Jamie gem not loaded, omitting tasks" unless ENV['CI']
+        end
+      RAKE
+      append_to_file("Thorfile", <<-THOR.gsub(/ {8}/, '')) if init_thorfile?
+
+        begin
+          require 'jamie/thor_tasks'
+          Jamie::ThorTasks.new
+        rescue LoadError
+          puts ">>>>> Jamie gem not loaded, omitting tasks" unless ENV['CI']
+        end
+      THOR
+      empty_directory "test/integration/standard" if init_test_dir?
+      append_to_gitignore(".jamie/")
+      append_to_gitignore(".jamie.local.yml")
+      add_plugins
+    end
+
+    private
 
     def default_yaml
       url_base = "https://opscode-vm.s3.amazonaws.com/vagrant/boxes"
@@ -259,4 +284,162 @@ module Jamie
       end
     end
   end
+
+  # A generator to create a new Jamie driver plugin.
+  class NewPluginGenerator < Thor
+
+    include Thor::Actions
+
+    desc "new_plugin [NAME]", "Generate a new Jamie Driver plugin gem project"
+    method_option :license, :aliases => "-l", :default => "apachev2",
+      :desc => "Type of license for gem (apachev2, mit, gplv3, gplv2, reserved)"
+    def new_plugin(plugin_name)
+      if ! run("command -v bundle", :verbose => false)
+        die "Bundler must be installed and on your PATH: `gem install bundler'"
+      end
+
+      @plugin_name = plugin_name
+      @gem_name = "jamie-#{plugin_name}"
+      @gemspec = "#{gem_name}.gemspec"
+      @klass_name = Util.to_camel_case(plugin_name)
+      @constant = Util.to_snake_case(plugin_name).upcase
+      @license = options[:license]
+      @author = %x{git config user.name}.chomp
+      @email = %x{git config user.email}.chomp
+      @year = Time.now.year
+
+      create_plugin
+    end
+
+    private
+
+    attr_reader :plugin_name, :gem_name, :gemspec, :klass_name,
+                :constant, :license, :author, :email, :year
+
+    def create_plugin
+      run("bundle gem #{gem_name}") unless File.directory?(gem_name)
+
+      inside(gem_name) do
+        update_gemspec
+        update_gemfile
+        update_rakefile
+        create_src_files
+        cleanup
+        create_license
+        add_git_files
+      end
+    end
+
+    def update_gemspec
+      gsub_file(gemspec, %r{require '#{gem_name}/version'},
+        %{require 'jamie/driver/#{plugin_name}_version.rb'})
+      gsub_file(gemspec, %r{Jamie::#{klass_name}::VERSION},
+        %{Jamie::Driver::#{constant}_VERSION})
+      gsub_file(gemspec, %r{(gem\.executables\s*) =.*$},
+        '\1 = []')
+      gsub_file(gemspec, %r{(gem\.description\s*) =.*$},
+        '\1 = "' + "Jamie::Driver::#{klass_name} - " +
+        "A Jamie Driver for #{klass_name}\"")
+      gsub_file(gemspec, %r{(gem\.summary\s*) =.*$},
+        '\1 = gem.description')
+      gsub_file(gemspec, %r{(gem\.homepage\s*) =.*$},
+        '\1 = "https://github.com/jamie-ci/' +
+        "#{gem_name}/\"")
+      insert_into_file(gemspec,
+        "\n  gem.add_dependency 'jamie'\n", :before => "end\n")
+      insert_into_file(gemspec,
+        "\n  gem.add_development_dependency 'cane'\n", :before => "end\n")
+      insert_into_file(gemspec,
+        "  gem.add_development_dependency 'tailor'\n", :before => "end\n")
+    end
+
+    def update_gemfile
+      append_to_file("Gemfile", "\ngroup :test do\n  gem 'rake'\nend\n")
+    end
+
+    def update_rakefile
+      append_to_file("Rakefile", <<-RAKEFILE.gsub(/^ {8}/, ''))
+        require 'cane/rake_task'
+        require 'tailor/rake_task'
+
+        desc "Run cane to check quality metrics"
+        Cane::RakeTask.new
+
+        Tailor::RakeTask.new
+
+        task :default => [ :cane, :tailor ]
+      RAKEFILE
+    end
+
+    def create_src_files
+      license_comments = rendered_license.gsub(/^/, '# ').gsub(/\s+$/, '')
+
+      empty_directory("lib/jamie/driver")
+      create_template("plugin/version.rb",
+        "lib/jamie/driver/#{plugin_name}_version.rb",
+        :klass_name => klass_name, :constant => constant,
+        :license => license_comments)
+      create_template("plugin/driver.rb",
+        "lib/jamie/driver/#{plugin_name}.rb",
+        :klass_name => klass_name, :license => license_comments)
+    end
+
+    def rendered_license
+      TemplateRenderer.render("plugin/license_#{license}",
+        :author => author, :email => email, :year => year)
+    end
+
+    def create_license
+      dest_file = case license
+      when "mit" then "LICENSE.txt"
+      when "apachev2", "reserved" then "LICENSE"
+      when "gplv2", "gplv3" then "COPYING"
+      else
+        raise ArgumentError, "No such license #{license}"
+      end
+
+      create_file(dest_file, rendered_license)
+    end
+
+    def cleanup
+      %W(LICENSE.txt lib/#{gem_name}/version.rb lib/#{gem_name}.rb).each do |f|
+        run("git rm -f #{f}") if File.exists?(f)
+      end
+      remove_dir("lib/#{gem_name}")
+    end
+
+    def add_git_files
+      run("git add .")
+    end
+
+    def create_template(template, destination, data = {})
+      create_file(destination, TemplateRenderer.render(template, data))
+    end
+
+    # Renders an ERB template with a hash of template variables.
+    class TemplateRenderer < OpenStruct
+
+      def self.render(template, data = {})
+        renderer = new(template, data)
+        yield renderer if block_given?
+        renderer.render
+      end
+
+      def initialize(template, data = {})
+        super()
+        data[:template] = template
+        data.each { |key, value| send("#{key}=", value) }
+      end
+
+      def render
+        ERB.new(IO.read(template_file)).result(binding)
+      end
+
+      private
+
+      def template_file
+        Jamie.source_root.join("templates", "#{template}.erb").to_s
+      end
+    end
+  end
 end

data/lib/jamie/driver/vagrant.rb

@@ -1,7 +1,5 @@
 # -*- encoding: utf-8 -*-
 
-require 'mixlib/shellout'
-
 require 'jamie'
 
 module Jamie

data/lib/jamie/vagrant.rb

@@ -47,6 +47,7 @@ module Jamie
           chef.run_list = instance.run_list
           chef.json = instance.attributes
           chef.data_bags_path = instance.suite.data_bags_path
+          chef.roles_path = instance.suite.roles_path
         end
       end
     end

data/lib/jamie/version.rb

@@ -2,5 +2,5 @@
 
 module Jamie
 
-  VERSION = "0.1.0.alpha13"
+  VERSION = "0.1.0.alpha14"
 end

data/lib/jamie.rb

@@ -18,6 +18,13 @@ require 'jamie/version'
 
 module Jamie
 
+  # Returns the root path of the Jamie gem source code.
+  #
+  # @return [Pathname] root path of gem
+  def self.source_root
+    @source_root ||= Pathname.new(File.expand_path('../../', __FILE__))
+  end
+
   # Base configuration class for Jamie. This class exposes configuration such
   # as the location of the Jamie YAML file, instances, log_levels, etc.
   class Config
@@ -122,7 +129,12 @@ module Jamie
 
     def new_suite(hash)
       data_bags_path = calculate_data_bags_path(hash['name'])
-      Suite.new(hash.rmerge({ 'data_bags_path' => data_bags_path }))
+      roles_path = calculate_roles_path(hash['name'])
+      path_hash = {
+        'data_bags_path' => data_bags_path,
+        'roles_path'     => roles_path
+      }
+      Suite.new(hash.rmerge(path_hash))
     end
 
     def new_platform(hash)
@@ -159,14 +171,33 @@ module Jamie
       default_driver_config.rmerge(common_driver_config.rmerge(platform_config))
     end
 
+    def calculate_roles_path(suite_name)
+      suite_roles_path = File.join(test_base_path, suite_name, "roles")
+      common_roles_path = File.join(test_base_path, "roles")
+      top_level_roles_path = File.join(Dir.pwd, "roles")
+
+      if File.directory?(suite_roles_path)
+        suite_roles_path
+      elsif File.directory?(common_roles_path)
+        common_roles_path
+      elsif File.directory?(top_level_roles_path)
+        top_level_roles_path
+      else
+        nil
+      end
+    end
+
     def calculate_data_bags_path(suite_name)
       suite_data_bags_path = File.join(test_base_path, suite_name, "data_bags")
       common_data_bags_path = File.join(test_base_path, "data_bags")
+      top_level_data_bags_path = File.join(Dir.pwd, "data_bags")
 
       if File.directory?(suite_data_bags_path)
         suite_data_bags_path
       elsif File.directory?(common_data_bags_path)
         common_data_bags_path
+      elsif File.directory?(top_level_data_bags_path)
+        top_level_data_bags_path
       else
         nil
       end
@@ -198,6 +229,10 @@ module Jamie
     #   not exist
     attr_reader :data_bags_path
 
+    # @return [String] local path to the suite's roles, or nil if one does
+    #   not exist
+    attr_reader :roles_path
+
     # Constructs a new suite.
     #
     # @param [Hash] options configuration for a new suite
@@ -213,6 +248,7 @@ module Jamie
       @run_list = options['run_list']
       @attributes = options['attributes'] || Hash.new
       @data_bags_path = options['data_bags_path']
+      @roles_path = options['roles_path']
     end
 
     private
@@ -887,6 +923,7 @@ module Jamie
         upload_solo_rb    scp
         upload_cookbooks  scp
         upload_data_bags  scp if instance.suite.data_bags_path
+        upload_roles      scp if instance.suite.roles_path
       end
     end
 
@@ -926,6 +963,16 @@ module Jamie
       end
     end
 
+    def upload_roles(scp)
+      roles_dir = instance.suite.roles_path
+      scp.upload!(roles_dir, "#{chef_home}/roles",
+        :recursive => true
+      ) do |ch, name, sent, total|
+        file = name.sub(%r{^#{roles_dir}/}, '')
+        puts "       #{file}: #{sent}/#{total}"
+      end
+    end
+
     def solo_rb_contents
       solo = []
       solo << %{node_name "#{instance.name}"}

data/templates/plugin/driver.rb.erb

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+#
+<%= license %>
+
+require 'jamie'
+
+module Jamie
+
+  module Driver
+
+    # <%= klass_name %> driver for Jamie.
+    class <%= klass_name %> < Jamie::Driver::SSHBase
+
+      def perform_create(instance, state)
+      end
+
+      def perform_destroy(instance, state)
+      end
+    end
+  end
+end

data/templates/plugin/license_apachev2.erb

@@ -0,0 +1,15 @@
+Author:: <%= author %> (<<%= email %>>)
+
+Copyright (C) <%= year %>, <%= author %>
+
+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.

data/templates/plugin/license_gplv2.erb

@@ -0,0 +1,18 @@
+Author:: <%= author %> (<<%= email %>>)
+
+Copyright (C) <%= year %>  <%= author %>
+
+This program is free software; you can redistribute it and/or
+modify it under the terms of the GNU General Public License
+as published by the Free Software Foundation; either version 2
+of the License, or (at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program; if not, write to the Free Software
+Foundation, Inc., 51 Franklin Street, Fifth Floor,
+Boston, MA  02110-1301, USA.

data/templates/plugin/license_gplv3.erb

@@ -0,0 +1,16 @@
+Author:: <%= author %> (<<%= email %>>)
+
+Copyright (C) <%= year %>  <%= author %>
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program.  If not, see <http://www.gnu.org/licenses/>.

data/templates/plugin/license_mit.erb

@@ -0,0 +1,22 @@
+Author:: <%= author %> (<<%= email %>>)
+
+Copyright (c) <%= year %>, <%= author %>
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/templates/plugin/license_reserved.erb

@@ -0,0 +1,5 @@
+Author:: <%= author %> (<<%= email %>>)
+
+Copyright (C) <%= year %>, <%= author %>
+
+All rights reserved - Do Not Redistribute

data/templates/plugin/version.rb.erb

@@ -0,0 +1,12 @@
+# -*- encoding: utf-8 -*-
+#
+<%= license %>
+
+module Jamie
+
+  module Driver
+
+    # Version string for <%= klass_name %> Jamie driver
+    <%= constant %>_VERSION = "0.1.0"
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jamie
 version: !ruby/object:Gem::Version
-  version: 0.1.0.alpha13
+  version: 0.1.0.alpha14
   prerelease: 6
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-20 00:00:00.000000000 Z
+date: 2012-12-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -180,6 +180,13 @@ files:
 - lib/jamie/vagrant.rb
 - lib/jamie/version.rb
 - lib/vendor/hash_recursive_merge.rb
+- templates/plugin/driver.rb.erb
+- templates/plugin/license_apachev2.erb
+- templates/plugin/license_gplv2.erb
+- templates/plugin/license_gplv3.erb
+- templates/plugin/license_mit.erb
+- templates/plugin/license_reserved.erb
+- templates/plugin/version.rb.erb
 homepage: ''
 licenses: []
 post_install_message: 
@@ -194,7 +201,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1363591312854279086
+      hash: 168460114090032110
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: