ricodigo-capistrano-recipes 0.1.0

data/generators/unicorn.rb.erb

@@ -0,0 +1,65 @@
+rails_root = '<%= "#{deploy_to}/current" %>'
+rails_env  = '<%= environment %>'
+pid_file   = '<%= unicorn_pid %>'
+socket_file= '<%= unicorn_socket %>'
+log_file   = '<%= deploy_to %>/current/log/unicorn.log'
+username   = '<%= unicorn_user %>'
+group      = '<%= unicorn_group %>'
+old_pid    = pid_file + '.oldbin'
+
+
+working_directory rails_root
+
+timeout <%= unicorn_workers_timeout %>
+
+worker_processes <%= unicorn_workers %>
+
+# Listen on a Unix data socket
+listen socket_file, :backlog => 1024
+pid pid_file
+
+stderr_path log_file
+stdout_path log_file
+
+preload_app true
+
+GC.copy_on_write_friendly = true if GC.respond_to?(:copy_on_write_friendly=)
+
+before_fork do |server, worker|
+  if File.exists?(old_pid) && server.pid != old_pid
+    pid = File.read(old_pid).to_i
+    begin
+      Process.kill("QUIT", pid)
+      Process.kill(0, pid)
+      Process.wait
+    rescue Errno::ECHILD, Errno::ESRCH => e
+      $stderr.puts ">> Process #{pid} has stopped"
+    rescue Errno::ENOENT => e
+      $stderr.puts ">> Error killing previous instance. #{e.message}"
+      # someone else did our job for us
+    end
+  end
+end
+
+
+after_fork do |server, worker|
+  begin
+    uid, gid = Process.euid, Process.egid
+
+    target_uid = File.stat(Rails.root).uid
+    user = Etc.getpwuid(target_uid).name
+
+    target_gid = File.stat(Rails.root).gid
+    group = Etc.getgrgid(target_gid).name
+
+    worker.tmp.chown(target_uid, target_gid)
+    if uid != target_uid || gid != target_gid
+      Process.initgroups(user, target_gid)
+      Process::GID.change_privilege(target_gid)
+      Process::UID.change_privilege(target_uid)
+    end
+  rescue => e
+    STDERR.puts "cannot change privileges on #{Rails.env} environment"
+    STDERR.puts "  #{e}"
+  end
+end

data/lib/helpers.rb

@@ -0,0 +1,88 @@
+# =========================================================================
+# These are helper methods that will be available to your recipes.
+# =========================================================================
+
+# automatically sets the environment based on presence of
+# :stage (multistage gem), :rails_env, or RAILS_ENV variable; otherwise defaults to 'production'
+def environment
+  if exists?(:stage)
+    stage
+  elsif exists?(:rails_env)
+    rails_env
+  elsif(ENV['RAILS_ENV'])
+    ENV['RAILS_ENV']
+  else
+    "production"
+  end
+end
+
+def is_using_nginx
+  is_using('nginx',:web_server)
+end
+
+def is_using_passenger
+  is_using('passenger',:app_server)
+end
+
+def is_using_unicorn
+  is_using('unicorn',:app_server)
+end
+
+def is_app_monitored?
+  is_using('bluepill', :monitorer)
+end
+
+def is_using(something, with_some_var)
+ exists?(with_some_var.to_sym) && fetch(with_some_var.to_sym).to_s.downcase == something
+end
+
+# Path to where the generators live
+def templates_path
+  expanded_path_for('../generators')
+end
+
+def docs_path
+  expanded_path_for('../doc')
+end
+
+def expanded_path_for(path)
+  e = File.join(File.dirname(__FILE__),path)
+  File.expand_path(e)
+end
+
+def parse_config(file)
+  require 'erb'  #render not available in Capistrano 2
+  template=File.read(file)          # read it
+  return ERB.new(template).result(binding)   # parse it
+end
+
+# =========================================================================
+# Prompts the user for a message to agree/decline
+# =========================================================================
+def ask(message, default=true)
+  Capistrano::CLI.ui.agree(message)
+end
+
+# Generates a configuration file parsing through ERB
+# Fetches local file and uploads it to remote_file
+# Make sure your user has the right permissions.
+def generate_config(local_file,remote_file)
+  temp_file = '/tmp/' + File.basename(local_file)
+  buffer    = parse_config(local_file)
+  File.open(temp_file, 'w+') { |f| f << buffer }
+  upload temp_file, remote_file, :via => :scp
+  `rm #{temp_file}`
+end
+
+# =========================================================================
+# Executes a basic rake task.
+# Example: run_rake log:clear
+# =========================================================================
+def run_rake(task)
+  run "cd #{current_path} && rake #{task} RAILS_ENV=#{environment}"
+end
+
+
+def rvmsudo(task)
+  run "cd #{current_path} && rvmsudo #{task}"
+end

data/lib/recipes/application.rb

@@ -0,0 +1,68 @@
+Capistrano::Configuration.instance.load do
+  # User settings
+  set :user, 'app'   unless exists?(:user)
+  set :group,'app' unless exists?(:group)
+
+  # Server settings
+  set :app_server, :unicorn       unless exists?(:app_server)
+  set :web_server, :nginx         unless exists?(:web_server)
+  set :runner, user               unless exists?(:runner)
+  set :application_port, 80       unless exists?(:application_port)
+
+  set :application_uses_ssl, true unless exists?(:application_uses_ssl)
+  set :application_port_ssl, 443  unless exists?(:application_port_ssl)
+
+  # Database settings
+  set :database, :mongodb unless exists?(:database)
+
+  # SCM settings
+  set :scm, :git
+  set :branch, 'master' unless exists?(:branch)
+  set :deploy_to, "/home/#{user}/rails/#{application}"
+  set :deploy_via, :checkout
+  set :keep_releases, 3
+  set :run_method, :run
+  set :git_enable_submodules, true
+  set :git_shallow_clone, 1
+  set :rails_env, 'production' unless exists?(:rails_env)
+
+  # Git settings for capistrano
+  default_run_options[:pty] = true
+  ssh_options[:forward_agent] = true
+
+  # RVM settings
+  set :using_rvm, true unless exists?(:using_rvm)
+
+  if using_rvm
+    $:.unshift(File.expand_path('./lib', ENV['rvm_path']))  # Add RVM's lib directory to the load path.
+    require "rvm/capistrano"                                # Load RVM's capistrano plugin.
+
+    # Sets the rvm to a specific version (or whatever env you want it to run in)
+    set :rvm_ruby_string, '1.9.2' unless exists?(:rvm_ruby_string)
+  end
+
+  # Daemons settings
+  # The unix socket that unicorn will be attached to.
+  # Also, nginx will upstream to this guy.
+  # The *nix place for socks is /var/run, so we should probably put it there
+  # Make sure the runner can access this though.
+  set :sockets_path, "/var/run/#{application}" unless exists?(:sockets_path)
+
+  # Just to be safe, put the pid somewhere that survives deploys. shared/pids is
+  # a good choice as any.
+  set(:pids_path) { File.join(shared_path, "pids") } unless exists?(:pids_path)
+
+  set :monitorer, 'bluepill' unless exists?(:monitorer)
+
+  # Application settings
+  set :shared_dirs, %w(config config/pills uploads backup bundle tmp sockets pids log system) unless exists?(:shared_dirs)
+
+  namespace :app do
+    task :setup, :roles => :app do
+      commands = shared_dirs.map do |path|
+        "if [ ! -d '#{path}' ]; then mkdir -p #{path}; fi;"
+      end
+      run "cd #{shared_path}; #{commands.join(' ')}"
+    end
+  end
+end

data/lib/recipes/bluepill.rb

@@ -0,0 +1,66 @@
+Capistrano::Configuration.instance.load do
+  set(:bluepill_local_config) { "#{templates_path}/app.bluepill.erb" } unless exists?(:nginx_local_config)
+  set(:bluepill_remote_config) { "#{shared_path}/config/pills/#{application}.pill" } unless exists?(:nginx_remote_config)
+
+  namespace :bluepill do
+    desc "|capistrano-recipes| Parses and uploads nginx configuration for this app."
+    task :setup, :roles => :app , :except => { :no_release => true } do
+      generate_config(bluepill_local_config, bluepill_remote_config)
+    end
+
+    desc "|capistrano-recipes| Install the bluepill monitoring tool"
+    task :install, :roles => [:app] do
+      sudo "gem install bluepill"
+    end
+
+    desc "|capistrano-recipes| Stop processes that bluepill is monitoring and quit bluepill"
+    task :quit, :roles => [:app] do
+      args = exists?(:options) ? options : ''
+      begin
+        rvmsudo "bluepill stop #{args}"
+      rescue
+        puts "Bluepill was unable to finish gracefully all the process"
+      ensure
+        rvmsudo "bluepill quit"
+      end
+    end
+
+    desc "|capistrano-recipes| Load the pill from {your-app}/config/pills/{app-name}.pill"
+    task :init, :roles =>[:app] do
+      rvmsudo "bluepill load #{shared_path}/config/pills/#{application}.pill"
+    end
+
+    desc "|capistrano-recipes| Starts your previous stopped pill"
+    task :start, :roles =>[:app] do
+      args = exists?(:options) ? options : ''
+      app = exists?(:app) ? app : application
+      rvmsudo "bluepill #{app} start #{args}"
+    end
+
+    desc "|capistrano-recipes| Stops some bluepill monitored process"
+    task :stop, :roles =>[:app] do
+      args = exists?(:options) ? options : ''
+      app = exists?(:app) ? app : application
+      rvmsudo "bluepill #{app} stop #{args}"
+    end
+
+    desc "|capistrano-recipes| Restarts the pill from {your-app}/config/pills/{app-name}.pill"
+    task :restart, :roles =>[:app] do
+      args = exists?(:options) ? options : ''
+      app = exists?(:app) ? app : application
+      rvmsudo "bluepill #{app} restart #{args}"
+    end
+
+    desc "|capistrano-recipes| Prints bluepills monitored processes statuses"
+    task :status, :roles => [:app] do
+      args = exists?(:options) ? options : ''
+      app = exists?(:app) ? app : application
+      rvmsudo "bluepill #{app} status #{args}"
+    end
+  end
+
+  after 'deploy:setup' do
+    bluepill.install if Capistrano::CLI.ui.agree("Do you want to install the bluepill monitor? [Yn]")
+    bluepill.setup if Capistrano::CLI.ui.agree("Create bluepill configuration file? [Yn]")
+  end if is_using('bluepill', :monitorer)
+end

data/lib/recipes/bundler.rb

@@ -0,0 +1,14 @@
+Capistrano::Configuration.instance.load do
+  namespace :bundler do
+    desc "|capistrano-recipes| Installs bundler gem to your server"
+    task :setup, :roles => :app do
+      run "if ! gem list | grep --silent -e 'bundler'; then #{try_sudo} gem uninstall bundler; #{try_sudo} gem install --no-rdoc --no-ri bundler; fi"
+    end
+    
+    desc "|capistrano-recipes| Runs bundle install on the app server (internal task)"
+    task :install, :roles => :app, :except => { :no_release => true } do
+      run "cd #{current_path} && bundle install --deployment --without=development test"
+    end
+  end
+end
+

data/lib/recipes/db.rb

@@ -0,0 +1,97 @@
+require 'erb'
+
+Capistrano::Configuration.instance.load do
+  namespace :db do
+    namespace :mongodb do
+      desc <<-EOF
+      |capistrano-recipes| Performs a compressed database dump. \
+      WARNING: This locks your tables for the duration of the mongodump.
+      Don't run it madly!
+      EOF
+      task :dump, :roles => :db, :only => { :primary => true } do
+        prepare_from_yaml
+        run "mongodump -u #{db_user} -p #{db_pass} -h #{db_host} --port #{db_port} -d #{db_name} #{db_backup_path}" do |ch, stream, out|
+          puts out
+        end
+      end
+
+      desc "|capistrano-recipes| Restores the database from the latest compressed dump"
+      task :restore, :roles => :db, :only => { :primary => true } do
+        prepare_from_yaml
+        run "mongorestore --drop -d #{db_name} #{db_backup_path}/#{db_name}" do |ch, stream, out|
+          puts out
+        end
+      end
+
+      desc "|capistrano-recipes| Downloads the compressed database dump to this machine"
+      task :fetch_dump, :roles => :db, :only => { :primary => true } do
+        prepare_from_yaml
+        download db_remote_file, db_local_file, :via => :scp
+      end
+
+      # Sets database variables from remote database.yaml
+      def prepare_from_yaml
+        set(:db_backup_path) { "#{shared_path}/backup/" }
+        set(:db_local_file)  { "tmp/#{db_file}" }
+        set(:db_user) { db_config[rails_env]["username"] }
+        set(:db_pass) { db_config[rails_env]["password"] }
+        set(:db_host) { db_config[rails_env]["host"] }
+        set(:db_name) { db_config[rails_env]["database"] }
+      end
+
+      def db_config
+        @db_config ||= fetch_db_config
+      end
+
+      def fetch_db_config
+        require 'yaml'
+        file = capture "cat #{shared_path}/config/mongoid.yml"
+        db_config = YAML.load(file)
+      end
+    end
+
+    desc "|capistrano-recipes| Create mongoid.yml in shared path with settings for current stage and test env"
+    task :setup do
+      set(:db_host) { Capistrano::CLI.ui.ask("Enter #{environment} database host:") {|q|q.default = "localhost"} }
+      set(:db_port) { Capistrano::CLI.ui.ask("Enter #{environment} database port:", Integer){|q| q.default = 27017 } }
+      set(:db_user) { Capistrano::CLI.ui.ask "Enter #{environment} database username:" }
+      set(:db_pass) { Capistrano::CLI.password_prompt "Enter #{environment} database password:" }
+      set(:db_safe_mode) { Capistrano::CLI.ui.agree "Enable safe mode on #{environment} database? [Yn]:" }
+
+      db_config = ERB.new <<-EOF
+defaults: &defaults
+  host: #{db_host}
+  port: #{db_port}
+  <% if db_user && !db_user.empty? %>
+  username: #{db_user}
+  password: #{db_pass}
+  <% end %>
+  autocreate_indexes: false
+  allow_dynamic_fields: true
+  include_root_in_json: false
+  parameterize_keys: true
+  persist_in_safe_mode: #{db_safe_mode}
+  raise_not_found_error: true
+  reconnect_time: 3
+
+development:
+  <<: *defaults
+  database: #{application}-development
+
+test:
+  <<: *defaults
+  database: #{application}-test
+
+production:
+  <<: *defaults
+  database: #{application}-production
+      EOF
+
+      put db_config.result(binding), "#{shared_path}/config/mongoid.yml"
+    end
+  end
+
+  after "deploy:setup" do
+    db.setup if Capistrano::CLI.ui.agree("Create mongoid.yml in app's shared path? [Yn]")
+  end
+end

data/lib/recipes/deploy.rb

@@ -0,0 +1,65 @@
+Capistrano::Configuration.instance.load do
+  set :shared_children, %w(system log pids config)
+
+  namespace :deploy do
+    desc "|capistrano-recipes| Deploy it, github-style."
+    task :default, :roles => :app, :except => { :no_release => true } do
+      update
+      restart
+    end
+
+    desc "|capistrano-recipes| Destroys everything"
+    task :seppuku, :roles => :app, :except => { :no_release => true } do
+      run "rm -rf #{current_path}; rm -rf #{shared_path}"
+    end
+
+    desc "|capistrano-recipes| Create shared dirs"
+    task :setup_dirs, :roles => :app, :except => { :no_release => true } do
+      commands = shared_dirs.map do |path|
+        "mkdir -p #{shared_path}/#{path}"
+      end
+      run commands.join(" && ")
+    end
+
+    desc "|capistrano-recipes| Uploads your local config.yml to the server"
+    task :configure, :roles => :app, :except => { :no_release => true } do
+      generate_config('config/config.yml', "#{shared_path}/config/config.yml")
+    end
+
+    desc "|capistrano-recipes| Setup a GitHub-style deployment."
+    task :setup, :roles => :app, :except => { :no_release => true } do
+      run "rm -rf #{current_path}"
+      setup_dirs
+      run "git clone #{repository} #{current_path}"
+    end
+
+    desc "|capistrano-recipes| Update the deployed code."
+    task :update_code, :roles => :app, :except => { :no_release => true } do
+      run "cd #{current_path}; git fetch origin; git reset --hard #{branch}"
+    end
+
+    desc "|capistrano-recipes| Alias for symlinks:make"
+    task :symlink, :roles => :app, :except => { :no_release => true } do
+      symlinks.make
+    end
+
+    desc "|capistrano-recipes| Remote run for rake db:seed"
+    task :migrate, :roles => :app, :except => { :no_release => true } do
+      run "cd #{current_path}; bundle exec rake RAILS_ENV=#{rails_env} db:seed"
+    end
+
+    desc "|capistrano-recipes| [Obsolete] Nothing to cleanup when using reset --hard on git"
+    task :cleanup, :roles => :app, :except => { :no_release => true } do
+      #nothing to cleanup, we're not working with 'releases'
+      puts "Nothing to cleanup, yay!"
+    end
+
+    namespace :rollback do
+      desc "|capistrano-recipes| Rollback , :except => { :no_release => true }a single commit."
+      task :default, :roles => :app, :except => { :no_release => true } do
+        set :branch, "HEAD^"
+        deploy.default
+      end
+    end
+  end
+end