sunshine 1.0.3 → 1.1.0

data/lib/sunshine/daemons/nginx.rb

@@ -8,6 +8,9 @@ module Sunshine
     def initialize app, options={}
       super
 
+      @supports_rack      = false
+      @supports_passenger = true
+
       @dep_name = options[:dep_name] ||
         use_passenger? ? 'passenger-nginx' : 'nginx'
     end

data/lib/sunshine/daemons/rainbows.rb

@@ -2,6 +2,8 @@ module Sunshine
 
   ##
   # Simple server wrapper for Rainbows setup and control.
+  # Rainbows is strictly a backend server and therefore does not support
+  # the :point_to proxying option.
 
   class Rainbows < Unicorn
 

data/lib/sunshine/daemons/server.rb

@@ -3,31 +3,48 @@ module Sunshine
   ##
   # An abstract class to wrap simple server software setup and start/stop.
   #
-  # Child classes are expected to at least provide a start and stop bash script
-  # by either overloading the start_cmd and stop_cmd methods, or by setting
-  # @start_cmd and @stop_cmd. A restart_cmd method or @restart_cmd attribute
-  # may also be specified if restart requires more functionality than simply
-  # calling start_cmd && stop_cmd.
+  # Child classes are expected to at least provide a start_cmd bash script
+  # by either overloading the start_cmd method, or by setting @start_cmd.
+  # A restart_cmd and stop_cmd method or attribute may also be specified
+  # if restart requires more functionality than simply calling
+  # start_cmd && stop_cmd.
 
   class Server < Daemon
 
+    ##
+    # Creates a server cluster object:
+    #   Mongrel.new_cluster 3, app, :port => 5000
+    #   #=> [<# mongrel_5000 >, <# mongrel_5001 >, <# mongrel_5002 >]
+
+    def self.new_cluster count, app, options={}
+      ServerCluster.new self, count, app, options
+    end
+
+
     def self.binder_methods
-      [:server_name, :port].concat super
+      [:server_name, :port, :target, :connections].concat super
     end
 
 
-    attr_reader :server_name, :port
-    attr_accessor :sigkill
+    attr_reader :server_name, :port, :target, :connections
+
+    attr_accessor :sigkill, :cluster
 
 
     # Server objects need only an App object to be instantiated.
     # All Daemon init options are supported plus the following:
     #
-    # :port:: port_num - the port to run the server on
-    #                    defaults to 80
+    # :connections:: num - Number of connections allowed per server;
+    # defaults to 1024.
+    #
+    # :point_to:: app|server - An app or server to point to,
+    # defaults to the passed app. If a server object is given, will
+    # act as a proxy. (Only valid on front-end servers - Nginx, Apache)
     #
-    # :server_name:: myserver.com - host name used by server
-    #                               defaults to nil
+    # :port:: port_num - The port to run the server on defaults to 80.
+    #
+    # :server_name:: myserver.com - Host name used by server
+    # defaults to the individual remote host.
     #
     # By default, servers also assign the option :role => :web.
 
@@ -36,20 +53,25 @@ module Sunshine
 
       super app, options
 
-      @port          = options[:port] || 80
-      @sudo          = options[:sudo] || @port < 1024 || nil
+      @connections   = options[:connections]          || 1024
+      @port          = options[:port]                 || 80
       @server_name   = options[:server_name]
-      @sigkill       = 'QUIT'
-      @supports_rack = false
+      # Setting @sudo to nil will let the server apps' shells handle sudo
+      @sudo          = options[:sudo] || @port < 1024 || nil
+      @target        = options[:point_to]             || @app
+
+      @supports_rack      = false
+      @supports_passenger = false
     end
 
 
     ##
     # Check if passenger is required to run the application.
-    # Returns true if the server's target is a Sunshine::App
+    # Returns true if the server's target is a Sunshine::App and if
+    # the server explicitely supports passenger.
 
     def use_passenger?
-      Sunshine::App === @target && !supports_rack?
+      Sunshine::App === @target && supports_passenger? && !supports_rack?
     end
 
 
@@ -68,7 +90,7 @@ module Sunshine
 
 
     ##
-    # Add passenger information to the binder at setup time.
+    # Adds passenger information to the binder at setup time.
 
     def setup
       super do |server_app, binder|
@@ -85,11 +107,10 @@ module Sunshine
 
 
     ##
-    # Default server stop command.
+    # Defines if this server has passenger support.
 
-    def stop_cmd
-      "test -f #{@pid} && kill -#{@sigkill} $(cat #{@pid}) && sleep 1 && "+
-        "rm -f #{@pid} || echo 'No #{@name} process to stop for #{@app.name}';"
+    def supports_passenger?
+      @supports_passenger
     end
 
 
@@ -108,6 +129,12 @@ module Sunshine
 
       binder.set :server_name, (@server_name || shell.host)
 
+      binder.set :proxy_name, "#{@app.name}_proxy"
+
+      binder.set :target_server do
+        target.server_name || server_name
+      end
+
       binder
     end
 
@@ -116,7 +143,7 @@ module Sunshine
       super
 
       @app.after_user_script do |app|
-        next unless @port
+        next unless @port && has_setup?
 
         each_server_app do |sa|
           sa.info[:ports][@pid] = @port

data/lib/sunshine/daemons/server_cluster.rb

@@ -0,0 +1,47 @@
+module Sunshine
+
+  ##
+  # The ServerCluster is simply a fancy Array that conveniently forwards
+  # some method calls to each server in the array, namely:
+  # Server#setup, Server#start, Server#stop, Server#restart,
+  # Server#has_setup?, Server#status.
+
+  class ServerCluster < Array
+
+    ##
+    # ServerClusters get initialized just like any server class with the
+    # additional svr_class (Unicorn, Thin, Mongrel) and the number of
+    # server instances you would like:
+    #
+    #   ServerCluster.new Mongrel, 3, app, :port => 5000
+    #   #=> [<# mongrel_5000 >, <# mongrel_5001 >, <# mongrel_5002 >]
+    #
+    # ServerClusters can also be created from any Server class:
+    #
+    #   Mongrel.new_cluster 3, app, :port => 5000
+
+    def initialize svr_class, count, app, options={}
+      count.times do |num|
+        port = (options[:port] || 80) + num
+        name = (options[:name] || svr_class.short_name) + ".#{port}"
+
+        self << svr_class.new(app, options.merge(:name => name, :port => port))
+      end
+    end
+
+
+    [:setup, :start, :stop, :restart].each do |method|
+      define_method method do
+        each{|server| server.send method }
+      end
+    end
+
+
+    [:has_setup?, :status].each do |method|
+      define_method method do
+        each{|server| return false unless server.send method}
+        true
+      end
+    end
+  end
+end

data/lib/sunshine/daemons/thin.rb

@@ -0,0 +1,36 @@
+module Sunshine
+
+  ##
+  # Simple server wrapper for Thin setup and control.
+  # Thin is considered a backend server and therefore does not support
+  # the :point_to proxying option.
+  #
+  # Note: Thin only supports a single log file. The default stdout file is used.
+  #
+  # Note: Thin manipulates the passed pid filepath to:
+  # path/[basename].[port].pid
+  # Sunshine::Thin will adjust the @pid attribute value accordingly.
+
+  class Thin < Server
+
+    def initialize app, options={}
+      super
+
+      @start_pid = @pid
+
+      pid_name  = File.basename(@pid, ".pid")
+      @pid      = File.join File.dirname(@pid), "#{pid_name}.#{@port}.pid"
+
+      @timeout = options[:timeout] || 3
+
+      @supports_rack = true
+      @supports_passenger = false
+    end
+
+
+    def start_cmd
+      "cd #{@app.current_path} && "+
+        "#{@bin} start -C #{self.config_file_path} -P #{@start_pid};"
+    end
+  end
+end

data/lib/sunshine/daemons/unicorn.rb

@@ -2,6 +2,8 @@ module Sunshine
 
   ##
   # Simple server wrapper for Unicorn setup and control.
+  # Unicorn is strictly a backend server and therefore does not support
+  # the :point_to proxying option.
 
   class Unicorn < Server
 
@@ -10,7 +12,8 @@ module Sunshine
 
       @timeout = options[:timeout] || 3.0
 
-      @supports_rack = true
+      @supports_rack      = true
+      @supports_passenger = false
     end
 
 

data/lib/sunshine/dependencies.rb

@@ -10,6 +10,9 @@ Sunshine.dependencies.instance_eval do
   apt 'git', :pkg => 'git-core'
   yum 'git', :pkg => 'git-core'
 
+  apt 'rsync'
+  yum 'rsync'
+
   yum 'httpd-devel'
 
   apt 'apache2', :pkg => 'apache2-mpm-prefork'
@@ -30,10 +33,10 @@ Sunshine.dependencies.instance_eval do
   apt 'irb'
   yum 'irb', :pkg => 'ruby-irb'
 
-  apt 'rubygems', :version => '1.3.5' do
+  apt 'rubygems' do
     requires 'ruby', 'ruby-devel'
   end
-  yum 'rubygems', :version => '1.3.5' do
+  yum 'rubygems' do
     requires 'ruby', 'ruby-devel'
   end
 
@@ -111,7 +114,7 @@ Sunshine.dependencies.instance_eval do
 
 
   ##
-  # Define gems used by Sunshine
+  # Define gems used by Sunshine remotely
 
   gem 'bundler', :version => ">=0.9"
 
@@ -121,6 +124,10 @@ Sunshine.dependencies.instance_eval do
 
   gem 'geminstaller', :version => ">=0.5"
 
+  gem 'mongrel', :version => ">=1.1.5"
+
+  gem 'thin', :version => ">=1.2.7"
+
   gem 'unicorn', :version => ">=0.9"
 
   gem 'rainbows', :version => ">=0.90.2"

data/lib/sunshine/healthcheck.rb

@@ -17,8 +17,8 @@ module Sunshine
   # :uri_path::    The path that healthcheck will be used on.
   # :health_file:: The file to check for health.
   #
-  #   use SunshineHealth, :uri_path    => "/health.txt",
-  #                       :health_file => "health.txt"
+  #   use Sunshine::Health, :uri_path    => "/health.txt",
+  #                         :health_file => "health.txt"
 
   class Healthcheck
 

data/lib/sunshine/remote_shell.rb

@@ -51,7 +51,7 @@ module Sunshine
     # The constructor also supports the following options:
     # :env:: hash - hash of environment variables to set for the ssh session
     # :password:: string - password for ssh login; if missing the deploy server
-    #                      will attempt to prompt the user for a password.
+    # will attempt to prompt the user for a password.
 
     def initialize host, options={}
       super $stdout, options
@@ -78,7 +78,7 @@ module Sunshine
 
     ##
     # Runs a command via SSH. Optional block is passed the
-    # stream(stderr, stdout) and string data
+    # stream(stderr, stdout) and string data.
 
     def call command_str, options={}, &block
       Sunshine.logger.info @host, "Running: #{command_str}" do
@@ -204,6 +204,9 @@ module Sunshine
 
     private
 
+    ##
+    # Figure out which rsync flags to use.
+
     def build_rsync_flags options
       flags = @rsync_flags.dup
 
@@ -222,12 +225,18 @@ module Sunshine
     end
 
 
+    ##
+    # Creates an rsync command.
+
     def rsync_cmd from_path, to_path, options={}
       cmd  = ["rsync", build_rsync_flags(options), from_path, to_path]
       cmd.flatten.compact.join(" ")
     end
 
 
+    ##
+    # Wraps the command in an ssh call.
+
     def ssh_cmd string, options=nil
       options ||= {}
 

data/lib/sunshine/repo.rb

@@ -62,7 +62,7 @@ module Sunshine
     def initialize url, options={}
       @scm = self.class.name.split("::").last.sub('Repo', '').downcase
 
-      @url   = url
+      @url   = url.to_s
       @flags = [*options[:flags]].compact
     end
 

data/lib/sunshine/repos/rsync_repo.rb

@@ -13,6 +13,7 @@ module Sunshine
     def initialize url, options={}
       super
       @flags << "-r"
+      @url << "/" unless @url[-1..-1] == "/"
     end
 
 

data/templates/apache/apache.conf.erb

@@ -4,28 +4,29 @@ LoadModule authz_host_module modules/mod_authz_host.so
 ErrorLog    <%= expand_path log_file(:stderr) %>
 TransferLog <%= expand_path log_file(:stdout) %>
 
-<% if use_passenger? %>
+<% if use_passenger? -%>
 LoadModule passenger_module <%= passenger_root %>/ext/apache2/mod_passenger.so
 
 PassengerRuby <%= shell.call "which ruby" %>
 PassengerRoot <%= passenger_root %>
 PassengerMaxPoolSize <%= processes %>
-<% end %>
+<% end -%>
 
-<% unless Sunshine::App === target %>
-LoadModule proxy_module         modules/mod_proxy.so
-LoadModule proxy_connect_module modules/mod_proxy_connect.so
-LoadModule proxy_http_module    modules/mod_proxy_http.so
-<% end %>
+<% unless App === target -%>
+LoadModule proxy_module          modules/mod_proxy.so
+LoadModule proxy_connect_module  modules/mod_proxy_connect.so
+LoadModule proxy_http_module     modules/mod_proxy_http.so
+LoadModule proxy_balancer_module modules/mod_proxy_balancer.so
+<% end -%>
 
 
 PidFile <%= expand_path pid %>
-MaxClients <%= max_clients %>
+MaxClients <%= connections %>
 
-<% if sudo == true || sudo == 'root' %>
+<% if sudo == true || sudo == 'root' -%>
 User nobody
 Group nobody
-<% end %>
+<% end -%>
 
 Listen <%= port %>
 
@@ -36,19 +37,25 @@ NameVirtualHost *:<%= port %>
   ServerName  <%= server_name %>
   ServerAlias www.<%= server_name %>
 
-  <% if Sunshine::App === target %>
-
   DocumentRoot <%= expand_path app.current_path %>/public
 
   <Directory <%= app.current_path %>/public>
-      Allow from all
-      Options -MultiViews
+    Allow from all
+    Options -MultiViews
   </Directory>
 
-  <% else %>
+  <% unless App === target -%>
 
-  ProxyPass / http://0.0.0.0:<%= target.port %>/
-  ProxyPassReverse / http://0.0.0.0:<%= target.port %>/
+  <Proxy balancer://<%= proxy_name %>>
+    <% [*target].each do |server| %>
+    BalancerMember http://0.0.0.0:<%= server.port %>
+    <% end -%>
+  </Proxy>
 
-  <% end %>
+  # Using / after the proxy target is essential to the public dir.
+  ProxyPass / balancer://<%= proxy_name %>/ timeout=<%= timeout %>
+  ProxyPassReverse / balancer://<%= proxy_name %>/
+  ProxyPreserveHost On
+  
+  <% end -%>
 </VirtualHost>