sunshine 1.2.0 → 1.2.1

data/lib/sunshine/daemon.rb

@@ -11,6 +11,10 @@ module Sunshine
 
   class Daemon
 
+    START_FAILED_CODE   = 10
+    STOP_FAILED_CODE    = 11
+    RESTART_FAILED_CODE = 12
+    STATUS_DOWN_CODE  = 13
 
     ##
     # Returns an array of method names to assign to the binder
@@ -142,7 +146,7 @@ module Sunshine
           binder = config_binding server_app.shell
 
           configure_remote_dirs server_app.shell
-          touch_log_files server_app.shell
+          chown_log_files server_app.shell
 
           yield(server_app, binder) if block_given?
 
@@ -156,7 +160,7 @@ module Sunshine
       @setup_successful = true
 
     rescue => e
-      raise CriticalDeployError.new(e, "Could not setup #{@name}")
+      raise DaemonError.new(e, "Could not setup #{@name}")
     end
 
 
@@ -186,12 +190,12 @@ module Sunshine
 
         each_server_app do |server_app|
           begin
-            server_app.shell.call start_cmd,
+            server_app.shell.call _start_cmd,
               :sudo => pick_sudo(server_app.shell)
 
             yield(server_app) if block_given?
           rescue => e
-            raise CriticalDeployError.new(e, "Could not start #{@name}")
+            raise DaemonError.new(e, "Could not start #{@name}")
           end
         end
       end
@@ -203,7 +207,7 @@ module Sunshine
 
     def status
       each_server_app do |server_app|
-        server_app.shell.call status_cmd, :sudo => pick_sudo(server_app.shell)
+        server_app.shell.call _status_cmd, :sudo => pick_sudo(server_app.shell)
       end
       true
 
@@ -220,12 +224,12 @@ module Sunshine
 
         each_server_app do |server_app|
           begin
-            server_app.shell.call stop_cmd,
+            server_app.shell.call _stop_cmd,
               :sudo => pick_sudo(server_app.shell)
 
             yield(server_app) if block_given?
           rescue => e
-            raise CriticalDeployError.new(e, "Could not stop #{@name}")
+            raise DaemonError.new(e, "Could not stop #{@name}")
           end
         end
       end
@@ -242,25 +246,42 @@ module Sunshine
       Sunshine.logger.info @name, "Restarting #{@name} daemon" do
         each_server_app do |server_app|
           begin
-            server_app.shell.call restart_cmd,
+            server_app.shell.call _restart_cmd,
               :sudo => pick_sudo(server_app.shell)
 
             yield(server_app) if block_given?
           rescue => e
-            raise CriticalDeployError.new(e, "Could not restart #{@name}")
+            raise DaemonError.new(e, "Could not restart #{@name}")
           end
         end
       end
     end
 
 
+    ##
+    # Wrap a command with a fail-specific exitcode and message.
+
+    def exit_on_failure cmd, exitcode=1, message=nil
+      "(#{cmd}) || (echo '#{message}' && exit #{exitcode});"
+    end
+
+
     ##
     # Gets the command that starts the daemon.
     # Should be overridden by child classes.
 
     def start_cmd
-      return @start_cmd ||
-        raise(CriticalDeployError, "@start_cmd undefined. Can't start #{@name}")
+      return @start_cmd if @start_cmd
+      raise DaemonError, "start_cmd undefined for #{@name}"
+    end
+
+
+    ##
+    # Start command wrapped with an exit_on_failure handler.
+
+    def _start_cmd
+      exit_on_failure start_cmd, START_FAILED_CODE,
+        "Could not start #{@name} for #{@app.name}"
     end
 
 
@@ -269,26 +290,59 @@ module Sunshine
 
     def stop_cmd
       "test -f #{@pid} && kill -#{@sigkill} $(cat #{@pid}) && sleep 1 && "+
-        "rm -f #{@pid} || echo 'Could not kill #{@name} pid for #{@app.name}';"
+        "rm -f #{@pid}"
+    end
+
+
+    ##
+    # Stop command wrapped with an exit_on_failure handler.
+
+    def _stop_cmd
+      exit_on_failure stop_cmd, STOP_FAILED_CODE,
+        "Could not kill #{@name} pid for #{@app.name}"
     end
 
 
     ##
     # Gets the command that restarts the daemon.
+    # Should be overridden by child classes if different
+    # from start_cmd && stop_cmd.
 
     def restart_cmd
-      @restart_cmd || [stop_cmd, start_cmd].map{|c| "(#{c})"}.join(" && ")
+      @restart_cmd
     end
 
 
     ##
-    # Get the command to check if the daemon is running.
+    # Restart command wrapped with an exit_on_failure handler.
+
+    def _restart_cmd
+      if restart_cmd
+        exit_on_failure restart_cmd, RESTART_FAILED_CODE,
+          "Could not restart #{@name} for #{@app.name}"
+      else
+        "(#{_stop_cmd}) && (#{_start_cmd});"
+      end
+    end
+
+
+    ##
+    # Status command wrapped with an exit_on_failure handler.
 
     def status_cmd
       @status_cmd || "test -f #{@pid} && kill -0 $(cat #{@pid})"
     end
 
 
+    ##
+    # Get the command to check if the daemon is running.
+
+    def _status_cmd
+      exit_on_failure status_cmd, STATUS_DOWN_CODE,
+        "#{@app.name} #{@name} is not running"
+    end
+
+
     ##
     # Append or override daemon log file paths:
     #   daemon.log_files :stderr => "/all_logs/stderr.log"
@@ -390,7 +444,7 @@ module Sunshine
     ##
     # Make sure log files are owned by the daemon's user.
 
-    def touch_log_files shell
+    def chown_log_files shell
       files = @log_files.values.join(" ")
 
       sudo = pick_sudo(shell)
@@ -401,8 +455,8 @@ module Sunshine
                nil
              end
 
-      shell.call "touch #{files}", :sudo => true
-      shell.call "chown #{user} #{files}", :sudo => true if user
+      return unless user
+      shell.call "chown -f #{user} #{files}", :sudo => true rescue nil
     end
 
 
@@ -419,7 +473,7 @@ module Sunshine
           %w{start stop restart status}.each do |script|
             script_file = "#{@config_path}/#{script}"
 
-            cmd = send "#{script}_cmd".to_sym
+            cmd = send "_#{script}_cmd"
 
             sa.shell.make_file script_file, cmd,
               :flags => '--chmod=ugo=rwx'

data/lib/sunshine/dependency_lib.rb

@@ -36,8 +36,6 @@ module Sunshine
 
   class DependencyLib
 
-    class MissingDependency < Exception; end
-
     ##
     # Array of all dependency classes. Appended to automatically when
     # DependencyLib::Dependency is inherited.

data/lib/sunshine/exceptions.rb

@@ -17,38 +17,56 @@ module Sunshine
 
   ##
   # An error occurred when attempting to run a command on the local system
-  class CmdError < Exception; end
+  class CmdError < Exception;
+    attr_reader :exit_code
 
-
-  ##
-  # An ssh call returned a non-zero exit code
-  class SSHCmdError < CmdError
-    attr_reader :shell
-    def initialize message=nil, shell=nil
-      @shell = shell
-      super(message)
+    def initialize exit_code, cmd=nil
+      message = "Execution failed with status #{exit_code}: #{cmd}"
+      super message
+      @exit_code = exit_code
     end
   end
 
 
+  ##
+  # A shell command timed out.
+  class TimeoutError < Exception; end
+
+
+  ##
+  # Remote connection to server failed.
+  class ConnectionError < Exception; end
+
+
   ##
   # Something went wrong with a deploy-specific item.
   class DeployError < Exception; end
 
 
   ##
-  # The error is serious enough that deploy cannot proceed.
-  # Sunshine will attempt to revert to a previous deploy if available.
-  class CriticalDeployError < DeployError; end
+  # Something went wrong with a daemon-specific item.
+  class DaemonError < Exception; end
 
 
   ##
-  # The error is so serious that all no more action can be taken.
-  # Sunshine will attempt to close any ssh connections and stop the deploy.
-  class FatalDeployError < DeployError; end
+  # Something went wrong with a dependency-specific item.
+  class DependencyError < Exception; end
+
+
+  ##
+  # Dependency requested could not be found.
+  class MissingDependency < DependencyError; end
+
 
   ##
-  # A dependency could not be installed.
-  class DependencyError < FatalDeployError; end
+  # Dependency failed to install.
+  class InstallError < DependencyError; end
 
+  ##
+  # Dependency failed to uninstall.
+  class UninstallError < DependencyError; end
+
+  ##
+  # Something went wrong with a scm-specific item.
+  class RepoError < Exception; end
 end

data/lib/sunshine/package_managers/apt.rb

@@ -32,7 +32,7 @@ module Sunshine
     # Checks if dependency type is valid for a given shell.
 
     def self.system_manager? shell=nil
-      (shell || Sunshine.shell).syscall "apt-get --version"
+      (shell || Sunshine.shell).system "apt-get --version"
     end
 
 

data/lib/sunshine/package_managers/dependency.rb

@@ -43,11 +43,6 @@ module Sunshine
 
   class Dependency
 
-    class CmdError < Exception; end
-    class InstallError < Exception; end
-    class UninstallError < Exception; end
-
-
     ##
     # Check if sudo should be used
 

data/lib/sunshine/package_managers/yum.rb

@@ -34,7 +34,7 @@ module Sunshine
     # Checks if dependency type is valid for a given shell.
 
     def self.system_manager? shell=nil
-      (shell || Sunshine.shell).syscall "yum --version"
+      (shell || Sunshine.shell).system "yum --version"
     end
 
 

data/lib/sunshine/remote_shell.rb

@@ -11,8 +11,6 @@ module Sunshine
 
   class RemoteShell < Shell
 
-    class ConnectionError < FatalDeployError; end
-
     ##
     # The loop to keep the ssh connection open.
     LOGIN_LOOP = "echo ok; echo ready; "+
@@ -61,7 +59,7 @@ module Sunshine
 
       @user ||= options[:user]
 
-      @rsync_flags = ["-azP"]
+      @rsync_flags = ["-azrP"]
       @rsync_flags.concat [*options[:rsync_flags]] if options[:rsync_flags]
 
       @ssh_flags = [
@@ -170,7 +168,25 @@ module Sunshine
     # Checks if the given file exists
 
     def file? filepath
-      syscall "test -f #{filepath}"
+      self.system "test -f #{filepath}"
+    end
+
+
+    ##
+    # Start an interactive shell with preset permissions and env.
+    # Optionally pass a command to be run first.
+
+    def tty! cmd=nil
+      sync do
+        cmd = [cmd, "sh -il"].compact.join " && "
+        cmd = quote_cmd cmd
+
+        pid = fork do
+          exec \
+            ssh_cmd(sudo_cmd(env_cmd(cmd)), :flags => "-t").to_a.join(" ")
+        end
+        Process.waitpid pid
+      end
     end
 
 
@@ -202,7 +218,7 @@ module Sunshine
 
 
     ##
-    # Uploads a file via rsync
+    # Uploads a file via rsync.
 
     def upload from_path, to_path, options={}, &block
       to_path = "#{@host}:#{to_path}"

data/lib/sunshine/repo.rb

@@ -1,7 +1,5 @@
 module Sunshine
 
-  class RepoError < Exception; end
-
   ##
   # An abstract class to wrap simple basic scm features. The primary function
   # of repo objects is to get information about the scm branch that is being
@@ -80,12 +78,12 @@ module Sunshine
     # Defaults to false. Subclasses must override this method to enable
     # auto detecting of a given scm implementation.
 
-    def self.valid?
+    def self.valid? *args
       false
     end
 
 
-    attr_reader :url, :scm
+    attr_accessor :url, :scm, :flags
 
     def initialize url, options={}
       @scm = self.class.name.split("::").last.sub('Repo', '').downcase
@@ -106,11 +104,12 @@ module Sunshine
       shell.call "test -d #{path} && rm -rf #{path} || echo false"
       shell.call "mkdir -p #{path}"
 
-      do_checkout   path, shell
-      get_repo_info path, shell
+      do_checkout     path, shell
+      get_repo_info   path, shell
     end
 
 
+
     ##
     # Checkout the repo - implemented by subclass
 

data/lib/sunshine/repos/rsync_repo.rb

@@ -12,7 +12,7 @@ module Sunshine
 
     def initialize url, options={}
       super
-      @flags << '-r' << '--exclude .svn/' << '--exclude .git/'
+      @flags << '--exclude .svn/' << '--exclude .git/'
       @url << "/" unless @url[-1..-1] == "/"
     end
 

data/lib/sunshine/server_app.rb

@@ -33,7 +33,7 @@ module Sunshine
 
 
     ##
-    # Define an attribue that will get a value from app, or locally if
+    # Define an attribute that will get a value from app, or locally if
     # @app isn't set.
 
     def self.app_attr *attribs
@@ -74,6 +74,23 @@ module Sunshine
     end
 
 
+    ##
+    # Creates a ServerApp instance from a deploy info file.
+
+    def self.from_info_file path, shell=nil
+      shell ||= Sunshine.shell
+
+      opts = YAML.load shell.call("cat #{path}")
+      opts[:root_path] = opts.delete :path
+
+      sa_shell = shell.dup
+      sa_shell.env = opts[:env] || Hash.new
+      sa_shell.connect if shell.connected?
+
+      new opts[:name], sa_shell, opts
+    end
+
+
     app_attr :name, :deploy_name
     app_attr :root_path, :checkout_path, :current_path
     app_attr :deploys_path, :log_path, :shared_path, :scripts_path
@@ -81,6 +98,13 @@ module Sunshine
     attr_accessor :app, :roles, :scripts, :info, :shell, :crontab, :health
     attr_writer :pkg_manager
 
+    ##
+    # Create a server app instance. Supports the following
+    # argument configurations:
+    #
+    #   ServerApp.new app_inst, "myserver.com", :roles => :web
+    #   ServerApp.new "app_name", shell_inst, options_hash
+
     def initialize app, host, options={}
 
       @app = App === app ? app : nil
@@ -108,6 +132,9 @@ module Sunshine
 
       @crontab = Crontab.new name, @shell
       @health  = Healthcheck.new shared_path, @shell
+
+      @all_deploy_names = nil
+      @previous_deploy_name = nil
     end
 
 
@@ -140,7 +167,7 @@ module Sunshine
       end
 
       if build_scripts[:status].empty?
-        build_scripts[:status] << "echo 'No daemons for #{self.name}'; exit 1;"
+        build_scripts[:status] << "echo 'No status for #{self.name}'; exit 1;"
       end
 
       build_scripts.each do |name, cmds|
@@ -152,6 +179,8 @@ module Sunshine
 
         write_script name, bash
       end
+
+      symlink_scripts_to_root
     end
 
 
@@ -194,7 +223,7 @@ module Sunshine
     def deploy_details reload=false
       return @deploy_details if @deploy_details && !reload
       @deploy_details =
-        YAML.load @shell.call("cat #{self.scripts_path}/info") rescue nil
+        YAML.load @shell.call("cat #{self.root_path}/info") rescue nil
 
       @deploy_details = nil unless Hash === @deploy_details
 
@@ -234,8 +263,11 @@ module Sunshine
         :deployed_as => @shell.call("whoami"),
         :deployed_by => Sunshine.shell.user,
         :deploy_name => File.basename(self.checkout_path),
+        :name        => self.name,
+        :env         => shell_env,
         :roles       => @roles,
-        :path        => self.root_path
+        :path        => self.root_path,
+        :sunshine_version => Sunshine::VERSION
       }.merge @info
     end
 
@@ -348,6 +380,31 @@ fi
     end
 
 
+    ##
+    # Returns an array of all deploys in the deploys_path dir,
+    # starting with the oldest.
+
+    def all_deploy_names reload=false
+      return @all_deploy_names if @all_deploy_names && !reload
+
+      @all_deploy_names =
+        @shell.call("ls -rc1 #{self.deploys_path}").split("\n")
+    end
+
+
+    ##
+    # Returns the name of the previous deploy.
+
+    def previous_deploy_name reload=false
+      return @previous_deploy_name if @previous_deploy_name && !reload
+
+      arr = all_deploy_names(reload)
+      arr.delete(@deploy_name)
+
+      @previous_deploy_name = arr.last
+    end
+
+
     ##
     # Run a rake task the deploy server.
 
@@ -370,7 +427,7 @@ fi
     # based on Sunshine's max_deploy_versions.
 
     def remove_old_deploys
-      deploys = @shell.call("ls -1 #{self.deploys_path}").split("\n")
+      deploys = all_deploy_names true
 
       return unless deploys.length > Sunshine.max_deploy_versions
 
@@ -388,7 +445,18 @@ fi
     # Post-deploy only.
 
     def restart
-      @shell.call "#{self.root_path}/restart" rescue false
+      # Permissions are handled by the script, use: :sudo => false
+      run_script :stop, :sudo => false
+    end
+
+
+    ##
+    # Run the app's restart script. Raises an exception on failure.
+    # Post-deploy only.
+
+    def restart!
+      # Permissions are handled by the script, use: :sudo => false
+      run_script! :restart, :sudo => false
     end
 
 
@@ -399,7 +467,7 @@ fi
     def revert!
       @shell.call "rm -rf #{self.checkout_path}"
 
-      last_deploy = @shell.call("ls -rc1 #{self.deploys_path}").split("\n").last
+      last_deploy = previous_deploy_name(true)
 
       if last_deploy && !last_deploy.empty?
         @shell.symlink "#{self.deploys_path}/#{last_deploy}", self.current_path
@@ -438,13 +506,25 @@ fi
 
 
     ##
-    # Runs a script from the script_path.
+    # Runs a script from the root_path.
     # Post-deploy only.
 
     def run_script name, options=nil, &block
       options ||= {}
-      @shell.call \
-        File.join(self.scripts_path, name.to_s), options, &block rescue false
+      run_script! name, options, &block rescue false
+    end
+
+
+    ##
+    # Runs a script from the root_path. Raises an exception if the status
+    # code is not 0.
+    # Post-deploy only.
+
+    def run_script! name, options=nil, &block
+      options ||= {}
+
+      script_path = File.join self.root_path, name.to_s
+      @shell.call script_path, options, &block
     end
 
 
@@ -454,7 +534,12 @@ fi
 
     def running?
       # Permissions are handled by the script, use: :sudo => false
-      run_script :status, :sudo => false
+      run_script! :status, :sudo => false
+      true
+
+    rescue CmdError => e
+      return false if e.exit_code == Daemon::STATUS_DOWN_CODE
+      raise e
     end
 
 
@@ -499,6 +584,23 @@ fi
     end
 
 
+    ##
+    # Run the app's start script. Raises an exception on failure.
+    # Post-deploy only.
+
+    def start! options=nil
+      options ||= {}
+
+      if running?
+        return unless options[:force]
+        stop!
+      end
+
+      # Permissions are handled by the script, use: :sudo => false
+      run_script! :start, :sudo => false
+    end
+
+
     ##
     # Get the app's status: :running or :down.
 
@@ -517,6 +619,16 @@ fi
     end
 
 
+    ##
+    # Run the app's stop script. Raises an exception on failure.
+    # Post-deploy only.
+
+    def stop!
+      # Permissions are handled by the script, use: :sudo => false
+      run_script! :stop, :sudo => false
+    end
+
+
     ##
     # Creates a symlink to the app's checkout path.
 
@@ -525,12 +637,34 @@ fi
     end
 
 
+    ##
+    # Creates a symlink of every script in the scripts_path dir in the
+    # app's root directory for easy access.
+
+    def symlink_scripts_to_root
+      scripts = @shell.call("ls -1 #{self.scripts_path}").split("\n")
+
+      scripts.each do |name|
+        script_file = File.join self.scripts_path, name
+        pointer_file = File.join self.root_path, name
+
+        @shell.symlink script_file, pointer_file
+      end
+    end
+
+
     ##
     # Assumes the passed code_dir is the root directory of the checked out
     # codebase and uploads it to the checkout_path.
 
     def upload_codebase code_dir, scm_info={}
-      RsyncRepo.new(code_dir).checkout_to self.checkout_path, @shell
+      excludes = scm_info.delete :exclude if scm_info[:exclude]
+      excludes = [excludes].flatten.compact
+      excludes.map!{|e| "--exclude #{e}"}
+
+      repo = RsyncRepo.new code_dir, :flags => excludes
+      repo.checkout_to self.checkout_path, @shell
+
       @info[:scm] = scm_info
     end
 
@@ -583,8 +717,6 @@ fi
 
       @shell.make_file script_file, contents,
         :flags => '--chmod=ugo=rwx' unless @shell.file? script_file
-
-      @shell.symlink script_file, "#{self.root_path}/#{name}"
     end