capistrano-magento2 0.8.0 → 0.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 39f8768fb9d567d6d6472c88c5678de0ab0301239c448ec8c553c2289b3bb7e2
-  data.tar.gz: b316370020b96dc2b90737ddfb56019e6f9f2097c93d05a208fdb622a0cd2b1d
+  metadata.gz: 647236f26af13c3c337e3c4c2c105f959c4a5af20b2d5cae9d064c7f1523d168
+  data.tar.gz: f8534cef247514959253f7e47caf8563966a92c4b9f712a987b9f68299b7b8d0
 SHA512:
-  metadata.gz: b63c59ddd943416c55cd7216cccf5797dd361f8c091b4b067b394c96f4d199d07760b608b7e2deae4d455bc0af3ce4910ead1f1ffa14ab4ed04df47ed548a8f7
-  data.tar.gz: a67d479d4a50a102c13fe0de1e7749170b26efdb2c330f1e40da0ee4641a0c5be1bc9384cee67a3e7811c1928ed8ae9010e7f42c3108138481d684c6a410310e
+  metadata.gz: 3e65ecf251ecb4b7d93d4ab838036b64859962decd16ec18f8848d4828cf86b85fb3c2c86225b0ec04febd7f65c6d4b550d49c0c2954217cb75f0d039bc87756
+  data.tar.gz: 6663d81e73de427ea960a3dbdb742de46e8bc58d8d7f115616b8c18511bb659a186a389eaf8bdee74bb530156c8005d5558417559a049803ba71bc5ba2bef0b5

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Capistrano::Magento2 Change Log
 
+0.8.1
+==========
+
+* Added `require 'capistrano/magento2/cachetool'` which may be used to enable flushing the php-opcache when [cachetool](http://gordalina.github.io/cachetool/) is installed on the server
+* Added `cachetool:opcache:status` and `cachetool:opcache:reset` commands (use `require 'capistrano/magento2/cachetool'` to enable them)
+* Fixed issue causing deployment to disable maintenance mode when manually enabled prior to deployment (issue #16)
+
 0.8.0
 ==========
 

data/README.md

@@ -204,6 +204,21 @@ To see what process the built-in routine runs, take a look at the included rake
 
 Before deploying with Capistrano, you must update each of your web servers to point to the `current` directory inside of the configured `:deploy_to` directory. For example: `/var/www/html/current/pub` Refer to the [Capistrano Structure](http://capistranorb.com/documentation/getting-started/structure/) to learn more about Capistrano's folder structure.
 
+### PHP Opcache Reset
+
+When doing atomic deployments with php-opcache installed on a server, the cache will reach a full state after which application performance will degrade as a result of the opcache not being able to do it's job. To work nicely with this, there is support included for automatically resetting the php-opcache after a release is published.
+
+To use this, include `require 'capistrano/magento2/cachetool'` in your `Capfile` and make sure there is an `/etc/cachetool.yml` or `/var/www/html/.cachetool.yml` (assuming `:deploy_to` points at `/var/www/html`) file configured with contents like the following:
+
+    adapter: fastcgi
+    fastcgi: /var/run/php-fpm/www-data.sock
+    temp_dir: /dev/shm/cachetool
+    extensions: [ opcache ]
+
+With this configuration in place, be sure cachetool ([available from here](http://gordalina.github.io/cachetool/)) has already been installed on the server and is available in `$PATH`.
+
+Congratulations! You should now begin to see the pre-deployemnt opcache status information when running a deployment followed immediately be the `cachetool opcache:reset` command used to keep things humming nicely along.
+
 ## Magento Specific Tasks
 
 All Magento 2 tasks used by the built-in `deploy.rake` file as well as some additional commands are implemented and exposed to the end-user for use directly via the cap tool. You can also see this list by running `cap -T` from your shell.

data/lib/capistrano/magento2/cachetool.rb

@@ -0,0 +1,14 @@
+##
+ # Copyright © 2018 by David Alger. All rights reserved
+ # 
+ # Licensed under the Open Software License 3.0 (OSL-3.0)
+ # See included LICENSE file for full text of OSL-3.0
+ # 
+ # http://davidalger.com/contact/
+ ##
+
+require 'capistrano/deploy'
+
+SSHKit.config.command_map[:cachetool] = "/usr/bin/env cachetool --"
+
+load File.expand_path('../../tasks/cachetool.rake', __FILE__)

data/lib/capistrano/magento2/version.rb

@@ -9,6 +9,6 @@
 
 module Capistrano
   module Magento2
-    VERSION = '0.8.0'
+    VERSION = '0.8.1'
   end
 end

data/lib/capistrano/tasks/cachetool.rake

@@ -0,0 +1,34 @@
+##
+ # Copyright © 2018 by David Alger. All rights reserved
+ # 
+ # Licensed under the Open Software License 3.0 (OSL-3.0)
+ # See included LICENSE file for full text of OSL-3.0
+ # 
+ # http://davidalger.com/contact/
+ ##
+
+after "deploy:published", "cachetool:opcache:status"
+after "deploy:published", "cachetool:opcache:reset"
+
+namespace :cachetool do
+ namespace :opcache do
+   desc "Resets the contents of the php-opcode cache"
+   task :reset do
+     on release_roles :all do
+       within release_path do
+         execute :cachetool, 'opcache:reset'
+       end
+     end
+   end
+
+   desc "Show information about the php-opcode cache"
+   task :status do
+     # Due to nature of the output, run this in sequence vs in parallel (the default) with shortest possible wait time
+     on release_roles(:all), in: :sequence, wait: 1 do
+       within release_path do
+         execute :cachetool, 'opcache:status'
+       end
+     end
+   end
+ end
+end

data/lib/capistrano/tasks/magento.rake

@@ -399,30 +399,61 @@ namespace :magento do
       end
     end
 
-    # Internal command used to check if maintenance mode is neeeded and disable when zero-down deploy is possible
+    # Internal command used to check if maintenance mode is neeeded and disable when zero-down deploy is
+    # possible or when maintenance mode was previously enabled on the deploy target
     task :check do
       on primary fetch(:magento_deploy_setup_role) do
-        within release_path do
-          # Do not disable maintenance mode by default; require a postive id on database status output
-          disable_maintenance = false
+        maintenance_enabled = nil
+        disable_maintenance = false     # Do not disable maintenance mode in absence of positive release checks
+
+        if test "[ -d #{current_path} ]"
+          within current_path do
+            # If maintenance mode is already enabled, enable maintenance mode on new release and disable management to
+            # avoid disabling maintenance mode in the event it was manually enabled prior to deployment
+            info "Checking maintenance status..."
+            maintenance_status = capture :magento, 'maintenance:status', raise_on_non_zero_exit: false
+
+            if maintenance_status.to_s.include? 'maintenance mode is active'
+              info "Maintenance mode is currently active."
+              maintenance_enabled = true
+            else
+              info "Maintenance mode is currently inactive."
+              maintenance_enabled = false
+            end
+            info ""
+          end
+        end
+
+        # If maintenance is currently active, enable it on the newly deployed release
+        if maintenance_enabled
+          info "Enabling maintenance mode on new release to match active status of current release."
+          on release_roles :all do
+            within release_path do
+              execute :magento, 'maintenance:enable'
+            end
+          end
+          info ""
+        end
 
+        within release_path do
           # The setup:db:status command is only available in Magento 2.2.2 and later
           if not test :magento, 'setup:db:status --help >/dev/null 2>&1'
             info "Magento CLI command setup:db:status is not available. Maintenance mode will be used by default."
           else
             info "Checking database status..."
             # Check setup:db:status output and disable maintenance mode if all modules are up-to-date
-            database_status = capture :magento, 'setup:db:status' , raise_on_non_zero_exit: false
+            database_status = capture :magento, 'setup:db:status', raise_on_non_zero_exit: false
 
             if database_status.to_s.include? 'All modules are up to date'
               info "All modules are up to date. No database updates should occur during this release."
-              puts ""
+              info ""
               disable_maintenance = true
             else
               puts "      #{database_status.gsub("\n", "\n      ").sub("Run 'setup:upgrade' to update your DB schema and data.", "")}"
             end
 
             # Gather md5sums of app/etc/config.php on current and new release
+            info "Checking config status..."
             config_hash_release = capture :md5sum, "#{release_path}/app/etc/config.php"
             if test "[ -f #{current_path}/app/etc/config.php ]"
               config_hash_current = capture :md5sum, "#{current_path}/app/etc/config.php"
@@ -433,20 +464,27 @@ namespace :magento do
             # Output some informational messages showing the config.php hash values
             info "<release_path>/app/etc/config.php hash: #{config_hash_release.split(" ")[0]}"
             info "<current_path>/app/etc/config.php hash: #{config_hash_current.split(" ")[0]}"
-            info ""
 
             # If hashes differ, maintenance mode should not be disabled even if there are no database changes.
             if config_hash_release.split(" ")[0] != config_hash_current.split(" ")[0]
-              info "Configuration hashes do not match. Maintenance mode will be used by default."
+              info "Maintenance mode will not be disabled (config hashes differ)."
               disable_maintenance = false
             end
+            info ""
+          end
 
-            if disable_maintenance
-              info "Disabling use of maintenance mode for a zero-down deployment."
-              set :magento_deploy_maintenance, false
-            else
-              info "Maintenance mode usage will be enforced per :magento_deploy_maintenance (enabled by default)"
-            end
+          if maintenance_enabled or disable_maintenance
+            info "Disabling maintenance mode management..."
+          end
+
+          if maintenance_enabled
+            info "Maintenance mode was already active prior to deploy."
+            set :magento_deploy_maintenance, false
+          elsif disable_maintenance
+            info "There are no database updates or config changes. This is a zero-down deployment."
+            set :magento_deploy_maintenance, false
+          else
+            info "Maintenance mode usage will be enforced per :magento_deploy_maintenance (setting is #{fetch(:magento_deploy_maintenance).to_s})"
           end
         end
       end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: capistrano-magento2
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.8.1
 platform: ruby
 authors:
 - David Alger
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-05-19 00:00:00.000000000 Z
+date: 2018-06-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capistrano
@@ -70,11 +70,13 @@ files:
 - capistrano-magento2.gemspec
 - lib/capistrano-magento2.rb
 - lib/capistrano/magento2.rb
+- lib/capistrano/magento2/cachetool.rb
 - lib/capistrano/magento2/defaults.rb
 - lib/capistrano/magento2/deploy.rb
 - lib/capistrano/magento2/notifier.rb
 - lib/capistrano/magento2/pending.rb
 - lib/capistrano/magento2/version.rb
+- lib/capistrano/tasks/cachetool.rake
 - lib/capistrano/tasks/deploy.rake
 - lib/capistrano/tasks/magento.rake
 - lib/capistrano/tasks/notifier.rake