deployml 0.3.0

data/lib/deployml/environment.rb

@@ -0,0 +1,273 @@
+require 'deployml/exceptions/missing_option'
+require 'deployml/exceptions/unknown_server'
+require 'deployml/exceptions/unknown_framework'
+require 'deployml/configuration'
+require 'deployml/local_shell'
+require 'deployml/remote_shell'
+require 'deployml/servers'
+require 'deployml/frameworks'
+
+module DeploYML
+  class Environment < Configuration
+
+    # Mapping of possible 'server' names to their mixins.
+    SERVERS = {
+      :apache => Servers::Apache,
+      :mongrel => Servers::Mongrel,
+      :thin => Servers::Thin
+    }
+
+    # Mapping of possible 'framework' names to their mixins.
+    FRAMEWORKS = {
+      :rails2 => Frameworks::Rails2,
+      :rails3 => Frameworks::Rails3
+    }
+
+    #
+    # Creates a new deployment environment.
+    #
+    # @param [Symbol, String] name
+    #   The name of the deployment environment.
+    #
+    # @param [Hash{String => Object}] config
+    #   Environment specific configuration.
+    #
+    # @raise [MissingOption]
+    #   Either the `source` or `dest` options were not specified in the
+    #   confirmation.
+    # 
+    # @since 0.3.0
+    #
+    def initialize(name,config={})
+      super(config)
+
+      unless @source
+        raise(MissingOption,":source option is missing for the #{@name} environment")
+      end
+
+      unless @dest
+        raise(MissingOption,":dest option is missing for the #{@name} environment")
+      end
+
+      @environment ||= name.to_sym
+
+      load_framework!
+      load_server!
+    end
+
+    #
+    # Creates a local shell.
+    #
+    # @yield [shell]
+    #   If a block is given, it will be passed the new local shell.
+    #
+    # @yieldparam [LocalShell] shell
+    #   The remote shell session.
+    #
+    # @return [LocalShell]
+    #   The local shell.
+    #
+    # @since 0.3.0
+    #
+    def local_shell(&block)
+      LocalShell.new(&block)
+    end
+
+    #
+    # Creates a remote shell with the destination server.
+    #
+    # @yield [shell]
+    #   If a block is given, it will be passed the new remote shell.
+    #
+    # @yieldparam [RemoteShell] shell
+    #   The remote shell.
+    #
+    # @return [RemoteShell]
+    #   The remote shell.
+    #
+    # @since 0.3.0
+    #
+    def remote_shell(&block)
+      RemoteShell.new(@dest,&block)
+    end
+
+    #
+    # Runs a command on the destination server, in the destination
+    # directory.
+    #
+    # @return [true]
+    #
+    # @since 0.3.0
+    #
+    def exec(command)
+      remote_shell do |shell|
+        shell.cd(@dest.path)
+        shell.run(command)
+      end
+
+      return true
+    end
+
+    #
+    # Executes a Rake task on the destination server, in the destination
+    # directory.
+    #
+    # @return [true]
+    #
+    # @since 0.3.0
+    #
+    def rake(task,*args)
+      remote_shell do |shell|
+        shell.cd(@dest.path)
+        shell.rake(task,*args)
+      end
+
+      return true
+    end
+
+    #
+    # Starts an SSH session with the destination server.
+    #
+    # @param [Array] args
+    #   Additional arguments to pass to SSH.
+    #
+    # @return [true]
+    #
+    # @since 0.3.0
+    #
+    def ssh(*args)
+      RemoteShell.new(@dest).ssh(*args)
+      return true
+    end
+
+    #
+    # Sets up the deployment repository for the project.
+    #
+    # @param [RemoteShell] shell
+    #   The remote shell to execute commands through.
+    #
+    # @since 0.3.0
+    #
+    def setup(shell)
+      shell.run 'git', 'clone', '--depth', 1, @source, @dest.path
+    end
+
+    #
+    # Updates the deployed repository for the project.
+    #
+    # @param [RemoteShell] shell
+    #   The remote shell to execute commands through.
+    #
+    # @since 0.3.0
+    #
+    def update(shell)
+      shell.run 'git', 'reset', '--hard', 'HEAD'
+      shell.run 'git', 'pull'
+    end
+
+    #
+    # Place-holder method.
+    #
+    # @param [RemoteShell] shell
+    #   The remote shell to execute commands through.
+    #
+    # @since 0.3.0
+    #
+    def install(shell)
+    end
+
+    #
+    # Place-holder method.
+    #
+    # @param [RemoteShell] shell
+    #   The remote shell to execute commands through.
+    #
+    # @since 0.3.0
+    #
+    def migrate(shell)
+    end
+
+    #
+    # Place-holder method.
+    #
+    # @param [RemoteShell] shell
+    #   The remote shell to execute commands through.
+    #
+    # @since 0.3.0
+    #
+    def server_config(shell)
+    end
+
+    #
+    # Place-holder method.
+    #
+    # @param [RemoteShell] shell
+    #   The remote shell to execute commands through.
+    #
+    # @since 0.3.0
+    #
+    def server_start(shell)
+    end
+
+    #
+    # Place-holder method.
+    #
+    # @param [RemoteShell] shell
+    #   The remote shell to execute commands through.
+    #
+    # @since 0.3.0
+    #
+    def server_stop(shell)
+    end
+
+    #
+    # Place-holder method.
+    #
+    # @param [RemoteShell] shell
+    #   The remote shell to execute commands through.
+    #
+    # @since 0.3.0
+    #
+    def server_restart(shell)
+    end
+
+    protected
+
+    #
+    # Loads the framework configuration.
+    #
+    # @since 0.3.0
+    #
+    def load_framework!
+      if @orm
+        unless FRAMEWORKS.has_key?(@framework)
+          raise(UnknownFramework,"Unknown framework #{@framework}")
+        end
+
+        extend FRAMEWORKS[@framework]
+
+        initialize_framework() if self.respond_to?(:initialize_framework)
+      end
+    end
+
+    #
+    # Loads the server configuration.
+    #
+    # @raise [UnknownServer]
+    #
+    # @since 0.3.0
+    #
+    def load_server!
+      if @server_name
+        unless SERVERS.has_key?(@server_name)
+          raise(UnknownServer,"Unknown server name #{@server_name}")
+        end
+
+        extend SERVERS[@server_name]
+
+        initialize_server() if self.respond_to?(:initialize_server)
+      end
+    end
+
+  end
+end

data/lib/deployml/exceptions/config_not_found.rb

@@ -0,0 +1,4 @@
+module DeploYML
+  class ConfigNotFound < RuntimeError
+  end
+end

data/lib/deployml/exceptions/invalid_config.rb

@@ -0,0 +1,4 @@
+module DeploYML
+  class InvalidConfig < RuntimeError
+  end
+end

data/lib/deployml/exceptions/missing_option.rb

@@ -0,0 +1,6 @@
+require 'deployml/exceptions/invalid_config'
+
+module DeploYML
+  class MissingOption < InvalidConfig
+  end
+end

data/lib/deployml/exceptions/unknown_environment.rb

@@ -0,0 +1,4 @@
+module DeploYML
+  class UnknownEnvironment < RuntimeError
+  end
+end

data/lib/deployml/exceptions/unknown_framework.rb

@@ -0,0 +1,6 @@
+require 'deployml/exceptions/invalid_config'
+
+module DeploYML
+  class UnknownFramework < InvalidConfig
+  end
+end

data/lib/deployml/exceptions/unknown_server.rb

@@ -0,0 +1,6 @@
+require 'deployml/exceptions/invalid_config'
+
+module DeploYML
+  class UnknownServer < InvalidConfig
+  end
+end

data/lib/deployml/frameworks/rails2.rb

@@ -0,0 +1,9 @@
+module DeploYML
+  module Frameworks
+    module Rails2
+      def migrate(shell)
+        shell.run 'rake', 'db:migrate', "RAILS_ENV=#{@environment}"
+      end
+    end
+  end
+end

data/lib/deployml/frameworks/rails3.rb

@@ -0,0 +1,20 @@
+module DeploYML
+  module Frameworks
+    module Rails3
+      def install(shell)
+        shell.run 'bundle', 'install', '--deployment'
+      end
+
+      def migrate(shell)
+        task = case @orm
+               when :datamapper
+                 'db:autoupgrade'
+               else
+                 'db:migrate'
+               end
+
+        shell.run 'rake', task, "RAILS_ENV=#{@environment}"
+      end
+    end
+  end
+end

data/lib/deployml/frameworks.rb

@@ -0,0 +1,2 @@
+require 'deployml/frameworks/rails2'
+require 'deployml/frameworks/rails3'

data/lib/deployml/local_shell.rb

@@ -0,0 +1,54 @@
+require 'deployml/shell'
+
+module DeploYML
+  class LocalShell
+
+    include Shell
+
+    #
+    # Runs a program locally.
+    #
+    # @param [String] program
+    #   The name or path of the program to run.
+    #
+    # @param [Array<String>] args
+    #   Additional arguments for the program.
+    #
+    def run(program,*args)
+      system(program,*args)
+    end
+
+    #
+    # Prints out a message.
+    #
+    # @param [String] message
+    #   The message to print.
+    #
+    def echo(message)
+      puts message
+    end
+
+    #
+    # Changes the current working directory.
+    #
+    # @param [String] path
+    #   The path of the new current working directory to use.
+    #
+    # @yield []
+    #   If a block is given, then the directory will be changed back after
+    #   the block has returned.
+    #
+    def cd(path,&block)
+      if block
+        cwd = Dir.pwd
+
+        Dir.chdir(path)
+        block.call()
+        Dir.chdir(cwd)
+      else
+        Dir.chdir(path)
+      end
+    end
+
+  end
+end

data/lib/deployml/options/mongrel.rb

@@ -0,0 +1,46 @@
+require 'rprogram/task'
+
+module DeploYML
+  module Options
+    class Mongrel < RProgram::Task
+
+      DEFAULTS = {
+        :environment => :production,
+        :address => '127.0.0.1',
+        :num_servers => 2
+      }
+
+      long_option :flag => '--environment'
+      long_option :flag => '--port'
+      long_option :flag => '--address'
+      long_option :flag => '--log'
+      long_option :flag => '--pid'
+      long_option :flag => '--chdir'
+      long_option :flag => '--timeout'
+      long_option :flag => '--throttle'
+      long_option :flag => '--mime'
+      long_option :flag => '--root'
+      long_option :flag => '--num-procs'
+      long_option :flag => '--debug'
+      long_option :flag => '--script'
+      long_option :flag => '--num-servers'
+      long_option :flag => '--config'
+      long_option :flag => '--user'
+      long_option :flag => '--group'
+      long_option :flag => '--prefix'
+      long_option :flag => '--help'
+      long_option :flag => '--version'
+
+      #
+      # Initialize the Mongrel options.
+      #
+      # @param [Hash] options
+      #   The given options.
+      #
+      def initialize(options={})
+        super(DEFAULTS.merge(options))
+      end
+
+    end
+  end
+end

data/lib/deployml/options/thin.rb

@@ -0,0 +1,72 @@
+require 'rprogram/task'
+
+module DeploYML
+  module Options
+    class Thin < RProgram::Task
+
+      # Default options for Thin
+      DEFAULTS = {
+        :environment => :production,
+        :address => '127.0.0.1',
+        :servers => 2
+      }
+
+      # Server options:
+      long_option :flag => '--address'
+      long_option :flag => '--port'
+      long_option :flag => '--socket'
+      long_option :flag => '--swiftiply'
+      long_option :flag => '--adapter'
+      long_option :flag => '--rackup'
+      long_option :flag => '--chdir'
+      long_option :flag => '--stats'
+
+      # Adapter options:
+      long_option :flag => '--environment'
+      long_option :flag => '--prefix'
+
+      # Daemon options:
+      long_option :flag => '--daemonize'
+      long_option :flag => '--log'
+      long_option :flag => '--pid'
+      long_option :flag => '--user'
+      long_option :flag => '--group'
+      long_option :flag => '--tag'
+
+      # Cluster options:
+      long_option :flag => '--servers'
+      long_option :flag => '--only'
+      long_option :flag => '--config'
+      long_option :flag => '--all'
+      long_option :flag => '--onebyone', :name => :one_by_one
+      long_option :flag => '--wait'
+
+      # Tuning options:
+      long_option :flag => '--backend'
+      long_option :flag => '--timeout'
+      long_option :flag => '--force'
+      long_option :flag => '--max-conns', :name => :max_connections
+      long_option :flag => '--max-persistent-conns', :name => :max_persistant_connections
+      long_option :flag => '--threaded'
+      long_option :flag => '--no-epoll'
+
+      # Common options:
+      long_option :flag => '--require'
+      long_option :flag => '--debug'
+      long_option :flag => '--trace'
+      long_option :flag => '--help'
+      long_option :flag => '--version'
+
+      #
+      # Initialize the Thin options.
+      #
+      # @param [Hash] options
+      #   The given options.
+      #
+      def initialize(options={})
+        super(DEFAULTS.merge(options))
+      end
+
+    end
+  end
+end

data/lib/deployml/options.rb

@@ -0,0 +1 @@
+require 'deployml/options/thin'