chef-sandwich 0.1.0 → 0.2.0

data/NEWS

@@ -0,0 +1,17 @@
+* sandwich NEWS
+** 0.2.0 (2011-09-07)
+
+ - Add support for cookbook_file and template resources
+ - Add support for standalone sandwich scripts: sandwich can now be
+   used in shebang lines
+ - Save file caches and file backups to ~/.cache/sandwich instead of
+   /var/cache/chef for non-root users, fixes #3
+ - Report correct recipe filename in error messages, fixes #2
+
+** 0.1.0 (2011-08-09)
+
+ - First release
+
+# Local Variables:
+# mode: org
+# End:

data/README.md

@@ -16,7 +16,7 @@ For example, installing the package `htop` works like this:
 
 If you wanted to install zsh, make it the default shell for root and add a simple alias (without overwriting the existing zshrc), you could do something like this:
 
-    cat << EOF | sudo sandwich -l info
+    cat <<EOF | sudo sandwich -l info
     package "zsh"
     
     user "root" do
@@ -42,17 +42,22 @@ Sandwich even makes managing cron jobs easy. Say you want to generate a new sign
       command "fortune bofh-excuses > ~/.signature.sample"
     end
     EOF
-    sudo sandwich -l info -f fortune-signature.rb
+    sudo sandwich -l info fortune-signature.rb
 
 Installation
 ------------
 
+Sandwich is available as a gem called `chef-sandwich`:
+
     sudo gem install chef-sandwich
 
-Limitations
------------
+There's also a [chef-sandwich package for Debian/Ubuntu](https://launchpad.net/~sometimesfood/+archive/chef-sandwich/). Make sure to install a recent Chef version to go with Sandwich:
 
-Sandwich does not yet properly handle `cookbook_file` and `template` resources. It's on my TODO list, don't worry.
+    sudo apt-get install curl lsb-release python-software-properties
+    bash < <( curl -sL https://raw.github.com/sometimesfood/chef-admin-essentials/master/contrib/install-chef.sh )
+    sudo add-apt-repository ppa:sometimesfood/chef-sandwich
+    sudo apt-get update
+    sudo apt-get install chef-sandwich
 
 Extras
 ------

data/lib/sandwich/cli.rb

@@ -1,4 +1,4 @@
-require 'mixlib/cli'
+require 'optparse'
 require 'sandwich/runner'
 require 'sandwich/version'
 
@@ -6,52 +6,60 @@ module Sandwich
   # This class parses ARGV style command line options and starts a
   # configured {Sandwich::Runner}.
   class CLI
-    include Mixlib::CLI
-
-    option :help,
-      :short        => '-h',
-      :long         => '--help',
-      :description  => 'Show this message',
-      :boolean      => true,
-      :on           => :tail,
-      :show_options => true,
-      :exit         => 0
-
-    option :file,
-      :short       => '-f FILE',
-      :long        => '--file FILE',
-      :description => 'Read recipe from FILE, defaults to standard input',
-      :default     => '-',
-      :on          => :head
-
-    option :log_level,
-      :short        => '-l LEVEL',
-      :long         => '--log_level LEVEL',
-      :description  => 'Set the log level (debug, info, warn, error, fatal)',
-      :default      => :warn,
-      :proc         => lambda { |l| l.to_sym }
-
-    option :version,
-      :short       => '-v',
-      :long        => '--version',
-      :description => 'Show sandwich version',
-      :boolean     => true,
-      :proc        => lambda { |v| puts "sandwich: #{Sandwich::Version}" },
-      :exit        => 0
+    def initialize
+      @options = {}
+
+      # default log level
+      @options[:log_level] = :warn
+
+      @optparse = OptionParser.new do |opts|
+        opts.banner = 'Usage: sandwich [options] [sandwichfile [arguments]]'
+
+        opts.on_tail('-v',
+                     '--version',
+                     'Show sandwich version') do
+          puts "sandwich: #{Sandwich::Version}"
+          exit
+        end
+
+        opts.on_tail('-h',
+                     '--help',
+                     'Show this message') do
+          puts opts
+          exit
+        end
+
+        opts.on('-l',
+                '--log_level LEVEL',
+                'Set the log level (debug, info, warn, error, fatal)') do |l|
+          @options[:log_level] = l.to_sym
+        end
+      end
+    end
 
     # Start Sandwich
     #
     # @param [Array] argv ARGV style command line options passed to sandwich
     # @return [void]
     def run(argv)
-      parse_options(argv)
-      if config[:file] == '-'
-        runner = Sandwich::Runner.new(STDIN.read)
+      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
       else
-        file = File.read(config[:file])
-        runner = Sandwich::Runner.new(file)
+        recipe_file = File.read(recipe_filename)
       end
-      runner.run(config[:log_level])
+
+      # ...and pass remaining arguments on to script
+      ARGV.replace(unparsed_arguments)
+      runner = Sandwich::Runner.new(recipe_file, recipe_filename)
+
+      runner.run(@options[:log_level])
     end
   end
 end

data/lib/sandwich/cookbook_version.rb

@@ -0,0 +1,21 @@
+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)
+  end
+end

data/lib/sandwich/recipe.rb

@@ -5,8 +5,9 @@ class Chef::Recipe
   # Loads a recipe from a string
   #
   # @param [String] string the recipe definition
+  # @param [String] filename the filename to use in error messages
   # @return [void]
-  def from_string(string)
-    self.instance_eval(string, 'sandwich', 1)
+  def from_string(string, filename = '(eval)')
+    self.instance_eval(string, filename, 1)
   end
 end

data/lib/sandwich/runner.rb

@@ -1,16 +1,19 @@
 require 'chef'
 require 'sandwich/recipe'
+require 'sandwich/cookbook_version'
 
 module Sandwich
   # This class constructs a {Chef::Recipe} from a recipe string and
   # applies it with Chef standalone mode
   class Runner
     # @param [String] recipe_string the recipe definition
-    def initialize(recipe_string)
+    def initialize(recipe_string, filename)
       @client = solo_client
-      @run_context = Chef::RunContext.new(@client.node, {})
-      @recipe = Chef::Recipe.new(nil, nil, @run_context)
-      @recipe.from_string(recipe_string)
+      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)
     end
 
     # Run Chef in standalone mode, apply recipe
@@ -21,7 +24,7 @@ module Sandwich
     #        +fatal+)
     # @return [void]
     def run(log_level = :warn)
-      Chef::Log.level = log_level
+      configure_chef(log_level)
       Chef::Runner.new(@run_context).converge
     end
 
@@ -32,5 +35,22 @@ module Sandwich
       client.run_ohai
       client.build_node
     end
+
+    def configure_chef(log_level)
+      Chef::Log.level = log_level
+
+      # don't try to write to /var as non-root user
+      unless ENV['USER'] == 'root'
+        local_cache = File.join(ENV['HOME'], '.cache', 'sandwich')
+        Chef::Config[:cache_options][:path] = File.join(local_cache, 'cache')
+        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.1.0'
+  Version = '0.2.0'
 end

metadata

@@ -1,8 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: chef-sandwich
 version: !ruby/object:Gem::Version 
-  prerelease: 
-  version: 0.1.0
+  hash: 23
+  prerelease: false
+  segments: 
+  - 0
+  - 2
+  - 0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Sebastian Boehm
@@ -10,10 +15,24 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-08-09 00:00:00 +02:00
+date: 2011-09-07 00:00:00 +02:00
 default_executable: 
-dependencies: []
-
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: chef
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 25
+        segments: 
+        - 0
+        - 9
+        version: "0.9"
+  type: :runtime
+  version_requirements: *id001
 description: |
   Sandwich lets you apply Chef recipes to your system without having to
   worry about cookbooks or configuration.
@@ -29,13 +48,15 @@ files:
 - Rakefile
 - README.md
 - LICENSE
+- NEWS
 - bin/sandwich
+- lib/sandwich.rb
+- lib/sandwich/version.rb
 - lib/sandwich/cli.rb
 - lib/sandwich/recipe.rb
+- lib/sandwich/cookbook_version.rb
 - lib/sandwich/runner.rb
-- lib/sandwich/version.rb
-- lib/sandwich.rb
-has_rdoc: true
+has_rdoc: yard
 homepage: https://github.com/sometimesfood/sandwich
 licenses: []
 
@@ -49,17 +70,23 @@ 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.6.2
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: The easiest way to get started as a chef