sous_chef 0.0.1 → 0.0.2

data/README.rdoc

@@ -2,5 +2,99 @@
 
 Chef's prep-cook
 
+== Description
+
 Create bash scripts with chef-like syntax
 
+== Example
+
+Given this code:
+
+    config = {:dir => '/home'}
+
+    SousChef.prep(:verbose, :shebang) do
+      halt_on_failed_command
+
+      log do
+        stdout "/root/stdout.log"
+        stderr "/root/stderr.log"
+      end
+
+      file "/etc/config.yml" do
+        content config.to_yaml
+        mode 0600
+      end
+
+      execute 'rvm' do
+        creates "/usr/local/rvm/scripts/rvm"
+        command "gem install rvm && rvm-install"
+      end
+
+      execute "source rvm" do
+        command <<-EOS
+    RUBYOPT=""
+    source /usr/local/rvm/scripts/rvm
+        EOS
+      end
+
+      gemfile config[:dir] do
+        source "http://gemcutter.org/"
+
+        gem 'chef'
+        gem 'dbi',          '0.4.3'
+        gem 'dbd-mysql',    '0.4.3'
+        gem 'open4',        '0.9.6'
+      end
+
+      execute 'install bundler' do
+        command "gem install bundler --no-ri --no-rdoc"
+      end
+
+      execute 'bundle gems' do
+        cwd config[:dir]
+        command "gem bundle"
+      end
+    end
+
+the return value will be:
+
+    #!/bin/bash
+
+    # halt on failed command
+    set -e
+
+    exec 1>/root/stdout.log 2>/root/stderr.log
+
+    # /etc/config.yml
+    if ! test -e /etc/config.yml; then
+      echo '--- 
+    :dir: /home
+    ' > /etc/config.yml
+    fi
+    chmod 0600 /etc/config.yml
+
+    # rvm
+    if ! test -e /usr/local/rvm/scripts/rvm; then
+      gem install rvm && rvm-install
+    fi
+
+    # source rvm
+    RUBYOPT=""
+    source /usr/local/rvm/scripts/rvm
+
+    # /home
+    if ! test -e /home/Gemfile; then
+      echo 'source "http://gemcutter.org/"
+
+    gem "chef"
+    gem "dbd-mysql", "0.4.3"
+    gem "dbi",       "0.4.3"
+    gem "open4",     "0.9.6"' > /home/Gemfile
+    fi
+
+    # install bundler
+    gem install bundler --no-ri --no-rdoc
+
+    # bundle gems
+    cd /home
+    gem bundle

data/VERSION.yml

@@ -1,5 +1,5 @@
 --- 
-:major: 0
 :minor: 0
-:patch: 1
-
+:build: 
+:patch: 2
+:major: 0

data/lib/sous_chef/recipe.rb

@@ -32,7 +32,8 @@ module SousChef
           script << %{# #{resource.name}\n} if verbose? && resource.name
           script << resource.to_script
         end
-        lines.join("\n\n")
+        # add a trailing newline for consistency and vim-friendliness
+        lines.join("\n\n") << "\n"
       end
     end
 
@@ -98,9 +99,12 @@ module SousChef
       end
 
       def escape_string(string)
-        # many slashes because single-quote has some sort of
-        # special meaning in regexp replacement strings
-        string && string.gsub(/'/, %q{\\\\'})
+        # bash is completely insane
+        # this stops the quote, immediately starts another one using
+        # double quotes to insert the single quote, then resumes the
+        # single quote again until the terminating single quote
+        return if string.nil?
+        string.gsub("'", %q{'"'"'})
       end
 
       def method_missing(meth, *args, &block)

data/lib/sous_chef/resource/execute.rb

@@ -9,6 +9,7 @@ module SousChef
 
       def to_script
         @script ||= begin
+          setup
           prepend %{cd #{escape_path(@cwd)}} if @cwd
           @commands = @commands.inject([]) do |result, line|
             result + line.split("\n")

data/lib/sous_chef/resource/file.rb

@@ -7,7 +7,7 @@ module SousChef
 
       protected
         def escaped_content
-          escape_string(content)
+          content#.gsub('$', '\$')
         end
 
         def create
@@ -24,9 +24,21 @@ module SousChef
           %{test -e #{escape_path(path)}}
         end
 
+        def heredoc
+          @heredoc ||= begin
+            candidate = "SousChefHeredoc"
+            candidate += "1" while content.include?(candidate)
+            candidate
+          end
+        end
+
         def create_file_command
           if content
-            %{echo '#{escaped_content}' > #{escape_path(path)}}
+            lines = []
+            lines << "cat <<'#{heredoc}' > #{escape_path(path)}"
+            lines << escaped_content
+            lines << heredoc
+            lines.join("\n")
           else
             %{touch #{escape_path(path)}}
           end

data/spec/fixtures/deploy_command_expected.sh

@@ -7,9 +7,11 @@ if test -e /root/report.log; then
 fi
 
 if ! test -e /etc/config.yml; then
-  echo '--- {}
+  cat <<'SousChefHeredoc' > /etc/config.yml
+--- {}
 
-' > /etc/config.yml
+
+SousChefHeredoc
 fi
 chmod 0600 /etc/config.yml
 
@@ -23,10 +25,12 @@ source /usr/local/rvm/scripts/rvm
 
 if ! test -e /etc/profile.d/rvm.sh; then
   echo 'Setting up rvm source'
-  echo '# rvm configuration
+  cat <<'SousChefHeredoc' > /etc/profile.d/rvm.sh
+# rvm configuration
 RUBYOPT=""
 if [[ -s /usr/local/rvm/scripts/rvm ]] ; then source /usr/local/rvm/scripts/rvm ; fi
-' > /etc/profile.d/rvm.sh
+
+SousChefHeredoc
 fi
 
 echo 'installing ruby'
@@ -49,12 +53,14 @@ mkdir -p /home/sous_chef
 chmod 0755 /home/sous_chef
 
 if ! test -e /home/sous_chef/Gemfile; then
-  echo 'source "http://gemcutter.org/"
+  cat <<'SousChefHeredoc' > /home/sous_chef/Gemfile
+source "http://gemcutter.org/"
 
 gem "chef"
 gem "dbd-mysql", "0.4.3"
 gem "dbi",       "0.4.3"
-gem "open4",     "0.9.6"' > /home/sous_chef/Gemfile
+gem "open4",     "0.9.6"
+SousChefHeredoc
 fi
 
 gem install bundler --no-ri --no-rdoc
@@ -64,9 +70,11 @@ gem bundle
 
 if ! test -e /etc/profile.d/bin-path.sh; then
   echo 'Setting up bin-path'
-  echo '# bundled gem bin path configuration
+  cat <<'SousChefHeredoc' > /etc/profile.d/bin-path.sh
+# bundled gem bin path configuration
 export PATH=/home/sous_chef/bin:$PATH
-' > /etc/profile.d/bin-path.sh
+
+SousChefHeredoc
 fi
 
 nohup /home/sous_chef/bin/chef --main &

data/spec/recipe_spec.rb

@@ -16,7 +16,7 @@ describe SousChef::Recipe do
       end
 
       it "includes comments" do
-        @recipe.to_script.should == "# run ls\nls"
+        @recipe.to_script.should == "# run ls\nls\n"
       end
     end
 
@@ -34,7 +34,7 @@ describe SousChef::Recipe do
       end
 
       it "includes a shebang line" do
-        @recipe.to_script.should == "#!/bin/bash\n\nls"
+        @recipe.to_script.should == "#!/bin/bash\n\nls\n"
       end
     end
   end
@@ -56,7 +56,7 @@ describe SousChef::Recipe do
     end
 
     it "loads a recipe from a file" do
-      @recipe.to_script.should == File.read(File.dirname(__FILE__) + '/fixtures/deploy_command_expected.sh').strip
+      @recipe.to_script.should == File.read(File.dirname(__FILE__) + '/fixtures/deploy_command_expected.sh')
     end
   end
 end

data/spec/resource/execute_spec.rb

@@ -1,37 +1,21 @@
 require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
 
 describe SousChef::Resource::Execute do
-  before do
-    @execute = SousChef::Resource::Execute.new(nil, "install bundler") do
-      command "gem install bundler"
+  it "formats multiline commands that are wrapped in not_if" do
+    execute = resource("clone sous_chef") do
+      command <<-EOS
+git clone git://github.com/engineyard/sous_chef.git
+cd sous_chef
+gem bundle
+EOS
+      not_if 'test -d sous_chef'
     end
-  end
-
-  it "has a name" do
-    @execute.name.should == "install bundler"
-  end
-
-  it "responds to a method its context responds to" do
-    @context = stub(:foobar => 5)
-    @execute = SousChef::Resource::Execute.new(@context, "install bundler") do
-      command "gem install bundler"
-    end
-    @execute.should respond_to(:foobar)
-  end
-
-  it "delegates missing methods to its context when it responds" do
-    @context = stub(:foobar => 5)
-    @execute = SousChef::Resource::Execute.new(@context, "install bundler") do
-      command "gem install bundler"
-    end
-    @execute.foobar.should == 5
-  end
-
-  it "does not resource_respond_to? a method its context responds to" do
-    @context = stub(:foobar => 5)
-    @execute = SousChef::Resource::Execute.new(@context, "install bundler") do
-      command "gem install bundler"
-    end
-    @execute.should_not be_resource_respond_to(:foobar)
+    execute.to_script.should == %{
+if ! test -d sous_chef; then
+  git clone git://github.com/engineyard/sous_chef.git
+  cd sous_chef
+  gem bundle
+fi
+    }.strip
   end
 end

data/spec/resource/file_spec.rb

@@ -35,10 +35,12 @@ describe SousChef::Resource::File do
     @file.content.should == nil
   end
 
-  it "echos content to file" do
+  it "cats content to file" do
     @file.to_script.should == %{
 if ! test -e note.txt; then
-  echo 'this is a note' > note.txt
+  cat <<'SousChefHeredoc' > note.txt
+this is a note
+SousChefHeredoc
 fi
     }.strip
   end
@@ -49,7 +51,9 @@ fi
     end
     @file.to_script.should == %q{
 if ! test -e note.txt; then
-  echo 'this is a \'note\'' > note.txt
+  cat <<'SousChefHeredoc' > note.txt
+this is a 'note'
+SousChefHeredoc
 fi
     }.strip
   end
@@ -58,11 +62,26 @@ fi
     @file = resource("note.txt") do
       content %{export PATH=/my/bin:$PATH}
     end
-    @file.to_script.should == %q{
+    @file.to_script.should == <<-EOSH.chomp
 if ! test -e note.txt; then
-  echo 'export PATH=/my/bin:$PATH' > note.txt
+  cat <<'SousChefHeredoc' > note.txt
+export PATH=/my/bin:$PATH
+SousChefHeredoc
 fi
-    }.strip
+    EOSH
+  end
+
+  it "changes it's heredoc if the content of the file contains the heredoc" do
+    @file = resource("note.txt") do
+      content %{SousChefHeredoc}
+    end
+    @file.to_script.should == <<-EOSH.chomp
+if ! test -e note.txt; then
+  cat <<'SousChefHeredoc1' > note.txt
+SousChefHeredoc
+SousChefHeredoc1
+fi
+    EOSH
   end
 
   it "handles newlines in the content" do
@@ -75,16 +94,18 @@ a
 NOTE
       EOS
     end
-    @file.to_script.should == %q{
+    @file.to_script.should == <<-EOSH.chomp
 if ! test -e note.txt; then
-  echo 'This
+  cat <<'SousChefHeredoc' > note.txt
+This
 is
 
 a
 NOTE
-' > note.txt
+
+SousChefHeredoc
 fi
-    }.strip
+    EOSH
   end
 
   it "outputs the path instead of the name if it exists" do
@@ -94,7 +115,9 @@ fi
     end
     @file.to_script.should == %q{
 if ! test -e /home/user/note.txt; then
-  echo 'this is a note' > /home/user/note.txt
+  cat <<'SousChefHeredoc' > /home/user/note.txt
+this is a note
+SousChefHeredoc
 fi
     }.strip
   end

data/spec/sous_spec.rb

@@ -8,7 +8,7 @@ describe SousChef do
           command "ls"
         end
       end
-      script.should == "ls"
+      script.should == "ls\n"
     end
 
     it "concatenates multiple commands" do
@@ -18,7 +18,7 @@ describe SousChef do
           command "tar xvfz file.tgz"
         end
       end
-      script.should == "curl -O http://www.example.com/file.tgz\ntar xvfz file.tgz"
+      script.should == "curl -O http://www.example.com/file.tgz\ntar xvfz file.tgz\n"
     end
 
     it "respects multiline commands" do
@@ -30,7 +30,7 @@ tar xvfz file.tgz
           CODE
         end
       end
-      script.should == "curl -O http://www.example.com/file.tgz\ntar xvfz file.tgz"
+      script.should == "curl -O http://www.example.com/file.tgz\ntar xvfz file.tgz\n"
     end
 
     it "changes current working directory on cwd" do
@@ -39,7 +39,7 @@ tar xvfz file.tgz
           cwd "/home/user"
         end
       end
-      script.should == %{cd /home/user}
+      script.should == "cd /home/user\n"
     end
 
     it "changes the current working directory before any commands" do
@@ -49,7 +49,7 @@ tar xvfz file.tgz
           cwd "/home/user"
         end
       end
-      script.should == %{cd /home/user\ncp foo bar}
+      script.should == "cd /home/user\ncp foo bar\n"
     end
 
     it "can use a method defined within the prep block" do
@@ -62,7 +62,7 @@ tar xvfz file.tgz
           report "`date`"
         end
       end
-      script.should == %{echo `date`}
+      script.should == "echo `date`\n"
     end
 
     it "scopes cwd to the correct execute block" do
@@ -76,7 +76,7 @@ tar xvfz file.tgz
           command "gem bundle"
         end
       end
-      script.should == %{gem install bundler\n\ncd /data/projects/foo\ngem bundle}
+      script.should == "gem install bundler\n\ncd /data/projects/foo\ngem bundle\n"
     end
 
     it "wraps commands in an if block on not_if" do
@@ -87,12 +87,12 @@ tar xvfz file.tgz
           not_if "test -d /data/projects/foo/vendor"
         end
       end
-      script.should == %{
+      script.should == <<-EOSH
 if ! test -d /data/projects/foo/vendor; then
   cd /data/projects/foo
   gem bundle
 fi
-      }.strip
+      EOSH
     end
 
     it "wraps commands in an if block with test -e on creates" do
@@ -103,12 +103,12 @@ fi
           command "gem bundle"
         end
       end
-      script.should == %{
+      script.should == <<-EOSH
 if ! test -e /data/projects/foo/vendor; then
   cd /data/projects/foo
   gem bundle
 fi
-      }.strip
+      EOSH
     end
   end
 
@@ -120,11 +120,13 @@ fi
           content "export PATH=~/bin:$PATH"
         end
       end
-      script.should == %{
+      script.should == <<-EOSH
 if ! test -e ~/.bash_profile; then
-  echo 'export PATH=~/bin:$PATH' > ~/.bash_profile
+  cat <<'SousChefHeredoc' > ~/.bash_profile
+export PATH=~/bin:\$PATH
+SousChefHeredoc
 fi
-      }.strip
+      EOSH
     end
   end
 
@@ -133,7 +135,7 @@ fi
       script = SousChef.prep do
         directory "/usr/local/bin"
       end
-      script.should == %{mkdir -p /usr/local/bin}
+      script.should == "mkdir -p /usr/local/bin\n"
     end
   end
 
@@ -142,7 +144,7 @@ fi
       script = SousChef.prep do
         log "~/script.log"
       end
-      script.should == %{exec 1>~/script.log 2>&1}
+      script.should == "exec 1>~/script.log 2>&1\n"
     end
 
     it "allows logging stdout only" do
@@ -151,7 +153,7 @@ fi
           stdout "stdout.log"
         end
       end
-      script.should == %{exec 1>stdout.log}
+      script.should == "exec 1>stdout.log\n"
     end
 
     it "allows logging stdout and stderr" do
@@ -161,7 +163,7 @@ fi
           stderr "stderr.log"
         end
       end
-      script.should == %{exec 1>stdout.log 2>stderr.log}
+      script.should == "exec 1>stdout.log 2>stderr.log\n"
     end
   end
 
@@ -170,7 +172,7 @@ fi
       script = SousChef.prep do
         halt_on_failed_command
       end
-      script.should == %{set -e}
+      script.should == "set -e\n"
     end
   end
 
@@ -179,7 +181,7 @@ fi
       script = SousChef.prep do
         echo "I'm in bash!"
       end
-      script.should == %q{echo 'I\'m in bash!'}
+      script.should == %{echo 'I'"'"'m in bash!'\n}
     end
 
     it "echoes from anywhere" do
@@ -189,12 +191,14 @@ fi
           content "something"
         end
       end
-      script.should == %q{
+      script.should == <<-EOSH
 if ! test -e newfile.txt; then
-  echo 'I\'m in bash!'
-  echo 'something' > newfile.txt
+  echo 'I'"'"'m in bash!'
+  cat <<'SousChefHeredoc' > newfile.txt
+something
+SousChefHeredoc
 fi
-      }.strip
+      EOSH
     end
   end
 
@@ -206,12 +210,14 @@ fi
           gem "rack",  "1.0.0"
         end
       end
-      script.should == %q{
+      script.should == <<-EOSH
 if ! test -e /data/projects/foo/Gemfile; then
-  echo 'gem "rack",  "1.0.0"
-gem "rails", "2.3.2"' > /data/projects/foo/Gemfile
+  cat <<'SousChefHeredoc' > /data/projects/foo/Gemfile
+gem "rack",  "1.0.0"
+gem "rails", "2.3.2"
+SousChefHeredoc
 fi
-      }.strip
+      EOSH
     end
 
     it "can have sources" do
@@ -221,13 +227,15 @@ fi
           source 'http://gems.engineyard.com/'
         end
       end
-      script.should == %q{
+      script.should == <<-EOSH
 if ! test -e /data/projects/foo/Gemfile; then
-  echo 'source "http://gems.engineyard.com/"
+  cat <<'SousChefHeredoc' > /data/projects/foo/Gemfile
+source "http://gems.engineyard.com/"
 
-gem "rails"' > /data/projects/foo/Gemfile
+gem "rails"
+SousChefHeredoc
 fi
-      }.strip
+      EOSH
     end
   end
 
@@ -239,7 +247,7 @@ fi
         end
       end
       recipe.node = { :dir => '/home' }
-      recipe.to_script.should == "ls /home"
+      recipe.to_script.should == "ls /home\n"
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: sous_chef
 version: !ruby/object:Gem::Version 
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors: 
 - Martin Emde