jemmyw-sprinkle 0.2.3

data/lib/sprinkle/configurable.rb

@@ -0,0 +1,31 @@
+module Sprinkle
+  #--
+  # TODO: Possible documentation?
+  #++
+  module Configurable #:nodoc:
+    attr_accessor :delivery
+    
+    def defaults(deployment)
+      defaults = deployment.defaults[self.class.name.split(/::/).last.downcase.to_sym]
+      self.instance_eval(&defaults) if defaults
+      @delivery = deployment.style
+    end
+    
+    def assert_delivery
+      raise 'Unknown command delivery target' unless @delivery
+    end
+    
+    def method_missing(sym, *args, &block)
+      unless args.empty? # mutate if not set
+        @options ||= {}
+        @options[sym] = *args unless @options[sym]
+      end
+
+      @options[sym] || @package.send(sym, *args, &block) # try the parents options if unknown
+    end
+    
+    def option?(sym)
+      !@options[sym].nil?
+    end
+  end
+end

data/lib/sprinkle/deployment.rb

@@ -0,0 +1,77 @@
+module Sprinkle
+  # Deployment blocks specify deployment specific information about a 
+  # sprinkle script. An example:
+  #
+  #   deployment do
+  #     # mechanism for deployment
+  #     delivery :capistrano do
+  #       recipes 'deploy'
+  #     end
+  # 
+  #     # source based package installer defaults
+  #     source do
+  #       prefix   '/usr/local'
+  #       archives '/usr/local/sources'
+  #       builds   '/usr/local/build'
+  #     end
+  #   end
+  #
+  # What the above example does is tell sprinkle that we will be using
+  # *capistrano* (Sprinkle::Actors::Capistrano) for deployment and
+  # everything within the block is capistrano specific configuration.
+  # For more information on what options are available, check the corresponding
+  # Sprinkle::Actors doc page.
+  #
+  # In addition to what delivery mechanism we're using, we specify some
+  # configuration options for the "source" command. The only things
+  # configurable, at this time, in the deployment block other than
+  # the delivery method are installers. If installers are configurable,
+  # they will say so on their corresponding documentation page. See
+  # Sprinkle::Installers
+  #
+  # <b>Only one deployment block is on any given sprinkle script</b>
+  module Deployment
+    # The method outlined above which specifies deployment specific information
+    # for a sprinkle script. For more information, read the header of this module.
+    def deployment(&block)
+      @deployment = Deployment.new(&block)
+    end
+
+    class Deployment
+      attr_accessor :style, :defaults #:nodoc:
+
+      def initialize(&block) #:nodoc:
+        @defaults = {}
+        self.instance_eval(&block)
+        raise 'No delivery mechanism defined' unless @style
+      end
+
+      # Specifies which Sprinkle::Actors to use for delivery. Although all
+      # actors jobs are the same: to run remote commands on a server, you
+      # may have a personal preference. The block you pass is used to configure
+      # the actor. For more information on what configuration options are
+      # available, view the corresponding Sprinkle::Actors page.
+      def delivery(type, &block) #:doc:
+        @style = Actors.const_get(type.to_s.titleize).new &block
+      end
+      
+      def find_servers(role)
+        style.find_servers(role)
+      end
+
+      def method_missing(sym, *args, &block) #:nodoc:
+        @defaults[sym] = block
+      end
+
+      def respond_to?(sym) #:nodoc:
+        !!@defaults[sym]
+      end
+
+      def process #:nodoc:
+        POLICIES.each do |policy|
+          policy.process(self)
+        end
+      end
+    end
+  end
+end

data/lib/sprinkle/extensions/arbitrary_options.rb

@@ -0,0 +1,10 @@
+module ArbitraryOptions #:nodoc:
+  def self.included(base)
+    base.alias_method_chain :method_missing, :arbitrary_options
+  end
+  
+  def method_missing_with_arbitrary_options(sym, *args, &block)
+    self.class.dsl_accessor sym
+    send(sym, *args, &block)
+  end
+end

data/lib/sprinkle/extensions/array.rb

@@ -0,0 +1,5 @@
+class Array #:nodoc:
+  def to_task_name
+    collect(&:to_task_name).join('_')
+  end
+end

data/lib/sprinkle/extensions/blank_slate.rb

@@ -0,0 +1,5 @@
+class BlankSlate #:nodoc:
+  instance_methods.each do |m| 
+    undef_method(m) unless %w( __send__ __id__ send class inspect instance_eval instance_variables ).include?(m)
+  end
+end

data/lib/sprinkle/extensions/dsl_accessor.rb

@@ -0,0 +1,15 @@
+class Module #:nodoc:
+  def dsl_accessor(*symbols)
+    symbols.each do |sym|
+      class_eval %{
+        def #{sym}(*val)
+          if val.empty?
+            @#{sym}
+          else
+            @#{sym} = val.size == 1 ? val[0] : val
+          end
+        end
+      }, __FILE__, __LINE__
+    end
+  end
+end

data/lib/sprinkle/extensions/string.rb

@@ -0,0 +1,10 @@
+class String #:nodoc:
+  
+  # REVISIT: what chars shall we allow in task names?
+  def to_task_name
+    s = downcase
+    s.gsub!(/-/, '_') # all - to _ chars
+    s
+  end
+  
+end

data/lib/sprinkle/extensions/symbol.rb

@@ -0,0 +1,7 @@
+class Symbol #:nodoc:
+  
+  def to_task_name
+    to_s.to_task_name
+  end
+  
+end

data/lib/sprinkle/installers/apt.rb

@@ -0,0 +1,52 @@
+module Sprinkle
+  module Installers
+    # = Apt Package Installer
+    #
+    # The Apt package installer uses the +apt-get+ command to install
+    # packages. The apt installer has only one option which can be
+    # modified which is the +dependencies_only+ option. When this is
+    # set to true, the installer uses +build-dep+ instead of +install+
+    # to only build the dependencies.
+    # 
+    # == Example Usage
+    #
+    # First, a simple installation of the magic_beans package:
+    #
+    #   package :magic_beans do
+    #     description "Beans beans they're good for your heart..."
+    #     apt 'magic_beans_package'
+    #   end
+    #
+    # Second, only build the magic_beans dependencies:
+    #
+    #   package :magic_beans_depends do
+    #     apt 'magic_beans_package' { dependencies_only true }
+    #   end
+    #
+    # As you can see, setting options is as simple as creating a
+    # block and calling the option as a method with the value as 
+    # its parameter.
+    class Apt < Installer
+      attr_accessor :packages #:nodoc:
+
+      def initialize(parent, *packages, &block) #:nodoc:
+        packages.flatten!
+        
+        options = { :dependencies_only => false }
+        options.update(packages.pop) if packages.last.is_a?(Hash)
+        
+        super parent, options, &block
+        
+        @packages = packages
+      end
+
+      protected
+
+        def install_commands #:nodoc:
+          command = @options[:dependencies_only] ? 'build-dep' : 'install'
+          "DEBCONF_TERSE='yes' DEBIAN_PRIORITY='critical' DEBIAN_FRONTEND=noninteractive apt-get -qyu #{command} #{@packages.join(' ')}"
+        end
+
+    end
+  end
+end

data/lib/sprinkle/installers/bsd_port.rb

@@ -0,0 +1,33 @@
+module Sprinkle
+  module Installers
+    # = OpenBSD and FreeBSD Port Installer
+    #
+    # The Port installer installs OpenBSD and FreeBSD ports.
+    # Before usage, the ports sytem must be installed and
+    # read on the target operating system.
+    # 
+    # == Example Usage
+    #
+    # Installing the magic_beans port.
+    #
+    #   package :magic_beans do
+    #     bsd_port 'magic/magic_beans'
+    #   end
+    #
+    class BsdPort < Installer
+      attr_accessor :port #:nodoc:
+
+      def initialize(parent, port, &block) #:nodoc:
+        super parent, &block
+        @port = port
+      end
+
+      protected
+
+        def install_commands #:nodoc:
+          "sh -c 'cd /usr/ports/#{@port} && make BATCH=yes install clean'"
+        end
+
+    end
+  end
+end

data/lib/sprinkle/installers/custom.rb

@@ -0,0 +1,28 @@
+module Sprinkle
+  module Installers
+    # = Custom Installer
+    #
+    # A really simple installer than just runs any commands
+    #
+    # == Example Usage
+    #
+    # Adding a user to passwd
+    #
+    #   package :deployment_user do
+    #     custom 'useradd -d /home/deployer -s /usr/sbin/nologin deployer'
+    #   end
+    #
+    class Custom < Installer
+      def initialize(parent, command, &block) #:nodoc:
+        options = {:command => command}
+        super parent, options, &block
+      end
+
+      protected
+
+      def install_commands #:nodoc:
+        @options[:command]
+      end
+    end
+  end
+end

data/lib/sprinkle/installers/deb.rb

@@ -0,0 +1,38 @@
+module Sprinkle
+  module Installers
+    # = Deb Package Installer
+    #
+    # The Deb installer installs deb packages sourced from a remote URL
+    # 
+    # == Example Usage
+    #
+    # Installing the magic_beans deb.
+    #
+    #   package :magic_beans do
+    #     deb 'http://debs.example.com/magic_beans.deb'
+    #   end
+    #
+    class Deb < Installer
+      attr_accessor :packages #:nodoc:
+
+      def initialize(parent, packages, &block) #:nodoc:
+        super parent, &block
+        packages = [packages] unless packages.is_a? Array
+        @packages = packages
+      end
+
+      protected
+
+        def install_commands #:nodoc:
+          "wget -cq --directory-prefix=/tmp #{@packages.join(' ')}; dpkg -i #{@packages.collect{|p| "/tmp/#{package_name(p)}"}.join(" ")}"
+        end
+        
+      private
+      
+        def package_name(url)
+          url.split('/').last
+        end
+
+    end
+  end
+end

data/lib/sprinkle/installers/freebsd_pkg.rb

@@ -0,0 +1,37 @@
+module Sprinkle
+  module Installers
+    # = FreeBSD Package Installer
+    #
+    # The Pkg package installer installs FreeBSD packages.
+    # 
+    # == Example Usage
+    #
+    # Installing the magic_beans package.
+    #
+    #   package :magic_beans do
+    #     freebsd_pkg 'magic_beans'
+    #   end
+    #
+    # You may also specify multiple packages as an array:
+    #
+    #   package :magic_beans do
+    #     freebsd_pkg %w(magic_beans magic_sauce)
+    #   end
+    class FreebsdPkg < Installer
+      attr_accessor :packages #:nodoc:
+
+      def initialize(parent, packages, &block) #:nodoc:
+        super parent, &block
+        packages = [packages] unless packages.is_a? Array
+        @packages = packages
+      end
+
+      protected
+
+        def install_commands #:nodoc:
+          "pkg_add -r #{@packages.join(' ')}"
+        end
+
+    end
+  end
+end

data/lib/sprinkle/installers/gem.rb

@@ -0,0 +1,63 @@
+module Sprinkle
+  module Installers
+    # = Ruby Gem Package Installer
+    #
+    # The gem package installer installs ruby gems.
+    #
+    # The installer has a single optional configuration: source.
+    # By changing source you can specify a given ruby gems
+    # repository from which to install.
+    # 
+    # == Example Usage
+    #
+    # First, a simple installation of the magic_beans gem:
+    #
+    #   package :magic_beans do
+    #     description "Beans beans they're good for your heart..."
+    #     gem 'magic_beans'
+    #   end
+    #
+    # Second, install magic_beans gem from github:
+    #
+    #   package :magic_beans do
+    #     gem 'magic_beans_package' do
+    #       source 'http://gems.github.com'
+    #     end
+    #   end
+    #
+    # As you can see, setting options is as simple as creating a
+    # block and calling the option as a method with the value as 
+    # its parameter.
+    class Gem < Installer
+      attr_accessor :gem #:nodoc:
+
+      def initialize(parent, gem, options = {}, &block) #:nodoc:
+        super parent, options, &block
+        @gem = gem
+      end
+
+      def source(location = nil) #:nodoc:
+        # package defines an installer called source so here we specify a method directly
+        # rather than rely on the automatic options processing since packages' method missing
+        # won't be run
+        return @options[:source] unless location
+        @options[:source] = location
+      end
+
+      protected
+
+        # rubygems 0.9.5+ installs dependencies by default, and does platform selection
+
+        def install_commands #:nodoc:
+          cmd = "gem install #{gem}"
+          cmd << " --version '#{version}'" if version
+          cmd << " --source #{source}" if source
+          cmd << " --install-dir #{repository}" if option?(:repository)
+          cmd << " --no-rdoc --no-ri" unless option?(:build_docs)
+          cmd << " -- #{build_flags}" if option?(:build_flags)
+          cmd
+        end
+        
+    end
+  end
+end

data/lib/sprinkle/installers/installer.rb

@@ -0,0 +1,120 @@
+module Sprinkle
+  module Installers
+    # The base class which all installers must subclass, this class makes
+    # sure all installers share some general features, which are outlined
+    # below. 
+    #
+    # = Pre/Post Installation Hooks
+    # 
+    # With all intallation methods you have the ability to specify multiple
+    # pre/post installation hooks. This gives you the ability to specify
+    # commands to run before and after an installation takes place. All 
+    # commands by default are sudo'd so there is no need to include "sudo"
+    # in the command itself. There are three ways to specify a pre/post hook.
+    # 
+    # First, a single command:
+    #
+    #   pre :install, 'echo "Hello, World!"'
+    #   post :install, 'rm -rf /'
+    #
+    # Second, an array of commands:
+    #
+    #   commands = ['echo "First"', 'echo "Then Another"']
+    #   pre :install, commands
+    #   post :install, commands
+    #
+    # Third, a block which returns either a single or multiple commands:
+    #
+    #   pre :install do
+    #     amount = 7 * 3
+    #     "echo 'Before we install, lets plant #{amount} magic beans...'"
+    #   end
+    #   post :install do
+    #     ['echo "Now... let's hope they sprout!", 'echo "Indeed they have!"']
+    #   end
+    #
+    # = Other Pre/Post Hooks
+    #
+    # Some installation methods actually grant you more fine grained
+    # control of when commands are run rather than a blanket pre :install
+    # or post :install. If this is the case, it will be documented on
+    # the installation method's corresponding documentation page. 
+    class Installer
+      include Sprinkle::Configurable
+      attr_accessor :delivery, :package, :options, :pre, :post #:nodoc:
+
+      def initialize(package, options = {}, &block) #:nodoc:
+        @package = package
+        @options = options
+        @pre = {}; @post = {}
+        self.instance_eval(&block) if block
+      end
+
+      def pre(stage, *commands)
+        @pre[stage] ||= []
+        @pre[stage] += commands
+        @pre[stage] += [yield] if block_given?
+      end
+
+      def post(stage, *commands)
+        @post[stage] ||= []
+        @post[stage] += commands
+        @post[stage] += [yield] if block_given?
+      end
+
+      def process(server) #:nodoc:
+        assert_delivery
+
+        if logger.debug?
+          sequence = install_sequence; sequence = sequence.join('; ') if sequence.is_a? Array
+          logger.debug "#{@package.name} install sequence: #{sequence} for server: #{server}\n"
+        end
+
+        unless Sprinkle::OPTIONS[:testing]
+          logger.info "--> Installing #{package.name} for server: #{server}"
+          @delivery.process(@package.name, install_sequence, server)
+        end
+      end
+
+      protected
+        # More complicated installers that have different stages, and require pre/post commands
+        # within stages can override install_sequence and take complete control of the install
+        # command sequence construction (eg. source based installer).
+        def install_sequence
+          commands = pre_commands(:install) + [ install_commands ] + post_commands(:install)
+          commands.flatten
+        end
+
+        # A concrete installer (subclass of this virtual class) must override this method
+        # and return the commands it needs to run as either a string or an array. 
+        #
+        # <b>Overriding this method is required.</b>
+        def install_commands
+          raise 'Concrete installers implement this to specify commands to run to install their respective packages'
+        end
+
+        def pre_commands(stage) #:nodoc:
+          dress @pre[stage] || [], :pre
+        end
+
+        def post_commands(stage) #:nodoc:
+          dress @post[stage] || [], :post
+        end
+
+        # Concrete installers (subclasses of this virtual class) can override this method to
+        # specify stage-specific (pre-installation, post-installation, etc.) modifications
+        # of commands. 
+        #
+        # An example usage of overriding this would be to prefix all commands for a 
+        # certain stage to change to a certain directory. An example is given below:
+        #
+        #   def dress(commands, stage)
+        #     commands.collect { |x| "cd #{magic_beans_path} && #{x}" }
+        #   end
+        #
+        # By default, no modifications are made to the commands.
+        def dress(commands, stage); commands; end
+
+    end
+  end
+end

data/lib/sprinkle/installers/mac_port.rb

@@ -0,0 +1,38 @@
+module Sprinkle
+  module Installers
+    # = Mac OS X Port Installer (macports)
+    #
+    # The Port installer installs macports ports.
+    # 
+    # == Example Usage
+    #
+    # Installing the magic_beans port.
+    #
+    #   package :magic_beans do
+    #     mac_port 'magic/magic_beans'
+    #   end
+    #
+    # == Notes
+    # Before MacPorts packages can be installed, the PATH
+    # environment variable probably has to be changed so
+    # capistrano can find the /opt/local/bin/port executable
+    #
+    # You must set PATH in ~/.ssh/environment on the remote
+    # system and enable 'PermitUserEnvironment yes' in /etc/sshd_config
+    class MacPort < Installer
+      attr_accessor :port #:nodoc:
+
+      def initialize(parent, port, &block) #:nodoc:
+        super parent, &block
+        @port = port
+      end
+
+      protected
+
+        def install_commands #:nodoc:
+          "port install #{@port}"
+        end
+
+    end
+  end
+end

data/lib/sprinkle/installers/openbsd_pkg.rb

@@ -0,0 +1,47 @@
+module Sprinkle
+  module Installers
+    # = OpenBSD Package Installer
+    #
+    # The Pkg package installer installs OpenBSD packages.
+    # 
+    # == Example Usage
+    #
+    # Installing the magic_beans package.
+    #
+    #   package :magic_beans do
+    #     openbsd_pkg 'magic_beans'
+    #   end
+    #
+    # You may also specify multiple packages as an array:
+    #
+    #   package :magic_beans do
+    #     openbsd_pkg %w(magic_beans magic_sauce)
+    #   end
+    #
+    # == Notes
+    # Before OpenBSD packages can be installed, the PKG_PATH
+    # environment variable must be set.
+    #
+    # You must set PKG_PATH in ~/.ssh/environment on the remote
+    # system and enable 'PermitUserEnvironment yes' in /etc/ssh/sshd_config
+    # 
+    # For help on PKG_PATH see section 15.2.2 of the OpenBSD FAQ 
+    # (http://www.openbsd.org/faq/faq15.html)
+    class OpenbsdPkg < Installer
+      attr_accessor :packages #:nodoc:
+
+      def initialize(parent, packages, &block) #:nodoc:
+        super parent, &block
+        packages = [packages] unless packages.is_a? Array
+        @packages = packages
+      end
+
+      protected
+
+        def install_commands #:nodoc:
+          "pkg_add #{@packages.join(' ')}"
+        end
+
+    end
+  end
+end

data/lib/sprinkle/installers/opensolaris_pkg.rb

@@ -0,0 +1,43 @@
+module Sprinkle
+  module Installers
+    # = OpenSolaris Package Installer
+    #
+    # The Pkg package installer installs OpenSolaris packages.
+    # 
+    # == Example Usage
+    #
+    # Installing the magic_beans package.
+    #
+    #   package :magic_beans do
+    #     opensolaris_pkg 'magic_beans'
+    #   end
+    #
+    # You may also specify multiple packages as an array:
+    #
+    #   package :magic_beans do
+    #     opensolaris_pkg %w(magic_beans magic_sauce)
+    #   end
+    #
+    # == Note
+    # If you are using capistrano as the deployment method
+    # you will need to add the following lines to your deploy.rb
+    # set :sudo, 'pfexec'
+    # set :sudo_prompt, ''
+    class OpensolarisPkg < Installer
+      attr_accessor :packages #:nodoc:
+
+      def initialize(parent, packages, &block) #:nodoc:
+        super parent, &block
+        packages = [packages] unless packages.is_a? Array
+        @packages = packages
+      end
+
+      protected
+
+        def install_commands #:nodoc:
+          "pkg install #{@packages.join(' ')}"
+        end
+
+    end
+  end
+end