pot 0.1.0

data/lib/pot/installers/apt.rb

@@ -0,0 +1,52 @@
+module Pot
+  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/pot/installers/binary.rb

@@ -0,0 +1,46 @@
+module Pot
+  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/pot/installers/brew.rb

@@ -0,0 +1,34 @@
+module Pot
+  module Installers
+    # = Homebrew Package Installer
+    #
+    # The Homebrew package installer uses the +brew+ command to install
+    # packages on OSX.
+    #
+    # == Example Usage
+    #
+    #   package :magic_beans do
+    #     description "Beans beans they're good for your heart..."
+    #     brew 'magic_beans_package'
+    #   end
+    #
+    class Brew < Installer
+      attr_accessor :formulas #:nodoc:
+
+      def initialize(parent, *formulas, &block) #:nodoc:
+        formulas.flatten!
+
+        super parent, &block
+
+        @formulas = formulas
+      end
+
+      protected
+
+        def install_commands #:nodoc:
+          "brew install #{@formulas.join(' ')}"
+        end
+
+    end
+  end
+end

data/lib/pot/installers/deb.rb

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

@@ -0,0 +1,64 @@
+module Pot
+  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/pot/installers/group.rb

@@ -0,0 +1,15 @@
+module Pot
+  module Installers
+    class Group < Installer
+      def initialize(package, groupname, options, &block)
+        super package, &block
+        @groupname = groupname
+        @options = options
+      end
+      protected
+      def install_commands
+        "addgroup #{@options[:flags]} #{@groupname}"
+      end
+    end
+  end
+end

data/lib/pot/installers/npm.rb

@@ -0,0 +1,19 @@
+module Pot
+  	module Installers
+
+  		class Npm < Installer
+  			attr_accessor :package_name
+
+  			def initialize(parent, package_name, &block)
+  				super parent, &block
+  				@package_name = package_name
+  			end
+
+  			protected
+  				def install_commands #override
+  					"npm install --global #{@package_name}"
+  				end
+
+  		end
+	end
+end

data/lib/pot/installers/push_text.rb

@@ -0,0 +1,49 @@
+module Pot
+  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
+      require 'shellwords'
+
+      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:
+          #"#{"#{'sudo ' if option?(:sudo)}grep \"^#{@text.gsub("'", "'\\\\''").gsub("\n", '\n')}$\" #{@path} ||" if option?(:idempotent) }/bin/echo -e '#{@text.gsub("'", "'\\\\''").gsub("\n", '\n')}' |#{'sudo ' if option?(:sudo)}tee -a #{@path}"
+          text = Shellwords.escape(@text)
+          "bash -c '/bin/echo -e #{text} | tee -a #{@path}'"
+        end
+
+    end
+  end
+end

data/lib/pot/installers/rake.rb

@@ -0,0 +1,37 @@
+module Pot
+  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
+      end
+
+      protected
+
+        def install_commands #:nodoc:
+          file = @options[:rakefile] ? "-f #{@options[:rakefile]} " : ""
+          "rake #{file}#{@commands}"
+        end
+
+    end
+  end
+end

data/lib/pot/installers/replace_text.rb

@@ -0,0 +1,45 @@
+module Pot
+  module Installers
+    # = Replace text installer
+    #
+    # This installer replaces a text with another one in a file.
+    #
+    # == Example Usage
+    #
+    # Change ssh port in /etc/ssh/sshd_config
+    #
+    #   package :magic_beans do
+    #     replace_text 'Port 22', 'Port 2500', '/etc/ssh/sshd_config'
+    #   end
+    #
+    # If you user has access to 'sudo' and theres a file that requires
+    # priveledges, you can pass :sudo => true
+    #
+    #   package :magic_beans do
+    #     replace_text 'Port 22', 'Port 2500', '/etc/ssh/sshd_config', :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 ReplaceText < Installer
+      attr_accessor :regex, :text, :path #:nodoc:
+
+      def initialize(parent, regex, text, path, options={}, &block) #:nodoc:
+        super parent, options, &block
+        @regex = regex
+        @text = text
+        @path = path
+      end
+
+      protected
+
+        def install_commands #:nodoc:
+          logger.info "--> Replace '#{@regex}' with '#{@text}' in file #{@path}"
+          "#{'sudo ' if option?(:sudo)}sed -i 's/#{@regex.gsub("'", "'\\\\''").gsub("/", "\\\\/").gsub("\n", '\n')}/#{@text.gsub("'", "'\\\\''").gsub("/", "\\\\/").gsub("\n", '\n')}/g' #{@path}"
+        end
+
+    end
+  end
+end

data/lib/pot/installers/runner.rb

@@ -0,0 +1,20 @@
+module Pot
+	module Installers
+		class Runner < Installer
+			require 'shellwords'
+
+			attr_accessor :cmd #:nodoc:
+
+			def initialize(parent, cmd, options = {}, &block) #:nodoc:
+			  super parent, options, &block
+				@cmd = cmd
+			end
+
+			protected
+
+				def install_commands #:nodoc:
+					@cmd
+				end
+		end
+	end
+end

data/lib/pot/installers/source.rb

@@ -0,0 +1,202 @@
+module Pot
+  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
+        @options[:prefix] ||= '/usr/local'
+        @options[:archives] ||= '/usr/src'
+        @options[:builds] ||= '/tmp'
+      end
+
+      def commands #:nodoc:
+        prepare + download + extract + configure + build + install
+      end
+
+      private
+
+        %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:
+          if File.exist? @source
+            [ "cp #{@source} #{@options[:archives]}/#{archive_name}" ]
+          else
+            [ "/usr/bin/curl -L -o '#{@options[:archives]}/#{archive_name}' #{@source}" ]
+          end
+        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 }
+
+          if options[:configure_options]
+            command << options[:configure_options]
+            command << ' '
+          end
+
+          [ 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
+
+        # dress is overriden from the base Pot::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
+
+        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 -o'
+          else
+            raise "Unknown source archive format: #{archive_name}"
+          end
+        end
+
+        def archive_name #:nodoc:
+          name = @source.split('/').last
+          if options[:custom_archive]
+            name = options[:custom_archive]
+            name = name.join if name.is_a? Array
+          end
+          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