sunshine 1.0.3 → 1.1.0

data/Rakefile

@@ -8,7 +8,7 @@ task :manifest do
   manifest_file = "Manifest.txt"
 
   gem_files = record_files do |f|
-    next if f =~ /^(tmp|pkg|deploy_tests)/
+    next if f =~ /^(tmp|pkg|deploy_scripts)/
     puts(f)
     true
   end

data/lib/commands/add.rb

@@ -3,7 +3,7 @@ module Sunshine
   ##
   # Registers a path as a sunshine application for control via sunshine.
   #
-  # Usage: sunshine add app_path [more paths...] [options]
+  # Usage: sunshine add [options] app_path [more paths...]
   #
   # Arguments:
   #     app_path    Path to the application to add.
@@ -83,7 +83,7 @@ module Sunshine
       parse_remote_args(argv) do |opt, options|
         opt.banner = <<-EOF
 
-Usage: #{opt.program_name} add app_path [more paths...] [options]
+Usage: #{opt.program_name} add [options] app_path [more paths...]
 
 Arguments:
     app_path      Path to the application to add.

data/lib/commands/default.rb

@@ -58,10 +58,17 @@ module Sunshine
 
         yield opt if block_given?
 
-        opt.on('-S', '--sudo [USER]',
-               'Run remote commands using sudo or sudo -u USER.') do |value|
-          options['sudo'] = value || true
-        end if options
+        if options
+          opt.on('-R', '--require lib1,lib2', Array,
+                 'Require a library or gem.') do |value|
+            options['require'] = value
+          end
+
+          opt.on('-S', '--sudo [USER]',
+                 'Run remote commands using sudo or sudo -u USER.') do |value|
+            options['sudo'] = value || true
+          end
+        end
       end
     end
 
@@ -80,13 +87,13 @@ Sunshine is an object oriented deploy tool for rack applications.
   Usage:
     #{opt.program_name} -h/--help
     #{opt.program_name} -v/--version
-    #{opt.program_name} command [arguments...] [options...]
+    #{opt.program_name} command [options...] [arguments...]
 
   Examples:
     #{opt.program_name} deploy deploy_script.rb
-    #{opt.program_name} restart myapp -r user@server.com,user@host.com
-    #{opt.program_name} list myapp myotherapp --health -r user@server.com
-    #{opt.program_name} list myapp --status
+    #{opt.program_name} restart -r user@server.com,user@host.com myapp
+    #{opt.program_name} list --health -r user@server.com myapp myotherapp
+    #{opt.program_name} list --status myapp
 
   Commands:
     add       Register an app with #{opt.program_name}

data/lib/commands/list.rb

@@ -3,7 +3,7 @@ module Sunshine
   ##
   # List and perform simple state actions on lists of sunshine apps.
   #
-  # Usage: sunshine list app_name [more names...] [options]
+  # Usage: sunshine list [options] app_name [more names...]
   #
   # Arguments:
   #   app_name      Name of an application to list.
@@ -268,7 +268,9 @@ module Sunshine
     # Load the app list yaml file from the server.
 
     def self.load_list server
-      list = YAML.load(server.call(Sunshine::READ_LIST_CMD))
+      yml_list = server.call "cat #{Sunshine::APP_LIST_PATH} || echo ''"
+
+      list = YAML.load yml_list
       list = {} unless Hash === list
       list
     end
@@ -290,7 +292,7 @@ module Sunshine
       parse_remote_args(argv) do |opt, options|
         opt.banner = <<-EOF
 
-Usage: #{opt.program_name} list app_name [more names...] [options]
+Usage: #{opt.program_name} list [options] app_name [more names...]
 
 Arguments:
     app_name      Name of an application to list.

data/lib/commands/restart.rb

@@ -3,7 +3,7 @@ module Sunshine
   ##
   # Runs the restart script of all specified sunshine apps.
   #
-  # Usage: sunshine restart app_name [more names...] [options]
+  # Usage: sunshine restart [options] app_name [more names...]
   #
   # Arguments:
   #     app_name     Name of the application to restart.
@@ -49,7 +49,7 @@ module Sunshine
       parse_remote_args(argv) do |opt, options|
         opt.banner = <<-EOF
 
-Usage: #{opt.program_name} restart app_name [more names...] [options]
+Usage: #{opt.program_name} restart [options] app_name [more names...]
 
 Arguments:
     app_name     Name of the application to restart.

data/lib/commands/rm.rb

@@ -3,7 +3,7 @@ module Sunshine
   ##
   # Unregister a sunshine app.
   #
-  # Usage: sunshine rm app_name [more names...] [options]
+  # Usage: sunshine rm [options] app_name [more names...]
   #
   # Arguments:
   #     app_name      Name of the application to remove.
@@ -67,7 +67,7 @@ module Sunshine
       parse_remote_args(argv) do |opt, options|
         opt.banner = <<-EOF
 
-Usage: #{opt.program_name} rm app_name [more names...] [options]
+Usage: #{opt.program_name} rm [options] app_name [more names...]
 
 Arguments:
     app_name      Name of the application to remove.

data/lib/commands/run.rb

@@ -3,7 +3,7 @@ module Sunshine
   ##
   # Run one or more sunshine scripts.
   #
-  # Usage: sunshine run [run_file] [options]
+  # Usage: sunshine run [options] [run_file] ...
   #
   # Arguments:
   #     run_file     Load a script or app path. Defaults to ./Sunshine
@@ -113,7 +113,7 @@ module Sunshine
       opts = opt_parser(options) do |opt|
         opt.banner = <<-EOF
 
-Usage: #{opt.program_name} run [run_file] [options]
+Usage: #{opt.program_name} run [options] [run_file] ...
 
 Arguments:
     run_file     Load a script or app path. Defaults to ./Sunshine

data/lib/commands/start.rb

@@ -3,7 +3,7 @@ module Sunshine
   ##
   # Runs the start script of all specified sunshine apps.
   #
-  # Usage: sunshine start app_name [more names...] [options]
+  # Usage: sunshine start [options] app_name [more names...]
   #
   # Arguments:
   #     app_name     Name of the application to start.
@@ -55,7 +55,7 @@ module Sunshine
       parse_remote_args(argv) do |opt, options|
         opt.banner = <<-EOF
 
-Usage: #{opt.program_name} start app_name [more names...] [options]
+Usage: #{opt.program_name} start [options] app_name [more names...]
 
 Arguments:
     app_name     Name of the application to start.

data/lib/commands/stop.rb

@@ -3,7 +3,7 @@ module Sunshine
   ##
   # Runs the stop script of all specified sunshine apps.
   #
-  # Usage: sunshine stop app_name [more names...] [options]
+  # Usage: sunshine stop [options] app_name [more names...]
   #
   # Arguments:
   #     app_name     Name of the application to stop.
@@ -48,7 +48,7 @@ module Sunshine
       parse_remote_args(argv) do |opt, options|
         opt.banner = <<-EOF
 
-Usage: #{opt.program_name} stop app_name [more names...] [options]
+Usage: #{opt.program_name} stop [options] app_name [more names...]
 
 Arguments:
     app_name     Name of the application to stop.

data/lib/sunshine.rb

@@ -4,7 +4,6 @@ require 'rainbow'
 require 'highline'
 require 'json'
 
-
 require 'yaml'
 require 'erb'
 require 'logger'
@@ -14,76 +13,64 @@ require 'fileutils'
 require 'tmpdir'
 
 ##
-# Sunshine is an object oriented deploy tool for rack applications.
-#
-# Writing a Sunshine config script is easy:
-#
-#   options = {
-#     :name => 'myapp',
-#     :repo => {:type => :svn, :url => 'svn://blah...'},
-#     :deploy_path => '/usr/local/myapp',
-#     :remote_shells => ['user@someserver.com']
-#   }
-#
-#   Sunshine::App.deploy(options) do |app|
-#
-#     app.yum_install 'sqlite'
-#     app.gem_install 'sqlite3-ruby'
-#
-#     app.rake "db:migrate"
-#
-#     app_server = Sunshine::Rainbows.new(app)
-#     app_server.restart
-#
-#     Sunshine::Nginx.new(app, :point_to => app_server).restart
-#
-#   end
-#
-# The App::deploy and App::new methods also support passing
-# a path to a yaml file:
-#
-#   app = Sunshine::App.new("path/to/config.yml")
-#   app.deploy{|app| Sunshine::Rainbows.new(app).restart }
-#
-#
-# Command line execution:
-#
-#   Usage:
-#     sunshine -h/--help
-#     sunshine -v/--version
-#     sunshine command [arguments...] [options...]
-#
-#   Examples:
-#     sunshine run deploy_script.rb
-#     sunshine restart myapp -r user@server.com,user@host.com
-#     sunshine list myapp myotherapp --health -r user@server.com
-#     sunshine list myapp --status
-#
-#   Commands:
-#     add       Register an app with sunshine
-#     list      Display deployed apps
-#     restart   Restart a deployed app
-#     rm        Unregister an app with sunshine
-#     run       Run a Sunshine script
-#     start     Start a deployed app
-#     stop      Stop a deployed app
-#
-#    For more help on sunshine commands, use 'sunshine COMMAND --help'
+# Main module, used for configuration and running commands.
 
 module Sunshine
 
   ##
   # Sunshine version.
-  VERSION = '1.0.3'
+  VERSION = '1.1.0'
 
+  ##
+  # Path to the list of installed sunshine apps.
+  APP_LIST_PATH = "~/.sunshine_list"
 
   ##
-  # Handles input/output to the shell. See Sunshine::Shell.
+  # Commands supported by Sunshine.
+  COMMANDS = %w{add list restart rm run start stop}
 
-  def self.shell
-    @shell ||= Sunshine::Shell.new
+  ##
+  # File DATA from Sunshine run files.
+  DATA = defined?(::DATA) ? ::DATA : nil
+
+  ##
+  # Default configuration.
+  DEFAULT_CONFIG = {
+    'level'               => 'info',
+    'deploy_env'          => :development,
+    'auto'                => false,
+    'max_deploy_versions' => 5,
+    'web_directory'       => '/var/www',
+    'auto_dependencies'   => true
+  }
+
+  ##
+  # Path where Sunshine assumes repo information can be found if missing.
+  PATH = Dir.getwd
+
+  ##
+  # Root directory of the Sunshine gem.
+  ROOT = File.expand_path File.join(File.dirname(__FILE__), "..")
+
+  ##
+  # Default Sunshine config file
+  USER_CONFIG_FILE = File.expand_path("~/.sunshine")
+
+  ##
+  # Temp directory used by various sunshine classes
+  # for uploads, checkouts, etc...
+  TMP_DIR = File.join Dir.tmpdir, "sunshine_#{$$}"
+  FileUtils.mkdir_p TMP_DIR
+
+
+  ##
+  # Returns the Sunshine config hash.
+
+  def self.config
+    @config ||= DEFAULT_CONFIG.dup
   end
 
+
   ##
   # The default deploy environment to use. Set with the -e option.
   # See App#deploy_env for app specific deploy environments.
@@ -109,6 +96,14 @@ module Sunshine
   end
 
 
+  ##
+  # Handles input/output to the shell. See Sunshine::Shell.
+
+  def self.shell
+    @shell ||= Sunshine::Shell.new
+  end
+
+
   ##
   # The default directory where apps should be deployed to:
   # '/var/www' by default. Overridden in the ~/.sunshine config file
@@ -132,8 +127,7 @@ module Sunshine
   # Handles all output for sunshine. See Sunshine::Output.
 
   def self.logger
-    @logger ||= Sunshine::Output.new \
-      :level => Logger.const_get(@config['level'].upcase)
+    @logger
   end
 
 
@@ -194,15 +188,6 @@ module Sunshine
   end
 
 
-  trap "INT" do
-    $stderr << "\n\n"
-    logger.indent = 0
-    logger.fatal :INT, "Caught INT signal!"
-
-    call_trap @trap_stack.shift
-    Kernel.exit 1
-  end
-
 
   ##
   # Global value of sudo to use. Returns true, nil, or a username.
@@ -215,93 +200,87 @@ module Sunshine
 
 
   ##
-  # Path to the list of installed sunshine apps.
-  APP_LIST_PATH = "~/.sunshine_list"
+  # Cleanup after Sunshine has run, remove temp dirs, etc...
 
-  READ_LIST_CMD = "test -f #{Sunshine::APP_LIST_PATH} && "+
-      "cat #{APP_LIST_PATH} || echo ''"
+  def self.cleanup
+    FileUtils.rm_rf TMP_DIR if Dir.glob("#{TMP_DIR}/*").empty?
+  end
 
-  ##
-  # Commands supported by Sunshine
-  COMMANDS = %w{add list restart rm run start stop}
 
   ##
-  # Default Sunshine config file
-  USER_CONFIG_FILE = File.expand_path("~/.sunshine")
+  # Loads a yaml config file to run setup with.
 
-  ##
-  # Default configuration
-  DEFAULT_CONFIG = {
-    'level'               => 'info',
-    'deploy_env'          => :development,
-    'auto'                => false,
-    'max_deploy_versions' => 5,
-    'web_directory'       => '/var/www',
-    'auto_dependencies'   => true
-  }
+  def self.load_config_file conf
+    setup YAML.load_file(conf)
+  end
 
-  ##
-  # Temp directory used by various sunshine classes
-  # for uploads, checkouts, etc...
-  TMP_DIR = File.join Dir.tmpdir, "sunshine_#{$$}"
-  FileUtils.mkdir_p TMP_DIR
 
   ##
-  # Path where sunshine assumes repo information can be found if missing.
-  PATH = Dir.getwd
+  # Loads the USER_CONFIG_FILE and runs setup. Creates the default
+  # config file and exits if not present.
 
-  ##
-  # File DATA from sunshine run files.
-  DATA = defined?(::DATA) ? ::DATA : nil
+  def self.load_user_config
+    unless File.file? USER_CONFIG_FILE
+      File.open(USER_CONFIG_FILE, "w+"){|f| f.write DEFAULT_CONFIG.to_yaml}
+
+      msg = "Missing config file was created for you: #{USER_CONFIG_FILE}\n\n"
+      msg << DEFAULT_CONFIG.to_yaml
+
+      self.exit 1, msg
+    end
+
+    load_config_file USER_CONFIG_FILE
+  end
 
-  ##
-  # Root directory of the Sunshine gem.
-  ROOT = File.expand_path File.join(File.dirname(__FILE__), "..")
 
   ##
-  # Cleanup after sunshine has run, remove temp dirs, etc...
+  # Loads an array of libraries or gems.
 
-  def self.cleanup
-    FileUtils.rm_rf TMP_DIR if Dir.glob("#{TMP_DIR}/*").empty?
+  def self.require_libs(*libs)
+    libs.compact.each{|lib| require lib }
   end
 
 
   ##
-  # Setup sunshine with a custom config:
+  # Setup Sunshine with a custom config:
   #   Sunshine.setup 'level' => 'debug', 'deploy_env' => :production
 
   def self.setup new_config={}, reset=false
-    @config = DEFAULT_CONFIG.dup if !defined?(@config) || reset
-    @config.merge! new_config
-    @config
+    @config = DEFAULT_CONFIG.dup if reset
+
+    trap "INT" do
+      $stderr << "\n\n"
+      logger.indent = 0
+      logger.fatal :INT, "Caught INT signal!"
+
+      call_trap @trap_stack.shift
+      exit 1
+    end
+
+    require_libs(*new_config['require'])
+
+    config.merge! new_config
+
+    log_level = Logger.const_get config['level'].upcase rescue Logger::INFO
+    @logger   = Sunshine::Output.new :level => log_level
+
+    config
   end
 
 
   ##
-  # Run sunshine with the passed argv and exits with appropriate exitcode.
+  # Run Sunshine with the passed argv and exits with appropriate exitcode.
   #   run %w{run my_script.rb -l debug}
   #   run %w{list -d}
+  #   run %w{--rakefile}
 
   def self.run argv=ARGV
-    unless File.file? USER_CONFIG_FILE
-      File.open(USER_CONFIG_FILE, "w+"){|f| f.write DEFAULT_CONFIG.to_yaml}
-
-      msg = "Missing config file was created for you: #{USER_CONFIG_FILE}\n\n"
-      msg << DEFAULT_CONFIG.to_yaml
-
-      self.exit 1, msg
-    end
+    command = find_command argv.first
+    argv.shift if command
 
-    command_name = find_command argv.first
-    argv.shift if command_name
-    command_name ||= "default"
+    command ||= DefaultCommand
 
-    command = Sunshine.const_get("#{command_name.capitalize}Command")
-
-    config = YAML.load_file USER_CONFIG_FILE
-    config.merge! command.parse_args(argv)
-
-    self.setup config, true
+    setup command.parse_args(argv)
 
     result = command.exec argv, config
 
@@ -312,12 +291,15 @@ module Sunshine
   ##
   # Find the sunshine command to run based on the passed name.
   # Handles partial command names if they can be uniquely mapped to a command.
-  #   find_command "dep" #=> "run"
-  #   find_command "zzz" #=> false
+  #   find_command "ru" #=> Sunshine::RunCommand
+  #   find_command "l" #=> Sunshine::ListCommand
+  #   find_command "zzz" #=> nil
 
   def self.find_command name
     commands = COMMANDS.select{|c| c =~ /^#{name}/}
-    commands.length == 1 && commands.first
+    return unless commands.length == 1 && commands.first
+
+    Sunshine.const_get "#{commands.first.capitalize}Command"
   end
 
 
@@ -371,11 +353,14 @@ module Sunshine
   require 'sunshine/repos/rsync_repo'
 
   require 'sunshine/daemon'
+  require 'sunshine/daemons/server_cluster'
   require 'sunshine/daemons/server'
   require 'sunshine/daemons/apache'
   require 'sunshine/daemons/nginx'
+  require 'sunshine/daemons/thin'
   require 'sunshine/daemons/unicorn'
   require 'sunshine/daemons/rainbows'
+  require 'sunshine/daemons/mongrel_rails'
   require 'sunshine/daemons/ar_sendmail'
   require 'sunshine/daemons/delayed_job'
 
@@ -398,6 +383,6 @@ module Sunshine
   require 'commands/stop'
 end
 
+Sunshine.load_user_config
 
-Sunshine.setup
 require 'sunshine/dependencies'