capistrano-exts 1.5.1 → 1.6.0

data/README.md

@@ -17,7 +17,7 @@ gem install capistrano-exts
 or add it to your Gemfile
 
 ```ruby
-gem 'capistrano-exts', '>=1.5.1'
+gem 'capistrano-exts', '>=1.6.0'
 ```
 
 Setup

data/examples/php_fpm/deploy/development.rb

@@ -26,6 +26,7 @@ set :use_sudo, false
 set :deploy_to,   -> { "/home/vhosts/#{fetch :stage}/#{fetch :application}" }
 set :logs_path,   -> { "#{fetch :deploy_to}/logs" }
 set :public_path, -> { "#{fetch :current_path}/public" }
+set :backup_path, -> { "#{fetch :deploy_to}/backups" }
 
 # How should we deploy?
 # Valid options:

data/examples/php_fpm/deploy/production.rb

@@ -26,6 +26,7 @@ set :use_sudo, false
 set :deploy_to,   -> { "/home/vhosts/#{fetch :stage}/#{fetch :application}" }
 set :logs_path,   -> { "#{fetch :deploy_to}/logs" }
 set :public_path, -> { "#{fetch :current_path}/public" }
+set :backup_path, -> { "#{fetch :deploy_to}/backups" }
 
 # How should we deploy?
 # Valid options:
@@ -81,7 +82,6 @@ set :mysql_db_server,                         'localhost'
 set :mysql_db_name,                           -> { "#{fetch :application}_#{fetch :stage}" }
 
 # What is the database user ?
-# NOTE: This is only used if you run deploy:server:setup which calls mysql:create_db_user
 set :mysql_db_user,                           -> { "#{fetch :application}" }
 
 # Where the database credentials are stored on the server ?

data/examples/php_fpm/deploy/staging.rb

@@ -26,6 +26,7 @@ set :use_sudo, false
 set :deploy_to,   -> { "/home/vhosts/#{fetch :stage}/#{fetch :application}" }
 set :logs_path,   -> { "#{fetch :deploy_to}/logs" }
 set :public_path, -> { "#{fetch :current_path}/public" }
+set :backup_path, -> { "#{fetch :deploy_to}/backups" }
 
 # How should we deploy?
 # Valid options:
@@ -81,7 +82,6 @@ set :mysql_db_server,                         'localhost'
 set :mysql_db_name,                           -> { "#{fetch :application}_#{fetch :stage}" }
 
 # What is the database user ?
-# NOTE: This is only used if you run deploy:server:setup which calls mysql:create_db_user
 set :mysql_db_user,                           -> { "#{fetch :application}" }
 
 # Where the database credentials are stored on the server ?

data/examples/rails_passenger/deploy/development.rb

@@ -26,6 +26,7 @@ set :use_sudo, false
 set :deploy_to,   -> { "/home/vhosts/#{fetch :stage}/#{fetch :application}" }
 set :logs_path,   -> { "#{fetch :deploy_to}/logs" }
 set :public_path, -> { "#{fetch :current_path}/public" }
+set :backup_path, -> { "#{fetch :deploy_to}/backups" }
 
 # How should we deploy?
 # Valid options:
@@ -82,7 +83,6 @@ set :mysql_db_server,                         'localhost'
 set :mysql_db_name,                           -> { "#{fetch :application}_#{fetch :stage}" }
 
 # What is the database user ?
-# NOTE: This is only used if you run deploy:server:setup which calls mysql:create_db_user
 set :mysql_db_user,                           -> { "#{fetch :application}" }
 
 # Where the database credentials are stored on the server ?

data/examples/rails_passenger/deploy/production.rb

@@ -26,6 +26,7 @@ set :use_sudo, false
 set :deploy_to,   -> { "/home/vhosts/#{fetch :stage}/#{fetch :application}" }
 set :logs_path,   -> { "#{fetch :deploy_to}/logs" }
 set :public_path, -> { "#{fetch :current_path}/public" }
+set :backup_path, -> { "#{fetch :deploy_to}/backups" }
 
 # How should we deploy?
 # Valid options:
@@ -82,7 +83,6 @@ set :mysql_db_server,                         'localhost'
 set :mysql_db_name,                           -> { "#{fetch :application}_#{fetch :stage}" }
 
 # What is the database user ?
-# NOTE: This is only used if you run deploy:server:setup which calls mysql:create_db_user
 set :mysql_db_user,                           -> { "#{fetch :application}" }
 
 # Where the database credentials are stored on the server ?

data/examples/rails_passenger/deploy/staging.rb

@@ -26,6 +26,7 @@ set :use_sudo, false
 set :deploy_to,   -> { "/home/vhosts/#{fetch :stage}/#{fetch :application}" }
 set :logs_path,   -> { "#{fetch :deploy_to}/logs" }
 set :public_path, -> { "#{fetch :current_path}/public" }
+set :backup_path, -> { "#{fetch :deploy_to}/backups" }
 
 # How should we deploy?
 # Valid options:
@@ -82,7 +83,6 @@ set :mysql_db_server,                         'localhost'
 set :mysql_db_name,                           -> { "#{fetch :application}_#{fetch :stage}" }
 
 # What is the database user ?
-# NOTE: This is only used if you run deploy:server:setup which calls mysql:create_db_user
 set :mysql_db_user,                           -> { "#{fetch :application}" }
 
 # Where the database credentials are stored on the server ?

data/examples/rails_reverse_proxy/deploy/development.rb

@@ -26,6 +26,7 @@ set :use_sudo, false
 set :deploy_to,   -> { "/home/vhosts/#{fetch :stage}/#{fetch :application}" }
 set :logs_path,   -> { "#{fetch :deploy_to}/logs" }
 set :public_path, -> { "#{fetch :current_path}/public" }
+set :backup_path, -> { "#{fetch :deploy_to}/backups" }
 
 # How should we deploy?
 # Valid options:
@@ -82,7 +83,6 @@ set :mysql_db_server,                         'localhost'
 set :mysql_db_name,                           -> { "#{fetch :application}_#{fetch :stage}" }
 
 # What is the database user ?
-# NOTE: This is only used if you run deploy:server:setup which calls mysql:create_db_user
 set :mysql_db_user,                           -> { "#{fetch :application}" }
 
 # Where the database credentials are stored on the server ?

data/examples/rails_reverse_proxy/deploy/production.rb

@@ -26,6 +26,7 @@ set :use_sudo, false
 set :deploy_to,   -> { "/home/vhosts/#{fetch :stage}/#{fetch :application}" }
 set :logs_path,   -> { "#{fetch :deploy_to}/logs" }
 set :public_path, -> { "#{fetch :current_path}/public" }
+set :backup_path, -> { "#{fetch :deploy_to}/backups" }
 
 # How should we deploy?
 # Valid options:
@@ -82,7 +83,6 @@ set :mysql_db_server,                         'localhost'
 set :mysql_db_name,                           -> { "#{fetch :application}_#{fetch :stage}" }
 
 # What is the database user ?
-# NOTE: This is only used if you run deploy:server:setup which calls mysql:create_db_user
 set :mysql_db_user,                           -> { "#{fetch :application}" }
 
 # Where the database credentials are stored on the server ?

data/examples/rails_reverse_proxy/deploy/staging.rb

@@ -26,6 +26,7 @@ set :use_sudo, false
 set :deploy_to,   -> { "/home/vhosts/#{fetch :stage}/#{fetch :application}" }
 set :logs_path,   -> { "#{fetch :deploy_to}/logs" }
 set :public_path, -> { "#{fetch :current_path}/public" }
+set :backup_path, -> { "#{fetch :deploy_to}/backups" }
 
 # How should we deploy?
 # Valid options:
@@ -82,7 +83,6 @@ set :mysql_db_server,                         'localhost'
 set :mysql_db_name,                           -> { "#{fetch :application}_#{fetch :stage}" }
 
 # What is the database user ?
-# NOTE: This is only used if you run deploy:server:setup which calls mysql:create_db_user
 set :mysql_db_user,                           -> { "#{fetch :application}" }
 
 # Where the database credentials are stored on the server ?

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

@@ -50,6 +50,7 @@ Capistrano::Configuration.instance(:must_exist).load do
 
       # Add MySQL credentials
       unless localconfig.blank? or mysql_credentials.blank?
+        localconfig.gsub!(/#DB_HOST#/, mysql_credentials[:host])
         localconfig.gsub!(/#DB_USER#/, mysql_credentials[:user])
         localconfig.gsub!(/#DB_PASS#/, mysql_credentials[:pass])
         localconfig.gsub!(/#DB_NAME#/, mysql_db_name)

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

@@ -25,6 +25,22 @@ Capistrano::Configuration.instance(:must_exist).load do
       end
     end
 
+    desc "Backup the contents folder"
+    task :backup, :roles => :app, :except => { :no_release => true } do
+      backup_path = fetch :backup_path, "#{fetch :deploy_to}/backups"
+      set :latest_contents_backup, "#{backup_path}/#{application}_shared_contents_#{Time.now.strftime('%d-%m-%Y_%H-%M-%S')}.tar.gz"
+      latest_contents_backup = fetch :latest_contents_backup
+
+      # Setup a rollback hook
+      on_rollback { run "rm -f #{latest_contents_backup}" }
+
+      # Create a tarball of the contents folder
+      run <<-CMD
+        cd #{shared_path}/shared_contents &&
+        tar chzf #{latest_contents_backup} --exclude='*~' --exclude='*.tmp' --exclude='*.bak' *
+      CMD
+    end
+
     desc "[internal] Fix contao's symlinks to the shared path"
     task :fix_links, :roles => :app, :except => { :no_release => true } do
       contents_folder = fetch :contents_folder
@@ -58,6 +74,7 @@ Capistrano::Configuration.instance(:must_exist).load do
     desc "Export the contents folder"
     task :export, :roles => :app, :except => { :no_release => true } do
       shared_path = fetch :shared_path
+      latest_contents_backup = fetch :latest_contents_backup
 
       # Find out at which index the file is located ?
       argv_file_index = ARGV.index("contents:export") + 1
@@ -72,20 +89,63 @@ Capistrano::Configuration.instance(:must_exist).load do
         export_filename = random_tmp_file + ".tar.gz"
       end
 
-      # Create a tarball of the contents folder
-      run <<-CMD
-        cd #{shared_path}/shared_contents &&
-        tar chzf /tmp/#{File.basename export_filename} --exclude='*~' --exclude='*.tmp' --exclude='*.bak' *
-      CMD
-
       # Tranfer the contents to the local system
-      get "/tmp/#{File.basename export_filename}", export_filename
+      get latest_contents_backup, export_filename
 
       puts "Contents has been downloaded to #{export_filename}"
       exit 0
     end
+
+    desc "Import the contents folder"
+    task :import, :roles => :app, :except => { :no_release => true } do
+      # Find out at which index the file is located ?
+      argv_file_index = ARGV.index("contents:import") + 1
+
+      unless ARGV.size >= (argv_file_index + 1) and File.exists?(ARGV[argv_file_index])
+        puts "ERROR: please run 'cap import <gzipped tar>'"
+        exit 1
+      else
+        # The contents file name
+        import_filename_argv = ARGV[argv_file_index]
+        # Read the dump
+        contents_dump = File.read(import_filename_argv)
+        # Generate a random file
+        random_file = random_tmp_file contents_dump
+        # Add a rollback hook
+        on_rollback { run "rm -f #{random_file}" }
+
+        # Ask for a confirmation
+        response = ask("I am going to add/replace all the files in the contents folder of #{fetch :application} with the contents of #{import_filename_argv}, are you sure you would like to continue (Yes, [No], Abort)", default:'N')
+        if response =~ /(no?)|(a(bort)?|\n)/i
+          abort "Canceled by the user."
+        end
+
+        # Transfer the SQL file to the server
+        # TODO: Try upload(filename, remote_file_name) function instead
+        put contents_dump, random_file
+
+        run <<-CMD
+          cd #{shared_path}/shared_contents &&
+          tar xzf #{random_file}
+        CMD
+
+        # Remove the uploaded file
+        run <<-CMD
+          rm -f '#{random_file}'
+        CMD
+
+        # Fix permissions
+        find_and_execute_task("deploy:fix_permissions")
+
+        # Exit because capistrano will rollback, the next argument is a file name and not a task
+        # TODO: Find a better solution!
+        exit 0
+      end
+    end
   end
 
   after "deploy:setup", "contents:setup"
   after "deploy:finalize_update", "contents:fix_links"
+  before "contents:export", "contents:backup"
+  before "contents:import", "contents:backup"
 end

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

@@ -32,6 +32,22 @@ Capistrano::Configuration.instance(:must_exist).load do
       run "chmod -R g+w #{fetch :latest_release}" if fetch(:group_writable, true)
     end
 
+    desc "[internal] create the required folders."
+    task :folders, :roles => :app do
+      backup_path = fetch :backup_path, "#{fetch :deploy_to}/backups"
+
+      run <<-CMD
+        mkdir -p #{fetch :deploy_to} &&
+        mkdir -p #{backup_path}
+      CMD
+
+      if exists? :logs_path
+        run <<-CMD
+          mkdir -p #{fetch :logs_path}
+        CMD
+      end
+    end
+
     desc "[internal] Symlink public folder"
     task :symlink_public_folders, :roles => :web, :except => { :no_release => true } do
       deploy_to = fetch :deploy_to
@@ -61,5 +77,6 @@ Capistrano::Configuration.instance(:must_exist).load do
   # Dependencies
   before "deploy", "deploy:check_if_remote_ready"
   after "deploy:restart", "deploy:fix_permissions"
+  after "deploy:setup", "deploy:folders"
   after "deploy:setup", "deploy:symlink_public_folders"
 end

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

@@ -55,7 +55,7 @@ Capistrano::Configuration.instance(:must_exist).load do
   end
 
   def generate_random_file_name(data = nil)
-    if data.present?
+    if data
       "#{fetch :application}_#{Time.now.strftime('%d-%m-%Y_%H-%M-%S-%L')}_#{Digest::SHA1.hexdigest data}"
     else
       "#{fetch :application}_#{Time.now.strftime('%d-%m-%Y_%H-%M-%S-%L')}"

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

@@ -15,7 +15,9 @@ Capistrano::Configuration.instance(:must_exist).load do
       mysql_credentials = fetch :mysql_credentials
       mysql_db_name = fetch :mysql_db_name
       deploy_to = fetch :deploy_to
-      set :latest_db_dump, "#{deploy_to}/backups/#{mysql_db_name}_#{Time.now.strftime('%d-%m-%Y_%H-%M-%S')}.sql"
+      backup_path = fetch :backup_path, "#{fetch :deploy_to}/backups"
+
+      set :latest_db_dump, "#{backup_path}/#{mysql_db_name}_#{Time.now.strftime('%d-%m-%Y_%H-%M-%S')}.sql"
       latest_db_dump = fetch :latest_db_dump
 
       on_rollback { run "rm -f #{latest_db_dump}" }
@@ -99,6 +101,7 @@ Capistrano::Configuration.instance(:must_exist).load do
           EOS
         end
 
+        # Upload the script
         put mysql_create, random_file
 
         begin
@@ -164,16 +167,28 @@ Capistrano::Configuration.instance(:must_exist).load do
         # The database dump name
         import_filename_argv = ARGV[argv_file_index]
         # Read the dump
-        mysql_dump = File.read(import_filename_argv)
+        contents_dump = File.read(import_filename_argv)
         # Generate a random file
-        random_file = random_tmp_file mysql_dump
+        random_file = random_tmp_file contents_dump
         # Add a rollback hook
         on_rollback { run "rm -f #{random_file}" }
 
         if mysql_credentials.present?
-          drop_db
-          create_db
-          put File.read(import_filename_argv), random_file
+          # Ask for a confirmation
+          response = ask("I am going to replace the database of #{fetch :application} with the contents of #{import_filename_argv}, are you sure you would like to continue (Yes, [No], Abort)", default:'N')
+          if response =~ /(no?)|(a(bort)?|\n)/i
+            abort "Canceled by the user."
+          end
+
+          # Transfer the SQL file to the server
+          # TODO: Try upload(filename, remote_file_name) function instead
+          put contents_dump, random_file
+
+          # Drop the database
+          find_and_execute_task("mysql:drop_db")
+
+          # Create the database
+          find_and_execute_task("mysql:create_db")
 
           run <<-CMD
             mysql \
@@ -185,10 +200,13 @@ Capistrano::Configuration.instance(:must_exist).load do
               #{random_file}
           CMD
 
+          # Remove the uploaded file
           run <<-CMD
             rm -f '#{random_file}'
           CMD
 
+          # Exit because capistrano will rollback, the next argument is a file name and not a task
+          # TODO: Find a better solution!
           exit 0
         end
       end

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

@@ -54,16 +54,8 @@ Capistrano::Configuration.instance(:must_exist).load do
         end
 
         task :folders, :roles => :app do
-          run <<-CMD
-            mkdir -p #{fetch :deploy_to} &&
-            mkdir -p #{fetch :deploy_to}/backups
-          CMD
-
-          if exists? :logs_path
-            run <<-CMD
-              mkdir -p #{fetch :logs_path}
-            CMD
-          end
+          # Use setup:folders
+          find_and_execute_task("setup:folders")
         end
 
         task :finish do

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

@@ -23,6 +23,7 @@ set :use_sudo, false
 set :deploy_to,   -> { "/home/vhosts/#{fetch :stage}/#{fetch :application}" }
 set :logs_path,   -> { "#{fetch :deploy_to}/logs" }
 set :public_path, -> { "#{fetch :current_path}/public" }
+set :backup_path, -> { "#{fetch :deploy_to}/backups" }
 
 # How should we deploy?
 # Valid options:
@@ -79,7 +80,6 @@ set :mysql_db_server,                         'localhost'
 set :mysql_db_name,                           -> { "#{fetch :application}_#{fetch :stage}" }
 
 # What is the database user ?
-# NOTE: This is only used if you run deploy:server:setup which calls mysql:create_db_user
 set :mysql_db_user,                           -> { "#{fetch :application}" }
 
 # Where the database credentials are stored on the server ?

data/lib/capistrano-exts/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: capistrano-exts
 version: !ruby/object:Gem::Version
-  version: 1.5.1
+  version: 1.6.0
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2011-09-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capistrano
-  requirement: &2156458100 !ruby/object:Gem::Requirement
+  requirement: &2156442460 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: 2.8.0
   type: :runtime
   prerelease: false
-  version_requirements: *2156458100
+  version_requirements: *2156442460
 - !ruby/object:Gem::Dependency
   name: i18n
-  requirement: &2156456100 !ruby/object:Gem::Requirement
+  requirement: &2156453940 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: 0.6.0
   type: :runtime
   prerelease: false
-  version_requirements: *2156456100
+  version_requirements: *2156453940
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &2156454120 !ruby/object:Gem::Requirement
+  requirement: &2156453160 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: 3.1.0
   type: :runtime
   prerelease: false
-  version_requirements: *2156454120
+  version_requirements: *2156453160
 - !ruby/object:Gem::Dependency
   name: guard
-  requirement: &2156452240 !ruby/object:Gem::Requirement
+  requirement: &2156451240 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: 0.6.2
   type: :development
   prerelease: false
-  version_requirements: *2156452240
+  version_requirements: *2156451240
 - !ruby/object:Gem::Dependency
   name: guard-bundler
-  requirement: &2156451180 !ruby/object:Gem::Requirement
+  requirement: &2156479320 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: 0.1.3
   type: :development
   prerelease: false
-  version_requirements: *2156451180
+  version_requirements: *2156479320
 - !ruby/object:Gem::Dependency
   name: guard-rspec
-  requirement: &2156469200 !ruby/object:Gem::Requirement
+  requirement: &2156475160 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +76,10 @@ dependencies:
         version: 0.4.3
   type: :development
   prerelease: false
-  version_requirements: *2156469200
+  version_requirements: *2156475160
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &2156467860 !ruby/object:Gem::Requirement
+  requirement: &2156486700 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,7 +87,7 @@ dependencies:
         version: 2.6.0
   type: :development
   prerelease: false
-  version_requirements: *2156467860
+  version_requirements: *2156486700
 description: Handy extensions for Capistrano
 email:
 - wael.nasreddine@gmail.com