chicken_soup 0.1.0 → 0.2.0

data/lib/chicken_soup/capabilities/nginx/nginx-checks.rb

@@ -0,0 +1,19 @@
+######################################################################
+#                             NGINX CHECKS                           #
+######################################################################
+Capistrano::Configuration.instance(:must_exist).load do
+  namespace :capabilities do
+    namespace :check do
+      desc <<-DESC
+        [internal] Checks to see if all necessary Nginx capabilities variables have been set up.
+      DESC
+      task :nginx do
+        required_variables = [
+          :web_server_control_script
+        ]
+
+        verify_variables(required_variables)
+      end
+    end
+  end
+end

data/lib/chicken_soup/capabilities/nginx/nginx-defaults.rb

@@ -0,0 +1,21 @@
+######################################################################
+#                           NGINX DEFAULTS                           #
+######################################################################
+Capistrano::Configuration.instance(:must_exist).load do
+  namespace :capabilities do
+    namespace :defaults do
+      desc "[internal] Checks to see what type of Nginx installation is running on the remote."
+      task :nginx do
+        find_web_server_control_script
+      end
+    end
+  end
+end
+
+def find_web_server_control_script
+  if remote_file_exists?("/etc/init.d/nginx")
+    set :web_server_control_script,   "/etc/init.d/nginx"
+  end
+
+  abort "Couldn't figure out how to control your installation of Nginx" unless exists?(:web_server_control_script)
+end

data/lib/chicken_soup/capabilities/nginx/nginx-tasks.rb

@@ -0,0 +1,85 @@
+######################################################################
+#                             NGINX TASKS                            #
+######################################################################
+Capistrano::Configuration.instance(:must_exist).load do
+  require   'chicken_soup/capabilities/shared/web_server-tasks'
+
+  namespace :website do
+    desc "Creates the site configuration for the files."
+    task :create do
+      abort "Sorry, auto-installing sites is not supported on your installation of Nginx." unless exists?(:nginx_disable_script)
+
+      passenger_friendly_error_messages = rails_env == :production ? "off" : "on"
+
+      virtual_host_config = <<-VHOST
+        server {
+            listen                          #{web_server_ip}:443;
+            server_name                     #{deploy_site_name} *.#{deploy_site_name};
+
+            passenger_enabled               on;
+            passenger_friendly_error_pages  #{passenger_friendly_error_pages};
+            passenger_min_instances         4;
+
+            rails_env                       #{rails_env};
+            rack_env                        #{rails_env};
+
+            ssl                             on;
+            ssl_certificate                 /etc/nginx/ssl/#{domain}.crt;
+            ssl_certificate_key             /etc/nginx/ssl/#{domain}.key;
+
+            ssl_session_timeout             5m;
+
+            ssl_ciphers                     ALL:!ADH:!EXPORT56:RC4+RSA:+HIGH:+MEDIUM:+LOW:+SSLv2:+EXP;
+            ssl_prefer_server_ciphers       on;
+
+            root                            #{deploy_to}/current/public;
+
+            client_max_body_size            3M;
+
+            access_log                      /var/log/nginx/#{application}.access.log main;
+            error_log                       /var/log/nginx/#{application}.error.log warn;
+
+            error_page                      500 501 504 505 506 507 508 509 /500.html;
+            error_page                      400 401 403 404 405 406 407 409 410 413 415 416 417 /404.html;
+            error_page                      422 444 /422.html;
+            error_page                      502 503 /public/maintenance.html;
+
+            location / {
+              try_files /system/maintenance.html $request_uri;
+            }
+        }
+
+        server {
+            listen                          #{web_server_ip}:80;
+            server_name                     #{deploy_site_name} *.#{deploy_site_name};
+
+            location / {
+              rewrite ^ https://$http_host$request_uri? permanent
+            }
+        }
+      VHOST
+
+      put virtual_host_config, "#{user_home}/#{deploy_site_name}"
+      run "#{sudo} mv #{user_home}/#{deploy_site_name} /etc/nginx/sites-available"
+      web_server.reload
+    end
+
+    desc "Completely removes the site configuration from the server (but leaves the files.)"
+    task :remove do
+      abort "Sorry, auto-removing sites is not supported on your installation of Nginx." unless exists?(:nginx_disable_script)
+
+      run "#{sudo} rm /etc/nginx/sites-available/#{deploy_site_name}"
+      web_server.reload
+    end
+
+    desc "Enable Site"
+    task :enable do
+      abort "Sorry, auto-enabling sites is not supported on your installation of Nginx." unless exists?(:nginx_enable_script)
+    end
+
+    desc "Disable Site"
+    task :disable do
+      abort "Sorry, auto-disabling sites is not supported on your installation of Nginx." unless exists?(:nginx_disable_script)
+    end
+  end
+end

data/lib/chicken_soup/capabilities/{passenger.rb → passenger/passenger-tasks.rb}

@@ -25,7 +25,7 @@ Capistrano::Configuration.instance(:must_exist).load do
       changes, Passenger restarts the app.
     DESC
     task :restart, :except => { :no_release => true } do
-      run "touch #{File.join(current_path,'tmp','restart.txt')}"
+      run "touch #{File.join( current_path, 'tmp', 'restart.txt' )}"
     end
   end
 end

data/lib/chicken_soup/capabilities/postgres/postgres-checks.rb

@@ -0,0 +1,17 @@
+######################################################################
+#                          POSTGRES CHECKS                           #
+######################################################################
+Capistrano::Configuration.instance(:must_exist).load do
+  require 'chicken_soup/capabilities/shared/db-checks'
+
+  namespace :capabilities do
+    namespace :check do
+      desc <<-DESC
+        [internal] Checks to see if all necessary Postgres capabilities variables have been set up.
+      DESC
+      task :postgres do
+        capabilities.check.db
+      end
+    end
+  end
+end

data/lib/chicken_soup/capabilities/postgres/postgres-defaults.rb

@@ -0,0 +1,15 @@
+######################################################################
+#                          POSTGRES DEFAULTS                         #
+######################################################################
+Capistrano::Configuration.instance(:must_exist).load do
+  require 'chicken_soup/capabilities/shared/db-defaults'
+
+  namespace :capabilities do
+    namespace :defaults do
+      desc "[internal] Sets intelligent defaults for Postgres deployments."
+      task :postgres do
+        capabilities.defaults.db
+      end
+    end
+  end
+end

data/lib/chicken_soup/capabilities/{postgres.rb → postgres/postgres-tasks.rb}

@@ -2,5 +2,5 @@
 #                          POSTGRES TASKS                            #
 ######################################################################
 Capistrano::Configuration.instance(:must_exist).load do
-  require 'chicken_soup/capabilities/shared/db'
+  require 'chicken_soup/capabilities/shared/db-tasks'
 end

data/lib/chicken_soup/capabilities/rvm/rvm-checks.rb

@@ -0,0 +1,21 @@
+######################################################################
+#                             RVM CHECKS                             #
+######################################################################
+Capistrano::Configuration.instance(:must_exist).load do
+  namespace :capabilities do
+    namespace :check do
+      desc <<-DESC
+        [internal] Checks to see if all necessary RVM variables have been set up.
+      DESC
+      task :rvm do
+        required_variables = [
+          :ruby_version,
+          :ruby_gemset,
+          :rvm_ruby_string,
+        ]
+
+        verify_variables(required_variables)
+      end
+    end
+  end
+end

data/lib/chicken_soup/capabilities/rvm/rvm-defaults.rb

@@ -0,0 +1,13 @@
+######################################################################
+#                           RVM DEFAULTS                             #
+######################################################################
+Capistrano::Configuration.instance(:must_exist).load do
+  namespace :capabilities do
+    namespace :defaults do
+      _cset :ruby_version,        ENV["rvm_ruby_string"]
+      _cset :ruby_gemset,         ENV["GEM_HOME"].split('@')[1]
+
+      _cset(:rvm_ruby_string)     {ruby_gemset ? "#{ruby_version}@#{ruby_gemset}" : ruby_version}
+    end
+  end
+end

data/lib/chicken_soup/capabilities/rvm/rvm-tasks.rb

@@ -0,0 +1,6 @@
+######################################################################
+#                             RVM TASKS                              #
+######################################################################
+def run_with_rvm(ruby_env_string, command)
+  run("rvm use #{ruby_env_string} && #{command}")
+end

data/lib/chicken_soup/capabilities/shared/db-checks.rb

@@ -0,0 +1,19 @@
+######################################################################
+#                              DB CHECKS                             #
+######################################################################
+Capistrano::Configuration.instance(:must_exist).load do
+  namespace :capabilities do
+    namespace :check do
+      desc <<-DESC
+        [internal] Checks to see if all necessary DB capabilities variables have been set up.
+      DESC
+      task :db do
+        required_variables = [
+          :skip_backup_before_migration
+        ]
+
+        verify_variables(required_variables)
+      end
+    end
+  end
+end

data/lib/chicken_soup/capabilities/shared/db-defaults.rb

@@ -0,0 +1,13 @@
+######################################################################
+#                             DB DEFAULTS                            #
+######################################################################
+Capistrano::Configuration.instance(:must_exist).load do
+  namespace :capabilities do
+    namespace :defaults do
+      desc "[internal] Sets intelligent defaults for DB deployments."
+      task :db do
+        _cset :skip_backup_before_migration,  false
+      end
+    end
+  end
+end

data/lib/chicken_soup/capabilities/shared/{db.rb → db-tasks.rb}

@@ -5,8 +5,12 @@ Capistrano::Configuration.instance(:must_exist).load do
   _cset(:db_root_password)    {Capistrano::CLI.password_prompt("Root Password For DB: ")}
   _cset(:db_app_password)     {Capistrano::CLI.password_prompt("App Password For DB: ")}
 
-  run_task "db:create",       :as => "manager"
-  run_task "db:drop",         :as => "manager"
+  run_task  "db:create",       :as => manager_username
+  run_task  "db:drop",         :as => manager_username
+
+  before    "deploy:migrate",  "db:backup"        unless skip_backup_before_migration
+
+  before    'db:backup',       'db:backup:check'
 
   namespace :db do
     desc <<-DESC
@@ -17,9 +21,18 @@ Capistrano::Configuration.instance(:must_exist).load do
       * The filenames are formatted with the timestamp of the backup.
       * After export, each file is zipped up using a bzip2 compression format.
     DESC
-    task :backup do
-      run "if [ ! -d #{shared_path}/db_backups ]; then mkdir #{shared_path}/db_backups; fi"
-      run "cd #{current_path} && bundle exec rake BACKUP_DIRECTORY=#{shared_path}/db_backups RAILS_ENV=#{rails_env} db:backup"
+    namespace :backup do
+      task :default do
+        run "cd #{current_path} && BACKUP_DIRECTORY=#{shared_path}/db_backups #{rake} db:backup"
+      end
+
+      desc "[internal] Used to check to see if the db:backup task exists on the server."
+      task :check do
+        backup_task_exists = capture("cd #{current_path} && #{rake} -T | grep db:backup | wc -l").chomp
+        abort("There must be a task named db:backup in order to deploy.  If you do not want to backup your DB during deployments, set the skip_backup_before_migration variable to true in your deploy.rb.") if backup_task_exists == '0'
+
+        run "if [ ! -d #{shared_path}/db_backups ]; then mkdir #{shared_path}/db_backups; fi"
+      end
     end
 
     desc <<-DESC
@@ -30,12 +43,12 @@ Capistrano::Configuration.instance(:must_exist).load do
 
       Warning: This task cannot be called in production mode.  If you truely wish
               to run this in production, you'll need to log into the server and
-              run the rake task manually.
+              run the rake task manually or use Capistrano's `console` task.
     DESC
     task :reset_and_seed do
-      raise "I'm sorry Dave, but I can't let you do that. I have full control over production." if rails_env == 'production'
+      abort "I'm sorry Dave, but I can't let you do that. I have full control over production." if rails_env == 'production'
       db.backup
-      run "cd #{current_path} && rake RAILS_ENV=#{rails_env} db:reset_and_seed"
+      run "cd #{current_path} && #{rake} db:reset_and_seed"
     end
 
     desc <<-DESC
@@ -47,12 +60,12 @@ Capistrano::Configuration.instance(:must_exist).load do
 
       Warning: This task cannot be called in production mode.  If you truely wish
               to run this in production, you'll need to log into the server and
-              run the rake task manually.
+              run the rake task manually or use Capistrano's `console` task.
     DESC
     task :seed do
-      raise "I'm sorry Dave, but I can't let you do that. I have full control over production." if rails_env == 'production'
+      abort "I'm sorry Dave, but I can't let you do that. I have full control over production." if rails_env == 'production'
       db.backup
-      run "cd #{current_path} && rake RAILS_ENV=#{rails_env} db:seed"
+      run "cd #{current_path} && #{rake} db:seed"
     end
   end
 end

data/lib/chicken_soup/capabilities/shared/web_server-tasks.rb

@@ -0,0 +1,99 @@
+######################################################################
+#                    COMMON WEB SERVER TASKS                         #
+######################################################################
+Capistrano::Configuration.instance(:must_exist).load do
+  run_task  'web_server:stop',            :as => manager_username
+  run_task  'web_server:start',           :as => manager_username
+  run_task  'web_server:restart',         :as => manager_username
+  run_task  'web_server:reload',          :as => manager_username
+
+  run_task  'website:install',            :as => manager_username
+  run_task  'website:remove',             :as => manager_username
+  run_task  'website:enable',             :as => manager_username
+  run_task  'website:disable',            :as => manager_username
+
+  before    'deploy',                     'deploy:web:disable'
+  after     'deploy',                     'deploy:web:enable'
+
+  namespace :deploy do
+    namespace :web do
+      desc <<-DESC
+        Enables the website's application by removing the maintenance page.
+      DESC
+      task :enable do
+        website.maintenance_mode.disable
+      end
+
+      desc <<-DESC
+        Disables the website's application by installing the maintenance page.
+      DESC
+      task :disable do
+        website.maintenance_mode.enable
+      end
+    end
+  end
+
+  namespace :website do
+    namespace :maintenance_mode do
+      desc <<-DESC
+        Makes the application web-accessible again. Removes the \
+        "maintenance.html" page generated by deploy:web:disable, which (if your \
+        web servers are configured correctly) will make your application \
+        web-accessible again.
+      DESC
+      task :disable, :except => { :no_release => true } do
+        run "rm #{shared_path}/system/maintenance.html"
+      end
+
+      desc <<-DESC
+        Present a maintenance page to visitors. Disables your application's web \
+        interface by writing a "maintenance.html" file to each web server. The \
+        servers must be configured to detect the presence of this file, and if \
+        it is present, always display it instead of performing the request.
+
+        By default, the maintenance page will just say the site is down for \
+        "maintenance", and will be back "shortly", but you can customize the \
+        page by specifying the REASON and UNTIL environment variables:
+
+          $ cap deploy:web:disable \\
+                REASON="hardware upgrade" \\
+                UNTIL="12pm Central Time"
+
+        Further customization will require that you write your own task.
+      DESC
+      task :enable, :except => { :no_release => true } do
+        on_rollback { rm "#{shared_path}/system/maintenance.html" }
+
+        require 'erb'
+        deadline, reason = ENV['UNTIL'], ENV['REASON']
+
+        template = File.read("./public/maintenance.html.erb")
+        maintenance_page = ERB.new(template).result(binding)
+
+        put maintenance_page, "#{shared_path}/system/maintenance.html", :mode => 0644
+      end
+    end
+  end
+
+  namespace :web_server do
+    desc "Stop the web server"
+    task :stop do
+      run "#{sudo} #{web_server_control_script} stop"
+    end
+
+    desc "Start the web server"
+    task :start do
+      run "#{sudo} #{web_server_control_script} start"
+    end
+
+    desc "Restart the web server"
+    task :restart do
+      run "#{sudo} #{web_server_control_script} restart"
+    end
+
+    desc "Reloads the web server configuration"
+    task :reload do
+      run "#{sudo} #{web_server_control_script} reload"
+    end
+  end
+end

data/lib/chicken_soup/capabilities/{svn.rb → svn/svn-defaults.rb}

@@ -1,16 +1,3 @@
-######################################################################
-#                          SUBVERSION TASKS                          #
-######################################################################
-Capistrano::Configuration.instance(:must_exist).load do
-  namespace :vc do
-    desc <<-DESC
-    DESC
-    task :log do
-      set :vc_log, `svn log -r #{previous_revision.to_i + 1}:#{current_revision}`
-    end
-  end
-end
-
 ######################################################################
 #                         SUBVERSION DEFAULTS                        #
 ######################################################################