powcloud-sprinkle 0.3.0

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(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:
+          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/noop.rb

@@ -0,0 +1,20 @@
+module Sprinkle
+  module Installers
+    # = Noop Installer
+    #
+    # This installer does nothing, it's simply useful for running pre / post hooks by themselves. 
+    # 
+    class Noop < Installer
+      def initialize(parent, name, options = {}, &block) #:nodoc:
+        super parent, options, &block
+      end
+
+      protected
+
+        def install_commands #:nodoc:
+          'echo noop'
+        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

data/lib/sprinkle/installers/push_text.rb

@@ -0,0 +1,45 @@
+module Sprinkle
+  module Installers
+    # Beware, strange "installer" coming your way.
+    #
+    # = Text configuration installer
+    #
+    # This installer pushes simple configuration into a file.
+    # 
+    # == Example Usage
+    #
+    # Installing magic_beans into apache2.conf
+    #
+    #   package :magic_beans do
+    #     push_text 'magic_beans', '/etc/apache2/apache2.conf'
+    #   end
+    #
+    # If you user has access to 'sudo' and theres a file that requires
+    # priveledges, you can pass :sudo => true 
+    #
+    #   package :magic_beans do
+    #     push_text 'magic_beans', '/etc/apache2/apache2.conf', :sudo => true
+    #   end
+    #
+    # A special verify step exists for this very installer
+    # its known as file_contains, it will test that a file indeed
+    # contains a substring that you send it.
+    #
+    class PushText < Installer
+      attr_accessor :text, :path #:nodoc:
+
+      def initialize(parent, text, path, options={}, &block) #:nodoc:
+        super parent, options, &block
+        @text = text
+        @path = path
+      end
+
+      protected
+
+        def install_commands #:nodoc:
+          "echo -e '#{@text.gsub("'", "'\\\\''").gsub("\n", '\n')}' |#{'sudo ' if option?(:sudo)}tee -a #{@path}"
+        end
+
+    end
+  end
+end

data/lib/sprinkle/installers/rake.rb

@@ -0,0 +1,37 @@
+module Sprinkle
+  module Installers
+    # = Rake Installer
+    #
+    # This installer runs a rake command.
+    # 
+    # == Example Usage
+    #
+    # The following example runs the command "rake spec" on
+    # the remote server.
+    #
+    #   package :spec do
+    #     rake 'spec'
+    #   end
+    # 
+    # Specify a Rakefile with the :rakefile option.
+    #
+    #   package :spec, :rakefile => "/var/setup/Rakefile" do
+    #     rake 'spec'
+    #   end
+     
+    class Rake < Installer
+      def initialize(parent, commands, options = {}, &block) #:nodoc:
+        super parent, options, &block
+        @commands = commands.to_a
+      end
+
+      protected
+
+        def install_commands #:nodoc:
+          file = @options[:rakefile] ? "-f #{@options[:rakefile]} " : ""
+          "rake #{file}#{@commands.join(' ')}"
+        end
+
+    end
+  end
+end

data/lib/sprinkle/installers/rpm.rb

@@ -0,0 +1,37 @@
+module Sprinkle
+  module Installers
+    # = RPM Package Installer
+    #
+    # The RPM package installer installs RPM packages.
+    # 
+    # == Example Usage
+    #
+    # Installing the magic_beans RPM. Its all the craze these days.
+    #
+    #   package :magic_beans do
+    #     rpm 'magic_beans'
+    #   end
+    #
+    # You may also specify multiple rpms as an array:
+    #
+    #   package :magic_beans do
+    #     rpm %w(magic_beans magic_sauce)
+    #   end
+    class Rpm < 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:
+          "rpm -Uvh #{@packages.join(' ')}"
+        end
+
+    end
+  end
+end

data/lib/sprinkle/installers/smart.rb

@@ -0,0 +1,29 @@
+module Sprinkle
+  module Installers
+    class Smart < 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:
+        "smart install #{@packages.join(' ')} -y 2>&1 | tee -a /var/log/smart-sprinkle"
+      end
+    end
+  end
+end
+
+module Sprinkle
+  module Package
+    class Package
+      def smart(*names, &block)
+        @installer = Sprinkle::Installers::Smart.new(self, *names, &block)
+      end
+    end
+  end
+end

data/lib/sprinkle/installers/source.rb

@@ -0,0 +1,190 @@
+module Sprinkle
+  module Installers
+    # = Source Package Installer
+    #
+    # The source package installer installs software from source.
+    # It handles downloading, extracting, configuring, building, 
+    # and installing software. 
+    #
+    # == Configuration Options
+    #
+    # The source installer has many configuration options:
+    # * <b>prefix</b> - The prefix directory that is configured to.
+    # * <b>archives</b> - The location all the files are downloaded to.
+    # * <b>builds</b> - The directory the package is extracted to to configure and install
+    #
+    # == Pre/Post Hooks
+    #
+    # The source installer defines a myriad of new stages which can be hooked into:
+    # * <b>prepare</b> - Prepare is the stage which all the prefix, archives, and build directories are made.
+    # * <b>download</b> - Download is the stage which the software package is downloaded.
+    # * <b>extract</b> - Extract is the stage which the software package is extracted.
+    # * <b>configure</b> - Configure is the stage which the ./configure script is run.
+    # * <b>build</b> - Build is the stage in which `make` is called.
+    # * <b>install</b> - Install is the stage which `make install` is called.
+    # 
+    # == Example Usage
+    #
+    # First, a simple package, no configuration:
+    #
+    #   package :magic_beans do
+    #     source 'http://magicbeansland.com/latest-1.1.1.tar.gz'
+    #   end
+    #
+    # Second, specifying exactly where I want my files:
+    #
+    #   package :magic_beans do
+    #     source 'http://magicbeansland.com/latest-1.1.1.tar.gz' do
+    #       prefix    '/usr/local'
+    #       archives  '/tmp'
+    #       builds    '/tmp/builds'
+    #     end
+    #   end
+    #
+    # Third, specifying some hooks:
+    #
+    #   package :magic_beans do
+    #     source 'http://magicbeansland.com/latest-1.1.1.tar.gz' do
+    #       prefix    '/usr/local'
+    #
+    #       pre :prepare { 'echo "Here we go folks."' }
+    #       post :extract { 'echo "I believe..."' }
+    #       pre :build { 'echo "Cross your fingers!"' }
+    #     end
+    #   end
+    #
+    # Fourth, specifying a custom archive name because the downloaded file name
+    # differs from the source URL:
+    #
+    #   package :gitosis do
+    #     source 'http://github.com/crafterm/sprinkle/tarball/master' do
+    #       custom_archive 'crafterm-sprinkle-518e33c835986c03ec7ae8ea88c657443b006f28.tar.gz'
+    #     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 Source < Installer
+      attr_accessor :source #:nodoc:
+
+      def initialize(parent, source, options = {}, &block) #:nodoc:
+        @source = source
+        super parent, options, &block
+      end
+
+      protected
+
+        def install_sequence #:nodoc:
+          prepare + download + extract + configure + build + install
+        end
+
+        %w( prepare download extract configure build install ).each do |stage|
+          define_method stage do
+            pre_commands(stage.to_sym) + self.send("#{stage}_commands") + post_commands(stage.to_sym)
+          end
+        end
+
+        def prepare_commands #:nodoc:
+          raise 'No installation area defined' unless @options[:prefix]
+          raise 'No build area defined' unless @options[:builds]
+          raise 'No source download area defined' unless @options[:archives]
+
+          [ "mkdir -p #{@options[:prefix]}",
+            "mkdir -p #{@options[:builds]}",
+            "mkdir -p #{@options[:archives]}" ]
+        end
+
+        def download_commands #:nodoc:
+          [ "wget -cq --directory-prefix='#{@options[:archives]}' #{@source}" ]
+        end
+
+        def extract_commands #:nodoc:
+          [ "bash -c 'cd #{@options[:builds]} && #{extract_command} #{@options[:archives]}/#{archive_name}'" ]
+        end
+
+        def configure_commands #:nodoc:
+          return [] if custom_install?
+
+          command = "bash -c 'cd #{build_dir} && ./configure --prefix=#{@options[:prefix]} "
+
+          extras = {
+            :enable  => '--enable', :disable => '--disable',
+            :with    => '--with',   :without => '--without',
+            :option  => '-',
+          }
+
+          extras.inject(command) { |m, (k, v)| m << create_options(k, v) if options[k]; m }
+
+          [ command << " > #{@package.name}-configure.log 2>&1'" ]
+        end
+
+        def build_commands #:nodoc:
+          return [] if custom_install?
+          [ "bash -c 'cd #{build_dir} && make > #{@package.name}-build.log 2>&1'" ]
+        end
+
+        def install_commands #:nodoc:
+          return custom_install_commands if custom_install?
+          [ "bash -c 'cd #{build_dir} && make install > #{@package.name}-install.log 2>&1'" ]
+        end
+
+        def custom_install? #:nodoc:
+          !! @options[:custom_install]
+        end
+
+        # REVISIT: must be better processing of custom install commands somehow? use splat operator?
+        def custom_install_commands #:nodoc:
+          dress @options[:custom_install], :install
+        end
+
+      protected
+
+        # dress is overriden from the base Sprinkle::Installers::Installer class so that the command changes
+        # directory to the build directory first. Also, the result of the command is logged.
+        def dress(commands, stage)
+          commands.collect { |command| "bash -c 'cd #{build_dir} && #{command} >> #{@package.name}-#{stage}.log 2>&1'" }
+        end
+
+      private
+
+        def create_options(key, prefix) #:nodoc:
+          @options[key].inject(' ') { |m, option| m << "#{prefix}-#{option} "; m }
+        end
+
+        def extract_command #:nodoc:
+          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 source archive format: #{archive_name}"
+          end
+        end
+
+        def archive_name #:nodoc:
+          name = @options[:custom_archive] || @source.split('/').last
+          raise "Unable to determine archive name for source: #{source}, please update code knowledge" unless name
+          name
+        end
+
+        def build_dir #:nodoc:
+          "#{@options[:builds]}/#{options[:custom_dir] || base_dir}"
+        end
+
+        def base_dir #:nodoc:
+          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"
+        end
+
+    end
+  end
+end