sunshine 1.1.0 → 1.1.1

data/History.txt

@@ -1,3 +1,15 @@
+=== 1.1.1 / 2010-04-05
+
+* Improvements:
+
+  * Added Repo subclass registration for greater expandability.
+
+  * Added support for checking out codebases locally then rsync-ing them.
+
+* Bugfixes:
+
+  * Fixed RemoteShell login script lingering after disconnect.
+
 === 1.1.0 / 2010-04-02
 
 * Improvements:

data/README.txt

@@ -492,6 +492,9 @@ defaults to :development.
 'max_deploy_versions' -> The maximum number of deploys to keep on a server;
 defaults to 5.
 
+'remote_checkouts'    -> Use remote servers to checkout the codebase;
+defaults to false.
+
 'require'             -> Require external ruby libs or gems; defaults to nil.
 
 'trace'               -> Show detailed output messages; defaults to false.

data/lib/sunshine.rb

@@ -19,7 +19,7 @@ module Sunshine
 
   ##
   # Sunshine version.
-  VERSION = '1.1.0'
+  VERSION = '1.1.1'
 
   ##
   # Path to the list of installed sunshine apps.
@@ -41,7 +41,8 @@ module Sunshine
     'auto'                => false,
     'max_deploy_versions' => 5,
     'web_directory'       => '/var/www',
-    'auto_dependencies'   => true
+    'auto_dependencies'   => true,
+    'remote_checkouts'    => false
   }
 
   ##
@@ -88,11 +89,20 @@ module Sunshine
     @config['auto_dependencies']
   end
 
-  ##
-  # Returns the main Sunshine dependencies library.
 
-  def self.dependencies
+  ##
+  # Returns the main Sunshine dependencies library. If passed a block,
+  # evaluates the block within the dependency lib instance:
+  #
+  #   Sunshine.dependencies do
+  #     yum 'new_dep'
+  #     gem 'commander'
+  #   end
+
+  def self.dependencies(&block)
     @dependency_lib ||= DependencyLib.new
+    @dependency_lib.instance_eval(&block) if block_given?
+    @dependency_lib
   end
 
 
@@ -140,6 +150,15 @@ module Sunshine
   end
 
 
+  ##
+  # Check if the codebase should be checked out remotely, or checked out
+  # locally and rsynced up. Overridden in the ~/.sunshine config file.
+
+  def self.remote_checkouts?
+    @config['remote_checkouts']
+  end
+
+
   ##
   # Check if trace log should be output at all.
   # This value can be assigned by default in ~/.sunshine

data/lib/sunshine/app.rb

@@ -151,6 +151,7 @@ module Sunshine
     attr_reader :name, :repo, :server_apps, :sudo
     attr_reader :root_path, :checkout_path, :current_path, :deploys_path
     attr_reader :shared_path, :log_path, :deploy_name, :deploy_env
+    attr_accessor :remote_checkout
 
     ##
     # App instantiation can be done in several ways:
@@ -183,6 +184,8 @@ module Sunshine
 
       @server_apps = server_apps_from_config options[:remote_shells]
 
+      @remote_checkout = options[:remote_checkout] || Sunshine.remote_checkouts?
+
       self.sudo = options[:sudo] || Sunshine.sudo
 
       @shell_env = {
@@ -401,11 +404,27 @@ module Sunshine
 
     ##
     # Checks out the app's codebase to one or all deploy servers.
+    # Supports all App#find options, plus:
+    # :copy:: Bool - Checkout locally and rsync; defaults to false.
 
     def checkout_codebase options=nil
-      with_server_apps options,
-        :msg  => "Checking out codebase",
-        :send => [:checkout_repo, @repo]
+      copy_option = options && options.has_key?(:copy) && options[:copy]
+
+      if @remote_checkout && !copy_option
+        with_server_apps options,
+          :msg  => "Checking out codebase (remotely)",
+          :send => [:checkout_repo, @repo]
+
+      else
+        Sunshine.logger.info :app, "Checking out codebase (locally)" do
+
+          tmp_path = File.join Sunshine::TMP_DIR, "#{@name}_checkout"
+          scm_info = @repo.checkout_to tmp_path
+
+          with_server_apps options,
+            :send => [:upload_codebase, tmp_path, scm_info]
+        end
+      end
 
     rescue => e
       raise CriticalDeployError, e
@@ -691,7 +710,9 @@ module Sunshine
     # See #after_user_script.
 
     def run_post_user_lambdas
-      @post_user_lambdas.each{|l| l.call self}
+      Sunshine.logger.info :app, "Running post deploy lambdas" do
+        @post_user_lambdas.each{|l| l.call self}
+      end
     end
 
 

data/lib/sunshine/dependencies.rb

@@ -1,8 +1,7 @@
 ##
 # Defines Sunshine deploy server dependencies.
 
-#class Sunshine::Dependencies < Settler
-Sunshine.dependencies.instance_eval do
+Sunshine.dependencies do
 
   apt 'svn', :pkg => 'subversion'
   yum 'svn', :pkg => 'subversion'

data/lib/sunshine/remote_shell.rb

@@ -15,7 +15,8 @@ module Sunshine
 
     ##
     # The loop to keep the ssh connection open.
-    LOGIN_LOOP = "echo connected; echo ready; for (( ; ; )); do sleep 10; done"
+    LOGIN_LOOP = "echo ok; echo ready; "+
+      "for (( ; ; )); do kill -0 $PPID && sleep 10 || exit; done;"
 
     LOGIN_TIMEOUT = 30
 
@@ -38,7 +39,7 @@ module Sunshine
     end
 
 
-    attr_reader :host, :user
+    attr_reader :host, :user, :pid
     attr_accessor :ssh_flags, :rsync_flags
 
 
@@ -82,7 +83,7 @@ module Sunshine
 
     def call command_str, options={}, &block
       Sunshine.logger.info @host, "Running: #{command_str}" do
-        execute ssh_cmd(command_str, options), &block
+        execute build_remote_cmd(command_str, options), &block
       end
     end
 
@@ -91,11 +92,11 @@ module Sunshine
     # Connect to host via SSH and return process pid
 
     def connect
-      return @pid if connected?
+      return true if connected?
 
-      cmd = ssh_cmd LOGIN_LOOP, :sudo => false
+      cmd = ssh_cmd quote_cmd(LOGIN_LOOP), :sudo => false
 
-      @pid, @inn, @out, @err = popen4(cmd.join(" "))
+      @pid, @inn, @out, @err = popen4 cmd.join(" ")
       @inn.sync = true
 
       data  = ""
@@ -132,13 +133,11 @@ module Sunshine
     # Disconnect from host
 
     def disconnect
-      return unless connected?
-
       @inn.close rescue nil
       @out.close rescue nil
       @err.close rescue nil
 
-      kill_process @pid, "HUP"
+      kill_process @pid, "HUP" rescue nil
 
       @pid = nil
     end
@@ -191,6 +190,17 @@ module Sunshine
     end
 
 
+    ##
+    # Builds an ssh command with permissions, env, etc.
+
+    def build_remote_cmd cmd, options={}
+      cmd = sh_cmd   cmd
+      cmd = env_cmd  cmd
+      cmd = sudo_cmd cmd, options
+      cmd = ssh_cmd  cmd, options
+    end
+
+
     ##
     # Uploads a file via rsync
 
@@ -237,13 +247,9 @@ module Sunshine
     ##
     # Wraps the command in an ssh call.
 
-    def ssh_cmd string, options=nil
+    def ssh_cmd cmd, options=nil
       options ||= {}
 
-      cmd = sh_cmd string
-      cmd = env_cmd cmd
-      cmd = sudo_cmd cmd, options
-
       flags = [*options[:flags]].concat @ssh_flags
 
       ["ssh", flags, @host, cmd].flatten.compact

data/lib/sunshine/repo.rb

@@ -13,14 +13,33 @@ module Sunshine
 
   class Repo
 
+    ##
+    # Adds subclasses to a repo_types hash for easy
+
+    def self.inherited subclass
+      @@repo_types ||= {}
+
+      # Turn Sunshine::ScmNameRepo into :scm_name
+      class_key = subclass.to_s.split("::").last
+      class_key = $1 if class_key =~ /(\w+)Repo$/
+      class_key.gsub! /([a-z0-9])([A-Z])/, '\1_\2'
+      class_key = class_key.downcase
+
+      @@repo_types[class_key] = subclass
+    end
+
+
     ##
     # Creates a new repo subclass object:
     #   Repo.new_of_type :svn, "https://path/to/repo/tags/releasetag"
     #   Repo.new_of_type :git, "user@gitbox.com:repo/path"
 
     def self.new_of_type repo_type, url, options={}
-      repo = "#{repo_type.to_s.capitalize}Repo"
-      Sunshine.const_get(repo).new(url, options)
+      repo_class = @@repo_types[repo_type.to_s]
+
+      raise RepoError, "Invalid type #{repo_type.inspect}" unless repo_class
+
+      repo_class.new(url, options)
     end
 
 
@@ -36,15 +55,16 @@ module Sunshine
     #     #=> nil
 
     def self.detect path=".", shell=nil
+      @@repo_types.values.each do |repo|
+        next if Sunshine::RsyncRepo === repo
 
-      if SvnRepo.valid? path
-        info = SvnRepo.get_info path, shell
-        SvnRepo.new info[:url], info
-
-      elsif GitRepo.valid? path
-        info = GitRepo.get_info path, shell
-        GitRepo.new info[:url], info
+        if repo.valid? path
+          info = repo.get_info path, shell
+          return repo.new(info[:url], info)
+        end
       end
+
+      nil
     end
 
 
@@ -69,21 +89,17 @@ module Sunshine
 
     ##
     # Checkout code to a shell and return an info log hash:
-    #   repo.chekout_to server, "some/path"
+    #   repo.chekout_to "some/path", remote_shell
     #   #=> {:revision => 123, :committer => 'someone', :date => time_obj ...}
 
     def checkout_to path, shell=nil
       shell ||= Sunshine.shell
 
-      Sunshine.logger.info @scm,
-        "Checking out to #{shell.host} #{path}" do
-
-        shell.call "test -d #{path} && rm -rf #{path} || echo false"
-        shell.call "mkdir -p #{path}"
+      shell.call "test -d #{path} && rm -rf #{path} || echo false"
+      shell.call "mkdir -p #{path}"
 
-        do_checkout   path, shell
-        get_repo_info path, shell
-      end
+      do_checkout   path, shell
+      get_repo_info path, shell
     end
 
 
@@ -97,7 +113,7 @@ module Sunshine
 
 
     ##
-    # Get the name of the specified repo - implemented by subclass
+    # Get the project name of the specified repo - implemented by subclass
 
     def name
       raise RepoError,

data/lib/sunshine/repos/rsync_repo.rb

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

data/lib/sunshine/server_app.rb

@@ -145,9 +145,15 @@ module Sunshine
     ##
     # Checks out the app's codebase to the checkout path.
 
-    def checkout_repo repo
+    def checkout_repo repo, scm_info={}
       install_deps repo.scm
-      @info[:scm] = repo.checkout_to self.checkout_path, @shell
+
+      Sunshine.logger.info repo.scm,
+        "Checking out to #{@shell.host} #{self.checkout_path}" do
+
+        @info[:scm] = repo.checkout_to self.checkout_path, @shell
+        @info[:scm].merge! scm_info
+      end
     end
 
 
@@ -480,6 +486,16 @@ fi
     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
+      @info[:scm] = scm_info
+    end
+
+
     ##
     # Upload common rake tasks from a local path or the sunshine lib.
     #   app.upload_tasks

data/lib/sunshine/shell.rb

@@ -172,12 +172,19 @@ module Sunshine
 
 
     ##
-    # Build an sh -c command
+    # Wrap command in quotes and escape as needed.
+
+    def quote_cmd cmd
+      cmd = [*cmd].join(" ")
+      "'#{cmd.gsub(/'/){|s| "'\\''"}}'"
+    end
 
-    def sh_cmd string
-      string = string.gsub(/'/){|s| "'\\''"}
 
-      ["sh", "-c", "'#{string}'"]
+    ##
+    # Build an sh -c command
+
+    def sh_cmd cmd
+      ["sh", "-c", quote_cmd(cmd)]
     end
 
 
@@ -340,6 +347,7 @@ module Sunshine
         "Execution failed with status #{status.exitstatus}: #{[*cmd].join ' '}"
     end
 
+
     def password_required? stream_name, data
       stream_name == :err && data =~ SUDO_PROMPT
     end

data/test/fixtures/app_configs/test_app.yml

@@ -1,5 +1,6 @@
 :default:
   :name: other_app
+  :remote_checkout: true
   :repo:
     :type: svn
     :url:  svn://subversion/path/to/other_app/tags/release001

data/test/helper_methods.rb

@@ -107,7 +107,7 @@ fi
 
 
   def assert_ssh_call expected, ds=@remote_shell, options={}
-    expected = ds.send(:ssh_cmd, expected, options).join(" ")
+    expected = ds.build_remote_cmd(expected, options).join(" ")
 
     error_msg = "No such command in remote_shell log [#{ds.host}]\n#{expected}"
     error_msg << "\n\n#{ds.cmd_log.select{|c| c =~ /^ssh/}.join("\n\n")}"

data/test/mocks/mock_open4.rb

@@ -1,9 +1,7 @@
 module MockOpen4
 
-  LOGIN_CMD = "echo ready;"
-
   CMD_RETURN = {
-    LOGIN_CMD => [:out, "ready\n"]
+    Sunshine::RemoteShell::LOGIN_LOOP => [:out, "ready\n"]
   }
 
   attr_reader :cmd_log
@@ -68,7 +66,9 @@ module MockOpen4
         next
       end
 
-      key = ssh_cmd(key, options).join(" ") if Sunshine::RemoteShell === self
+      if Sunshine::RemoteShell === self
+        key = build_remote_cmd(key, options).join(" ")
+      end
 
       new_stream_vals[key] = (val.dup << code)
     end

data/test/test_helper.rb

@@ -13,7 +13,7 @@ unless defined? TEST_APP_CONFIG_FILE
 end
 
 
-Sunshine.setup({}, true)
+Sunshine.setup({'remote_checkouts' => true}, true)
 
 unless MockObject === Sunshine.shell
   Sunshine.shell.extend MockObject

data/test/unit/test_app.rb

@@ -6,10 +6,12 @@ class TestApp < Test::Unit::TestCase
     mock_remote_shell_popen4
     @svn_url = "svn://subversion/path/to/app_name/trunk"
 
-    @config = {:name => "app_name",
-               :repo => {:type => "svn", :url => @svn_url},
-               :remote_shells => ["user@some_server.com"],
-               :root_path => "/usr/local/my_user/app_name"}
+    @config = {
+      :name => "app_name",
+      :remote_checkout => true,
+      :repo => {:type => "svn", :url => @svn_url},
+      :remote_shells => ["user@some_server.com"],
+      :root_path => "/usr/local/my_user/app_name"}
 
     @app = Sunshine::App.new @config
     @app.each do |server_app|
@@ -277,7 +279,7 @@ class TestApp < Test::Unit::TestCase
 
     state = true
     @app.server_apps.each do |sa|
-      assert sa.method_called? :deployed?
+      assert sa.method_called?(:deployed?)
 
       set_mock_response_for sa.shell, 0,
         "cat #{@app.current_path}/info" => [:out,

data/test/unit/test_remote_shell.rb

@@ -17,8 +17,11 @@ class TestRemoteShell < Test::Unit::TestCase
   end
 
   def test_connect
-    assert_ssh_call \
-      "echo connected; echo ready; for (( ; ; )); do sleep 10; done"
+    login_cmd = Sunshine::RemoteShell::LOGIN_LOOP
+    login_cmd = @remote_shell.send :quote_cmd, login_cmd
+    login_cmd = @remote_shell.send :ssh_cmd, login_cmd, :sudo => false
+
+    assert @remote_shell.method_called?(:popen4, :args => [login_cmd.join(" ")])
     assert @remote_shell.connected?
   end
 
@@ -42,7 +45,7 @@ class TestRemoteShell < Test::Unit::TestCase
     @remote_shell.call cmd
     raise "Didn't raise CmdError on stderr"
   rescue Sunshine::CmdError => e
-    ssh_cmd = @remote_shell.send(:ssh_cmd, cmd).join(" ")
+    ssh_cmd = @remote_shell.build_remote_cmd(cmd).join(" ")
     assert_equal "Execution failed with status 1: #{ssh_cmd}", e.message
   end
 

data/test/unit/test_repo.rb

@@ -13,8 +13,16 @@ class TestRepo < Test::Unit::TestCase
     assert_equal Sunshine::SvnRepo, repo.class
     assert_equal @svn_url, repo.url
 
-    repo = Sunshine::Repo.new_of_type "", @svn_url
-    assert_equal Sunshine::Repo, repo.class
+    repo = Sunshine::Repo.new_of_type 'git', @svn_url
+    assert_equal Sunshine::GitRepo, repo.class
+    assert_equal @svn_url, repo.url
+
+    begin
+      repo = Sunshine::Repo.new_of_type "", @svn_url
+      raise "Didn't raise RepoError for invalid repo type"
+    rescue Sunshine::RepoError => e
+      assert_equal "Invalid type \"\"", e.message
+    end
   end
 
 

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 1
   - 1
-  - 0
-  version: 1.1.0
+  - 1
+  version: 1.1.1
 platform: ruby
 authors: 
 - Jeremie Castagna
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-04-02 00:00:00 -07:00
+date: 2010-04-06 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency