test-kitchen-provisioners 0.1

data/.gitignore

@@ -0,0 +1,3 @@
+Gemfile.lock
+tmp
+*.gem

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+- 2.0.0
+- 1.9.3
+install: bundle install
+script: rspec

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+gemspec
+
+gem "rake"
+
+group :test do
+  gem "rspec", "~> 2.14"
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 David Genord II
+
+MIT License
+
+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/README.md

@@ -0,0 +1,28 @@
+test-kitchen-provisioners
+=========================
+
+A collection of provisioners to be used in [test-kitchen](https://github.com/opscode/test-kitchen) runs to
+add functionality to the Provisioner system.
+
+Unfortunately as Provisioners were not built with chaining in mind, these may come across as a bit hackish.
+
+## Usage
+
+    gem install test-kitchen-provisioners
+
+Set the `provisioner` value in `.kitchen.yml` to one of the available provisioners.
+
+## Available Providers
+
+### ChefAptRubyRolesChefZero
+
+    provisioner: chef_apt_ruby_roles_chef_zero
+
+A chain provisioners that ensure:
+
+1. Aptitude update is called before chef-zero starts. This lets us not have to make every single cookbook
+reliant on the apt cookbook.
+2. Ruby roles get converted to JSON. chef-zero only knows how to work with JSON files, but we like Ruby.
+This provider runs against the cookbook sandbox on the host machine before the files are uploaded to the VM
+3. Calls the built-in chef-zero provisioner to continue as normal.
+

data/lib/kitchen/provisioner/apt.rb

@@ -0,0 +1,16 @@
+require 'kitchen'
+require 'kitchen/provisioner/base'
+
+module Kitchen
+  module Provisioner
+
+    # Apt Provisioner
+    # This makes sure that aptitude is up-to-date at the beginning of the
+    # chef run before cookbooks are pulled in.
+    class Apt < Base
+      def run_command
+        "#{sudo("aptitude")} update"
+      end
+    end
+  end
+end

data/lib/kitchen/provisioner/chef_apt_ruby_roles_chef_zero.rb

@@ -0,0 +1,58 @@
+require 'kitchen/provisioner/apt'
+require 'kitchen/provisioner/ruby_roles'
+require 'kitchen/provisioner/chef_zero'
+
+module Kitchen
+  module Provisioner
+
+    # This Provisioner combines the roles of the Apt, Ruby Roles, and ChefZero
+    # provisioners, to ensure a server is ready to run before ChefZero starts its magic
+    # Must be named "Chef..." otherwise TestKitchen won't understand that we intend to use chef
+    class ChefAptRubyRolesChefZero < Base
+      def initialize(instance, options)
+        super
+        @apt = Apt.new(instance, options)
+        @chef_zero = ChefZero.new(instance, options)
+        @ruby_roles = RubyRoles.new(instance, options)
+      end
+
+      def install_command
+        @chef_zero.install_command
+      end
+
+      def init_command
+        @chef_zero.init_command
+      end
+
+      # Let chef-zero create the sandbox then convert the Ruby-based role files
+      # into JSON before uploads happen (which happen right after this returns)
+      def create_sandbox
+        sandbox_path = @chef_zero.create_sandbox
+        @ruby_roles.roles_path = File.join(sandbox_path, "roles")
+        @ruby_roles.create_sandbox
+        sandbox_path
+      end
+
+      def prepare_command
+        @chef_zero.prepare_command
+      end
+
+      # Run the apt provisioner before starting up chef-zero
+      def run_command
+        [
+          @apt.run_command,
+          @chef_zero.run_command
+        ].join(" && ")
+      end
+
+      def cleanup_sandbox
+        @chef_zero.cleanup_sandbox
+      end
+
+      def home_path
+        @chef_zero.home_path
+      end
+    end
+
+  end
+end

data/lib/kitchen/provisioner/ruby_roles.rb

@@ -0,0 +1,32 @@
+require 'kitchen'
+require 'kitchen/provisioner/base'
+require 'chef'
+
+module Kitchen
+  module Provisioner
+
+    # RubyRoles Provisioner
+    # This provisioner, when given a path to a cookbook's roles directory, will iterate through
+    # each Ruby-written role and generate the JSON version.
+    # This then allows the ChefZero tool to pick up these roles, as it only knows about JSON
+    class RubyRoles < Base
+
+      attr_accessor :roles_path
+
+      def create_sandbox
+        # From https://gist.github.com/red56/834890
+        Dir.glob(File.join(@roles_path, "*.rb")).each do |ruby_role_file_name|
+          role = Chef::Role.new
+          role.from_file(ruby_role_file_name)
+          json_file_name = ruby_role_file_name.gsub(/rb$/, "json")
+
+          File.open(json_file_name, "w+") do |json_file|
+            json_file.write(JSON.pretty_generate(role))
+          end
+        end
+      end
+
+    end
+
+  end
+end

data/spec/kitchen/provisioner/apt_spec.rb

@@ -0,0 +1,10 @@
+require 'spec_helper'
+require 'kitchen/provisioner/apt'
+
+describe Kitchen::Provisioner::Apt do
+  it "runs aptitude update" do
+    provisioner = Kitchen::Provisioner::Apt.new(BogusInstance.new, nil)
+    expect(provisioner).to receive(:sudo).with("aptitude").and_return("aptitude")
+    expect(provisioner.run_command).to eq("aptitude update")
+  end
+end

data/spec/kitchen/provisioner/chef_apt_ruby_roles_chef_zero_spec.rb

@@ -0,0 +1,69 @@
+require 'spec_helper'
+require 'kitchen/provisioner/chef_apt_ruby_roles_chef_zero'
+
+describe Kitchen::Provisioner::ChefAptRubyRolesChefZero do
+
+  before do
+    @provisioner = Kitchen::Provisioner::ChefAptRubyRolesChefZero.new(BogusInstance.new, nil)
+    @apt        = @provisioner.instance_variable_get("@apt")
+    @ruby_roles = @provisioner.instance_variable_get("@ruby_roles")
+    @chef_zero  = @provisioner.instance_variable_get("@chef_zero")
+  end
+
+  it "installs chef zero" do
+    expect(@chef_zero).to receive(:install_command)
+    expect(@ruby_roles).not_to receive(:install_command)
+    expect(@apt).not_to receive(:install_command)
+
+    @provisioner.install_command
+  end
+
+  it "inits chef zero" do
+    expect(@chef_zero).to receive(:init_command)
+    expect(@ruby_roles).not_to receive(:init_command)
+    expect(@apt).not_to receive(:init_command)
+
+    @provisioner.init_command
+  end
+
+  it "creates sandbox for chef zero and converts ruby roles" do
+    expect(@chef_zero).to receive(:create_sandbox).and_return("path").ordered
+    expect(@ruby_roles).to receive(:roles_path=).with("path/roles").ordered
+    expect(@ruby_roles).to receive(:create_sandbox).ordered
+    expect(@apt).not_to receive(:create_sandbox)
+
+    @provisioner.create_sandbox
+  end
+
+  it "prepares chef zero" do
+    expect(@chef_zero).to receive(:prepare_command)
+    expect(@ruby_roles).not_to receive(:prepare_command)
+    expect(@apt).not_to receive(:prepare_command)
+
+    @provisioner.prepare_command
+  end
+
+  it "runs apt, ruby roles, then chef-zero, in that order" do
+    expect(@apt).to receive(:run_command).and_return("apt me").ordered
+    expect(@chef_zero).to receive(:run_command).and_return("chef me").ordered
+    expect(@ruby_roles).not_to receive(:run_command)
+
+    expect(@provisioner.run_command).to eq("apt me && chef me")
+  end
+
+  it "cleans up the chef zero sandbox" do
+    expect(@chef_zero).to receive(:cleanup_sandbox)
+    expect(@ruby_roles).not_to receive(:cleanup_sandbox)
+    expect(@apt).not_to receive(:cleanup_sandbox)
+
+    @provisioner.cleanup_sandbox
+  end
+
+  it "returns the home path of chef zero" do
+    expect(@chef_zero).to receive(:home_path)
+    expect(@ruby_roles).not_to receive(:home_path)
+    expect(@apt).not_to receive(:home_path)
+
+    @provisioner.home_path
+  end
+end

data/spec/kitchen/provisioner/ruby_roles_spec.rb

@@ -0,0 +1,46 @@
+require 'spec_helper'
+require 'kitchen/provisioner/ruby_roles'
+
+describe Kitchen::Provisioner::RubyRoles do
+  before do
+    # Sorry, can't use FakeFS because chef completely bypasses the
+    # entire File api when reading the file.
+    FileUtils.mkdir_p("tmp/roles")
+  end
+
+  after do
+    FileUtils.rm_r("tmp/roles")
+  end
+
+  it "converts any existing Ruby chef roles into JSON" do
+    File.open("tmp/roles/role1.rb", "w+") do |role|
+      role.puts <<EOC
+name        "role1"
+description "I define how things work"
+
+run_list("recipe[test::role1]")
+EOC
+    end
+
+    File.open("tmp/roles/role2.rb", "w+") do |role|
+      role.puts <<EOC
+name        "role2"
+description "I define how other things work"
+
+run_list("recipe[test::role2]")
+EOC
+    end
+
+    File.open("tmp/roles/role3.js", "w+") do |role|
+      role.puts "This is role thingy 3"
+    end
+
+    provisioner = Kitchen::Provisioner::RubyRoles.new(BogusInstance.new, nil)
+    provisioner.roles_path = "tmp/roles"
+    provisioner.create_sandbox
+
+    expect(File.exists?("tmp/roles/role1.json")).to be_true
+    expect(File.exists?("tmp/roles/role2.json")).to be_true
+    expect(File.exists?("tmp/roles/role3.json")).to be_false
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+RSpec.configure do |config|
+  config.order = "random"
+  config.expect_with(:rspec) {|c| c.syntax = :expect }
+end
+
+class BogusInstance
+  def logger
+  end
+end

data/test-kitchen-provisioners.gemspec

@@ -0,0 +1,18 @@
+Gem::Specification.new do |gem|
+  gem.name    = "test-kitchen-provisioners"
+  gem.version = "0.1"
+  gem.license = "MIT"
+  gem.authors = ["Collective Idea"]
+  gem.email   = ["info@collectiveidea.com"]
+
+  gem.summary     = "A collection of helpful provisioniners for working with Test Kitchen"
+  gem.description = gem.summary
+  gem.homepage    = "https://github.com/collectiveidea/test-kitchen-provisioners"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.test_files    = gem.files.grep(%r{spec})
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency "chef",         "~> 11.6.0"
+  gem.add_dependency "test-kitchen", "1.0.0.beta.2"
+end

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: test-kitchen-provisioners
+version: !ruby/object:Gem::Version
+  version: '0.1'
+  prerelease: 
+platform: ruby
+authors:
+- Collective Idea
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-08-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: chef
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 11.6.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 11.6.0
+- !ruby/object:Gem::Dependency
+  name: test-kitchen
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.0.0.beta.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.0.0.beta.2
+description: A collection of helpful provisioniners for working with Test Kitchen
+email:
+- info@collectiveidea.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/kitchen/provisioner/apt.rb
+- lib/kitchen/provisioner/chef_apt_ruby_roles_chef_zero.rb
+- lib/kitchen/provisioner/ruby_roles.rb
+- spec/kitchen/provisioner/apt_spec.rb
+- spec/kitchen/provisioner/chef_apt_ruby_roles_chef_zero_spec.rb
+- spec/kitchen/provisioner/ruby_roles_spec.rb
+- spec/spec_helper.rb
+- test-kitchen-provisioners.gemspec
+homepage: https://github.com/collectiveidea/test-kitchen-provisioners
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: A collection of helpful provisioniners for working with Test Kitchen
+test_files:
+- spec/kitchen/provisioner/apt_spec.rb
+- spec/kitchen/provisioner/chef_apt_ruby_roles_chef_zero_spec.rb
+- spec/kitchen/provisioner/ruby_roles_spec.rb
+- spec/spec_helper.rb
+- test-kitchen-provisioners.gemspec
+has_rdoc: