sunshine 1.0.0.pre

data/lib/sunshine.rb

@@ -0,0 +1,391 @@
+require 'rubygems'
+require 'open4'
+require 'rainbow'
+require 'highline'
+require 'tmpdir'
+
+require 'yaml'
+require 'erb'
+require 'logger'
+require 'optparse'
+require 'time'
+require 'fileutils'
+
+##
+# 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'
+
+module Sunshine
+
+  ##
+  # Sunshine version.
+  VERSION = '1.0.0.pre'
+
+
+  ##
+  # Handles input/output to the shell. See Sunshine::Shell.
+
+  def self.shell
+    @shell ||= Sunshine::Shell.new
+  end
+
+  ##
+  # The default deploy environment to use. Set with the -e option.
+  # See App#deploy_env for app specific deploy environments.
+
+  def self.deploy_env
+    @config['deploy_env'].to_s
+  end
+
+
+  ##
+  # Returns the main Sunshine dependencies library.
+
+  def self.dependencies
+    @dependency_lib ||= DependencyLib.new
+  end
+
+
+  ##
+  # The default directory where apps should be deployed to:
+  # '/var/www' by default. Overridden in the ~/.sunshine config file.
+  # See also App#deploy_path.
+
+  def self.web_directory
+    @config['web_directory']
+  end
+
+
+  ##
+  # Should sunshine ever ask for user input? True by default; overridden with
+  # the -a option.
+
+  def self.interactive?
+    !@config['auto']
+  end
+
+
+  ##
+  # Handles all output for sunshine. See Sunshine::Output.
+
+  def self.logger
+    @logger ||= Sunshine::Output.new \
+      :level => Logger.const_get(@config['level'].upcase)
+  end
+
+
+  ##
+  # Maximum number of deploys (history) to keep on the remote server,
+  # 5 by default. Overridden in the ~/.sunshine config file.
+
+  def self.max_deploy_versions
+    @config['max_deploy_versions']
+  end
+
+
+  ##
+  # Check if trace log should be output at all.
+  # This value can be assigned by default in ~/.sunshine
+  # or switched off with the run command's --no-trace option.
+  # Defaults to true.
+
+  def self.trace?
+    @config['trace']
+  end
+
+
+  ##
+  # Adds an INT signal trap with its description on the stack.
+  # Returns a trap_item Array.
+
+  def self.add_trap desc, &block
+    trap_item = [desc, block]
+    (@trap_stack ||= []).unshift trap_item
+    trap_item
+  end
+
+  add_trap "Disconnecting all remote shells." do
+    RemoteShell.disconnect_all
+  end
+
+
+  ##
+  # Call a trap item and display it's message.
+
+  def self.call_trap trap_item
+    return unless trap_item
+
+    msg, block = trap_item
+
+    logger.info :INT, msg do
+      block.call
+    end
+  end
+
+
+  ##
+  # Remove a trap_item from the stack.
+
+  def self.delete_trap trap_item
+    @trap_stack.delete trap_item
+  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.
+  # This value can be assigned by default in ~/.sunshine
+  # or with the --sudo [username] option. Defaults to nil.
+
+  def self.sudo
+    @config['sudo']
+  end
+
+
+  ##
+  # Path to the list of installed sunshine apps.
+  APP_LIST_PATH = "~/.sunshine_list"
+
+  READ_LIST_CMD = "test -f #{Sunshine::APP_LIST_PATH} && "+
+      "cat #{APP_LIST_PATH} || echo ''"
+
+  ##
+  # Commands supported by Sunshine
+  COMMANDS = %w{add list restart rm run start stop}
+
+  ##
+  # Default Sunshine config file
+  USER_CONFIG_FILE = File.expand_path("~/.sunshine")
+
+  ##
+  # Default configuration
+  DEFAULT_CONFIG = {
+    'level'               => 'info',
+    'deploy_env'          => :development,
+    'auto'                => false,
+    'max_deploy_versions' => 5,
+    'web_directory'       => '/var/www'
+  }
+
+  ##
+  # 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
+
+  ##
+  # File DATA from sunshine run files.
+  DATA = defined?(::DATA) ? ::DATA : nil
+
+  ##
+  # Root directory of the Sunshine gem.
+  ROOT = File.expand_path File.join(File.dirname(__FILE__), "..")
+
+  ##
+  # Cleanup after sunshine has run, remove temp dirs, etc...
+
+  def self.cleanup
+    FileUtils.rm_rf TMP_DIR if Dir.glob("#{TMP_DIR}/*").empty?
+  end
+
+
+  ##
+  # 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
+  end
+
+
+  ##
+  # Run sunshine with the passed argv and exits with appropriate exitcode.
+  #   run %w{run my_script.rb -l debug}
+  #   run %w{list -d}
+
+  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_name = find_command argv.first
+    argv.shift if command_name
+    command_name ||= "default"
+
+    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
+
+    result = command.exec argv, config
+
+    self.exit(*result)
+  end
+
+
+  ##
+  # 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
+
+  def self.find_command name
+    commands = COMMANDS.select{|c| c =~ /^#{name}/}
+    commands.length == 1 && commands.first
+  end
+
+
+  ##
+  # Exits sunshine process and returns the appropriate exit code
+  #   exit 0, "ok"
+  #   exit false, "ok"
+  #     # both output: stdout >> ok - exitcode 0
+  #   exit 1, "oh noes"
+  #   exit true, "oh noes"
+  #     # both output: stderr >> oh noes - exitcode 1
+
+  def self.exit status, msg=nil
+    self.cleanup
+
+    status = case status
+    when true
+      0
+    when false
+      1
+    when Integer
+      status
+    else
+      status.to_i
+    end
+
+    output = status == 0 ? $stdout : $stderr
+
+    output << "#{msg}\n" if !msg.nil?
+
+    Kernel.exit status
+  end
+
+
+  require 'sunshine/exceptions'
+
+  require 'sunshine/shell'
+  require 'sunshine/output'
+
+  require 'sunshine/binder'
+
+  require 'sunshine/dependency_lib'
+  require 'sunshine/package_managers/dependency'
+  require 'sunshine/package_managers/apt'
+  require 'sunshine/package_managers/yum'
+  require 'sunshine/package_managers/gem'
+
+  require 'sunshine/repo'
+  require 'sunshine/repos/svn_repo'
+  require 'sunshine/repos/git_repo'
+  require 'sunshine/repos/rsync_repo'
+
+  require 'sunshine/daemon'
+  require 'sunshine/daemons/server'
+  require 'sunshine/daemons/nginx'
+  require 'sunshine/daemons/unicorn'
+  require 'sunshine/daemons/rainbows'
+  require 'sunshine/daemons/ar_sendmail'
+  require 'sunshine/daemons/delayed_job'
+
+  require 'sunshine/crontab'
+
+  require 'sunshine/healthcheck'
+
+  require 'sunshine/remote_shell'
+
+  require 'sunshine/server_app'
+  require 'sunshine/app'
+
+  require 'commands/default'
+  require 'commands/list'
+  require 'commands/add'
+  require 'commands/run'
+  require 'commands/restart'
+  require 'commands/rm'
+  require 'commands/start'
+  require 'commands/stop'
+end
+
+
+Sunshine.setup
+require 'sunshine/dependencies'

data/templates/logrotate/logrotate.conf.erb

@@ -0,0 +1,11 @@
+<%= log_path %>/* {
+missingok
+rotate 168
+compress
+delaycompress
+olddir <%= log_path %>/rotate
+create 0666 <%= server_app.shell.user %>
+lastaction
+  logpush <%= log_path %>/rotate/*
+endscript
+} 

data/templates/nginx/nginx.conf.erb

@@ -0,0 +1,109 @@
+<% darwin = shell.os_name =~ /^darwin$/i %>
+
+<% if sudo == true || sudo == 'root' %>
+user nobody nobody;
+<% end %>
+worker_processes  <%= processes %>;
+pid               <%= expand_path pid %>;
+error_log         <%= expand_path log_file(:stderr) %> info;
+
+events {
+  worker_connections  1024;
+  <% unless darwin %>
+  use epoll;
+  <% end %>
+}
+
+http {
+
+  <% if use_passenger? %>
+  passenger_root <%= passenger_root %>;
+  <% end %>
+
+  client_body_temp_path <%= darwin ? '/var/tmp/nginx' : '/dev/shm' %>;
+  proxy_temp_path <%= darwin ? '/var/tmp/nginx' : '/dev/shm' %>;
+
+  include       <%= File.join nginx_conf_path, 'mime.types' %>;
+  default_type  application/octet-stream;
+
+  log_format sunshine '$remote_addr - $remote_user [$time_local] '
+                      '"$request" $status $body_bytes_sent "$http_referer" '
+                      '"$http_user_agent" "$http_cookie" $request_time '
+                      '$upstream_http_x_urid';
+  access_log <%= expand_path log_file(:stdout) %> sunshine;
+
+  
+  # This should be some other include file
+  include  <%= expand_path config_path %>/nginx_optimize.conf;
+  
+  
+  ##
+  # gZip config
+  gzip              on;
+  gzip_disable      "MSIE [1-6]\.";
+  gzip_min_length   1100;
+  gzip_buffers      4 8k;
+  gzip_http_version 1.0;
+  gzip_comp_level   5;
+  gzip_proxied      any;
+  gzip_types        text/plain text/html text/css application/x-javascript application/xml application/xml+rss text/javascript;
+
+  <% if target.is_a?(Sunshine::Server) %>
+  upstream app_server {
+    server 0:<%= target.port %> fail_timeout=<%= timeout %>;
+  }
+  <% end %>
+
+  ##
+  # 301 redirect www to non-www host.
+  server {
+    listen <%= port %>;
+    server_name www.<%= server_name %>;
+    rewrite ^/(.*) http://<%= server_name %>/$1 permanent;
+  }
+
+  ##
+  # Main server definition.
+  server {
+    listen <%= port %> default;
+    server_name <%= server_name %>;
+    port_in_redirect off; # needed for the F5, unfortunately
+    server_name_in_redirect off;
+
+
+    root <%= expand_path app.current_path %>/public;
+
+  <% if use_passenger? %>
+    passenger_enabled on;
+
+  <% else %>
+
+    ##
+    # Main proxy
+    location / {
+      <% if darwin %>
+      ssi on;
+      <% end %>
+      if (-f $request_filename) {
+        break;
+      }
+
+      include  <%= expand_path config_path %>/nginx_proxy.conf;
+      expires -1;
+
+      <% if target.is_a?(Sunshine::Server) %>
+      if (!-f $request_filename) {
+        proxy_pass http://app_server;
+        break;
+      }
+      <% end %>
+
+      error_page   500 502 503 504  /500.html;
+      location = /500.html {
+        root <%= expand_path app.current_path %>/public;
+      }
+    }
+  <% end %>
+  }
+
+}

data/templates/nginx/nginx_optimize.conf

@@ -0,0 +1,23 @@
+server_name_in_redirect       off;
+
+sendfile                      on;
+tcp_nodelay                   on;
+tcp_nopush                    off;
+keepalive_timeout             75 20;
+server_names_hash_bucket_size 128; # Seems to be required for vhosts.
+
+##
+# Optimizations: http://www.typemiss.net/blog/kounoike/20060227-75
+client_header_timeout         10m;
+client_body_timeout           10m;
+send_timeout                  10m;
+
+connection_pool_size          256;
+client_header_buffer_size     12k;
+large_client_header_buffers   4 8k;
+request_pool_size             4k;
+
+output_buffers                1 32k;
+postpone_output               1460;
+
+ignore_invalid_headers        on;

data/templates/nginx/nginx_proxy.conf

@@ -0,0 +1,13 @@
+proxy_redirect              off;
+proxy_set_header            Host $host;
+proxy_set_header            X-Real-IP $remote_addr;
+proxy_set_header            X-Forwarded-For $proxy_add_x_forwarded_for;
+client_max_body_size        10m;
+client_body_buffer_size     128k;
+proxy_connect_timeout       90;
+proxy_send_timeout          90;
+proxy_read_timeout          90;
+proxy_buffer_size           4k;
+proxy_buffers               4 32k;
+proxy_busy_buffers_size     64k;
+proxy_temp_file_write_size  64k;

data/templates/rainbows/rainbows.conf.erb

@@ -0,0 +1,18 @@
+timeout <%= timeout %>
+worker_processes <%= processes %>
+listen "0.0.0.0:<%= port %>"
+pid File.expand_path("<%= pid %>")
+stderr_path File.expand_path("<%= log_file :stderr %>")
+stdout_path File.expand_path("<%= log_file :stdout %>")
+
+<% if concurrency && !concurrency.empty? %>
+Rainbows! do
+  use <%= concurrency[:model].inspect %>
+  <% if concurrency[:connections] %>
+  worker_connections <%= concurrency[:connections] %>
+  <% end %>
+  <% if concurrency[:timeout] %>
+  keepalive_timeout <%= concurrency[:timeout] %>
+  <% end %>
+end
+<% end %>

data/templates/tasks/sunshine.rake

@@ -0,0 +1,114 @@
+require 'sunshine'
+
+namespace :sunshine do
+
+  ##
+  # If using rails, have rails information available by updating :app task to:
+  #   task :app => :environment do
+  #     ...
+  #   end
+
+  desc "Instantiate Sunshine"
+  task :app do
+    deploy_env = ENV['env'] || ENV['RACK_ENV'] || ENV['RAILS_ENV']
+
+    Sunshine.setup 'deploy_env' => ( deploy_env || "development" )
+
+
+    # View the Sunshine README, scripts in the sunshine/examples
+    # directory, or the docs for Sunshine::App for more information on
+    # App instantiation.
+
+    @app = Sunshine::App.new "path/to/app_deploy_config.yml"
+    # or
+    # @app = Sunshine::App.new app_config_hash
+  end
+
+
+  desc "Deploy the app"
+  task :deploy => :app do
+    Sunshine.setup 'trace' => true
+
+    @app.deploy do |app|
+
+      # Do deploy-specific stuff here, e.g.
+      #
+      #   app.run_bundler
+      #
+      #   unicorn = Sunshine::Unicorn.new app, :port      => 3000,
+      #                                        :processes => 8
+      #   unicorn.setup
+
+    end
+
+    @app.start :force => true
+  end
+
+
+  # Post-deploy control tasks:
+
+  desc "Run db:migrate on remote :db servers"
+  task :db_migrate => :app do
+    @app.rake 'db:migrate', :role => :db
+  end
+
+
+  desc "Run the remote start script"
+  task :start => :app do
+    @app.start
+    puts @app.status.to_yaml
+  end
+
+
+  desc "Run the remote stop script"
+  task :stop => :app do
+    @app.stop
+    puts @app.status.to_yaml
+  end
+
+
+  desc "Run the remote restart script"
+  task :restart => :app do
+    @app.restart
+    puts @app.status.to_yaml
+  end
+
+
+  desc "Check if the deployed app is running"
+  task :status => :app do
+    puts @app.status.to_yaml
+  end
+
+
+  desc "Get deployed app info"
+  task :info => :app do
+    puts @app.deploy_details.to_yaml
+  end
+
+
+  desc "Get the health state"
+  task :health => :app do
+    puts @app.health.to_yaml
+  end
+
+
+  namespace :health do
+
+    desc "Turn on health check"
+    task :enable => :app do
+      puts @app.health(:enable).to_yaml
+    end
+
+
+    desc "Turn off health check"
+    task :disable => :app do
+      puts @app.health(:disable).to_yaml
+    end
+
+
+    desc "Remove health check"
+    task :remove => :app do
+      puts @app.health(:remove).to_yaml
+    end
+  end
+end

data/templates/unicorn/unicorn.conf.erb

@@ -0,0 +1,6 @@
+timeout <%= timeout %>
+worker_processes <%= processes %>
+listen "0.0.0.0:<%= port %>"
+pid File.expand_path("<%= pid %>")
+stderr_path File.expand_path("<%= log_file :stderr %>")
+stdout_path File.expand_path("<%= log_file :stdout %>")

data/test/fixtures/app_configs/test_app.yml

@@ -0,0 +1,11 @@
+:default:
+  :name: other_app
+  :repo:
+    :type: svn
+    :url:  svn://subversion/path/to/other_app/tags/release001
+
+  :root_path: /usr/local/my_user/other_app
+
+  :remote_shells:
+    - - "user@some_server.com"
+      - :roles: web db app