sunshine 1.2.0 → 1.2.1

data/lib/sunshine/shell.rb

@@ -7,13 +7,23 @@ module Sunshine
 
     include Open4
 
-    class TimeoutError < CriticalDeployError; end
-
     LOCAL_USER = `whoami`.chomp
     LOCAL_HOST = `hostname`.chomp
 
-    SUDO_FAILED = /^Sorry, try again./
-    SUDO_PROMPT = /^Password:/
+    class << self
+      # The message to match in stderr to determine logging in has failed.
+      # Defaults to:
+      #   /^Sorry, try again./
+      attr_accessor :sudo_failed_matcher
+
+      # The message to match in stderr to determine a password is required.
+      # Defaults to:
+      #   /^Password:/
+      attr_accessor :sudo_prompt_matcher
+    end
+
+    self.sudo_failed_matcher = /^Sorry, try again./
+    self.sudo_prompt_matcher = /^Password:/
 
     attr_reader :user, :host, :password, :input, :output, :mutex
     attr_accessor :env, :sudo, :timeout
@@ -33,8 +43,6 @@ module Sunshine
 
       @timeout = options[:timeout] || Sunshine.timeout
 
-      @cmd_activity = nil
-
       @mutex = nil
     end
 
@@ -73,6 +81,14 @@ module Sunshine
     end
 
 
+    ##
+    # Prompt the user to make a choice.
+
+    def choose &block
+      sync{ @input.choose(&block) }
+    end
+
+
     ##
     # Close the output IO. (Required by the Logger class)
 
@@ -133,6 +149,21 @@ module Sunshine
     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 " && "
+        pid = fork do
+          exec sudo_cmd(env_cmd(cmd)).to_a.join(" ")
+        end
+        Process.waitpid pid
+      end
+    end
+
+
     ##
     # Write a file. Compatibility method with RemoteShell.
 
@@ -237,7 +268,7 @@ module Sunshine
     ##
     # Returns true if command was run successfully, otherwise returns false.
 
-    def syscall cmd, options=nil
+    def system cmd, options=nil
       call(cmd, options) && true rescue false
     end
 
@@ -245,20 +276,12 @@ module Sunshine
     ##
     # Checks if timeout occurred.
 
-    def timed_out? start_time=@cmd_activity, max_time=@timeout
+    def timed_out? start_time, max_time=@timeout
       return unless max_time
       Time.now.to_i - start_time.to_i > max_time
     end
 
 
-    ##
-    # Update the time of the last command activity
-
-    def update_timeout
-      @cmd_activity = Time.now
-    end
-
-
     ##
     # Execute a block while setting the shell's mutex.
     # Sets the mutex to its original value on exit.
@@ -319,7 +342,9 @@ module Sunshine
       log_methods = {out => :debug, err => :error}
 
       result, status = process_streams(pid, out, err) do |stream, data|
-        stream_name = stream == out ? :out : :err
+        stream_name = :out if stream == out
+        stream_name = :err if stream == err
+        stream_name = :inn if stream == inn
 
 
         # User blocks should run with sync threads to avoid badness.
@@ -353,18 +378,18 @@ module Sunshine
     private
 
     def raise_command_failed(status, cmd)
-      raise CmdError,
-        "Execution failed with status #{status.exitstatus}: #{[*cmd].join ' '}"
+      err = CmdError.new status.exitstatus, [*cmd].join(" ")
+      raise err
     end
 
 
     def password_required? stream_name, data
-      stream_name == :err && data =~ SUDO_PROMPT
+      stream_name == :err && data =~ Shell.sudo_prompt_matcher
     end
 
 
     def send_password_to_stream inn, data
-      prompt_for_password if data =~ SUDO_FAILED
+      prompt_for_password if data =~ Shell.sudo_failed_matcher
       inn.puts @password || prompt_for_password
     end
 
@@ -380,7 +405,7 @@ module Sunshine
 
     def process_streams pid, *streams
       result = Hash.new{|h,k| h[k] = []}
-      update_timeout
+      start_time = Time.now
 
       # Handle process termination ourselves
       status = nil
@@ -392,13 +417,13 @@ module Sunshine
         # don't busy loop
         selected, = select streams, nil, nil, 0.1
 
-        raise TimeoutError if timed_out?
+        raise TimeoutError if timed_out? start_time
 
         next if selected.nil? or selected.empty?
 
         selected.each do |stream|
 
-          update_timeout
+          start_time = Time.now
 
           if stream.eof? then
             streams.delete stream if status # we've quit, so no more writing

data/lib/sunshine/trap_stack.rb

@@ -0,0 +1,54 @@
+module Sunshine
+
+  ##
+  # The TrapStack class handles setting multiple trap blocks as a stack.
+  # Once a trap block is triggered, it gets popped off the stack.
+
+  class TrapStack
+
+    ##
+    # Adds an INT signal trap with its description on the stack.
+    # Returns a trap_item Array.
+
+    def self.add_trap desc=nil, &block
+      @trap_stack.unshift [desc, block]
+      @trap_stack.first
+    end
+
+
+
+    ##
+    # Call a trap item and display it's message.
+
+    def self.call_trap trap_item
+      return unless trap_item
+
+      msg, trap_block = trap_item
+
+      yield msg if block_given?
+
+      trap_block.call
+    end
+
+
+    ##
+    # Remove a trap_item from the stack.
+
+    def self.delete_trap trap_item
+      @trap_stack.delete trap_item
+    end
+
+
+    ##
+    # Sets the default trap.
+
+    def self.trap_signal sig, &block
+      @trap_stack = []
+
+      trap sig do
+        call_trap @trap_stack.shift, &block
+        exit 1
+      end
+    end
+  end
+end

data/templates/nginx/nginx.conf.erb

@@ -25,7 +25,31 @@ http {
   client_body_temp_path <%= darwin ? '/var/tmp/nginx' : '/dev/shm' %>;
   proxy_temp_path <%= darwin ? '/var/tmp/nginx' : '/dev/shm' %>;
 
+  <%
+  mime_types = "#{File.dirname(shell.call("which nginx"))}/../conf/mime.types"
+
+  if shell.file? mime_types
+  -%>
   include <%= File.dirname shell.call("which nginx") %>/../conf/mime.types;
+
+  <% else -%>
+
+	types {
+		application/x-plist    plist;
+		application/json     json;
+	  image/gif     gif;
+	  image/jpeg    jpg;
+	  image/png     png;
+	  image/x-icon  ico;
+	  text/css      css;
+	  text/html    html;
+	  text/plain    bob;
+	  text/plain    txt;
+		application/vnd.android.package-archive apk;
+	}
+
+  <% end -%>
+
   default_type  application/octet-stream;
 
   log_format sunshine '$remote_addr - $remote_user [$time_local] '

data/test/helper_methods.rb

@@ -123,7 +123,7 @@ fi
       "--rsync-path='#{ path }' "
     end
 
-    rsync_cmd = "rsync -azP #{rsync_path}-e \"ssh #{ds.ssh_flags.join(' ')}\""
+    rsync_cmd = "rsync -azrP #{rsync_path}-e \"ssh #{ds.ssh_flags.join(' ')}\""
 
     error_msg = "No such command in remote_shell log [#{ds.host}]\n#{rsync_cmd}"
     error_msg << "#{from.inspect} #{to.inspect}"

data/test/unit/test_app.rb

@@ -26,6 +26,7 @@ class TestApp < Test::Unit::TestCase
   end
 
   def teardown
+    Sunshine.exclude_paths.clear
     FileUtils.rm_rf @tmpdir
   end
 
@@ -159,8 +160,7 @@ class TestApp < Test::Unit::TestCase
 
   def test_app_deploy_error_handling
     [ MockError,
-      Sunshine::CriticalDeployError,
-      Sunshine::FatalDeployError ].each do |error|
+      Sunshine::DeployError ].each do |error|
 
       begin
         app = Sunshine::App.deploy @config do |app|
@@ -277,9 +277,51 @@ class TestApp < Test::Unit::TestCase
   end
 
 
+  def test_checkout_local_codebase
+    tmp_path = File.join Sunshine::TMP_DIR, "#{@app.name}_checkout"
+    @app.repo.extend MockObject
+    @app.repo.mock :checkout_to, :args   => [tmp_path],
+                                 :return => {:test => "scm info"}
+
+    @app.each do |sa|
+      sa.mock :upload_codebase
+    end
+
+    @app.checkout_codebase :copy => true
+
+    @app.each do |sa|
+      assert sa.method_called?(:upload_codebase,
+        :args => [tmp_path, {:test => "scm info", :exclude => []}])
+    end
+  end
+
+
+  def test_checkout_local_codebase_with_exludes
+    Sunshine.exclude_paths.concat ["path1/", "path2/"]
+
+    tmp_path = File.join Sunshine::TMP_DIR, "#{@app.name}_checkout"
+    @app.repo.extend MockObject
+
+    @app.repo.mock :checkout_to, :args   => [tmp_path],
+                                 :return => {:test => "scm info"}
+
+    @app.each do |sa|
+      sa.mock :upload_codebase
+    end
+
+    @app.checkout_codebase :copy => true, :exclude => ["path3/", "path4/"]
+
+    @app.each do |sa|
+      assert sa.method_called?(:upload_codebase,
+        :args => [tmp_path, {:test => "scm info",
+                  :exclude => ["path1/", "path2/", "path3/", "path4/"]}])
+    end
+  end
+
+
   def test_deployed?
     set_mock_response_for @app, 0,
-      "cat #{@app.scripts_path}/info" => [:out,
+      "cat #{@app.root_path}/info" => [:out,
           "---\n:deploy_name: '#{@app.deploy_name}'"]
 
     deployed = @app.deployed?
@@ -437,7 +479,7 @@ class TestApp < Test::Unit::TestCase
     returned_dirs = %w{old_deploy1 old_deploy2 old_deploy3 main_deploy}
     old_deploys = returned_dirs[0..-2].map{|d| "#{@app.deploys_path}/#{d}"}
 
-    list_cmd = "ls -1 #{@app.deploys_path}"
+    list_cmd = "ls -rc1 #{@app.deploys_path}"
     rm_cmd   = "rm -rf #{old_deploys.join(" ")}"
 
     set_mock_response_for @app, 0,
@@ -500,7 +542,7 @@ class TestApp < Test::Unit::TestCase
 
     @app.threaded_each do |server_app|
       if server_app.shell.host == err_host
-        raise Sunshine::CriticalDeployError, server_app.shell.host
+        raise Sunshine::DeployError, server_app.shell.host
       else
         finished = finished.next
       end
@@ -508,7 +550,7 @@ class TestApp < Test::Unit::TestCase
 
     raise "Didn't raise threaded error when it should have"
 
-  rescue Sunshine::CriticalDeployError => e
+  rescue Sunshine::DeployError => e
     host = @app.server_apps.first.shell.host
 
     assert_equal host, e.message

data/test/unit/test_daemon.rb

@@ -17,9 +17,9 @@ class TestDaemon < Test::Unit::TestCase
 
     begin
       daemon.start_cmd
-      raise "Should have thrown CriticalDeployError but didn't :("
-    rescue Sunshine::CriticalDeployError => e
-      assert_equal "@start_cmd undefined. Can't start daemon", e.message
+      raise "Should have thrown DaemonError but didn't :("
+    rescue Sunshine::DaemonError => e
+      assert_equal "start_cmd undefined for daemon", e.message
     end
   end
 

data/test/unit/test_nginx.rb

@@ -87,13 +87,16 @@ class TestNginx < Test::Unit::TestCase
   ## Helper methods
 
   def start_cmd svr
-    "#{svr.bin} -c #{svr.config_file_path}"
+    svr.exit_on_failure "#{svr.bin} -c #{svr.config_file_path}", 10,
+      "Could not start #{svr.name} for #{svr.app.name}"
   end
 
 
   def stop_cmd svr
-    "test -f #{svr.pid} && kill -#{svr.sigkill} $(cat #{svr.pid}) && "+
-      "sleep 1 && rm -f #{svr.pid} || "+
-      "echo 'Could not kill #{svr.name} pid for #{svr.app.name}';"
+    cmd = "test -f #{svr.pid} && kill -#{svr.sigkill} $(cat #{svr.pid}) && "+
+            "sleep 1 && rm -f #{svr.pid}"
+
+    svr.exit_on_failure cmd, 11,
+      "Could not kill #{svr.name} pid for #{svr.app.name}"
   end
 end

data/test/unit/test_server.rb

@@ -69,7 +69,7 @@ class TestServer < Test::Unit::TestCase
       assert sa.method_called?(:install_deps, :args => ["rainbows"])
 
       assert server.method_called?(:configure_remote_dirs, :args => [sa.shell])
-      assert server.method_called?(:touch_log_files, :args => [sa.shell])
+      assert server.method_called?(:chown_log_files, :args => [sa.shell])
       assert server.method_called?(:upload_config_files, :args => [sa.shell])
     end
 
@@ -121,7 +121,7 @@ class TestServer < Test::Unit::TestCase
 
     server.start do |sa|
       assert_equal @server_app, sa
-      assert_ssh_call server.start_cmd, sa.shell, :sudo => true
+      assert_ssh_call server._start_cmd, sa.shell, :sudo => true
     end
 
     assert server.method_called?(:setup)
@@ -135,7 +135,7 @@ class TestServer < Test::Unit::TestCase
 
     server.start do |sa|
       assert_equal @server_app, sa
-      assert_ssh_call server.start_cmd, sa.shell, :sudo => true
+      assert_ssh_call server._start_cmd, sa.shell, :sudo => true
     end
 
     assert !server.method_called?(:setup)
@@ -147,7 +147,7 @@ class TestServer < Test::Unit::TestCase
 
     server.stop do |sa|
       assert_equal @server_app, sa
-      assert_ssh_call server.stop_cmd, sa.shell, :sudo => true
+      assert_ssh_call server._stop_cmd, sa.shell, :sudo => true
     end
   end
 
@@ -157,7 +157,7 @@ class TestServer < Test::Unit::TestCase
 
     server.restart do |sa|
       assert_equal @server_app, sa
-      assert_ssh_call server.restart_cmd, sa.shell, :sudo => true
+      assert_ssh_call server._restart_cmd, sa.shell, :sudo => true
     end
   end
 
@@ -181,7 +181,7 @@ class TestServer < Test::Unit::TestCase
 
     server.restart do |sa|
       assert_equal @server_app, sa
-      assert_ssh_call server.restart_cmd, sa.shell, :sudo => true
+      assert_ssh_call server._restart_cmd, sa.shell, :sudo => true
     end
 
     assert server.method_called?(:setup)

data/test/unit/test_server_app.rb

@@ -15,6 +15,27 @@ class TestServerApp < Test::Unit::TestCase
   end
 
 
+  def test_from_info_file
+    info_data = @sa.get_deploy_info.to_yaml
+    @sa.shell.mock :call, :args => "cat info/path", :return => info_data
+
+    server_app = Sunshine::ServerApp.from_info_file "info/path", @sa.shell
+
+    assert_equal @sa.root_path,     server_app.root_path
+    assert_equal @sa.checkout_path, server_app.checkout_path
+    assert_equal @sa.current_path,  server_app.current_path
+    assert_equal @sa.deploys_path,  server_app.deploys_path
+    assert_equal @sa.log_path,      server_app.log_path
+    assert_equal @sa.shared_path,   server_app.shared_path
+    assert_equal @sa.scripts_path,  server_app.scripts_path
+    assert_equal @sa.roles,         server_app.roles
+
+    assert_equal @sa.shell.env,   server_app.shell_env
+    assert_equal @sa.name,        server_app.name
+    assert_equal @sa.deploy_name, server_app.deploy_name
+  end
+
+
   def test_init
     default_info = {:ports => {}}
     assert_equal default_info, @sa.info
@@ -119,7 +140,7 @@ class TestServerApp < Test::Unit::TestCase
     deploy_details = {:item => "thing"}
     other_details  = {:key  => "value"}
 
-    @sa.shell.mock :call, :args   => ["cat #{@sa.scripts_path}/info"],
+    @sa.shell.mock :call, :args   => ["cat #{@sa.root_path}/info"],
                           :return => other_details.to_yaml
 
     @sa.instance_variable_set "@deploy_details", deploy_details
@@ -158,8 +179,11 @@ class TestServerApp < Test::Unit::TestCase
       :deployed_as => @sa.shell.call("whoami"),
       :deployed_by => Sunshine.shell.user,
       :deploy_name => File.basename(@app.checkout_path),
+      :name        => @sa.name,
+      :env         => @sa.shell_env,
       :roles       => @sa.roles,
-      :path        => @app.root_path
+      :path        => @app.root_path,
+      :sunshine_version => Sunshine::VERSION
     }.merge @sa.info
 
     deploy_info = @sa.get_deploy_info
@@ -204,7 +228,7 @@ class TestServerApp < Test::Unit::TestCase
     @sa.install_deps nginx_dep, :type => Sunshine::Gem
     raise "Didn't raise missing dependency when it should have."
 
-  rescue Sunshine::DependencyLib::MissingDependency => e
+  rescue Sunshine::MissingDependency => e
     assert_equal "No dependency 'nginx' [Sunshine::Gem]", e.message
   end
 
@@ -257,7 +281,7 @@ class TestServerApp < Test::Unit::TestCase
     deploys = %w{ploy1 ploy2 ploy3 ploy4 ploy5}
 
     @sa.shell.mock :call,
-      :args   => ["ls -1 #{@app.deploys_path}"],
+      :args   => ["ls -rc1 #{@app.deploys_path}"],
       :return => "#{deploys.join("\n")}\n"
 
     removed = deploys[0..1].map{|d| "#{@app.deploys_path}/#{d}"}
@@ -330,6 +354,32 @@ class TestServerApp < Test::Unit::TestCase
   end
 
 
+  def test_running?
+    set_mock_response_for @sa, 0,
+      "#{@sa.root_path}/status" => [:out, "THE SYSTEM OK!"]
+
+    assert_equal true, @sa.running?
+  end
+
+
+  def test_not_running?
+    set_mock_response_for @sa, 13,
+      "#{@sa.root_path}/status" => [:err, "THE SYSTEM IS DOWN!"]
+
+    assert_equal false, @sa.running?
+  end
+
+
+  def test_errored_running?
+    set_mock_response_for @sa, 1,
+      "#{@sa.root_path}/status" => [:err, "KABLAM!"]
+
+    assert_raises Sunshine::CmdError do
+      @sa.running?
+    end
+  end
+
+
   def test_sass
     sass_files = %w{file1 file2 file3}
 
@@ -426,6 +476,50 @@ class TestServerApp < Test::Unit::TestCase
   end
 
 
+  def test_upload_codebase
+    @sa.shell.mock(:upload)
+
+    @sa.upload_codebase "tmp/thing/", :test_scm => "info"
+    assert_equal({:test_scm => "info"} , @sa.info[:scm])
+    assert @sa.shell.method_called?(
+      :upload, :args => ["tmp/thing/", @sa.checkout_path,
+        {:flags => ["--exclude .svn/","--exclude .git/"]}])
+  end
+
+
+  def test_upload_codebase_with_exclude
+    @sa.shell.mock(:upload)
+
+    @sa.upload_codebase "tmp/thing/",
+      :test_scm => "info",
+      :exclude  => "bad/path/"
+
+    assert_equal({:test_scm => "info"} , @sa.info[:scm])
+    assert @sa.shell.method_called?(
+      :upload, :args => ["tmp/thing/", @sa.checkout_path,
+        {:flags => ["--exclude bad/path/",
+                    "--exclude .svn/",
+                    "--exclude .git/"]}])
+  end
+
+
+  def test_upload_codebase_with_excludes
+    @sa.shell.mock(:upload)
+
+    @sa.upload_codebase "tmp/thing/",
+      :test_scm => "info",
+      :exclude  => ["bad/path/", "other/exclude/"]
+
+    assert_equal({:test_scm => "info"} , @sa.info[:scm])
+    assert @sa.shell.method_called?(
+      :upload, :args => ["tmp/thing/", @sa.checkout_path,
+        {:flags => ["--exclude bad/path/",
+                    "--exclude other/exclude/",
+                    "--exclude .svn/",
+                    "--exclude .git/"]}])
+  end
+
+
   def test_write_script
     @sa.shell.mock :file?, :return => false
 
@@ -435,10 +529,19 @@ class TestServerApp < Test::Unit::TestCase
             "script contents", {:flags => "--chmod=ugo=rwx"}]
 
     assert @sa.shell.method_called?(:make_file, :args => args)
+  end
+
+
+  def test_symlink_scripts_to_root
+    @sa.shell.mock :call,
+      :args   => ["ls -1 #{@sa.scripts_path}"],
+      :return => "script_name\n"
 
     args = ["#{@app.scripts_path}/script_name",
             "#{@app.root_path}/script_name"]
 
+    @sa.symlink_scripts_to_root
+
     assert @sa.shell.method_called?(:symlink, :args => args)
   end
 
@@ -452,10 +555,5 @@ class TestServerApp < Test::Unit::TestCase
             "script contents", {:flags => "--chmod=ugo=rwx"}]
 
     assert !@sa.shell.method_called?(:make_file, :args => args)
-
-    args = ["#{@app.scripts_path}/script_name",
-            "#{@app.root_path}/script_name"]
-
-    assert @sa.shell.method_called?(:symlink, :args => args)
   end
 end