dhill-sprinkle 0.3.3.1

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'
+          "env DEBCONF_TERSE='yes' DEBIAN_PRIORITY='critical' DEBIAN_FRONTEND=noninteractive apt-get --force-yes -qyu #{command} #{@packages.join(' ')}"
+        end
+
+    end
+  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 -o'
+        else
+          raise "Unknown binary archive format: #{archive_name}"
+        end
+      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/deb.rb

@@ -0,0 +1,41 @@
+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/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/gem.rb

@@ -0,0 +1,64 @@
+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 << " --http-proxy #{http_proxy}" if option?(:http_proxy)
+          cmd << " -- #{build_flags}" if option?(:build_flags)
+          cmd
+        end
+        
+    end
+  end
+end

data/lib/sprinkle/installers/install_package.rb

@@ -0,0 +1,79 @@
+module Sprinkle
+  module Installers
+    class InstallPackage < Installer
+      cattr_accessor :installer
+      attr_accessor :packages #:nodoc:
+
+      def initialize(parent, packages, &block) #:nodoc:
+        super parent, &block
+        if packages.is_a?(Array) && packages.first.is_a?(Array)
+          packages = packages.first
+        else
+          packages = [packages] unless packages.is_a? Array
+        end
+
+        @packages = packages
+      end
+
+      protected
+
+      def install_commands #:nodoc:
+        case installer
+          when :smart
+            "smart install #{@packages.join(' ')} -y 2>&1 | tee -a /var/log/smart-sprinkle"
+          when :yum
+            "yum install #{@packages.join(' ')} -y 2>&1 | tee -a /var/log/yum-sprinkle"
+          else
+            raise "Unknown InstallPackage.installer"
+        end
+      end
+    end
+
+    class UninstallPackage < Installer
+      attr_accessor :packages #:nodoc:
+
+      def initialize(parent, packages, &block) #:nodoc:
+        super parent, &block
+        if packages.is_a?(Array) && packages.first.is_a?(Array)
+          packages = packages.first
+        else
+          packages = [packages] unless packages.is_a? Array
+        end
+
+        @packages = packages
+      end
+
+      protected
+
+      def install_commands #:nodoc:
+        case Sprinkle::Installers::InstallPackage.installer
+          when :smart
+            "smart remove #{@packages.join(' ')} -y 2>&1 | tee -a /var/log/smart-sprinkle"
+          when :yum
+            "yum erase #{@packages.join(' ')} -y 2>&1 | tee -a /var/log/yum-sprinkle"
+          else
+            raise "Unknown InstallPackage.installer"
+        end
+      end
+    end
+  end
+end
+
+module Sprinkle
+  module Package
+    class Package
+      def install_package(*names, &block)
+        @installers << Sprinkle::Installers::InstallPackage.new(self, names, &block)
+      end
+
+      def uninstall_package(*names, &block)
+        @installers << Sprinkle::Installers::UninstallPackage.new(self, names, &block)
+      end
+
+
+      alias_method :install_packages, :install_package
+      alias_method :uninstall_packages, :uninstall_package
+    end
+  end
+end
+

data/lib/sprinkle/installers/installer.rb

@@ -0,0 +1,123 @@
+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(roles) #: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 roles: #{roles}\n"
+        end
+
+        unless Sprinkle::OPTIONS[:testing]
+          logger.info "--> Installing #{package.name} for roles: #{roles}"
+          @delivery.process(@package.name, install_sequence, roles)
+        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:
+          # DWH 20110407 - Added stage to fix bug as build directory and log don't exist yet
+          dress @pre[stage] || [], stage, :pre
+        end
+
+        def post_commands(stage) #:nodoc:
+          # DWH 20110407 - Added stage to fix bug as build directory and log don't exist yet
+          dress @post[stage] || [], 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, type)
+        #     commands.collect { |x| "cd #{magic_beans_path} && #{x}" }
+        #   end
+        #
+        # By default, no modifications are made to the commands.
+        # DWH 20110407 - Added stage parameter to fix bug as build directory and log don't exist yet
+        def dress(commands, stage, type); commands; end
+
+    end
+  end
+end