chef-sandwich 0.2.0 → 0.3.0

data/NEWS

@@ -1,4 +1,13 @@
 * sandwich NEWS
+** 0.3.0 (2011-10-17)
+
+ - Add -e option
+ - Add support for cookbooks: sandwich can now load other cookbooks
+ - Show chef version in --version output
+ - Change default log level from "warn" to "error"
+ - Change cookbook file lookup to work relative to sandwich scripts,
+   fixes #6
+
 ** 0.2.0 (2011-09-07)
 
  - Add support for cookbook_file and template resources

data/Rakefile

@@ -1,6 +1,13 @@
+require 'rake/testtask'
+
 namespace :gem do
   desc 'Build chef-sandwich gem'
   task :build do
     sh 'gem build chef-sandwich.gemspec'
   end
 end
+
+Rake::TestTask.new do |t|
+  t.pattern = 'spec/*_spec.rb'
+  t.verbose = false
+end

data/lib/sandwich/cli.rb

@@ -10,7 +10,9 @@ module Sandwich
       @options = {}
 
       # default log level
-      @options[:log_level] = :warn
+      @options[:log_level] = :error
+
+      @options[:command] = []
 
       @optparse = OptionParser.new do |opts|
         opts.banner = 'Usage: sandwich [options] [sandwichfile [arguments]]'
@@ -18,7 +20,8 @@ module Sandwich
         opts.on_tail('-v',
                      '--version',
                      'Show sandwich version') do
-          puts "sandwich: #{Sandwich::Version}"
+          puts "sandwich: #{Sandwich::VERSION}"
+          puts "chef: #{Chef::VERSION}"
           exit
         end
 
@@ -34,6 +37,12 @@ module Sandwich
                 'Set the log level (debug, info, warn, error, fatal)') do |l|
           @options[:log_level] = l.to_sym
         end
+
+        opts.on('-e',
+                '--command COMMAND',
+                'Execute command as a sandwich script') do |c|
+          @options[:command] << c
+        end
       end
     end
 
@@ -44,21 +53,27 @@ module Sandwich
     def run(argv)
       unparsed_arguments = @optparse.order!(argv)
 
-      # use first argument as sandwich script filename...
-      recipe_filename = unparsed_arguments.shift
-
-      # ...check for stdin...
-      if recipe_filename.nil? || recipe_filename == '-'
-        recipe_filename = '<STDIN>'
-        recipe_file = STDIN.read
+      # check for -e commands
+      if @options[:command].any?
+        recipe_filename = '<COMMAND>'
+        recipe = @options[:command].join("\n")
       else
-        recipe_file = File.read(recipe_filename)
+        # use first argument as sandwich script filename...
+        recipe_filename = unparsed_arguments.shift
+
+        # check for stdin
+        if recipe_filename.nil? || recipe_filename == '-'
+          recipe_filename = '<STDIN>'
+          recipe = STDIN.read
+        else
+          recipe = nil
+        end
       end
 
-      # ...and pass remaining arguments on to script
+      # pass remaining arguments on to script
       ARGV.replace(unparsed_arguments)
-      runner = Sandwich::Runner.new(recipe_file, recipe_filename)
 
+      runner = Sandwich::Runner.new(recipe_filename, recipe)
       runner.run(@options[:log_level])
     end
   end

data/lib/sandwich/client.rb

@@ -0,0 +1,82 @@
+require 'sandwich/cookbook_version'
+require 'chef'
+
+module Sandwich
+  # Chef::Client extended to inject a Sandwich cookbook into the
+  # client's run context
+  class Client < Chef::Client
+    # Create a new instance of Client.
+    #
+    # File specified by +recipe_filename+ is only read if no
+    # +recipe_string+ is supplied, otherwise +recipe_string+ is used
+    # as a recipe and +recipe_filename+ is only used in log messages.
+    #
+    # @param [String] recipe_filename the recipe filename
+    # @param [String] recipe_string the recipe definition
+    def initialize(recipe_filename, recipe_string = nil)
+      Chef::Config[:solo] = true
+      super()
+
+      if recipe_string
+        @sandwich_basedir = Dir.getwd
+      else
+        @sandwich_basedir = File.expand_path(File.dirname(recipe_filename))
+        recipe_string = File.read(recipe_filename)
+      end
+
+      add_cookbook_dir(@sandwich_basedir)
+
+      @sandwich_cookbook_name = unique_cookbook_name
+      @sandwich_recipe = recipe_string
+      @sandwich_filename = recipe_filename
+    end
+
+    # Silently build a new node object for this client
+    #
+    # @return [Chef::Node] the created node object
+    def build_node
+      # silence build_node from super class
+      silence_chef { super }
+    end
+
+    # Set up the client's run context, inject Sandwich cookbook into
+    # the created run context
+    #
+    # @return [Chef::RunContext] the created run context
+    def setup_run_context
+      run_context = super
+      cookbook = Sandwich::CookbookVersion.new(@sandwich_cookbook_name,
+                                               @sandwich_basedir)
+      run_context.cookbook_collection[@sandwich_cookbook_name] = cookbook
+      recipe = Chef::Recipe.new(@sandwich_cookbook_name, nil, run_context)
+      recipe.from_string(@sandwich_recipe, @sandwich_filename)
+      run_context
+    end
+
+    # Add a cookbook directory to the front of the client's cookbook
+    # search path.
+    #
+    # @param [String] cookbook_dir the cookbook directory to add
+    # @return [Array] the new cookbook search path
+    def add_cookbook_dir(cookbook_dir)
+      Chef::Config[:cookbook_path].unshift(cookbook_dir)
+    end
+
+    private
+    def silence_chef
+      log_level = Chef::Log.level
+      Chef::Log.level = :fatal
+      yield
+    ensure
+      Chef::Log.level = log_level
+    end
+
+    # monkey patch: don't check for empty cookbook paths
+    def assert_cookbook_path_not_empty(run_context); end
+
+    def unique_cookbook_name
+      # use uuid in sandwich cookbook name to avoid name collisions
+      "sandwich_#{UUIDTools::UUID.random_create}"
+    end
+  end
+end

data/lib/sandwich/cookbook_version.rb

@@ -1,21 +1,31 @@
 require 'chef/cookbook_version'
 
-# Chef::CookbookVersion, monkey patched to use simpler file source
-# paths (always uses local files instead of manifest records)
-class Chef::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] filename the source file path
-  # @param [String] current_filepath the target file path, ignored
-  # @return [String] the preferred source filename
-  def preferred_filename_on_disk_location(node,
-                                          segment,
-                                          filename,
-                                          current_filepath=nil)
-    # keep absolute paths, convert relative paths into absolute paths
-    filename.start_with?('/') ? filename : File.join(Dir.getwd, filename)
+module Sandwich
+  # Chef::CookbookVersion, extended to use simpler file source paths
+  # (always uses local files relative to @basedir instead of manifest
+  # records)
+  class CookbookVersion < Chef::CookbookVersion
+    # @param [String] name the cookbook's name
+    # @param [String basedir the cookbook's basedir
+    def initialize(name, basedir)
+      super(name)
+      @basedir = basedir
+    end
+
+    # 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] filename the source file path
+    # @param [String] current_filepath the target file path, ignored
+    # @return [String] the preferred source filename
+    def preferred_filename_on_disk_location(node,
+                                            segment,
+                                            filename,
+                                            current_filepath=nil)
+      # keep absolute paths, convert relative paths into absolute paths
+      filename.start_with?('/') ? filename : File.join(@basedir, filename)
+    end
   end
 end

data/lib/sandwich/runner.rb

@@ -1,19 +1,21 @@
-require 'chef'
+require 'chef/config'
 require 'sandwich/recipe'
-require 'sandwich/cookbook_version'
+require 'sandwich/client'
 
 module Sandwich
   # This class constructs a {Chef::Recipe} from a recipe string and
-  # applies it with Chef standalone mode
+  # applies it with Chef standalone mode.
   class Runner
+    # Create a new instance of Runner.
+    #
+    # File specified by +recipe_filename+ is only read if no
+    # +recipe_string+ is supplied, otherwise +recipe_string+ is used
+    # as a recipe and +recipe_filename+ is only used in log messages.
+    #
+    # @param [String] recipe_filename the recipe filename
     # @param [String] recipe_string the recipe definition
-    def initialize(recipe_string, filename)
-      @client = solo_client
-      cookbook_name = 'sandwich'
-      cookbook_collection = single_cookbook_collection(cookbook_name)
-      @run_context = Chef::RunContext.new(@client.node, cookbook_collection)
-      @recipe = Chef::Recipe.new(cookbook_name, nil, @run_context)
-      @recipe.from_string(recipe_string, filename)
+    def initialize(recipe_filename, recipe_string = nil)
+      @client = Sandwich::Client.new(recipe_filename, recipe_string)
     end
 
     # Run Chef in standalone mode, apply recipe
@@ -25,17 +27,10 @@ module Sandwich
     # @return [void]
     def run(log_level = :warn)
       configure_chef(log_level)
-      Chef::Runner.new(@run_context).converge
+      @client.run
     end
 
     private
-    def solo_client
-      Chef::Config[:solo] = true
-      client = Chef::Client.new
-      client.run_ohai
-      client.build_node
-    end
-
     def configure_chef(log_level)
       Chef::Log.level = log_level
 
@@ -46,11 +41,5 @@ module Sandwich
         Chef::Config[:file_backup_path] = File.join(local_cache, 'backup')
       end
     end
-
-    # create a cookbook collection containing a single empty cookbook
-    def single_cookbook_collection(cookbook_name)
-      cookbook = Chef::CookbookVersion.new(cookbook_name)
-      Chef::CookbookCollection.new({ cookbook_name => cookbook })
-    end
   end
 end

data/lib/sandwich/version.rb

@@ -1,4 +1,4 @@
 module Sandwich
   # the current version of sandwich
-  Version = '0.2.0'
+  VERSION = '0.3.0'
 end

data/spec/runner_spec.rb

@@ -0,0 +1,59 @@
+$LOAD_PATH.unshift File.dirname(__FILE__)
+require 'spec_helper'
+
+describe Sandwich::Runner do
+  after(:each) do
+    FakeFS::FileSystem.clear
+  end
+
+  describe Chef::Resource::File do
+    it 'should create files' do
+      with_fakefs do
+        filename = '/foo'
+        content = 'hello world'
+        recipe = %Q(file '#{filename}' do content '#{content}';end)
+        run_recipe(recipe)
+        file = File.read(filename)
+        file.must_equal content
+      end
+    end
+
+    it 'should throw exceptions for files in missing directories' do
+      with_fakefs do
+        filename = '/i/am/not/here'
+        content = 'hello world'
+        recipe = %Q(file '#{filename}' do content '#{content}';end)
+        run = Proc.new { run_recipe recipe }
+        run.must_raise(Errno::ENOENT,
+                       Chef::Exceptions::EnclosingDirectoryDoesNotExist)
+      end
+    end
+  end
+
+  describe Chef::Resource::CookbookFile do
+    it 'should create cookbook files' do
+      with_fakefs do
+        source = '/source'
+        target = '/target'
+        content = 'hello world'
+        recipe = %Q(cookbook_file '#{target}' do source '#{source}';end)
+        # create source for cookbook file
+        File.open(source, 'w') { |f| f.write(content) }
+        run_recipe(recipe)
+        File.read(source).must_equal File.read(target)
+      end
+    end
+  end
+
+  describe Chef::Resource::Directory do
+    it 'should create directories' do
+      with_fakefs do
+        dir = '/foo'
+        recipe = %Q(directory '#{dir}')
+        assert !Dir.exists?(dir)
+        run_recipe(recipe)
+        assert Dir.exists?(dir)
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,47 @@
+require 'minitest/spec'
+require 'minitest/autorun'
+require 'fileutils'
+require 'fakefs/safe'
+require 'sandwich/runner'
+require 'chef'
+
+# Ohai::System, monkey patched to return static values
+class Ohai::System
+  def all_plugins
+    @data = Mash.new({ :hostname => 'archie',
+                       :platform => 'ubuntu',
+                       :fqdn => 'archie.example.com',
+                       :platform_version => '11.04',
+                       :os_version => '2.6.38-10-generic' })
+  end
+end
+
+# monkey patch for https://github.com/defunkt/fakefs/issues/96
+class FakeFS::Dir
+  def self.mkdir(path, integer = 0)
+    FileUtils.mkdir(path)
+  end
+end
+
+def runner_from_recipe(recipe)
+  Sandwich::Runner.new('<SPEC_HELPER>', recipe)
+end
+
+def run_recipe(recipe)
+  runner_from_recipe(recipe).run(:fatal)
+end
+
+def with_fakefs
+  FakeFS.activate!
+  setup_standard_dirs
+  yield
+ensure
+  FakeFS.deactivate!
+end
+
+def setup_standard_dirs
+  FileUtils.mkdir_p '/tmp'
+end
+
+# make sure Chef 0.10 exceptions are available when using older Chef versions
+class Chef::Exceptions::EnclosingDirectoryDoesNotExist; end

metadata

@@ -1,13 +1,8 @@
 --- !ruby/object:Gem::Specification 
 name: chef-sandwich
 version: !ruby/object:Gem::Version 
-  hash: 23
-  prerelease: false
-  segments: 
-  - 0
-  - 2
-  - 0
-  version: 0.2.0
+  prerelease: 
+  version: 0.3.0
 platform: ruby
 authors: 
 - Sebastian Boehm
@@ -15,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-09-07 00:00:00 +02:00
+date: 2011-10-17 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -26,13 +21,53 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 25
-        segments: 
-        - 0
-        - 9
         version: "0.9"
   type: :runtime
   version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: uuidtools
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: minitest
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: fakefs
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 0.8.7
+  type: :development
+  version_requirements: *id005
 description: |
   Sandwich lets you apply Chef recipes to your system without having to
   worry about cookbooks or configuration.
@@ -50,13 +85,16 @@ files:
 - LICENSE
 - NEWS
 - bin/sandwich
-- lib/sandwich.rb
-- lib/sandwich/version.rb
 - lib/sandwich/cli.rb
-- lib/sandwich/recipe.rb
+- lib/sandwich/client.rb
 - lib/sandwich/cookbook_version.rb
+- lib/sandwich/recipe.rb
 - lib/sandwich/runner.rb
-has_rdoc: yard
+- lib/sandwich/version.rb
+- lib/sandwich.rb
+- spec/runner_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
 homepage: https://github.com/sometimesfood/sandwich
 licenses: []
 
@@ -70,23 +108,17 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
       version: "0"
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
 summary: The easiest way to get started as a chef