sprinkle 0.7.6.2 → 0.7.7

data/Gemfile.lock

@@ -3,7 +3,7 @@ PATH
   specs:
     sprinkle (0.7.6.2)
       activesupport (>= 2.0.2)
-      capistrano (~> 2.5.5)
+      capistrano (>= 2.5.5, < 3)
       erubis (>= 2.7.0)
       highline (>= 1.4.0)
       open4 (>= 1.1.0)
@@ -28,12 +28,12 @@ GEM
       i18n (= 0.6.1)
       multi_json (~> 1.0)
     builder (3.0.4)
-    capistrano (2.5.21)
+    capistrano (2.15.5)
       highline
       net-scp (>= 1.0.0)
       net-sftp (>= 2.0.0)
       net-ssh (>= 2.0.14)
-      net-ssh-gateway (>= 1.0.0)
+      net-ssh-gateway (>= 1.1.0)
     coderay (1.0.9)
     diff-lcs (1.2.4)
     erubis (2.7.0)

data/bin/sprinkle

@@ -46,19 +46,19 @@ Options are:
 BANNER
   opts.separator ""
   opts.on("-s", "--script=PATH", String,
-          "Path to a sprinkle script to run") { |v| OPTIONS[:path] = v }
+          "path to a sprinkle script to run") { |v| OPTIONS[:path] = v }
   opts.on("--only [ROLE]", String,
-          "Only run sprinkle policies for the specified role") { |v| OPTIONS[:only_role] = v }
+          "only run sprinkle policies for given role") { |v| OPTIONS[:only_role] = v }
   opts.on("-t", "--test",
-          "Process but don't perform any actions") { |v| OPTIONS[:testing] = v }
-  opts.on("-v", "--verbose",
-          "Verbose output") { |v| OPTIONS[:verbose] = v }
+          "process but don't perform any actions","(this does not connect to any servers)") { |v| OPTIONS[:testing] = v }
   opts.on("-c", "--cloud",
-          "Show powder cloud, ie. package hierarchy and installation order") { |v| OPTIONS[:cloud] = v }
+          "show powder cloud, package hierarchy","and installation order") { |v| OPTIONS[:cloud] = v }
   opts.on("-f", "--force",
-          "Force installation of all packages even if it is detected that it has been previously installed") { |v| OPTIONS[:force] = v }
+          "force installation of all packages","by skipping pre-verify checks.") { |v| OPTIONS[:force] = v }
+  opts.on("-v", "--verbose",
+          "verbose output") { |v| OPTIONS[:verbose] = v }
   opts.on("-h", "--help",
-          "Show this help message.") { puts opts; exit }
+          "show this help message") { puts opts; exit }
   opts.parse!(ARGV)
 
   if MANDATORY_OPTIONS && MANDATORY_OPTIONS.find { |option| OPTIONS[option.to_sym].nil? }

data/lib/sprinkle/actors/capistrano.rb

@@ -25,6 +25,8 @@ module Sprinkle
         @config = ::Capistrano::Configuration.new
         @config.logger.level = Sprinkle::OPTIONS[:verbose] ? ::Capistrano::Logger::INFO : ::Capistrano::Logger::IMPORTANT
         @config.set(:password) { ::Capistrano::CLI.password_prompt }
+        # default sudo to false, we must turn it on
+        @config.set(:run_method) { @config.fetch(:use_sudo, false) ? :sudo : :run }
         
         @config.set(:_sprinkle_actor, self)
         
@@ -40,7 +42,7 @@ module Sprinkle
       end
       
       def sudo? #:nodoc:
-        @config.fetch(:run_method, :run) == :sudo
+        @config.fetch(:run_method) == :sudo
       end
       
       def sudo_command #:nodoc:
@@ -98,7 +100,7 @@ module Sprinkle
         @log_recorder = log_recorder = Sprinkle::Utility::LogRecorder.new
         commands = commands.map {|x| rewrite_command(x)}
         define_task(name, roles) do
-          via = fetch(:run_method, :run)
+          via = fetch(:run_method)
           commands.each do |command|
             if command.is_a? Commands::Transfer
               upload command.source, command.destination, :via => :scp, 
@@ -123,7 +125,7 @@ module Sprinkle
         # rip out any double sudos from the beginning of the command
         def rewrite_command(cmd)
           return cmd if cmd.is_a?(Symbol)
-          via = @config.fetch(:run_method, :run)
+          via = @config.fetch(:run_method)
           if via == :sudo and cmd =~ /^#{sudo_command}/
             cmd.gsub(/^#{sudo_command}\s?/,"")
           else

data/lib/sprinkle/installers/binary.rb

@@ -13,13 +13,13 @@ module Sprinkle
     # This example will download archive.tar.gz to /home/user/sources and then
     # extract it into /home/user/local.
     class Binary < Installer
-      
+
       api do
         def binary(source, options = {}, &block)
           install Binary.new(self, source, options, &block)
         end
       end
-      
+
       def initialize(parent, binary_archive, options = {}, &block) #:nodoc:
         @binary_archive = binary_archive
         super parent, options, &block
@@ -35,7 +35,7 @@ module Sprinkle
 
       def install_commands #:nodoc:
         commands = [ "bash -c 'wget -cq --directory-prefix=#{@options[:archives]} #{@binary_archive}'" ]
-        commands << "bash -c \"cd #{@options[:prefix]} && #{extract_command} '#{@options[:archives]}/#{archive_name}'\""
+        commands << "bash -c \"cd #{@options[:prefix]} && #{sudo_cmd} #{extract_command} '#{@options[:archives]}/#{archive_name}'\""
       end
 
       def archive_name #:nodoc:

data/lib/sprinkle/installers/gem.rb

@@ -49,7 +49,7 @@ module Sprinkle
         # rubygems 0.9.5+ installs dependencies by default, and does platform selection
 
         def install_commands #:nodoc:
-          cmd = "gem install #{gem}"
+          cmd = "#{sudo_cmd}gem install #{gem}"
           cmd << " --version '#{version}'" if version
           cmd << " --source #{source}" if source
           cmd << " --install-dir #{repository}" if option?(:repository)

data/lib/sprinkle/installers/group.rb

@@ -20,7 +20,7 @@ module Sprinkle
       
       verify_api do
         def has_group(group)
-          @commands << "id -g #{group}"
+          @commands << "egrep -i \"^#{group}:\" /etc/group"
         end
       end
       

data/lib/sprinkle/installers/installer.rb

@@ -14,7 +14,7 @@ module Sprinkle
     # pre/post installation hooks. This gives you the ability to specify
     # commands to run before and after an installation takes place.
     # There are three ways to specify a pre/post hook.
-
+    #
     # Note about sudo:
     # When using the Capistrano actor all commands by default are run using
     # sudo (unless your Capfile includes "set :use_sudo, false").  If you wish

data/lib/sprinkle/package.rb

@@ -143,7 +143,7 @@ module Sprinkle
         @verifications = []
         @install_queues ||= [[]]
         @block = block
-        @use_sudo = false
+        @use_sudo = nil
         @version = nil
         # this should probably not be done twice
         self.instance_eval(&block)
@@ -167,7 +167,7 @@ module Sprinkle
       end
 
       def sudo?
-        @use_sudo
+        !!@use_sudo
       end
 
       def use_sudo(flag=true)
@@ -204,14 +204,10 @@ module Sprinkle
       def verify(description = '', &block)
         @verifications << Sprinkle::Verify.new(self, description, &block)
       end
-
+      
       def process(deployment, roles)
-        logger.info "  * #{name}"
+        output_name
         return if meta_package?
-        opts.each_with_index do |(k, v), index|
-          branch = (index == opts.size - 1) ? "└" : "├"
-          logger.debug "    #{branch}─ #{k}: #{v}"
-        end
 
         # Run a pre-test to see if the software is already installed. If so,
         # we can skip it, unless we have the force option turned on!
@@ -246,7 +242,7 @@ module Sprinkle
 
         @verifications.each do |v|
           v.defaults(deployment)
-          v.process(roles)
+          v.process(roles, pre)
         end
       end
 
@@ -302,6 +298,18 @@ module Sprinkle
       end
 
     private
+    
+      def output_name
+        logger.info "  * #{name} #{output_arguments}" 
+        opts.each_with_index do |(k, v), index|
+          branch = (index == opts.size - 1) ? "└" : "├"
+          logger.debug "    #{branch}─ #{k}: #{v}"
+        end
+      end
+    
+      def output_arguments
+        (opts.empty? or Sprinkle::OPTIONS[:verbose]) ? "" :  opts.inspect.gsub(/^\{(.*)\}$/, "\\1" )
+      end
 
       def add_dependencies(packages, kind)
         opts = packages.extract_options!

data/lib/sprinkle/package/chooser.rb

@@ -7,13 +7,12 @@ module Sprinkle::Package
       else
         package = choose do |menu|
           menu.prompt = "Multiple choices exist for virtual package #{name}"
-          menu.choices( *packages.collect(&:to_s) )
+          packages.each do |pkg|
+            menu.choice(pkg.to_s) { pkg; }
+          end
         end
-        package = Sprinkle::Package::PACKAGES.first(package)
       end
-
       cloud_info "Selecting #{package.to_s} for virtual package #{name}"
-
       package
     end
 

data/lib/sprinkle/policy.rb

@@ -52,6 +52,31 @@ module Sprinkle
   # The capistrano and vlad syntax is the same for that. If you're using a
   # custom actor, you may have to do it differently.
   #
+  # == Requiring a package more than once with different options
+  #
+  # This works exactly as you might expect:
+  #
+  #   policy :bootstrap, :roles => :app do
+  #     require :user_settings, :for => "john"
+  #     require :user_settings, :for => "suzy"
+  #     require :user_settings, :for => "dorothy"
+  #   end
+  #
+  # Multiple requires for a package with no options will be 
+  # collapsed; that package will be installed once.
+  #
+  #   policy :apache, :roles => :app do
+  #     require :devtools
+  #     ...
+  #   end
+  #   policy :git, :roles => :app do
+  #     require :devtools
+  #     ...
+  #   end
+  # 
+  # In this example devtools will only be installed once, prior to
+  # apache and git.
+  #
   # == Multiple Policies
   #
   # You may specify as many policies as you'd like. If the packages you're
@@ -92,38 +117,45 @@ module Sprinkle
     def process(deployment) #:nodoc:
       raise NoMatchingServersError.new(@name, @roles) unless deployment.style.servers_for_role?(@roles)
 
-      all = []
-
       logger.info "[#{name}]"
 
-      cloud_info "--> Cloud hierarchy for policy #{@name}"
-
-      @packages.each do |p, args|
-        cloud_info "  * requires package #{p}"
-
-        opts = args.clone.extract_options!
-        package = Sprinkle::Package::PACKAGES.find_all(p, opts)
-        raise MissingPackageError.new(p) unless package.any?
-        package = Sprinkle::Package::Chooser.select_package(p, package) if package.is_a? Array # handle virtual package selection
-        # get an instance of the package and pass our config options
-        package = package.instance(*args)
-
-        tree = package.tree do |parent, child, depth|
-          indent = "\t" * depth; cloud_info "#{indent}Package #{parent.name} requires #{child.name}"
-        end
-
-        all << tree
-      end
-
-      normalize(all).each do |package|
+      package_install_tree.each do |package|
         package.process(deployment, @roles)
       end
     end
+    
+    def package_install_tree
+      @install_tree ||= normalize(tree)
+    end
 
     private
+    
+      def tree()
+        all = []
+        
+        cloud_info "--> Cloud hierarchy for policy #{@name}"
+        
+        @packages.each do |p, args|
+          cloud_info "  * requires package #{p}"
+
+          opts = args.clone.extract_options!
+          package = Sprinkle::Package::PACKAGES.find_all(p, opts)
+          raise MissingPackageError.new(p) unless package.any?
+          package = Sprinkle::Package::Chooser.select_package(p, package) if package.is_a? Array # handle virtual package selection
+          # get an instance of the package and pass our config options
+          package = package.instance(*args)
+          tree = package.tree do |parent, child, depth|
+            indent = "\t" * depth; cloud_info "#{indent}Package #{parent.name} requires #{child.name}"
+          end
+
+          all << tree
+        end
+        all
+        
+      end
 
       def normalize(all, &block)
-        all = all.flatten.uniq {|x| [x.name, x.version] }
+        all = all.flatten.uniq {|x| [x.name, x.version, x.opts] }
         cloud_info "--> Normalized installation order for all packages: #{all.collect(&:name).join(', ')}\n"
         all
       end

data/lib/sprinkle/verify.rb

@@ -62,7 +62,7 @@ module Sprinkle
     include Sprinkle::Attributes
     include Sprinkle::Package::Rendering::Helpers
     include Sprinkle::Sudo
-    attr_accessor :package, :description, :commands, :options #:nodoc:
+    attr_accessor :package, :description, :options #:nodoc:
     
     delegate :opts, :to => :package
     delegate :args, :to => :package
@@ -87,8 +87,19 @@ module Sprinkle
       @options ||= {}
       @options[:padding] = 4
       @delivery = nil
-      
-      self.instance_eval(&block)
+      @block = block
+    end
+    
+    def commands
+      prepare
+      @commands
+    end
+    
+    def prepare
+      return if @prepared
+      @commands = []
+      self.instance_eval(&@block)
+      @prepared = true
     end
     
     def runner(*cmds)
@@ -109,7 +120,10 @@ module Sprinkle
         logger.debug "#{@package.name}#{description} verification sequence: #{@commands.join('; ')} for roles: #{roles}\n"
       end
       
-      unless Sprinkle::OPTIONS[:testing]
+      if Sprinkle::OPTIONS[:testing]
+        # always fail when testing to force an install
+        raise Sprinkle::VerificationFailed.new(@package, description) if pre
+      else
         logger.debug "#{" " * @options[:padding]}--> Verifying #{description}..."
         
         unless @delivery.verify(self, roles)

data/lib/sprinkle/version.rb

@@ -1,3 +1,3 @@
 module Sprinkle
-  Version = "0.7.6.2"
+  Version = "0.7.7"
 end

data/spec/sprinkle/actors/local_spec.rb

@@ -30,7 +30,7 @@ describe Sprinkle::Actors::Local do
     
     before do
       @verifier = Sprinkle::Verify::new(@package) {}
-      @verifier.commands += ["test","test"]
+      @verifier.commands.concat ["test","test"]
       @roles    = %w( app )
       @name     = 'name'
     end

data/spec/sprinkle/installers/binary_spec.rb

@@ -3,7 +3,7 @@ require File.expand_path("../../spec_helper", File.dirname(__FILE__))
 describe Sprinkle::Installers::Binary do
   include Sprinkle::Deployment
 
-  def create_context(source = 'http://www.example.com/archive.tar.gz')
+  def create_context(source = 'http://www.example.com/archive.tar.gz', sudo = false)
     deployment = deployment do
       delivery :capistrano
       binary source do
@@ -12,7 +12,7 @@ describe Sprinkle::Installers::Binary do
       end
     end
 
-    installer = create_binary source do
+    installer = create_binary source, sudo do
       prefix   '/prefix/directory'
       archives '/archives/directory'
     end
@@ -22,8 +22,8 @@ describe Sprinkle::Installers::Binary do
     [source, deployment, installer]
   end
 
-  def create_binary(binary, version = nil, &block)
-    @package = double(Sprinkle::Package, :name => 'package', :version => version)
+  def create_binary(binary, sudo, version = nil, &block)
+    @package ||= double(Sprinkle::Package, :name => 'package', :version => version, :sudo? => sudo)
     Sprinkle::Installers::Binary.new(@package, binary, &block)
   end
 
@@ -59,6 +59,16 @@ describe Sprinkle::Installers::Binary do
     end
   end
 
+  describe "binary#install_commands", "with sudo support" do
+    before do
+      @binary, @deployment, @installer = create_context 'http://www.example.com/archive.tar.gz', true
+    end
+
+    it "should sudo the command when required" do
+      @installer.send(:install_commands)[1].should =~ /sudo/
+    end
+  end
+
   describe "when source contains spaces (%20's) in path" do
     before do
       _, _, @installer = create_context('http://c758482.r82.cf2.rackcdn.com/Sublime%20Text%202.0.1%20x64.tar.bz2')

data/spec/sprinkle/installers/gem_spec.rb

@@ -86,6 +86,17 @@ describe Sprinkle::Installers::Gem do
 
     end
     
+    describe "with sudo" do
+      before do
+        @installer = create_gem @gem, nil, :sudo => true
+      end
+      
+      it 'should call sudo' do
+        @installer.send(:install_commands).should == "sudo gem install #{@gem} --no-rdoc --no-ri"
+      end
+      
+    end
+    
     describe 'with build flags' do
       
       before do

data/spec/sprinkle/package_spec.rb

@@ -397,7 +397,7 @@ CODE
     it 'should request _each_ verification to process' do
       @pkg.verifications.each do |v|
         v.stub(:defaults)
-        v.should_receive(:process).with(@roles).once
+        v.should_receive(:process).with(@roles, false).once
       end
     end
 

data/spec/sprinkle/policy_spec.rb

@@ -51,6 +51,35 @@ describe Sprinkle::Policy do
     end
 
   end
+  
+  describe 'with the same package multiple times' do
+    include Sprinkle::Package
+    
+    before do
+      @deployment = double(Sprinkle::Deployment)
+      actor = double(:servers_for_role? => true)
+      @deployment.stub(:style).and_return(actor)
+      Sprinkle::Package::PACKAGES.clear # reset full package list before each spec is run
+      
+      @user = package :user do; end
+      
+      @policy = policy :test, :roles => :app do
+        requires :user, :name => "josh"
+        requires :user, :name => "bill"
+      end
+    end
+    
+    it "should call process on both users" do
+      (all=@policy.package_install_tree).size.should == 2
+      all.each do |p|
+        p.should_receive(:process).and_return
+      end
+    end
+    
+    after do
+      @policy.process(@deployment)
+    end
+  end
 
   describe 'with packages' do
     include Sprinkle::Package
@@ -72,7 +101,7 @@ describe Sprinkle::Policy do
       @d.stub(:instance).and_return(@d)
 
       @policy = policy :test, :roles => :app do; requires :a; end
-      $terminal.stub(:choose).and_return(:c) # stub out highline asking questions
+      $terminal.stub(:choose).and_return(@c) # stub out highline asking questions
     end
 
     describe 'when applying' do
@@ -123,7 +152,7 @@ describe Sprinkle::Policy do
 
       it 'should ask the user for the concrete package implementation to use for a virtual one when more than one possible choice exists' do
         @policy = policy :virtual, :roles => :app do; requires :abc; end
-        $terminal.should_receive(:choose).and_return(:c)
+        $terminal.should_receive(:choose).and_return(@c)
         @c.should_receive(:process)
       end
 

data/spec/sprinkle/verify_spec.rb

@@ -65,7 +65,7 @@ describe Sprinkle::Verify do
       end
     end
     @verification = @package.verifications[0]
-    @delivery = double(Sprinkle::Deployment, :process => true, :sudo_command => "sudo")
+    @delivery = double(Sprinkle::Deployment, :process => true, :sudo_command => "sudo", :sudo? => false)
     @verification.delivery = @delivery
   end
   
@@ -136,8 +136,8 @@ describe Sprinkle::Verify do
       @verification.commands.should include('id bob')
     end
     
-    it 'should use id to check for group' do
-      @verification.commands.should include('id -g bobgroup')
+    it 'should use egrep to check a group exists' do
+      @verification.commands.should include('egrep -i "^bobgroup:" /etc/group')
     end
 
     it 'should do a "test -L" to check something is a symbolic link' do

data/sprinkle.gemspec

@@ -34,7 +34,7 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency(%q<open4>, [">= 1.1.0"])
   s.add_runtime_dependency(%q<activesupport>, [">= 2.0.2"])
   s.add_runtime_dependency(%q<highline>, [">= 1.4.0"])
-  s.add_runtime_dependency(%q<capistrano>, ["~> 2.5.5"])
+  s.add_runtime_dependency(%q<capistrano>, [">= 2.5.5", '< 3'])
 
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sprinkle
 version: !ruby/object:Gem::Version
-  version: 0.7.6.2
+  version: 0.7.7
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-15 00:00:00.000000000 Z
+date: 2014-07-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -129,17 +129,23 @@ dependencies:
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: 2.5.5
+    - - <
+      - !ruby/object:Gem::Version
+        version: '3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: 2.5.5
+    - - <
+      - !ruby/object:Gem::Version
+        version: '3'
 description: Ruby DSL based software provisioning tool
 email: crafterm@redartisan.com
 executables: