capistrano-ash 1.3.4 → 1.3.5

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    NjUwNmQyZTMxMTNiYjMwMjU3NmEwNDRjODkyOTMyYWY0ZDBkMDQxZA==
+    N2Q3MzdiNTQ0ZTAyOWIzMzJiNzUyODE4NTU1NDhkNDllNmFjNTRkOQ==
   data.tar.gz: !binary |-
-    YzlmNGZkZjk0NjJkMDAyNDYxYmZhMDE2MzVhYjY3YTA2NGRiYzAwZg==
+    MWEyMmFmOWVmM2ZlODcyYzQ5YTJlZTA4ZTFjODhkYTA4NDBmODliNQ==
 !binary "U0hBNTEy":
   metadata.gz: !binary |-
-    YThjYzdhMDg5ODQxYWI2YzNlMjdiOTQ0YzgzZWMwMmMyMWM5NjU2OGY3MWI1
-    MmU4Y2M0MDBiNmQ1ZTIzMDNmYTMwZjFhODI0MjdhOTc5MWVlZjBmMzFiZmU5
-    Y2FhOTZlMzgwYzM4ZDM3YzI0YWNlYjFmODk1OGIwNzJjYjI5YjY=
+    OGE4ZjljMDdkMTAzZjk4YzQ1NWY3YTk0MzhlOTM3NGRiMDJhYmExZTc4YTQx
+    ZTMwYzQzODY2NTE4NzNmNzQ2NWUxNmUyOTQ1NTM5MzI4MTc3YmQ4YjIzZmM0
+    MmY2ZDQ2OWZkYzZhOGY3YjA5YjcxOTQ2MGEzNWZjYTVhNmM2NzE=
   data.tar.gz: !binary |-
-    NTc0NzQ0NTMyMjQwYmM5ZjMxNWFmYWZlNTlkOTIyZThlMWVlZjRkM2U0ZDk4
-    YWY4ZjhhODIyZTQ2ZDY5ZmI2NjNhYWZhMDNhZTAxMTVhMjBiYzkzNTAwMzc2
-    MjMwNjdjZmU5MTM5OWIzMzZkMWQzNTBiOTA5M2VmMWYyYWYzYjI=
+    ODBiOTRiNjUyY2FlMTlhNzA3YzBkMzJlNzM5MzZkMzk3NTJmODE5YWYzOTY4
+    OWI5ZjA3MDU5Yzc4MDVkMzA4MTE4MTAwODAyMGIzYWNmNmU2NzdkZWMxMmQ2
+    ZjA1NTFhODM1NDUzOTllYzE0NTBmODY0MDNiNjJiMjI5NDlmZjU=

data/VERSION

@@ -1 +1 @@
-1.3.4
+1.3.5

data/lib/ash/base.rb

@@ -25,6 +25,7 @@ configuration.load do
   after "deploy:setup_shared", "deploy:setup_backup"
   after "deploy:finalize_update", "ash:htaccess"
   after "deploy", "deploy:cleanup"
+  after "deploy", "seo:robots"
 
   # --------------------------------------------
   # Default variables
@@ -38,7 +39,7 @@ configuration.load do
   set :dbpass,            proc{Capistrano::CLI.password_prompt("Database password for '#{dbuser}':")}
   set :dbname,            proc{text_prompt("Database name: ")}
   _cset :mysqldump,       "mysqldump"
-  _cset :dump_options,    "--single-transaction --create-options --quick"
+  _cset :dump_options,    "--single-transaction --create-options --quick --triggers --routines"
 
   # Source Control
   set :group_writable,    false
@@ -53,7 +54,7 @@ configuration.load do
   set :copy_strategy,     :checkout
   set :copy_compression,  :bz2
   set :copy_exclude,      [".svn", ".git*", ".DS_Store", "*.sample", "LICENSE*", "Capfile",
-    "RELEASE*", "*.rb", "*.sql", "nbproject", "_template"]
+    "RELEASE*", "config/deploy", "*.rb", "*.sql", "nbproject", "_template"]
 
   # phpMyAdmin version
   set :pma_version,       "3.4.5"
@@ -137,29 +138,44 @@ configuration.load do
       will use sudo to clean up the old releases, but if sudo is not available \
       for your environment, set the :use_sudo variable to false instead. \
 
-      Overridden to set/reset file and directory permissions
+      OVERRIDES:
+      + set/reset file and directory permissions
+      + remove old releases per host instead of assuming the releases are \
+        the same for every host
+
+      see http://blog.perplexedlabs.com/2010/09/08/improved-deploycleanup-for-capistrano/
     DESC
     task :cleanup, :except => { :no_release => true } do
       count = fetch(:keep_releases, 5).to_i
-      local_releases = capture("ls -xt #{releases_path}").split.reverse
-      if count >= local_releases.length
-        logger.important "no old releases to clean up"
-      else
-        logger.info "keeping #{count} of #{local_releases.length} deployed releases"
-        directories = (local_releases - local_releases.last(count)).map { |release|
-          File.join(releases_path, release) }.join(" ")
-
-        directories.split(" ").each do |dir|
-          # adding a chown -R method to fix permissions on the directory
-          # this should help with issues related to permission denied
-          # as in issues #28 and #30
-          try_sudo "chown -R #{user}:#{user} #{dir}"
-
-          set_perms_dirs(dir)
-          set_perms_files(dir)
-        end
+      cmd = "ls -xt #{releases_path}"
+      run cmd do |channel, stream, data|
+        local_releases = data.split.reverse
+        if count >= local_releases.length
+          logger.important "no old releases to clean up on #{channel[:server]}"
+        else
+          logger.info "keeping #{count} of #{local_releases.length} deployed releases on #{channel[:server]}"
+
+          directories = (local_releases - local_releases.last(count)).map { |release|
+            File.join(releases_path, release)
+          }.join(" ")
+
+          directories.split(" ").each do |dir|
+            begin
+              # adding a chown -R method to fix permissions on the directory
+              # this should help with issues related to permission denied
+              # as in issues #28 and #30
+              run "#{sudo} chown -R #{user}:#{user} #{dir}" if remote_dir_exists?(dir)
+
+              set_perms_dirs(dir)
+              set_perms_files(dir)
+            rescue Exception => e
+              logger.important e.message
+              logger.info "Moving on to the next directory..."
+            end
+          end
 
-        try_sudo "rm -rf #{directories}"
+          run "#{sudo} rm -rf #{directories}", :hosts => [channel[:server]]
+        end
       end
     end
   end
@@ -200,6 +216,39 @@ configuration.load do
     end
   end
 
+  # --------------------------------------------
+  # SEO - robots.txt files
+  # --------------------------------------------
+  namespace :seo do
+    desc <<-DESC
+      Creates a robots.txt appropriate for the environment
+
+      staging     => block all robots from indexing the site
+      production  => allow robots to index the site
+    DESC
+    task :robots, :roles => :web do
+      case "#{stage}"
+      when 'staging'
+        # block all robots from indexing anything
+        robots_txt = <<-EOF
+User-agent: *
+Disallow: /
+EOF
+      when 'production'
+        # allow all robots to index anything
+        robots_txt = <<-EOF
+User-agent: *
+Disallow:
+EOF
+      else
+        logger.important "SKIPPING creation of robots.txt because the #{stage} stage was unanticipated. You should override the `seo:robots` task with your own implementation."
+      end
+
+      # echo the file out into the root of the latest_release directory
+      put robots_txt, "#{latest_release}/robots.txt"
+    end
+  end
+
   # --------------------------------------------
   # PHP tasks
   # --------------------------------------------
@@ -217,6 +266,24 @@ configuration.load do
     end
   end
 
+  # --------------------------------------------
+  # NGINX tasks
+  # --------------------------------------------
+  namespace :nginx do
+    %w(start stop restart status).each do |cmd|
+      desc "[internal] - #{cmd.upcase} nginx and php-fpm"
+      task cmd.to_sym, :roles => :web do
+
+        nginx_cmd   = fetch(:nginx_init_command, "/etc/init.d/nginx")
+        phpfpm_cmd  = fetch(:phpfpm_init_command, "/etc/init.d/php-fpm")
+
+        run "#{sudo} #{nginx_cmd} #{cmd}"
+        run "#{sudo} #{phpfpm_cmd} #{cmd}"
+      end
+    end
+  end
+
+
   # --------------------------------------------
   # Remote/Local database migration tasks
   # --------------------------------------------
@@ -348,7 +415,7 @@ configuration.load do
       You can specify which files or directories to exclude from being \
       backed up (i.e., log files, sessions, cache) by setting the \
       :backup_exclude variable
-          set(:backup_exclude) { [ "var/", "tmp/", logs/debug.log ] }
+          set(:backup_exclude) { [ "var/", "tmp/", "logs/debug.log" ] }
     DESC
     task :web, :roles => :web do
       if previous_release
@@ -369,17 +436,22 @@ configuration.load do
         # --------------------------
         # SET/RESET PERMISSIONS
         # --------------------------
-        set_perms_dirs("#{tmp_backups_path}/#{release_name}", 755)
-        set_perms_files("#{tmp_backups_path}/#{release_name}", 644)
+        begin
+          set_perms_dirs("#{tmp_backups_path}/#{release_name}", 755)
+          set_perms_files("#{tmp_backups_path}/#{release_name}", 644)
 
-        # create the tarball of the previous release
-        set :archive_name, "release_B4_#{release_name}.tar.gz"
-        logger.debug "Creating a Tarball of the previous release in #{backups_path}/#{archive_name}"
-        run "cd #{tmp_backups_path} && tar -cvpf - ./#{release_name}/ | gzip -c --best > #{backups_path}/#{archive_name}"
+          # create the tarball of the previous release
+          set :archive_name, "release_B4_#{release_name}.tar.gz"
+          logger.debug "Creating a Tarball of the previous release in #{backups_path}/#{archive_name}"
+          run "cd #{tmp_backups_path} && tar -cvpf - ./#{release_name}/ | gzip -c --best > #{backups_path}/#{archive_name}"
 
-        # remove the the temporary copy
-        logger.debug "Removing the tempory copy"
-        run "rm -rf #{tmp_backups_path}/#{release_name}"
+          # remove the the temporary copy
+          logger.debug "Removing the temporary copy"
+          run "rm -rf #{tmp_backups_path}/#{release_name}"
+        rescue Exception => e
+          logger.debug e.message
+          logger.info "Error setting permissions on backed up files but continuing on..."
+        end
       else
         logger.important "no previous release to backup; backup of files skipped"
       end
@@ -392,8 +464,13 @@ configuration.load do
         dump_options  = fetch(:dump_options, "--single-transaction --create-options --quick")
 
         puts "Backing up the database now and putting dump file in the previous release directory"
+
+        # create the temporary copy for the release directory
+        # which we'll tarball in the backup:web task
+        run "mkdir -p #{tmp_backups_path}/#{release_name}"
+
         # define the filename (include the current_path so the dump file will be within the directory)
-        filename = "#{current_path}/#{dbname}_dump-#{Time.now.to_s.gsub(/ /, "_")}.sql.gz"
+        filename = "#{tmp_backups_path}/#{release_name}/#{dbname}_dump-#{Time.now.to_s.gsub(/ /, "_")}.sql.gz"
         # dump the database for the proper environment
         run "#{mysqldump} #{dump_options} -u #{dbuser} -p #{dbname} | gzip -c --best > #{filename}" do |ch, stream, out|
             ch.send_data "#{dbpass}\n" if out =~ /^Enter password:/
@@ -423,11 +500,11 @@ configuration.load do
 
           # fix permissions on the the files and directories before removing them
           archives.split(" ").each do |backup|
-            set_perms_dirs("#{backup}", 755) if File.directory?(backup)
-            set_perms_files("#{backup}", 644)
+            set_perms_dirs("#{backup}", 755) if remote_dir_exists?(backup)
+            set_perms_files("#{backup}", 644) if remote_dir_exists?(backup)
           end
 
-          try_sudo "rm -rf #{archives}"
+          run "rm -rf #{archives}"
         rescue Exception => e
           logger.important e.message
         end
@@ -544,6 +621,51 @@ configuration.load do
     end
   end
 
+  # --------------------------------------------
+  # Track changes made to remote release file directory via a throw away git repo
+  # --------------------------------------------
+  namespace :watchdog do
+    desc "Track changes made to remote release file directory via a throw away git repo"
+    task :default, :roles => :web do
+      watchdog.init_git_repo
+      watchdog.init_git_ignore
+      watchdog.commit
+      watchdog.check_status
+    end
+
+    desc <<-DESC
+      [internal] initialize a git repo in the latest release directory to track changes anybody makes to the filesystem
+    DESC
+    task :init_git_repo, :roles => :web do
+      logger.important "Creating a local git repo in #{latest_release} to track changes done outside of our git-flow process"
+      run "cd #{latest_release} && git init ." unless remote_dir_exists?("#{latest_release}/.git")
+    end
+
+    desc <<-DESC
+      [internal] copy the .gitignore file from the cached-copy directory to only commit what we really care about
+    DESC
+    task :init_git_ignore, :roles => :web do
+      logger.important "Copying the .gitignore file from the cached-copy directory"
+      run "ln -s #{shared_path}/cached-copy/.gitignore #{latest_release}/.gitignore"
+    end
+
+    desc <<-DESC
+      [internal] Adds and commits the files in the latest release directory
+    DESC
+    task :commit, :roles => :web do
+      logger.important "Adding and committing the files in the latest release directory"
+      run "cd #{latest_release} && git add . && git commit -m 'Keeping track of changes done outside of AAI git-flow'"
+    end
+
+    desc <<-DESC
+      [internal] Adds and commits the files in the latest release directory
+    DESC
+    task :check_status, :roles => :web do
+      logger.important "Checking status of git repo for any changes in watched files/directories"
+      run "cd #{latest_release} && git status"
+    end
+
+  end
 
   # --------------------------------------------
   # Remote File/Directory test tasks

data/lib/ash/common.rb

@@ -44,10 +44,10 @@ end
 
 # set the permissions for files recurisvely from the starting directory (dir_path)
 def set_perms_files(dir_path, perm = 644)
-  try_sudo "find #{dir_path} -type f -print0 | xargs -0 chmod #{perm}"
+  run "find #{dir_path} -type f -print0 | xargs -0 #{sudo} chmod #{perm}" if remote_dir_exists?(dir_path)
 end
 
 # set the permissions for directories recurisvely from the starting directory (dir_path)
 def set_perms_dirs(dir_path, perm = 755)
-  try_sudo "find #{dir_path} -type d -print0 | xargs -0 chmod #{perm}" if File.directory?(dir_path)
+  run "find #{dir_path} -type d -print0 | xargs -0 #{sudo} chmod #{perm}" if remote_dir_exists?(dir_path)
 end

data/lib/ash/drupal.rb

@@ -15,6 +15,7 @@ configuration.load do
   #
   # --------------------------------------------
   depend :remote, :command, 'drush'
+  depend :remote, :command, 'rsync'
 
   # --------------------------------------------
   # Setting defaults
@@ -57,7 +58,7 @@ configuration.load do
     desc "Setup local files necessary for deployment"
     task :setup_local do
       # attempt to create files needed for proper deployment
-      system("cp .htaccess htaccess.dist")
+      system("cp .htaccess htaccess.dist") unless local_file_exists?("htaccess.dist")
     end
 
     desc "Setup shared application directories and permissions after initial setup"
@@ -130,9 +131,14 @@ configuration.load do
     task :db, :roles => :db do
       if previous_release
         puts "Backing up the database now and putting dump file in the previous release directory"
+
+        # create the temporary copy for the release directory
+        # which we'll tarball in the backup:web task
+        run "mkdir -p #{tmp_backups_path}/#{release_name}"
+
         multisites.each_pair do |folder, url|
           # define the filename (include the current_path so the dump file will be within the directory)
-          filename = "#{current_path}/#{folder}_dump-#{Time.now.to_s.gsub(/ /, "_")}.sql.gz"
+          filename = "#{tmp_backups_path}/#{release_name}/#{folder}_dump-#{Time.now.to_s.gsub(/ /, "_")}.sql.gz"
           # dump the database for the proper environment
           run "#{drush_bin} -l #{url} -r #{current_path} sql-dump | gzip -c --best > #{filename}"
         end

data/lib/ash/magento.rb

@@ -8,11 +8,26 @@ configuration = Capistrano::Configuration.respond_to?(:instance) ?
   Capistrano.configuration(:must_exist)
 
 configuration.load do
+
+  # --------------------------------------------
+  # Deployment dependencies
+  #
+  #     $ cap <stage> deploy:check
+  #
+  # --------------------------------------------
+  depend :remote, :command, 'rsync'
+
+  # --------------------------------------------
+  # Magento Variables
+  # --------------------------------------------
+  set :enable_modules, []
+  set :disable_modules, %w(Ash_Bar)
+
   # --------------------------------------------
   # Task chains
   # --------------------------------------------
   after "deploy:setup", "deploy:setup_local"
-#  after "deploy:setup_shared", "pma:install"
+  #  after "deploy:setup_shared", "pma:install"
   after "deploy:finalize_update", "magento:activate_config"
   # after "deploy:create_symlink", "magento:symlink"
 
@@ -20,6 +35,8 @@ configuration.load do
   # before/after callbacks not firing for 'deploy:symlink'
   # or 'deploy:create_symlink'
   after "deploy", "magento:symlink"
+  after "magento:symlink", "magento:enable_mods"
+  after "magento:enable_mods", "magento:disable_mods"
   after "magento:symlink", "magento:purge_cache"
   before "magento:purge_cache", "compass"
 
@@ -30,9 +47,11 @@ configuration.load do
     desc "Setup local files necessary for deployment"
     task :setup_local do
       # attempt to create files needed for proper deployment
-      system("cp .htaccess htaccess.dist")
-      system("cp app/etc/local.xml app/etc/local.xml.staging")
-      system("cp app/etc/local.xml app/etc/local.xml.production")
+      system("cp .htaccess htaccess.dist") unless local_file_exists?("htaccess.dist")
+      stages = fetch(:stages, %w(staging production))
+      stages.each do |env|
+        system("cp app/etc/local.xml app/etc/local.xml.#{env}") unless local_file_exists?("app/etc/local.xml.#{env}")
+      end
     end
 
     desc "Setup shared application directories and permissions after initial setup"
@@ -55,8 +74,8 @@ configuration.load do
     desc "[internal] Touches up the released code. This is called by update_code after the basic deploy finishes."
     task :finalize_update, :roles => :web, :except => { :no_release => true } do
       # synchronize media directory with shared data
-      try_sudo "rsync -rltDvzog #{latest_release}/media/ #{shared_path}/media/"
-      try_sudo "chmod -R 777 #{shared_path}/media/"
+      run "rsync -rltDvzog #{latest_release}/media/ #{shared_path}/media/"
+      run "#{sudo} chmod -R 777 #{shared_path}/media/"
 
       # remove directories that will be shared
       run "rm -Rf #{latest_release}/includes"
@@ -108,7 +127,7 @@ configuration.load do
 
     desc "Purge Magento cache directory"
     task :purge_cache, :roles => :web, :except => { :no_release => true } do
-      try_sudo "rm -Rf #{shared_path}/var/cache/*"
+      run "#{sudo} rm -Rf #{shared_path}/var/cache/*"
     end
 
     desc "Watch Magento system log"
@@ -131,8 +150,9 @@ configuration.load do
 
     desc "Clear the Magento Cache"
     task :cc, :roles => [:web, :app], :except => { :no_release => true } do
+      run "#{sudo} chown -R #{user}:#{user} #{shared_path}/var/*"
       magento.purge_cache
-      try_sudo "rm -rf #{shared_path}/var/full_page_cache/*"
+      run "#{sudo} rm -rf #{shared_path}/var/full_page_cache/*"
     end
 
     desc "Enable display errors"
@@ -140,6 +160,30 @@ configuration.load do
       run "perl -pi -e 's/#ini_set/ini_set/g' #{latest_release}/index.php"
     end
 
+    desc "Enable Modules"
+    task :enable_mods, :roles => :web, :except => { :no_release => true } do
+      modules = fetch(:enable_modules, [])
+      # enable specific modules
+      modules.each do |name|
+        mod_name = name.include?('.xml') ? "#{name}" : "#{name}.xml"
+        mod_path = "#{latest_release}/app/etc/modules/#{mod_path}"
+        # enable the module
+        run "perl -pi -e 's/false/true/g' #{mod_path}" if remote_file_exists?("#{mod_path}")
+      end
+    end
+
+    desc "Disable Modules"
+    task :disable_mods, :roles => :web, :except => { :no_release => true } do
+      modules = fetch(:disable_modules, [])
+
+      # enable specific modules
+      modules.each do |name|
+        mod_name = name.include?('.xml') ? "#{name}" : "#{name}.xml"
+        mod_path = "#{latest_release}/app/etc/modules/#{mod_path}"
+        # disable the module
+        run "perl -pi -e 's/true/false/g' #{mod_path}" if remote_file_exists?("#{mod_path}")
+      end
+    end
   end
 
   # --------------------------------------------

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: capistrano-ash
 version: !ruby/object:Gem::Version
-  version: 1.3.4
+  version: 1.3.5
 platform: ruby
 authors:
 - August Ash
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-09 00:00:00.000000000 Z
+date: 2013-10-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capistrano