sprinkle 0.2.6 → 0.3.0

data/.gitignore

@@ -0,0 +1,5 @@
+pkg
+.DS_Store
+.idea
+.*.swp
+sprinkle.gemspec

data/CREDITS

@@ -25,5 +25,9 @@ Justin Pease           (http://jit.nuance9.com)
 Tobias Lütke           (http://blog.leetsoft.com)
 Josh Reynolds          (http://github.com/jreynolds)
 Jan Ulbrich            (http://www.ulbrich.net)
+Chris Gaffney          (http://github.com/gaffneyc)
+Maxmpz                 (http://github.com/maxmpz)
+Geoff Garside          (http://geoffgarside.co.uk/)
+Oliver Kiessler        (http://inceedo.com)
 
 The transfer installer contains a piece of exception reporting code copied from the Chef library (http://wiki.opscode.com/display/chef/Home)

data/Rakefile

@@ -1,4 +1,50 @@
-require 'config/requirements'
-require 'config/hoe' # setup Hoe + all gem configuration
-
-Dir['tasks/**/*.rake'].each { |rake| load rake }
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "sprinkle"
+    gem.summary = "Ruby DSL based software provisioning tool"
+    gem.description = "Ruby DSL based software provisioning tool"
+    gem.email = "crafterm@redartisan.com"
+    gem.rubyforge_project = 'sprinkle'
+    gem.homepage = "http://github.com/crafterm/sprinkle"
+    gem.authors = ["Marcus Crafter"]
+    gem.add_development_dependency "rspec", ">= 1.2.9"
+    gem.add_dependency('activesupport', '>= 2.0.2')
+    gem.add_dependency('highline', '>= 1.4.0')
+    gem.add_dependency('capistrano', '>= 2.5.5')
+    
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "sprinkle #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/TODO

@@ -0,0 +1,56 @@
+Version 0.1 plan
+================
+
+INSTALLER
+* Fix up apt so that we can handle it if it asks questions, or fail? Check with Ben
+* Support alternate gem package sources - DONE
+* MD5/SHA1 checking on the installation files?
+
+MISC
+* Growl support
+* Do a merb example
+* Fix up printing of output so that its nice and a bit more like ports - DONE
+  * print ports style output for stages (installing, configuring, etc...)
+* Add an option to print the hierarchy tree of packages to be installed only - DONE
+* BlankSlate - active support has one
+* CREDITS file - DONE
+* Get #!/usr/bin/env sprinkle working - DONE
+
+OPERATING SYSTEM
+* OS abstraction
+  * build essential on Ubuntu only for example
+
+TESTING
+* Test on a base system Ubuntu system - DONE
+* Multiple runs, check system that's partially installed - DONE
+* Resuming downloads with wget ok - DONE
+
+ERRORS
+* Need to think about handling errors nicely
+* Recovering from an error, and or successive runs of sprinkle
+  * store installed state on the remote server so we can skip installed packages?
+    * what about self healing things later? need to think about it
+
+DOCUMENTATION
+* Document the code somewhat, at least review that its all ok
+* Wiki
+* Home page somewhere? point to github
+* Blog post
+* Screencast - use that cool screenflow tool?
+
+Post Version 0.1 plan
+=====================
+
+CONFIGURATION
+* Think about it - talk to Lincoln and Ben
+* Use cap 2.3 send/download file helpers, might be useful somehow for transporting config files
+
+ACTOR
+* Investigate a pure net:ssh/gateway delivery mechanism, ie. without cap?
+* Generate a cap task file as output? not sure if people would be interested in this?
+  * use ruby2ruby to generate the file, nice :)
+
+MISC
+* Slicehost API support for creating a slice on the way
+  * active resource
+* SSH keys, have to deploy them somehow?

data/VERSION

@@ -0,0 +1 @@
+0.3.0

data/bin/sprinkle

@@ -16,6 +16,10 @@ require 'optparse'
 OPTIONS = {}
 MANDATORY_OPTIONS = %w( path )
 
+ARGV.each do |arg|
+  ENV[$1] = $2 if arg =~ /^(\w+)=(.*)$/
+end
+
 parser = OptionParser.new do |opts|
   opts.banner = <<BANNER
 Sprinkle

data/examples/rails/deploy.rb

@@ -1,2 +1,2 @@
 set :user, 'root'
-role :app, 'yourhost.com', :primary => true
+role :app, 'sprinkle.redartisan.com', :primary => true

data/lib/sprinkle/actors/ssh.rb

@@ -22,7 +22,11 @@ module Sprinkle
       def user(user)
         @options[:user] = user
       end
-      
+
+      def password(password)
+        @options[:password] = password
+      end
+
       def process(name, commands, roles, suppress_and_return_failures = false)
         return process_with_gateway(name, commands, roles) if gateway_defined?
         process_direct(name, commands, roles)
@@ -71,7 +75,7 @@ module Sprinkle
               execute_on_connection(commands, ssh)
             end
           else # direct SSH connection
-            Net::SSH.start(host, @options[:user]) do |ssh|
+            Net::SSH.start(host, @options[:user], :password => @options[:password]) do |ssh|
               execute_on_connection(commands, ssh)
             end
           end

data/lib/sprinkle/installers/binary.rb

@@ -0,0 +1,46 @@
+module Sprinkle
+  module Installers
+    # = Binary Installer
+    # 
+    # binary "http://some.url.com/archive.tar.gz" do
+    #  prefix   "/home/user/local"
+    #  archives "/home/user/sources"
+    # end 
+    #
+    class Binary < Installer
+      def initialize(parent, binary_archive, options = {}, &block) #:nodoc:
+        @binary_archive = binary_archive
+        @options = options
+        super parent, options, &block
+      end
+
+      def prepare_commands #:nodoc:
+        raise 'No installation area defined' unless @options[:prefix]
+        raise 'No archive download area defined' unless @options[:archives]
+
+        [ "mkdir -p #{@options[:prefix]}",
+          "mkdir -p #{@options[:archives]}" ]
+      end
+
+      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]}/#{@binary_archive.split("/").last}'"
+      end
+
+      def extract_command(archive_name = @binary_archive.split("/").last)
+        case archive_name
+        when /(tar.gz)|(tgz)$/
+          'tar xzf'
+        when /(tar.bz2)|(tb2)$/
+          'tar xjf'
+        when /tar$/
+          'tar xf'
+        when /zip$/
+          'unzip'
+        else
+          raise "Unknown binary archive format: #{archive_name}"
+        end
+      end
+    end
+  end
+end

data/lib/sprinkle/installers/freebsd_portinstall.rb

@@ -0,0 +1,36 @@
+module Sprinkle
+  module Installers
+    # = FreeBSD Portinstall Installer
+    #
+    # The Portinstall installer installs FreeBSD ports.
+    # It uses the ports-mgmt/portupgrade port to install.
+    # Before usage, the ports system must be installed and
+    # read on the target operating system.
+    # It is recommended to use `portsnap fetch extract` to
+    # install the ports system.
+    # 
+    # == Example Usage
+    #
+    # Installing the magic_beans port.
+    #
+    #   package :magic_beans do
+    #     freebsd_portinstall 'magic/magic_beans'
+    #   end
+    #
+    class FreebsdPortinstall < Installer
+      attr_accessor :port #:nodoc:
+
+      def initialize(parent, port, &block) #:nodoc:
+        super parent, &block
+        @port = port
+      end
+
+      protected
+
+        def install_commands #:nodoc:
+          "portinstall --batch #{@port}"
+        end
+
+    end
+  end
+end

data/lib/sprinkle/installers/source.rb

@@ -111,7 +111,8 @@ module Sprinkle
 
           extras = {
             :enable  => '--enable', :disable => '--disable',
-            :with    => '--with',   :without => '--without'
+            :with    => '--with',   :without => '--without',
+            :option  => '-',
           }
 
           extras.inject(command) { |m, (k, v)| m << create_options(k, v) if options[k]; m }
@@ -178,7 +179,7 @@ module Sprinkle
         end
 
         def base_dir #:nodoc:
-          if archive_name.split('/').last =~ /(.*)\.(tar\.gz|tgz|tar\.bz2|tar|tb2)/
+          if archive_name.split('/').last =~ /(.*)\.(tar\.gz|tgz|tar\.bz2|tar|tb2|zip)/
             return $1
           end
           raise "Unknown base path for source archive: #{@source}, please update code knowledge"

data/lib/sprinkle/package.rb

@@ -107,7 +107,7 @@ module Sprinkle
 
     class Package #:nodoc:
       include ArbitraryOptions
-      attr_accessor :name, :provides, :installer, :dependencies, :recommends, :verifications
+      attr_accessor :name, :provides, :installers, :dependencies, :recommends, :verifications
 
       def initialize(name, metadata = {}, &block)
         raise 'No package name supplied' unless name
@@ -118,69 +118,74 @@ module Sprinkle
         @recommends = []
         @optional = []
         @verifications = []
+        @installers = []
         self.instance_eval &block
       end
 
       def freebsd_pkg(*names, &block)
-        @installer = Sprinkle::Installers::FreebsdPkg.new(self, *names, &block)
+        @installers << Sprinkle::Installers::FreebsdPkg.new(self, *names, &block)
       end
       
       def openbsd_pkg(*names, &block)
-        @installer = Sprinkle::Installers::OpenbsdPkg.new(self, *names, &block)
+        @installers << Sprinkle::Installers::OpenbsdPkg.new(self, *names, &block)
       end
       
       def opensolaris_pkg(*names, &block)
-        @installer = Sprinkle::Installers::OpensolarisPkg.new(self, *names, &block)
+        @installers << Sprinkle::Installers::OpensolarisPkg.new(self, *names, &block)
       end
       
       def bsd_port(port, &block)
-        @installer = Sprinkle::Installers::BsdPort.new(self, port, &block)
+        @installers << Sprinkle::Installers::BsdPort.new(self, port, &block)
       end
       
       def mac_port(port, &block)
-        @installer = Sprinkle::Installers::MacPort.new(self, port, &block)
+        @installers << Sprinkle::Installers::MacPort.new(self, port, &block)
       end
 
       def apt(*names, &block)
-        @installer = Sprinkle::Installers::Apt.new(self, *names, &block)
+        @installers << Sprinkle::Installers::Apt.new(self, *names, &block)
       end
 
       def deb(*names, &block)
-        @installer = Sprinkle::Installers::Deb.new(self, *names, &block)
+        @installers << Sprinkle::Installers::Deb.new(self, *names, &block)
       end
 
       def rpm(*names, &block)
-        @installer = Sprinkle::Installers::Rpm.new(self, *names, &block)
+        @installers << Sprinkle::Installers::Rpm.new(self, *names, &block)
       end
 
       def yum(*names, &block)
-        @installer = Sprinkle::Installers::Yum.new(self, *names, &block)
+        @installers << Sprinkle::Installers::Yum.new(self, *names, &block)
       end
 
       def gem(name, options = {}, &block)
         @recommends << :rubygems
-        @installer = Sprinkle::Installers::Gem.new(self, name, options, &block)
+        @installers << Sprinkle::Installers::Gem.new(self, name, options, &block)
       end
 
       def source(source, options = {}, &block)
         @recommends << :build_essential # Ubuntu/Debian
-        @installer = Sprinkle::Installers::Source.new(self, source, options, &block)
+        @installers << Sprinkle::Installers::Source.new(self, source, options, &block)
+      end
+      
+      def binary(source, options = {}, &block)
+        @installers << Sprinkle::Installers::Binary.new(self, source, options, &block)
       end
       
       def rake(name, options = {}, &block)
-        @installer = Sprinkle::Installers::Rake.new(self, name, options, &block)        
+        @installers << Sprinkle::Installers::Rake.new(self, name, options, &block)
       end    
       
       def noop(&block)
-        @installer = Sprinkle::Installers::Noop.new(self, name, options, &block)        
+        @installers << Sprinkle::Installers::Noop.new(self, name, options, &block)
       end
       
       def push_text(text, path, options = {}, &block)
-        @installer = Sprinkle::Installers::PushText.new(self, text, path, options, &block)
+        @installers << Sprinkle::Installers::PushText.new(self, text, path, options, &block)
       end
 
-			def transfer(source, destination, options = {}, &block)
-				@installer = Sprinkle::Installers::Transfer.new(self, source, destination, options, &block)
+      def transfer(source, destination, options = {}, &block)
+        @installers << Sprinkle::Installers::Transfer.new(self, source, destination, options, &block)
       end
 
       def verify(description = '', &block)
@@ -203,8 +208,10 @@ module Sprinkle
           end
         end
 
-        @installer.defaults(deployment)
-        @installer.process(roles)
+        @installers.each do |installer|
+          installer.defaults(deployment)
+          installer.process(roles)
+        end
         
         process_verifications(deployment, roles)
       end
@@ -291,7 +298,7 @@ module Sprinkle
         end
 
         def meta_package?
-          @installer == nil
+          @installers.blank?
         end
     end
   end

data/lib/sprinkle/verifiers/rpm.rb

@@ -0,0 +1,21 @@
+module Sprinkle
+  module Verifiers
+    # = RPM Verifier
+    #
+    # Contains a verifier to check the existance of an RPM package.
+    # 
+    # == Example Usage
+    #
+    #   verify { has_rpm 'ntp' }
+    #
+    module Rpm
+      Sprinkle::Verify.register(Sprinkle::Verifiers::Rpm)
+      
+      # Checks to make sure <tt>package</tt> exists in the rpm installed database on the remote server.
+      def has_rpm(package)
+        @commands << "rpm -qa | grep #{package}"
+      end
+      
+    end
+  end
+end

data/script/console

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+# File: script/console
+irb = RUBY_PLATFORM =~ /(:?mswin|mingw)/ ? 'irb.bat' : 'irb'
+
+libs =  " -r irb/completion"
+libs <<  " -r #{File.dirname(__FILE__) + '/../lib/sprinkle.rb'}"
+puts "Loading sprinkle gem"
+exec "#{irb} #{libs} --simple-prompt"

data/spec/sprinkle/installers/freebsd_portinstall_spec.rb

@@ -0,0 +1,42 @@
+require File.dirname(__FILE__) + '/../../spec_helper'
+
+describe Sprinkle::Installers::FreebsdPortinstall do
+
+  before do
+    @package = mock(Sprinkle::Package, :name => 'package')
+  end
+
+  def create_port(ports, &block)
+    Sprinkle::Installers::FreebsdPortinstall.new(@package, ports, &block)
+  end
+
+  describe 'when created' do
+
+    it 'should accept a single package to install' do
+      @installer = create_port 'lang/ruby'
+      @installer.port.should == 'lang/ruby'
+    end
+
+  end
+
+  describe 'during installation' do
+
+    before do
+      @installer = create_port 'lang/ruby' do
+        pre :install, 'op1'
+        post :install, 'op2'
+      end
+      @install_commands = @installer.send :install_commands
+    end
+
+    it 'should invoke the port installer for all specified packages' do
+      @install_commands.should =~ /portinstall --batch lang\/ruby/
+    end
+
+    it 'should automatically insert pre/post commands for the specified package' do
+      @installer.send(:install_sequence).should == [ 'op1', 'portinstall --batch lang/ruby', 'op2' ]
+    end
+
+  end
+
+end