capistrano-exts 1.11.3 → 1.12.0

data/lib/capistrano-exts/receipts/rails.rb

@@ -1,7 +1,3 @@
-require 'capistrano'
-require 'capistrano-exts/receipts/deploy'
-require 'capistrano-exts/receipts/files'
-
 # Verify that Capistrano is version 2
 unless Capistrano::Configuration.respond_to?(:instance)
   abort "This extension requires Capistrano 2"

data/lib/capistrano-exts/receipts/servers.rb

@@ -1,8 +1,6 @@
 # encoding: utf-8
 
 # Requirements
-require 'capistrano'
-require 'capistrano-exts/receipts/deploy'
 require 'capistrano-exts/receipts/mysql'
 require 'capistrano-exts/receipts/servers/web_server'
 require 'capistrano-exts/receipts/servers/db_server'
@@ -25,7 +23,7 @@ Capistrano::Configuration.instance(:must_exist).load do
         idrsa_filename_argv = ARGV.try(:[], argv_file_index)
 
         # Generate the file name
-        if idrsa_filename_argv && !idrsa_filename_argv =~ /.+:.+/ && !File.exists?(idrsa_filename_argv)
+        if idrsa_filename_argv and not idrsa_filename_argv =~ /.+:.+/ and not File.exists?(idrsa_filename_argv)
           idrsa_filename = idrsa_filename_argv
         else
           idrsa_filename = "#{ENV['HOME']}/.ssh/id_rsa.pub"

data/lib/capistrano-exts/receipts/servers/web_server.rb

@@ -71,7 +71,7 @@ Capistrano::Configuration.instance(:must_exist).load do
 
         desc "[internal] Write authentification file"
         task :write_web_server_auth_file do
-          if exists?(:web_server_auth_file) && !remote_file_exists?(fetch :web_server_auth_file)
+          if exists?(:web_server_auth_file) and not remote_file_exists?(fetch :web_server_auth_file)
             web_server_auth_file = fetch :web_server_auth_file
             web_server_auth_file_contents = fetch :web_server_auth_file_contents
             web_server_auth_file_unencrypted_contents = fetch :web_server_auth_file_unencrypted_contents

data/lib/capistrano-exts/receipts/unicorn.rb

@@ -1,27 +1,34 @@
-namespace :unicorn do
-  desc "start unicorn"
-  task :start, :roles => :app, :except => {:no_release => true} do
-    run "cd #{current_path} && #{unicorn_binary} -c #{unicorn_config} -E #{rails_env} -D"
-  end
+# Verify that Capistrano is version 2
+unless Capistrano::Configuration.respond_to?(:instance)
+  abort "This extension requires Capistrano 2"
+end
 
-  desc "stop unicorn"
-  task :stop, :roles => :app, :except => {:no_release => true} do
-    run "#{try_sudo} kill `cat #{unicorn_pid}`"
-  end
+Capistrano::Configuration.instance(:must_exist).load do
+  namespace :unicorn do
+    desc "start unicorn"
+    task :start, :roles => :app, :except => {:no_release => true} do
+      run "cd #{current_path} && #{unicorn_binary} -c #{unicorn_config} -E #{rails_env} -D"
+    end
 
-  desc "unicorn reload"
-  task :reload, :roles => :app, :except => {:no_release => true} do
-    run "#{try_sudo} kill -s USR2 `cat #{unicorn_pid}`"
-  end
+    desc "stop unicorn"
+    task :stop, :roles => :app, :except => {:no_release => true} do
+      run "#{try_sudo} kill `cat #{unicorn_pid}`"
+    end
 
-  desc "graceful stop unicorn"
-  task :graceful_stop, :roles => :app, :except => {:no_release => true} do
-    run "#{try_sudo} kill -s QUIT `cat #{unicorn_pid}`"
-  end
+    desc "unicorn reload"
+    task :reload, :roles => :app, :except => {:no_release => true} do
+      run "#{try_sudo} kill -s USR2 `cat #{unicorn_pid}`"
+    end
+
+    desc "graceful stop unicorn"
+    task :graceful_stop, :roles => :app, :except => {:no_release => true} do
+      run "#{try_sudo} kill -s QUIT `cat #{unicorn_pid}`"
+    end
 
-  desc "restart unicorn"
-  task :restart, :roles => :app, :except => {:no_release => true} do
-    stop
-    start
+    desc "restart unicorn"
+    task :restart, :roles => :app, :except => {:no_release => true} do
+      stop
+      start
+    end
   end
 end

data/lib/capistrano-exts/receipts/web.rb

@@ -0,0 +1,136 @@
+# Verify that Capistrano is version 2
+unless Capistrano::Configuration.respond_to?(:instance)
+  abort "This extension requires Capistrano 2"
+end
+
+require 'fileutils'
+
+Capistrano::Configuration.instance(:must_exist).load do
+  namespace :web do
+
+    desc "Symlink system folder"
+    task :symlink_system_folder, :roles => :web, :except => { :no_release => true } do
+      public_path = fetch(:public_path).gsub(%r{#{current_path}}, latest_release)
+      link_file "#{fetch :shared_path}/__system__", "#{public_path}/__system__"
+    end
+
+    desc <<-DESC
+      Present a maintenance page to visitors. Disables your application's web \
+      interface by writing a maintenance page 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 TITLE, REASON and UNTIL environment variables:
+
+        $ cap deploy:web:disable \\
+              TITLE="Upgrading" \\
+              REASON="hardware upgrade" \\
+              UNTIL="12pm Central Time"
+
+      Further customization will require that you write your own task.
+    DESC
+    task :disable, :roles => :web, :except => { :no_release => true } do
+      on_rollback { run "rm -rf #{fetch :shared_path}/__system__/maintenance" }
+
+      # Define the maintenance_url
+      maintenance_url = '/__system__/maintenance'
+
+      # Get the maintenance_path or use the default one
+      maintenance_path = fetch :maintenance_path,
+        File.expand_path(File.join(File.dirname(__FILE__), '..', "templates", "maintenance"))
+
+      # Fetch command line options
+      title = ENV['TITLE']
+      reason = ENV['REASON']
+      deadline = ENV['UNTIL']
+
+      # Create the maintenance folder
+      run <<-CMD
+        #{try_sudo} mkdir -p #{fetch :shared_path}/__system__/maintenance
+      CMD
+
+      if File.directory?(maintenance_path)
+        # Generate random names
+        random_folder = random_tmp_file
+        random_file = "#{random_tmp_file}.tar.gz"
+        # Add a rollback hook
+        on_rollback do
+          run "rm -f #{random_file}"
+          system "rm -rf #{random_file} #{random_folder}"
+        end
+        # Copy the folder to /tmp
+        FileUtils.cp_r maintenance_path, random_folder
+
+        # If we have an rhtml file
+        if File.exists?("#{random_folder}/index.rhtml")
+          # Read it
+          erb_contents = File.read("#{random_folder}/index.rhtml")
+          # Delete it
+          FileUtils.rm "#{random_folder}/index.rhtml"
+          # Write the rendered ERB to the html file
+          File.open("#{random_folder}/index.html", 'w') do |f|
+            f.write ERB.new(erb_contents).result(binding)
+          end
+        end
+
+        # Create a local tar file
+        system <<-CMD
+          cd #{random_folder} &&
+          tar chzf #{random_file} --exclude='*~' --exclude='*.tmp' --exclude='*.bak' * &&
+          rm -rf #{random_folder}
+        CMD
+
+        # Upload the file
+        put File.read(random_file), random_file
+
+        # Remove the file locally
+        system <<-CMD
+          rm -f #{random_file}
+        CMD
+
+        # Extract the folder remotely
+        run <<-CMD
+          cd #{fetch :shared_path}/__system__/maintenance &&
+          #{try_sudo} tar xzf #{random_file} &&
+          rm -f #{random_file}
+        CMD
+      else
+        erb_contents = File.read(maintenance_path)
+        result = ERB.new(erb_contents).result(binding)
+
+        put result, "#{fetch :shared_path}/__system__/maintenance/index.html", :mode => 0644
+      end
+
+      if fetch(:web_server_app) == :apache
+        warn <<-EOHTACCESS
+
+          # Please add something like this to your site's htaccess to redirect users to the maintenance page.
+          # More Info: http://www.shiftcommathree.com/articles/make-your-rails-maintenance-page-respond-with-a-503
+
+          ErrorDocument 503 /__system__/maintenance/index.html
+          RewriteEngine On
+          RewriteCond %{REQUEST_URI} !\.(css|js|gif|jpg|png)$
+          RewriteCond %{DOCUMENT_ROOT}/__system__/maintenance/index.html -f
+          RewriteCond %{SCRIPT_FILENAME} !/__system__/maintenance/index.html
+          RewriteRule ^.*$  -  [redirect=503,last]
+        EOHTACCESS
+      end
+    end
+
+    desc <<-DESC
+      Makes the application web-accessible again. Removes the \
+      "#{maintenance_basename}.html" page generated by deploy:web:disable, which (if your \
+      web servers are configured correctly) will make your application \
+      web-accessible again.
+    DESC
+    task :enable, :roles => :web, :except => { :no_release => true } do
+      run "rm -rf #{fetch :shared_path}/__system__/maintenance"
+    end
+  end
+
+  # Dependencies
+  after "deploy:finalize_update", "web:symlink_system_folder"
+  after "web:disable", "deploy:fix_permissions"
+end

data/lib/capistrano-exts/servers/web_server.rb

@@ -40,7 +40,7 @@ module Capistrano
 
           def php_build_with_force_cgi_redirect?
             # required if PHP was built with --enable-force-cgi-redirect
-            @php_build_with_force_cgi_redirect.present? && @php_build_with_force_cgi_redirect == true
+            @php_build_with_force_cgi_redirect.present? and @php_build_with_force_cgi_redirect == true
           end
 
           def sanity_check
@@ -59,19 +59,19 @@ module Capistrano
             end
 
             if reverse_proxy?
-              if @reverse_proxy_server_address.blank? && @reverse_proxy_server_port.blank? && @reverse_proxy_socket.blank?
+              if @reverse_proxy_server_address.blank? and @reverse_proxy_server_port.blank? and @reverse_proxy_socket.blank?
                 raise ArgumentError, "None of the address, port or socket has been defined."
               end
 
-              if @reverse_proxy_server_address.present? && @reverse_proxy_server_port.blank?
+              if @reverse_proxy_server_address.present? and @reverse_proxy_server_port.blank?
                 raise ArgumentError, "reverse_proxy_server_address is defined but reverse_proxy_server_port is not please define it."
               end
 
-              if @reverse_proxy_server_port.present? && @reverse_proxy_server_address.blank?
+              if @reverse_proxy_server_port.present? and @reverse_proxy_server_address.blank?
                 raise ArgumentError, "reverse_proxy_server_port is defined but reverse_proxy_server_address is not please define it."
               end
 
-              if @reverse_proxy_server_address.present? && @reverse_proxy_server_port.present? && @reverse_proxy_socket.present?
+              if @reverse_proxy_server_address.present? and @reverse_proxy_server_port.present? and @reverse_proxy_socket.present?
                 raise ArgumentError, "you should not define reverse_proxy_server_address, reverse_proxy_server_port and reverse_proxy_socket."
               end
             end

data/lib/capistrano-exts/templates/maintenance/index.rhtml

@@ -0,0 +1,26 @@
+<!DOCTYPE html>
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+  <head>
+    <meta http-equiv="content-type" content="text/html;charset=UTF-8" />
+    <title><%= title || 'System down for maintenance' %></title>
+    <link type="text/css" rel="stylesheet" href="<%= maintenance_url %>/stylesheets/styles.css">
+    <!--[if lt IE 9]>
+    <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
+    <![endif]-->
+  </head>
+  <body>
+    <section>
+       <article>
+         <div class="inside">
+           <p class="reason">
+             The system is down for <%= reason ? reason : "maintenance" %>
+             as of <%= Time.now.strftime("%H:%M %Z") %>.
+           </p>
+           <p class="duration">
+             It'll be back <%= deadline ? deadline : "shortly" %>.
+           </p>
+         </div>
+       </article>
+    </section>
+  </body>
+</html>

data/lib/capistrano-exts/templates/maintenance/stylesheets/styles.css

@@ -0,0 +1,37 @@
+section {
+  position: absolute;
+  left: 50%;
+  top: 50%;
+  width: 500px;
+  height: 300px;
+  margin-left: -260px;
+  margin-top: -150px;
+}
+
+article {
+  margin: 0;
+  padding: 10px;
+  text-align: center;
+  border: 1px solid #ccc;
+  border-right: 1px solid #999;
+  border-bottom: 1px solid #999;
+  background-color: #fff;
+}
+
+article .inside {
+  text-align: center;
+  width: 200px;
+  margin: 0 auto;
+}
+
+article .inside .reason {
+  color: red;
+  font-size: 16px;
+  line-height: 20px;
+}
+
+article .inside .duration {
+  color: #666;
+}
+
+body { background-color: #fff; }

data/lib/capistrano-exts/templates/multistage.rb

@@ -88,6 +88,22 @@ set :rvm_ruby_string, "1.9.3"
 #
 #############
 
+#############
+# Maintenance
+#
+
+# Set the maintenance path to wherever you have stored the maintenance page,
+# it could be a single file or an entire folder. The template will be parsed
+# with ERB.
+# if it's a folder, capistrano expects an index.html file. You could provide an
+# index.rhtml file and it would be parsed with ERB before uploading to the server
+# set :maintenance_path,
+#   File.expand_path(File.join(File.dirname(__FILE__), '..', '..', 'maintenance'))
+
+#
+#
+#############
+
 #############
 # Mysql
 #

data/lib/capistrano-exts/templates/web_servers/nginx.conf.erb

@@ -21,26 +21,40 @@ server {
   index <%= @indexes.join(' ') %>;
 <% end %>
 
-  # This allows people to use images and css in their maintenance.html file
-  if ($request_filename ~* \.(css|jpg|gif|png)$) {
+  # Enable recursive error pages to catch 405 in a 503 error.
+  recursive_error_pages on;
+
+  # This allows people to use stylesheet, javascript and images in their
+  # maintenance html file
+  if ($request_filename ~* \.(css|js|jpg|gif|png)$) {
+    expires 30d;
     break;
   }
-  # Rewrite all the requests to the maintenance.html page if it exists.
-  if (-f $document_root/system/maintenance.html) {
+
+  # If the maintenance page exists, throw a 503 error which we'd catch later.
+  if (-f $document_root/__system__/maintenance/index.html) {
     return 503;
   }
-  # with 503 error code
+
+  # Catch the 503 error and send it to the @503 location
+  error_page 503 @503;
+
+  # The @503 location
   location @503 {
-    rewrite  ^(.*)$  /system/maintenance.html break;
-  }
+    # Nginx will refuse POST requests to a static file and will throw a 405 error
+    # So we need to catch that and display again our maintenance page
+    error_page 405 = /__system__/maintenance/index.html;
 
-<% if passenger? %>
-  passenger_enabled on;
+    # Rewrite all the requests to the maintenance page if it exists.
+    rewrite ^(.*)$ /__system__/maintenance/index.html break;
+  }
 
-  # Rails errors
+  # Error Pages
   error_page 404 /404.html;
   error_page 500 502 504 /500.html;
-  error_page 503 @503;
+
+<% if passenger? %>
+  passenger_enabled on;
 
   <% if mod_rewrite? %>
   # this serves static files that exist without running other rewrite tests

data/lib/capistrano-exts/version.rb

@@ -2,8 +2,8 @@ module Capistrano
   module Extensions
     module Version #:nodoc:
       MAJOR = 1
-      MINOR = 11
-      TINY = 3
+      MINOR = 12
+      TINY = 0
 
       ARRAY  = [MAJOR, MINOR, TINY]
       STRING = ARRAY.join(".")

data/spec/{requests → acceptance}/nginx_spec.rb

@@ -22,8 +22,13 @@ describe Nginx do
     end
 
     it "should render the correct file" do
-      expected_result = File.read File.join(RENDERED_TEMPLATES_PATH, 'nginx_php_fpm.conf')
-      subject.render.should == expected_result
+      rendered_template = File.join(RENDERED_TEMPLATES_PATH, 'nginx_php_fpm.conf')
+      if ENV['write_templates'] == 'yes'
+        File.open(rendered_template, 'w') { |f| f.write(subject.render) }
+      else
+        expected_result = File.read rendered_template
+        subject.render.should == expected_result
+      end
     end
   end
 
@@ -41,8 +46,13 @@ describe Nginx do
     end
 
     it "should render the correct file" do
-      expected_result = File.read File.join(RENDERED_TEMPLATES_PATH, 'nginx_passenger.conf')
-      subject.render.should == expected_result
+      rendered_template = File.join(RENDERED_TEMPLATES_PATH, 'nginx_passenger.conf')
+      if ENV['write_templates'] == 'yes'
+        File.open(rendered_template, 'w') { |f| f.write(subject.render) }
+      else
+        expected_result = File.read rendered_template
+        subject.render.should == expected_result
+      end
     end
   end
 
@@ -60,8 +70,13 @@ describe Nginx do
     end
 
     it "should render the correct file" do
-      expected_result = File.read File.join(RENDERED_TEMPLATES_PATH, 'nginx_reverse_proxy_socket.conf')
-      subject.render.should == expected_result
+      rendered_template = File.join(RENDERED_TEMPLATES_PATH, 'nginx_reverse_proxy_socket.conf')
+      if ENV['write_templates'] == 'yes'
+        File.open(rendered_template, 'w') { |f| f.write(subject.render) }
+      else
+        expected_result = File.read rendered_template
+        subject.render.should == expected_result
+      end
     end
   end
 
@@ -81,8 +96,13 @@ describe Nginx do
     end
 
     it "should render the correct file" do
-      expected_result = File.read File.join(RENDERED_TEMPLATES_PATH, 'nginx_reverse_proxy_address.conf')
-      subject.render.should == expected_result
+      rendered_template = File.join(RENDERED_TEMPLATES_PATH, 'nginx_reverse_proxy_address.conf')
+      if ENV['write_templates'] == 'yes'
+        File.open(rendered_template, 'w') { |f| f.write(subject.render) }
+      else
+        expected_result = File.read rendered_template
+        subject.render.should == expected_result
+      end
     end
   end