sprinkle 0.5.0 → 0.5.1

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 1.9.2
+  - 1.8.7
+  - ree

data/CREDITS

@@ -1,8 +1,10 @@
 = CREDITS
 
-Many thanks to the following people who have submitted ideas, patches, helped with testing
-and/or generally provided support to Sprinkle, I really appreciate your help:
+Many thanks to the following people who have submitted ideas, patches, helped with 
+testing and/or generally provided support to Sprinkle, I really appreciate your help:
 
+Koen Punt              (http://github.com/koenpunt)
+Manuel Meurer          (http://github.com/manuelmeurer)
 Kristin Baumann        (http://crafterm.net/kristin/blog/)
 Ben Schwarz            (http://germanforblack.com/)
 Jim Freeze             (http://www.artima.com/rubycs/articles/ruby_as_dslP.html)
@@ -31,4 +33,5 @@ Geoff Garside          (http://geoffgarside.co.uk/)
 Oliver Kiessler        (http://inceedo.com)
 Nick Plante            (http://blog.zerosum.org)
 
-The transfer installer contains a piece of exception reporting code copied from the Chef library (http://wiki.opscode.com/display/chef/Home)
+The transfer installer contains a piece of exception reporting code copied from 
+the Chef library (http://wiki.opscode.com/display/chef/Home)

data/README.md

@@ -6,6 +6,7 @@ its been created.
 
 [![Build Status](https://travis-ci.org/sprinkle-tool/sprinkle.png?branch=master)](https://travis-ci.org/sprinkle-tool/sprinkle)
 
+  * `#sprinkle` channel on the Freenode IRC Network
   * <http://redartisan.com/2008/5/27/sprinkle-intro>
   * <http://github.com/sprinkle-tool/sprinkle>
   * <http://github.com/benschwarz/passenger-stack>

data/bin/sprinkle

@@ -90,8 +90,7 @@ def verbosity(options)
 end
 
 def log_level(options)
-  severity = ActiveSupport::BufferedLogger::Severity
-  Object.logger.level = options[:verbose] ? severity::DEBUG : severity::INFO
+  Object.logger.level = OPTIONS[:verbose] ? Logger::Severity::DEBUG : Logger::Severity::INFO
 end
 
 require File.dirname(__FILE__) + '/../lib/sprinkle'

data/lib/sprinkle.rb

@@ -37,6 +37,9 @@ class Object
   include Sprinkle::Package, Sprinkle::Policy, Sprinkle::Deployment
 
   def logger # :nodoc:
-    @@__log__ ||= ActiveSupport::BufferedLogger.new($stdout, ActiveSupport::BufferedLogger::Severity::INFO)
+    # ActiveSupport::BufferedLogger was deprecated and replaced by ActiveSupport::Logger in Rails 4.
+    # Use ActiveSupport::Logger if available.
+    active_support_logger = defined?(ActiveSupport::Logger) ? ActiveSupport::Logger : ActiveSupport::BufferedLogger
+    @@__log__ ||= active_support_logger.new($stdout, active_support_logger::Severity::INFO)
   end
 end

data/lib/sprinkle/actors/actor.rb

@@ -0,0 +1,44 @@
+module Sprinkle
+  module Actors
+    # An actor is a method of command delivery to a remote machine. Actors are the
+    # layer setting between Sprinkle and the systems you and wanting to apply
+    # policies to.  All actors should inherit from Sprinkle::Actors::Actor. 
+    #
+    # Sprinkle ships with actors for Capistrano, Vlad, localhost and pure SSH.
+    # 99% of the time these should be sufficient but you can always write your 
+    # own actor otherwise. 
+    #
+    # == Writing an actor
+    #
+    # Actors must provide only 3 methods:
+    # 
+    # * install (installer, roles, options)
+    # * verify (verifier, roles, options)
+    # * servers_for_role? (roles)
+    #
+    # Hopefully these methods are kind of fairly obvious.  They should return true
+    # to indicate success and false to indicate failure.
+    # The actual commands you need to execute can be retrived from 
+    # +installer.install_sequence+ and +verifier.commands+.  
+    class Actor
+      
+      # an actor must define this method so that each policy can ask the actor
+      # if there are any servers with that policy's roles so the policy knows
+      # whether it should execute or not
+      #
+      # input: a single role or array of roles
+      def servers_for_role?(r)
+        raise "please define servers_for_role?"
+      end
+      
+      def install(*args)
+        raise "you must define install"
+      end
+      
+      def verify(*args)
+        raise "you must define verify"
+      end
+      
+    end
+  end
+end

data/lib/sprinkle/actors/capistrano.rb

@@ -17,7 +17,7 @@ module Sprinkle
     # Recipes is given a list of files which capistrano will include and load.
     # These recipes are mainly to set variables such as :user, :password, and to 
     # set the app domain which will be sprinkled. 
-    class Capistrano
+    class Capistrano < Actor
       attr_accessor :config, :loaded_recipes #:nodoc:
 
       def initialize(&block) #:nodoc:
@@ -37,6 +37,13 @@ module Sprinkle
           @config.load 'deploy' # normally in the config directory for rails
         end
       end
+      
+      # Determines if there are any servers for the given roles
+      def servers_for_role?(roles)
+        roles=Array(roles)
+        roles.any? { |r| @config.roles.keys.include? (r) }
+      end
+      
 
       # Defines a recipe file which will be included by capistrano. Use these
       # recipe files to set capistrano specific configurations. Default recipe

data/lib/sprinkle/actors/dummy.rb

@@ -3,24 +3,7 @@ require 'pp'
 
 module Sprinkle
   module Actors
-    # = Capistrano Delivery Method
-    #
-    # Capistrano is one of the delivery method options available out of the
-    # box with Sprinkle. If you have the capistrano gem install, you may use
-    # this delivery. The only configuration option available, and which is 
-    # mandatory to include is +recipes+. An example:
-    #
-    #   deployment do
-    #     delivery :capistrano do
-    #       recipes 'deploy'
-    #     end
-    #   end
-    #
-    # Recipes is given a list of files which capistrano will include and load.
-    # These recipes are mainly to set variables such as :user, :password, and to 
-    # set the app domain which will be sprinkled. 
-    class Dummy #:nodoc:
-      attr_accessor :config, :loaded_recipes #:nodoc:
+    class Dummy < Actor #:nodoc:
 
       def initialize(&block) #:nodoc:
         # @config.set(:_sprinkle_actor, self)
@@ -28,26 +11,17 @@ module Sprinkle
         self.instance_eval &block
       end
 
-      # Defines a recipe file which will be included by capistrano. Use these
-      # recipe files to set capistrano specific configurations. Default recipe
-      # included is "deploy." But if any other recipe is specified, it will
-      # include that instead. Multiple recipes may be specified through multiple
-      # recipes calls, an example:
-      #
-      #   deployment do
-      #     delivery :capistrano do
-      #       recipes 'deploy'
-      #       recipes 'magic_beans'
-      #     end
-      #   end
-      # def recipes(script)
-      # end
-      
       def role(role, server, opts={})
         @roles[role]||=[]
         @roles[role] << [ server, opts ]
       end
       
+      # Determines if there are any servers for the given roles
+      def servers_for_role?(roles)
+        roles=Array(roles)
+        roles.any? { |r| @roles.keys.include? (r) }
+      end
+      
       def install(installer, roles, opts={})
         if per_host=opts.delete(:per_host)
           servers_per_role(roles).each do |server|
@@ -74,54 +48,6 @@ module Sprinkle
         # return false if suppress_and_return_failures
         true
       end
-
-      def transfer(name, source, destination, roles, recursive = true, suppress_and_return_failures = false)
-        
-      end
-			
-      private
-
-        # REVISIT: can we set the description somehow?
-        def define_task(name, roles, &block)
-          @config.task task_sym(name), :roles => roles, &block
-        end
-
-        def run(task)
-          @config.send task_sym(task)
-        end
-
-        def task_sym(name)
-          "install_#{name.to_task_name}".to_sym
-        end
     end
   end
-end
-
-
-=begin
-
-# channel: the SSH channel object used for this response
-# stream: either :err or :out, for stderr or stdout responses
-# output: the text that the server is sending, might be in chunks
-run "apt-get update" do |channel, stream, output|
-   if output =~ /Are you sure?/
-     answer = Capistrano::CLI.ui.ask("Are you sure: ")
-     channel.send_data(answer + "\n")
-   else
-     # allow the default callback to be processed
-     Capistrano::Configuration.default_io_proc.call[channel, stream, output]
-   end
- end
-
-
-
- You can tell subversion to use a different username+password by
- setting a couple variables:
-    set :svn_username, "my svn username"
-    set :svn_password, "my svn password"
- If you don't want to set the password explicitly in your recipe like
- that, you can make capistrano prompt you for it like this:
-    set(:svn_password) { Capistrano::CLI.password_prompt("Subversion
- password: ") }
- - Jamis
-=end
+end

data/lib/sprinkle/actors/local.rb

@@ -16,10 +16,14 @@ module Sprinkle
     #
     # Note: The local actor completely ignores roles and behaves as if your
     # local system was a member of all roles defined.
-    class Local
+    class Local < Actor
       
       class LocalCommandError < StandardError; end
       
+      def servers_for_role?
+        true
+      end
+      
       def install(installer, roles, opts = {}) #:nodoc:
         # all local installer cares about is the commands
         @installer = installer

data/lib/sprinkle/actors/ssh.rb

@@ -25,7 +25,7 @@ module Sprinkle
     #       gateway "work.sshgateway.com"
     #     end
     #   end
-    class SSH
+    class SSH < Actor
       attr_accessor :options #:nodoc:
       
       class SSHCommandFailure < StandardError #:nodoc:
@@ -43,7 +43,7 @@ module Sprinkle
       
       def initialize(options = {}, &block) #:nodoc:
         @options = options.update(:user => 'root')
-        @roles = {}
+        @roles = {}.with_indifferent_access
         @connection_cache = SSHConnectionCache.new
         self.instance_eval &block if block
         raise "You must define at least a single role." if @roles.empty?
@@ -55,6 +55,12 @@ module Sprinkle
       def roles(roles)
         @roles = roles
       end
+      
+      # Determines if there are any servers for the given roles
+      def servers_for_role?(roles)
+        roles=Array(roles)
+        roles.any? { |r| @roles.keys.include? (r) }
+      end
 
       # Define a role and add servers to it
       #   

data/lib/sprinkle/actors/vlad.rb

@@ -16,12 +16,17 @@ module Sprinkle
     # script is given a list of files which vlad will include and load.
     # These recipes are mainly to set variables such as :user, :password, and to 
     # set the app domain which will be sprinkled.
-    class Vlad
+    class Vlad < Actor
       attr_accessor :loaded_recipes #:nodoc:
 
       def initialize(&block) #:nodoc:
         self.instance_eval &block if block
       end
+      
+      def servers_for_role?
+        raise "The vlad actor needs a maintainer.  "+
+        "Please file an issue on github.com/sprinkle-tool/sprinkle if you can help."
+      end
 
       # Defines a script file which will be included by vlad. Use these
       # script files to set vlad specific configurations. Multiple scripts

data/lib/sprinkle/installers/installer.rb

@@ -82,11 +82,15 @@ module Sprinkle
       def sudo_cmd
         "sudo " if sudo?
       end
-      
+
       def sudo?
         options[:sudo] or package.sudo?
       end
-            
+
+      def escape_shell_arg(str)
+        str.gsub("'", "'\\\\''").gsub("/", "\\\\/").gsub("\n", '\n').gsub('&', '\\\&')
+      end
+
       def pre(stage, *commands)
         @pre[stage] ||= []
         @pre[stage] += commands

data/lib/sprinkle/installers/push_text.rb

@@ -47,12 +47,20 @@ module Sprinkle
         @path = path
       end
 
+      def announce
+        log "--> Append '#{@text}' to file #{@path}"
+      end
+
       protected
 
         def install_commands #:nodoc:
-          "#{"#{sudo_cmd}grep \"^#{@text.gsub("'", "'\\\\''").gsub("\n", '\n')}$\" #{@path} || " if option?(:idempotent) }/bin/echo -e '#{@text.gsub("'", "'\\\\''").gsub("\n", '\n')}' |#{sudo_cmd}tee -a #{@path}"
+          escaped_text = escape_shell_arg(@text)
+          escaped_regex = Regexp.escape(@text)
+          command = ""
+          command << "#{sudo_cmd}grep -qPzo '^#{escaped_regex}$' #{@path} || " if option?(:idempotent)
+          command << "/bin/echo -e '#{escaped_text}' |#{sudo_cmd}tee -a #{@path}"
+          command
         end
-
     end
   end
 end

data/lib/sprinkle/installers/replace_text.rb

@@ -13,7 +13,7 @@ module Sprinkle
     #   end
     #
     # If you user has access to 'sudo' and theres a file that requires
-    # priveledges, you can pass :sudo => true 
+    # privileges, you can pass :sudo => true 
     #
     #   package :magic_beans do
     #     replace_text 'Port 22', 'Port 2500', '/etc/ssh/sshd_config', :sudo => true
@@ -46,7 +46,7 @@ module Sprinkle
       protected
       
         def install_commands #:nodoc:
-          "#{'sudo ' if option?(:sudo)}sed -i 's/#{@regex.gsub("'", "'\\\\''").gsub("/", "\\\\/").gsub("\n", '\n')}/#{@text.gsub("'", "'\\\\''").gsub("/", "\\\\/").gsub("\n", '\n')}/g' #{@path}"
+          "#{sudo_cmd}sed -i 's/#{escape_shell_arg(@regex)}/#{escape_shell_arg(@text)}/g' #{@path}"
         end
 
     end

data/lib/sprinkle/policy.rb

@@ -49,7 +49,18 @@ module Sprinkle
       POLICIES << p
       p
     end
-
+    
+    class NoMatchingServersError < StandardError #:nodoc:
+      def initialize(name, roles)
+        @name = name
+        @roles = roles
+      end
+      
+      def to_s
+        "Policy #{@name} is to be installed on #{@roles.inspect} but no server has such a role."
+      end
+    end
+    
     class Policy #:nodoc:
       attr_reader :name, :roles
 
@@ -73,6 +84,8 @@ module Sprinkle
       def to_s; name; end
 
       def process(deployment)
+        raise NoMatchingServersError.new(@name, @roles) unless deployment.style.servers_for_role?(@roles)
+        
         all = []
         
         logger.info "[#{name}]"

data/lib/sprinkle/version.rb

@@ -1,3 +1,3 @@
 module Sprinkle
-  Version = "0.5"
+  Version = "0.5.1"
 end

data/spec/spec_helper.rb

@@ -3,7 +3,10 @@ require 'sprinkle'
 
 class Object
   def logger
+    # ActiveSupport::BufferedLogger was deprecated and replaced by ActiveSupport::Logger in Rails 4.
+    # Use ActiveSupport::Logger if available.
+    active_support_logger = defined?(ActiveSupport::Logger) ? ActiveSupport::Logger : ActiveSupport::BufferedLogger
     @@__log_file__ ||= StringIO.new
-    @@__log__ = ActiveSupport::BufferedLogger.new @@__log_file__, ActiveSupport::BufferedLogger::Severity::INFO
+    @@__log__ = active_support_logger.new @@__log_file__, active_support_logger::Severity::INFO
   end
 end

data/spec/sprinkle/installers/installer_spec.rb

@@ -69,7 +69,7 @@ describe Sprinkle::Installers::Installer do
 
       before do
         Sprinkle::OPTIONS[:testing] = true
-        @logger = mock(ActiveSupport::BufferedLogger, :debug => true, :debug? => true)
+        @logger = mock(:debug => true, :debug? => true)
       end
 
       it 'should not invoke the delivery mechanism with the install sequence' do

data/spec/sprinkle/installers/push_text_spec.rb

@@ -39,7 +39,22 @@ describe Sprinkle::Installers::PushText do
         @install_commands = @installer.send :install_commands
       end
       it "should grep for existing of the string" do
-        @install_commands.should == %q[grep "^another-hair-brained-idea$" /dev/mind/late-night || /bin/echo -e 'another-hair-brained-idea' |tee -a /dev/mind/late-night]
+        @install_commands.should == %q<grep -qPzo '^another\-hair\-brained\-idea$' /dev/mind/late-night || /bin/echo -e 'another-hair-brained-idea' |tee -a /dev/mind/late-night>
+      end
+    end
+    
+    describe 'with multiline idempotent' do
+      before do
+        mline = <<-MULTI
+^search( [adnor]{2,3} rescue)?$
+^fries( [adnor]{2,3} barbecue)?
+^songs( [adnor]{2,3} autocue)?
+MULTI
+        @installer = create_text mline.strip, '/dev/mind/late-night', :idempotent => true
+        @install_commands = @installer.send :install_commands
+      end
+      it "should grep for existence of the string" do
+        @install_commands.should == %q<grep -qPzo '^\^search\(\ \[adnor\]\{2,3\}\ rescue\)\?\$\n\^fries\(\ \[adnor\]\{2,3\}\ barbecue\)\?\n\^songs\(\ \[adnor\]\{2,3\}\ autocue\)\?$' /dev/mind/late-night || /bin/echo -e '^search( [adnor]{2,3} rescue)?$\n^fries( [adnor]{2,3} barbecue)?\n^songs( [adnor]{2,3} autocue)?' |tee -a /dev/mind/late-night>
       end
     end
     

data/spec/sprinkle/installers/replace_text_spec.rb

@@ -3,8 +3,7 @@ require File.expand_path("../../spec_helper", File.dirname(__FILE__))
 describe Sprinkle::Installers::ReplaceText do
 
   before do
-    @package = mock(Sprinkle::Package, :name => 'package')
-    @options = {:sudo => true}
+    @package = mock(Sprinkle::Package, :name => 'package', :sudo? => false)
   end
 
   def create_replacement_text(regex, text, path, options={}, &block)
@@ -20,6 +19,13 @@ describe Sprinkle::Installers::ReplaceText do
       @installer.path.should == '/etc/example/foo.conf'
     end
 
+    it 'should not escape original search string and replacement' do
+      @installer = create_replacement_text "some option with 'quotes' & ampersand", "other 'quotes' & ampersand", '/etc/example/foo.conf'
+      @installer.regex.should == %q[some option with 'quotes' & ampersand]
+      @installer.text.should == %q[other 'quotes' & ampersand]
+      @installer.path.should == '/etc/example/foo.conf'
+    end
+
   end
 
   describe 'during installation' do
@@ -40,6 +46,10 @@ describe Sprinkle::Installers::ReplaceText do
       @installer.send(:install_sequence).should == [ 'op1', "sed -i 's/bad option/super option/g' /etc/brand/new.conf", 'op2' ]
     end
 
+    it 'should correctly escape search string and replacement' do
+      installer = create_replacement_text "some option with 'quotes' & ampersand", "other 'quotes' & ampersand", '/etc/example/foo.conf'
+      installer.send(:install_commands).should == "sed -i 's/some option with '\\''quotes'\\'' \\& ampersand/other '\\''quotes'\\'' \\& ampersand/g' /etc/example/foo.conf"
+    end
   end
 
 end

data/spec/sprinkle/package_spec.rb

@@ -352,7 +352,7 @@ CODE
       @pkg.installers = [ @installer ]
       @installer.stub!(:defaults)
       @installer.stub!(:process)
-      @logger = mock(ActiveSupport::BufferedLogger, :debug => true, :debug? => true)
+      @logger = mock(:debug => true, :debug? => true)
       @logger.stub!(:info)
     end
 

data/spec/sprinkle/policy_spec.rb

@@ -6,6 +6,17 @@ describe Sprinkle::Policy do
   before do
     @name = 'a policy'
   end
+  
+  describe 'with a role with no matching servers' do
+    before do
+      @policy = policy @name, :roles => :app do; end
+    end
+    
+    it "should raise an error" do
+      @deployment = mock(:style => Sprinkle::Actors::Dummy.new {})
+      lambda { @policy.process(@deployment) }.should raise_error(Sprinkle::Policy::NoMatchingServersError)
+    end
+  end
 
   describe 'when created' do
 
@@ -46,6 +57,8 @@ describe Sprinkle::Policy do
 
     before do
       @deployment = mock(Sprinkle::Deployment)
+      actor = mock(:servers_for_role? => true)
+      @deployment.stub!(:style).and_return(actor)
       Sprinkle::Package::PACKAGES.clear # reset full package list before each spec is run
 
       @a = package :a do; requires :b; requires :c; end
@@ -125,6 +138,8 @@ describe Sprinkle::Policy, 'with missing packages' do
 
   before do
     @deployment = mock(Sprinkle::Deployment)
+    actor = mock(:servers_for_role? => true)
+    @deployment.stub!(:style).and_return(actor)
     Sprinkle::Package::PACKAGES.clear # reset full package list before each spec is run
 
     @policy = policy :test, :roles => :app do; requires :z; end

data/spec/sprinkle/sprinkle_spec.rb

@@ -15,11 +15,14 @@ describe Sprinkle do
   it 'should automatically create a logger object on Kernel' do
     Object.should respond_to(:logger)
     logger.should_not be_nil
-    logger.class.should == ActiveSupport::BufferedLogger
+    # ActiveSupport::BufferedLogger was deprecated and replaced by ActiveSupport::Logger in Rails 4.
+    # Use ActiveSupport::Logger if available
+    active_support_logger = defined?(ActiveSupport::Logger) ? ActiveSupport::Logger : ActiveSupport::BufferedLogger
+    logger.class.should == active_support_logger
   end
 
   it 'should create a logger of level INFO' do
-    logger.level.should == ActiveSupport::BufferedLogger::Severity::INFO
+    logger.level.should == Logger::Severity::INFO
   end
 
 end

data/spec/sprinkle/verify_spec.rb

@@ -180,7 +180,7 @@ describe Sprinkle::Verify do
     describe 'when testing' do
       before do
         Sprinkle::OPTIONS[:testing] = true
-        @logger = mock(ActiveSupport::BufferedLogger, :debug => true, :debug? => true)
+        @logger = mock(:debug => true, :debug? => true)
       end
 
       it 'should not call process on the delivery' do

data/sprinkle.gemspec

@@ -1,6 +1,8 @@
+require "./lib/sprinkle/version"
+
 Gem::Specification.new do |s|
   s.name = "sprinkle"
-  s.version = "0.5.0"
+  s.version = Sprinkle::Version
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Marcus Crafter", "Josh Goebel"]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sprinkle
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.5.1
   prerelease: 
 platform: ruby
 authors:
@@ -133,6 +133,7 @@ extra_rdoc_files:
 - README.md
 files:
 - .gitignore
+- .travis.yml
 - CREDITS
 - Gemfile
 - Gemfile.lock
@@ -161,7 +162,7 @@ files:
 - examples/rails/rails.rb
 - examples/sprinkle/sprinkle.rb
 - lib/sprinkle.rb
-- lib/sprinkle/actors/actors.rb
+- lib/sprinkle/actors/actor.rb
 - lib/sprinkle/actors/capistrano.rb
 - lib/sprinkle/actors/dummy.rb
 - lib/sprinkle/actors/local.rb

data/lib/sprinkle/actors/actors.rb

@@ -1,32 +0,0 @@
-#--
-# The only point of this file is to give RDoc a definition for
-# Sprinkle::Actors. This file in production is never actually included
-# since ActiveSupport only on-demand loads classes which are needed
-# and this module is never explicitly needed.
-#++
-
-module Sprinkle
-  # An actor is a method of command delivery to a remote machine. Actors are the
-  # layer setting between Sprinkle and the systems you and wanting to apply
-  # policies to.  
-  #
-  # Sprinkle ships with actors for Capistrano, Vlad, localhost and pure SSH.
-  # 99% of the time these should be sufficient but you can always write your 
-  # own actor otherwise. 
-  #
-  # == Writing an actor
-  #
-  # Actors must provide only 3 methods:
-  # 
-  # * install (installer, roles, options)
-  # * verify (verifier, roles, options)
-  # * transfer (source, destination, roles, options)
-  #
-  # Hopefully these methods are kind of fairly obvious.  They should return true
-  # to indicate success and false to indicate failure.
-  # The actual commands you need to execute can be retrived from 
-  # +installer.install_sequence+ and +verifier.commands+.  
-  
-  module Actors
-  end
-end