capistrano-magento2 0.5.2 → 0.5.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 548f3c638350c7873876db3869f74c22003c02f7
-  data.tar.gz: 69a9f0dbe7e4e119b081b5b60d016aef69cb5700
+  metadata.gz: 6a81db107c4c34b425b713d6fa60472526266e14
+  data.tar.gz: 5a3bf1bb110c1f121a3063a6d67a32a3346cba96
 SHA512:
-  metadata.gz: a6b6854c65c9833dc2aef4c6bd4d2f9fdd98c8b0bf6857bd89d88812058e68a98e657d6b3e64dd2fc4a3148918df926867dacb36d2a465b36382893ac55fb79b
-  data.tar.gz: 1e10f1c370c2f6429dd973e1930740cdb11c2c228c050a613f3a6db2f7b2700bd7a61be5eae259338ac336f3fac96f0b74d4d704d9338bfea6beaec369602a6c
+  metadata.gz: 1f4f5c17e3e55132443b1bae1658ef3d09ac434a09b10d14709a23707200a51b1adedff986f1d5ca83f54ff86957b3c84fc12c6ba47082ef924e3b9255295e0c
+  data.tar.gz: ea57f3391c18f3ec8388fb5fe96a97c1405c26dad2b62ec87810a014c22dd053eae1c18092acad7f1d5b60db8e4a2fc4fcee40a32e6b2ffeaf4c512ee13641bd

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 # Capistrano::Magento2 Change Log
 
+0.5.3
+==========
+
+* Added setting `:magento_deploy_cache_shared` for targeting cache related tasks (issue #33)
+* Added setting `:magento_deploy_setup_role` for targeting setup related tasks (issue #33)
+* Fixed magento setup, cache, index commands to only run on appropriate node(s) in multi-node deploys (issue #33).
+* Fixed capistrano-pending support to play nicely with multiple hosts. Now only performs check on a single host.
+* Updated `magento:deploy:verify` output with host specific messaging on configuration errors.
+
 0.5.2
 ==========
 

data/README.md

@@ -109,17 +109,19 @@ Before you can use Capistrano to deploy, you must configure the `config/deploy.r
 
 ### Magento Deploy Settings
 
-| setting                       | default | what it does
-| ----------------------------- | ------- | ---
-| `:magento_deploy_languages`   | `['en_US']` | Array of languages passed to static content deploy routine
-| `:magento_deploy_themes`      | `[]`   | Array of themes passed to static content deploy routine (Magento 2.1+ only)
-| `:magento_deploy_composer`    | `true` | Enables composer install behaviour in the built-in deploy routine
-| `:magento_deploy_production`  | `true` | Enables production specific DI compilation and static content generation
-| `:magento_deploy_maintenance` | `true` | Enables use of maintenance mode while magento:setup:upgrade runs
-| `:magento_deploy_confirm`     | `[]`   | Used to require confirmation of deployment to a set of capistrano stages
-| `:magento_deploy_chmod_d`     | `2770` | Default permissions applied to all directories in the release path
-| `:magento_deploy_chmod_f`     | `0660` | Default permissions applied to all non-executable files in the release path
-| `:magento_deploy_chmod_x`     | `['bin/magento']` | Default list of files in release path to set executable bit on
+| setting                        | default | what it does
+| ------------------------------ | ------- | ---
+| `:magento_deploy_setup_role`   | `:all`  | Role from which primary host is chosen to run things like setup:upgrade on
+| `:magento_deploy_cache_shared` | `true`  | If true, cache operations are restricted to the primary node in setup role
+| `:magento_deploy_languages`    | `['en_US']` | Array of languages passed to static content deploy routine
+| `:magento_deploy_themes`       | `[]`   | Array of themes passed to static content deploy routine (Magento 2.1+ only)
+| `:magento_deploy_composer`     | `true` | Enables composer install behaviour in the built-in deploy routine
+| `:magento_deploy_production`   | `true` | Enables production specific DI compilation and static content generation
+| `:magento_deploy_maintenance`  | `true` | Enables use of maintenance mode while magento:setup:upgrade runs
+| `:magento_deploy_confirm`      | `[]`   | Used to require confirmation of deployment to a set of capistrano stages
+| `:magento_deploy_chmod_d`      | `2770` | Default permissions applied to all directories in the release path
+| `:magento_deploy_chmod_f`      | `0660` | Default permissions applied to all non-executable files in the release path
+| `:magento_deploy_chmod_x`      | `['bin/magento']` | Default list of files in release path to set executable bit on
 
 #### Example Usage
 

data/lib/capistrano/magento2.rb

@@ -7,4 +7,12 @@
  # http://davidalger.com/contact/
  ##
 
+module Capistrano
+  class Magento2
+    def self.cache_hosts
+      return fetch(:magento_deploy_cache_shared) ? (primary fetch :magento_deploy_setup_role) : (release_roles :all)
+    end
+  end
+end
+
 load File.expand_path('../tasks/magento.rake', __FILE__)

data/lib/capistrano/magento2/version.rb

@@ -9,6 +9,6 @@
 
 module Capistrano
   module Magento2
-    VERSION = '0.5.2'
+    VERSION = '0.5.3'
   end
 end

data/lib/capistrano/tasks/deploy.rake

@@ -19,47 +19,36 @@ namespace :deploy do
   end
 
   task :updated do
+    invoke 'magento:deploy:verify'
+    invoke 'magento:composer:install' if fetch(:magento_deploy_composer)
+    invoke 'magento:setup:permissions'
+    if fetch(:magento_deploy_production)
+      invoke 'magento:setup:static-content:deploy'
+      invoke 'magento:setup:di:compile'
+    end
+    invoke 'magento:setup:permissions'
+    invoke 'magento:maintenance:enable' if fetch(:magento_deploy_maintenance)
+
     on release_roles :all do
-      invoke 'magento:deploy:verify'
-      invoke 'magento:composer:install' if fetch(:magento_deploy_composer)
-      invoke 'magento:setup:permissions'
-      if fetch(:magento_deploy_production)
-        invoke 'magento:setup:static-content:deploy'
-        invoke 'magento:setup:di:compile'
-      end
-      invoke 'magento:setup:permissions'
-      invoke 'magento:maintenance:enable' if fetch(:magento_deploy_maintenance)
       if test "[ -f #{current_path}/bin/magento ]"
         within current_path do
           execute :magento, 'maintenance:enable' if fetch(:magento_deploy_maintenance)
         end
       end
-      invoke 'magento:setup:upgrade'
     end
+
+    invoke 'magento:setup:upgrade'
   end
 
   task :published do
-    on release_roles :all do
-      invoke 'magento:cache:flush'
-      invoke 'magento:cache:varnish:ban'
-      invoke 'magento:maintenance:disable' if fetch(:magento_deploy_maintenance)
-    end
+    invoke 'magento:cache:flush'
+    invoke 'magento:cache:varnish:ban'
+    invoke 'magento:maintenance:disable' if fetch(:magento_deploy_maintenance)
   end
 
   task :reverted do
-    on release_roles :all do
-      invoke 'magento:maintenance:disable' if fetch(:magento_deploy_maintenance)
-      invoke 'magento:cache:flush'
-      invoke 'magento:cache:varnish:ban'
-    end
-  end
-end
-
-namespace :load do
-  task :defaults do
-    set :magento_deploy_composer, fetch(:magento_deploy_composer, true)
-    set :magento_deploy_confirm, fetch(:magento_deploy_confirm, [])
-    set :magento_deploy_maintenance, fetch(:magento_deploy_maintenance, true)
-    set :magento_deploy_production, fetch(:magento_deploy_production, true)
+    invoke 'magento:maintenance:disable' if fetch(:magento_deploy_maintenance)
+    invoke 'magento:cache:flush'
+    invoke 'magento:cache:varnish:ban'
   end
 end

data/lib/capistrano/tasks/magento.rake

@@ -12,7 +12,7 @@ namespace :magento do
   namespace :cache do
     desc 'Flush Magento cache storage'
     task :flush do
-      on release_roles :all do
+      on Capistrano::Magento2.cache_hosts do
         within release_path do
           execute :magento, 'cache:flush'
         end
@@ -21,7 +21,7 @@ namespace :magento do
     
     desc 'Clean Magento cache by types'
     task :clean do
-      on release_roles :all do
+      on Capistrano::Magento2.cache_hosts do
         within release_path do
           execute :magento, 'cache:clean'
         end
@@ -30,7 +30,7 @@ namespace :magento do
     
     desc 'Enable Magento cache'
     task :enable do
-      on release_roles :all do
+      on Capistrano::Magento2.cache_hosts do
         within release_path do
           execute :magento, 'cache:enable'
         end
@@ -39,7 +39,7 @@ namespace :magento do
     
     desc 'Disable Magento cache'
     task :disable do
-      on release_roles :all do
+      on Capistrano::Magento2.cache_hosts do
         within release_path do
           execute :magento, 'cache:disable'
         end
@@ -48,7 +48,7 @@ namespace :magento do
     
     desc 'Check Magento cache enabled status'
     task :status do
-      on release_roles :all do
+      on Capistrano::Magento2.cache_hosts do
         within release_path do
           execute :magento, 'cache:status'
         end
@@ -59,7 +59,7 @@ namespace :magento do
       # TODO: Document what the magento:cache:varnish:ban task is for and how to use it. See also magento/magento2#4106
       desc 'Add ban to Varnish for url(s)'
       task :ban do
-        on release_roles :all do
+        on primary fetch(:magento_deploy_setup_role) do
           # TODO: Document use of :ban_pools and :varnish_cache_hosts in project config file
           next unless any? :ban_pools
           next unless any? :varnish_cache_hosts
@@ -124,27 +124,30 @@ namespace :magento do
     end
 
     task :verify do
+      is_err = false
       on release_roles :all do
         unless test "[ -f #{release_path}/app/etc/config.php ]"
-          error "The repository is missing app/etc/config.php. Please install the application and retry!"
-          exit 1
+          error "\e[0;31mThe repository is missing app/etc/config.php. Please install the application and retry!\e[0m"
+          exit 1  # only need to check the repo once, so we immediately exit
         end
 
         unless test %Q[#{SSHKit.config.command_map[:php]} -r '
               $cfg = include "#{release_path}/app/etc/env.php";
               exit((int)!isset($cfg["install"]["date"]));
           ']
-          error "No environment configuration could be found. Please configure app/etc/env.php and retry!"
-          exit 1
+          error "\e[0;31mError on #{host}:\e[0m No environment configuration could be found." +
+                " Please configure app/etc/env.php and retry!"
+          is_err = true
         end
       end
+      exit 1 if is_err
     end
   end
 
   namespace :setup do
     desc 'Run the Magento upgrade process'
     task :upgrade do
-      on release_roles :all do
+      on primary fetch(:magento_deploy_setup_role) do
         within release_path do
           execute :magento, 'setup:upgrade --keep-generated'
         end
@@ -280,7 +283,7 @@ namespace :magento do
   namespace :indexer do
     desc 'Reindex data by all indexers'
     task :reindex do
-      on release_roles :all do
+      on primary fetch(:magento_deploy_setup_role) do
         within release_path do
           execute :magento, 'indexer:reindex'
         end
@@ -289,7 +292,7 @@ namespace :magento do
 
     desc 'Shows allowed indexers'
     task :info do
-      on release_roles :all do
+      on primary fetch(:magento_deploy_setup_role) do
         within release_path do
           execute :magento, 'indexer:info'
         end
@@ -298,7 +301,7 @@ namespace :magento do
 
     desc 'Shows status of all indexers'
     task :status do
-      on release_roles :all do
+      on primary fetch(:magento_deploy_setup_role) do
         within release_path do
           execute :magento, 'indexer:status'
         end
@@ -307,7 +310,7 @@ namespace :magento do
 
     desc 'Shows mode of all indexers'
     task 'show-mode', :index do |t, args|
-      on release_roles :all do
+      on primary fetch(:magento_deploy_setup_role) do
         within release_path do
           execute :magento, 'indexer:show-mode', args[:index]
         end
@@ -316,14 +319,13 @@ namespace :magento do
 
     desc 'Sets mode of all indexers'
     task 'set-mode', :mode, :index do |t, args|
-      on release_roles :all do
+      on primary fetch(:magento_deploy_setup_role) do
         within release_path do
           execute :magento, 'indexer:set-mode', args[:mode], args[:index]
         end
       end
     end
   end
-
 end
 
 namespace :load do
@@ -356,10 +358,21 @@ namespace :load do
       'var/tmp'
     )
 
-    set :magento_deploy_languages, fetch(:magento_deploy_languages, ['en_US'])
-    set :magento_deploy_themes, fetch(:magento_deploy_themes, [])
+    # deploy permissions defaults
     set :magento_deploy_chmod_d, fetch(:magento_deploy_chmod_d, '2770')
     set :magento_deploy_chmod_f, fetch(:magento_deploy_chmod_f, '0660')
     set :magento_deploy_chmod_x, fetch(:magento_deploy_chmod_x, ['bin/magento'])
+
+    # deploy configuration defaults
+    set :magento_deploy_composer, fetch(:magento_deploy_composer, true)
+    set :magento_deploy_confirm, fetch(:magento_deploy_confirm, [])
+    set :magento_deploy_languages, fetch(:magento_deploy_languages, ['en_US'])
+    set :magento_deploy_maintenance, fetch(:magento_deploy_maintenance, true)
+    set :magento_deploy_production, fetch(:magento_deploy_production, true)
+    set :magento_deploy_themes, fetch(:magento_deploy_themes, [])
+
+    # deploy targetting defaults
+    set :magento_deploy_setup_role, fetch(:magento_deploy_setup_role, :all)
+    set :magento_deploy_cache_shared, fetch(:magento_deploy_cache_shared, true)
   end
 end

data/lib/capistrano/tasks/pending.rake

@@ -11,11 +11,12 @@ require 'capistrano-pending'
 
 before :deploy, 'deploy:pending:check_changes'
 namespace :deploy do
-    
+
+  # Check for pending changes on the primary node and then notify user of any incoming
+  # changes and/or warn that there is nothing to deploy
   namespace :pending do
-    # Check for pending changes and notify user of incoming changes or warn them that there are no changes
     task :check_changes do
-      on roles fetch(:capistrano_pending_role, :app) do |host|
+      on primary fetch(:magento_deploy_setup_role) do
         # check for pending changes only if REVISION file exists to prevent error
         if test "[ -f #{current_path}/REVISION ]"
           invoke 'deploy:pending:setup'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: capistrano-magento2
 version: !ruby/object:Gem::Version
-  version: 0.5.2
+  version: 0.5.3
 platform: ruby
 authors:
 - David Alger
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-10-03 00:00:00.000000000 Z
+date: 2016-10-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capistrano