deployml 0.3.0

data/lib/deployml/project.rb

@@ -0,0 +1,304 @@
+require 'deployml/exceptions/config_not_found'
+require 'deployml/exceptions/invalid_config'
+require 'deployml/exceptions/unknown_environment'
+require 'deployml/environment'
+require 'deployml/remote_shell'
+
+require 'yaml'
+
+module DeploYML
+  class Project
+
+    # The general configuration directory.
+    CONFIG_DIR = 'config'
+
+    # The configuration file name.
+    CONFIG_FILE = 'deploy.yml'
+
+    # The configuration directory.
+    ENVIRONMENTS_DIR = 'deploy'
+
+    # The name of the directory to stage deployments in.
+    STAGING_DIR = '.deploy'
+
+    # The root directory of the project
+    attr_reader :root
+
+    # The deployment environments of the project
+    attr_reader :environments
+
+    #
+    # Creates a new project using the given configuration file.
+    #
+    # @param [String] root
+    #   The root directory of the project.
+    #
+    # @raise [ConfigNotFound]
+    #   The configuration file for the project could not be found
+    #   in any of the common directories.
+    #
+    def initialize(root)
+      @root = File.expand_path(root)
+      @config_file = File.join(@root,CONFIG_DIR,CONFIG_FILE)
+      @environments_dir = File.join(@root,CONFIG_DIR,ENVIRONMENTS_DIR)
+
+      unless (File.file?(@config_file) || File.directory?(@environments_dir))
+        raise(ConfigNotFound,"could not find '#{CONFIG_FILE}' or '#{ENVIRONMENTS_DIR}' in #{root}")
+      end
+
+      load_environments!
+    end
+
+    #
+    # @param [Symbol, String] name
+    #   The name of the environment to use.
+    #
+    # @return [Environment]
+    #   The environment with the given name.
+    #
+    # @raise [UnknownEnvironment]
+    #   No environment was configured with the given name.
+    #
+    # @since 0.3.0
+    #
+    def environment(name=:production)
+      name = name.to_sym
+
+      unless @environments[name]
+        raise(UnknownEnvironment,"unknown environment: #{name}")
+      end
+
+      return @environments[name]
+    end
+
+    #
+    # Conveniance method for accessing the development environment.
+    #
+    # @return [Environment]
+    #   The development environment.
+    #
+    # @since 0.3.0
+    #
+    def development
+      environment(:development)
+    end
+
+    #
+    # Conveniance method for accessing the staging environment.
+    #
+    # @return [Environment]
+    #   The staging environment.
+    #
+    # @since 0.3.0
+    #
+    def staging
+      environment(:staging)
+    end
+
+    #
+    # Conveniance method for accessing the production environment.
+    #
+    # @return [Environment]
+    #   The production environment.
+    #
+    # @since 0.3.0
+    #
+    def production
+      environment(:production)
+    end
+
+    #
+    # Deploys the project.
+    #
+    # @param [Array<Symbol>] tasks
+    #   The tasks to run during the deployment.
+    #
+    # @param [Symbol, String] env
+    #   The environment to deploy to.
+    #
+    # @return [true]
+    #
+    # @since 0.2.0
+    #
+    def invoke(tasks,env=:production)
+      env = environment(env)
+
+      env.remote_shell do |shell|
+        # setup the deployment repository
+        env.setup(shell) if tasks.include?(:setup)
+
+        # cd into the deployment repository
+        shell.cd env.dest.path
+
+        # update the deployment repository
+        env.update(shell) if tasks.include?(:update)
+
+        # framework tasks
+        env.install(shell) if tasks.include?(:install)
+        env.migrate(shell) if tasks.include?(:migrate)
+
+        # server tasks
+        if tasks.include?(:config)
+          env.server_config(shell)
+        elsif tasks.include?(:start)
+          env.server_start(shell)
+        elsif tasks.include?(:stop)
+          env.server_stop(shell)
+        elsif tasks.include?(:restart)
+          env.server_restart(shell)
+        end
+      end
+
+      return true
+    end
+
+    #
+    # Sets up the deployment repository for the project.
+    #
+    # @param [Symbol, String] env
+    #   The environment to deploy to.
+    #
+    def setup!(env=:production)
+      invoke [:setup], env
+    end
+
+    #
+    # Updates the deployed repository of the project.
+    #
+    # @param [Symbol, String] env
+    #   The environment to deploy to.
+    #
+    def update!(env=:production)
+      invoke [:update], env
+    end
+
+    #
+    # Installs the project on the destination server.
+    #
+    # @param [Symbol, String] env
+    #   The environment to deploy to.
+    #
+    def install!(env=:production)
+      invoke [:install], env
+    end
+
+    #
+    # Migrates the database used by the project.
+    #
+    # @param [Symbol, String] env
+    #   The environment to deploy to.
+    #
+    def migrate!(env=:production)
+      invoke [:migrate], env
+    end
+
+    #
+    # Configures the Web server to be ran on the destination server.
+    #
+    # @param [Symbol, String] env
+    #   The environment to deploy to.
+    #
+    def config!(env=:production)
+      invoke [:config], env
+    end
+
+    #
+    # Starts the Web server for the project.
+    #
+    # @param [Symbol, String] env
+    #   The environment to deploy to.
+    #
+    def start!(env=:production)
+      invoke [:start], env
+    end
+
+    #
+    # Stops the Web server for the project.
+    #
+    # @param [Symbol, String] env
+    #   The environment to deploy to.
+    #
+    def stop!(env=:production)
+      invoke [:stop], env
+    end
+
+    #
+    # Restarts the Web server for the project.
+    #
+    # @param [Symbol, String] env
+    #   The environment to deploy to.
+    #
+    def restart!(env=:production)
+      invoke [:restart], env
+    end
+
+    #
+    # Deploys a new project.
+    #
+    # @param [Symbol, String] env
+    #   The environment to deploy to.
+    #
+    # @since 0.2.0
+    #
+    def deploy!(env=:production)
+      invoke [:setup, :install, :migrate, :config, :start], env
+    end
+
+    #
+    # Redeploys a project.
+    #
+    # @param [Symbol, String] env
+    #   The environment to deploy to.
+    #
+    # @since 0.2.0
+    #
+    def redeploy!(env=:production)
+      invoke [:update, :install, :migrate, :restart], env
+    end
+
+    protected
+
+    #
+    # Loads the project configuration.
+    #
+    # @raise [InvalidConfig]
+    #   The YAML configuration file did not contain a Hash.
+    #
+    # @raise [MissingOption]
+    #   The `source` or `dest` options were not specified.
+    #
+    # @since 0.3.0
+    #
+    def load_environments!
+      base_config = {}
+
+      load_config_data = lambda { |path|
+        config_data = YAML.load_file(path)
+
+        unless config_data.kind_of?(Hash)
+          raise(InvalidConfig,"DeploYML file '#{path}' does not contain a Hash")
+        end
+
+        config_data
+      }
+
+      if File.file?(@config_file)
+        base_config.merge!(load_config_data[@config_file])
+      end
+
+      @environments = {}
+
+      if File.directory?(@environments_dir)
+        Dir.glob(File.join(@environments_dir,'*.yml')) do |path|
+          config_data = base_config.merge(load_config_data[path])
+          name = File.basename(path).sub(/\.yml$/,'').to_sym
+
+          @environments[name] = Environment.new(name,config_data)
+        end
+      else
+        @environments[:production] = Environment.new(:production,base_config)
+      end
+    end
+
+  end
+end

data/lib/deployml/remote_shell.rb

@@ -0,0 +1,130 @@
+require 'deployml/shell'
+
+module DeploYML
+  class RemoteShell
+
+    include Shell
+
+    #
+    # Initializes a remote shell session.
+    #
+    # @param [Addressable::URI, String] uri
+    #   The URI of the host to connect to.
+    #
+    # @yield [session]
+    #   If a block is given, it will be passed the new remote shell session.
+    #
+    # @yieldparam [ShellSession] session
+    #   The remote shell session.
+    #
+    def initialize(uri,&block)
+      case uri
+      when Addressable::URI
+        @uri = uri
+      else
+        @uri = Addressable::URI.parse(uri.to_s)
+      end
+
+      @history = []
+
+      super(&block)
+
+      replay if block
+    end
+
+    #
+    # Enqueues a program to be ran in the session.
+    #
+    # @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)
+      @history << [program, *args]
+    end
+
+    #
+    # Enqueues an `echo` command to be ran in the session.
+    #
+    # @param [String] message
+    #   The message to echo.
+    #
+    def each(message)
+      run 'echo', message
+    end
+
+    #
+    # Enqueues a directory change for the session.
+    #
+    # @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)
+      @history << ['cd', path]
+
+      if block
+        block.call() if block
+
+        @history << ['cd', '-']
+      end
+    end
+
+    #
+    # Joins the command history together with ` && `, to form a
+    # single command.
+    #
+    # @return [String]
+    #   A single command string.
+    #
+    def join
+      @history.map { |command| command.join(' ') }.join(' && ')
+    end
+
+    #
+    # Converts the URI to one compatible with SSH.
+    #
+    # @return [String]
+    #   The SSH compatible URI.
+    #
+    def ssh_uri
+      new_uri = @uri.host
+      new_uri = "#{@uri.user}@#{new_uri}" if @uri.user
+
+      return new_uri
+    end
+
+    #
+    # Starts a SSH session with the destination server.
+    #
+    # @param [Array] args
+    #   Additional arguments to pass to SSH.
+    #
+    def ssh(*args)
+      options = []
+
+      # Add the -p option if an alternate destination port is given
+      if @uri.port
+        options += ['-p', @uri.port.to_s]
+      end
+
+      options << ssh_uri
+      options += args
+
+      return system('ssh',*options)
+    end
+
+    #
+    # Replays the command history on the remote server.
+    #
+    def replay
+      ssh(self.join) unless @history.empty?
+    end
+
+  end
+end

data/lib/deployml/servers/apache.rb

@@ -0,0 +1,19 @@
+require 'deployml/exceptions/invalid_config'
+
+module DeploYML
+  module Servers
+    module Apache
+      def server_start(shell)
+        shell.run 'apachectl', 'start'
+      end
+
+      def server_restart(shell)
+        shell.run 'apachectl', 'restart'
+      end
+
+      def server_stop(shell)
+        shell.run 'apachectl', 'stop'
+      end
+    end
+  end
+end

data/lib/deployml/servers/mongrel.rb

@@ -0,0 +1,41 @@
+require 'deployml/exceptions/missing_option'
+require 'deployml/options/mongrel'
+
+module DeploYML
+  module Servers
+    module Mongrel
+      def initialize_server
+        @mongrel = Options::Mongrel.new(@server_options)
+        @mongrel.environment ||= @name
+      end
+
+      def mongrel_cluster(shell,*args)
+        options = args + ['-c', @mongrel.config]
+
+        shell.run 'mongrel_rails', *options
+      end
+
+      def server_config(shell)
+        unless @mongrel.config
+          raise(MissingOption,"No 'config' option specified under server options",caller)
+        end
+
+        options = ['-c', dest.path] + @mongrel.arguments
+
+        shell.run 'mongrel_rails', 'cluster::configure', *options
+      end
+
+      def server_start(shell)
+        mongrel_cluster 'cluster::start'
+      end
+
+      def server_stop(shell)
+        mongrel_cluster 'cluster::stop'
+      end
+
+      def server_restart(shell)
+        mongrel_cluster 'cluster::restart'
+      end
+    end
+  end
+end

data/lib/deployml/servers/thin.rb

@@ -0,0 +1,41 @@
+require 'deployml/exceptions/missing_option'
+require 'deployml/options/thin'
+
+module DeploYML
+  module Servers
+    module Thin
+      def initialize_server
+        @thin = Options::Thin.new(@server_options)
+        @thin.environment ||= @name
+      end
+
+      def thin(shell,*args)
+        options = args + ['-C', @thin.config, '-s', @thin.servers]
+
+        shell.run 'thin', *options
+      end
+
+      def server_config(shell)
+        unless @thin.config
+          raise(MissingOption,"No 'config' option specified under the server options",caller)
+        end
+
+        options = ['-c', dest.path] + @thin.arguments
+
+        shell.run 'thin', 'config', *options
+      end
+
+      def server_start(shell)
+        thin shell, 'start'
+      end
+
+      def server_stop(shell)
+        thin shell, 'stop'
+      end
+
+      def server_restart(shell)
+        thin shell, 'restart'
+      end
+    end
+  end
+end

data/lib/deployml/servers.rb

@@ -0,0 +1,3 @@
+require 'deployml/servers/apache'
+require 'deployml/servers/mongrel'
+require 'deployml/servers/thin'

data/lib/deployml/shell.rb

@@ -0,0 +1,46 @@
+module DeploYML
+  module Shell
+
+    def initialize(&block)
+      block.call(self) if block
+    end
+
+    #
+    # Place-holder method.
+    #
+    # @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)
+    end
+
+    #
+    # Executes a Rake task.
+    #
+    # @param [Symbol, String] task
+    #   Name of the Rake task to run.
+    #
+    # @param [Array<String>] args
+    #   Additional arguments for the Rake task.
+    #
+    def rake(task,*args)
+      run 'rake', rake_task(task,*args)
+    end
+
+    protected
+
+    def rake_task(name,*args)
+      name = name.to_s
+
+      unless args.empty?
+        name += ('[' + args.join(',') + ']')
+      end
+
+      return name
+    end
+
+  end
+end

data/lib/deployml/version.rb

@@ -0,0 +1,4 @@
+module DeploYML
+  # deploYML version
+  VERSION = '0.3.0'
+end

data/lib/deployml.rb

@@ -0,0 +1,2 @@
+require 'deployml/project'
+require 'deployml/version'

data/spec/configuration_spec.rb

@@ -0,0 +1,73 @@
+require 'spec_helper'
+
+require 'deployml/configuration'
+
+describe Configuration do
+  it "should accept String keys" do
+    config = Configuration.new('orm' => :datamapper)
+
+    config.orm.should == :datamapper
+  end
+
+  it "should accept Symbol keys" do
+    config = Configuration.new(:orm => :datamapper)
+
+    config.orm.should == :datamapper
+  end
+
+  it "should parse 'dest' String URIs" do
+    config = Configuration.new(
+      :dest => 'ssh://user@www.example.com/srv/project'
+    )
+
+    config.dest.scheme.should == 'ssh'
+    config.dest.user.should == 'user'
+    config.dest.host.should == 'www.example.com'
+    config.dest.path.should == '/srv/project'
+  end
+
+  it "should parse 'dest' Hash URIs" do
+    config = Configuration.new(:dest => {
+        'scheme' => 'ssh',
+        'user' => 'user',
+        'host' => 'www.example.com',
+        'path' => '/srv/project'
+    })
+
+    config.dest.scheme.should == 'ssh'
+    config.dest.user.should == 'user'
+    config.dest.host.should == 'www.example.com'
+    config.dest.path.should == '/srv/project'
+  end
+
+  it "should default the 'debug' option to false" do
+    config = Configuration.new
+
+    config.debug.should == false
+  end
+
+  it "should default the environment to nil" do
+    config = Configuration.new
+
+    config.environment.should be_nil
+  end
+
+  it "should accept a Symbol for the 'server' option" do
+    config = Configuration.new(:server => :thin)
+
+    config.server_name.should == :thin
+    config.server_options.should be_empty
+  end
+
+  it "should accept a Hash for the 'server' option" do
+    config = Configuration.new(
+      :server => {
+        :name => :thin,
+        :options => {:address => '127.0.0.1'}
+      }
+    )
+
+    config.server_name.should == :thin
+    config.server_options.should == {:address => '127.0.0.1'}
+  end
+end

data/spec/deployml_spec.rb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+
+require 'deployml/version'
+
+describe DeploYML do
+  it "should have a version" do
+    @version = DeploYML.const_get('VERSION')
+    @version.should_not be_nil
+    @version.should_not be_empty
+  end
+end