capistrano-sozo_magento2 1.3.1 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1b1790fdeb92ff66403be9ccd3f3977ad51383a401deeb09d073e927f1dff17f
-  data.tar.gz: 38e34911ea738869e55fe0d0fe5b5e6baad4207a7af91fbbbcae8a615f1b6208
+  metadata.gz: ab55bf423e1766857aeff0a542b1b2657e35a6401d7dda6469404df07060d90c
+  data.tar.gz: 43a54ea1407c899c1f9545c6cb6703977ac70690053f6efdd61d18024eb933dd
 SHA512:
-  metadata.gz: 81a868673b25d2ee710b90dba9be7b478b48dbe80b5c238dcdbe493e6255d6647202b619b6bb0c9d71c2c34632d7757450252193e1f218e571dba14dd3dd9e00
-  data.tar.gz: 3125ca35d6f5e0b0ef62cf3283fdf9f97935e5ff3a56268ac8c52c231ff7c36459084f9d72a174a5b60b073a9dd9fe557250e4d81bcede40f30852d38e688547
+  metadata.gz: 0d068c92ebcd093a49b7ca63685a0d27e898aa3884d5ecd9a5ea9b7c339eae83c700eccaab3b5ac959b2c12d20cfae7d7526376365045996e8d88e5a38802dff
+  data.tar.gz: 42b84543c461b955f32cff824750a12b06ed8de464c5b6227915440b28f732a3d22355a0066bd38c45f425b16c58ecaa11e4d7ea6f40cbd7d078f15a5d5e39dd

data/.yardopts

@@ -0,0 +1,5 @@
+--protected
+--no-private
+-
+CHANGELOG.md
+LICENSE

data/CHANGELOG.md

@@ -22,6 +22,20 @@ Given a version number MAJOR.MINOR.PATCH, increment the:
 ## [Unreleased]
 
 
+## [v1.4.0] - 2021-08-03
+### Added
+- New `deploy:check` info output with key information displayed.
+- Magento Cron control now included in the deployment methods with `:handle_cron` option (default false).
+- New check `sozo:git:check` to see if the branch exists in the repository before deployment begins.
+- Documented code with Yardoc
+
+### Changed
+- Delay added (3 seconds) before trying to delete a failed deployment to allow file or disk activity to finish.
+- Added sudo to failed deployments release deleting.
+- Changed maintenance mode path to use the `deploy_root` location from `current_path`
+- Checked all boolean values against string "true" or "false" using .to_s == 'true'
+
+
 ## [v1.3.1] - 2021-07-29
 ### Changed
 - Changed ENV options for WordPress plugins and themes removal.

data/lib/capistrano/sozo_magento2.rb

@@ -17,12 +17,16 @@ load File.expand_path('../tasks/provision.rake', __FILE__)
 load File.expand_path('../tasks/server.rake', __FILE__)
 load File.expand_path('../tasks/wordpress.rake', __FILE__)
 
+after 'deploy:check', 'sozo:git:check'
+after 'deploy:check', 'sozo:info'
+
 after 'deploy:updating', 'composer:install'
 after 'deploy:updating', 'magento:patches:apply'
 after 'deploy:updating', 'magento:setup:permissions'
 
 before 'deploy:updated', 'slack:deploying'
 before 'deploy:updated', 'db:backup'
+before 'deploy:updated', 'magento:cron:remove'
 before 'deploy:updated', 'sozo:config:setup'
 before 'deploy:updated', 'magento:maintenance:enable'
 
@@ -39,12 +43,15 @@ after 'deploy:finishing', 'wordpress:cleanup'
 after 'deploy:finishing', 'sozo:optimise'
 after 'deploy:finishing', 'server:service:restart'
 after 'deploy:finishing', 'magento:maintenance:disable'
+after 'deploy:finishing', 'magento:cron:install'
 
 after 'deploy:finished', "slack:deployed"
 after 'deploy:finished', "db:cleanup"
 
 after 'deploy:failed', "sozo:fix_current"
 after 'deploy:failed', "slack:failed"
+after 'deploy:failed', 'magento:cron:remove'
+after 'deploy:failed', 'magento:cron:install'
 after 'deploy:failed', 'magento:maintenance:disable'
 
 namespace :load do

data/lib/capistrano/sozo_magento2/defaults.rb

@@ -42,6 +42,9 @@ set :slack_webhook,                 'https://hooks.slack.com/services/T06K8GR2L/
 # Deployment defaults
 set :magento_deploy_confirm_roles,  fetch(:magento_deploy_confirm_roles, [])
 
+# Handle removing and installing of cron tasks?
+set :handle_cron,                   fetch(:handle_cron, false)
+
 # Other defaults (for future use)
 # Clear or leave the failed deployment dirs
 set :clear_failures,                fetch(:clear_failures, true)

data/lib/capistrano/sozo_magento2/info.rb

@@ -0,0 +1,64 @@
+require "capistrano/doctor/output_helpers"
+
+include Capistrano::DSL
+
+# @author Clive Walkden
+module SozoMagento2
+    # Class to out key information at the end of the deploy:check command
+    module Info
+        # Class to out key information at the end of the deploy:check command
+        class Info
+            WHITELIST = %i(
+                branch
+                environment
+                handle_cron
+                slack_channel
+                url
+              ).freeze
+              private_constant :WHITELIST
+            
+            include Capistrano::Doctor::OutputHelpers
+
+            # Initialize the class with access to env data
+            def initialize(env=Capistrano::Configuration.env)
+                @env = env
+            end
+
+            # Output the key information in the CLI
+            def call
+                title("Deployment Info")
+
+                values = inspect_all_values
+
+                table(values.keys.sort_by(&:to_s)) do |key, row|
+                    row.yellow if values[key] == "\"production\""
+                    row << key.inspect
+                    row << ''
+                    row << values[key]
+                end
+                
+                puts("")
+                warning("Make sure you check these values before deploying!")
+                puts("")
+            end
+
+            private
+
+            attr_reader :env
+
+            # Read all variables in
+            def variables
+                env.variables
+            end
+
+            # Only include variables in the whitelist
+            def inspect_all_values
+                variables.keys.each_with_object({}) do |key, inspected|
+                    if WHITELIST.include?(key)
+                        inspected[key] = variables.peek(key).inspect
+                    end
+                end
+            end
+        end
+    end
+end

data/lib/capistrano/sozo_magento2/slack.rb

@@ -2,8 +2,12 @@ require 'json'
 
 include Capistrano::DSL
 
+# @author Clive Walkden
 module SozoMagento2
+    # Slack message template
     module Slack
+        # Slack message template
+        # @return [String] the template hash
         def message_hash
             {
                 "channel" => fetch(:slack_channel), 

data/lib/capistrano/sozo_magento2/version.rb

@@ -1,5 +1,9 @@
+# @author Clive Walkden
 module Capistrano
+    # The plugin version number
     module SozoMagento2
-        VERSION = "1.3.1"
+        # The plugin version number
+        # @return [String] The gem version number
+        VERSION = "1.4.0"
     end
 end

data/lib/capistrano/tasks/composer.rake

@@ -1,3 +1,4 @@
+# Composer namespace
 namespace :composer do
     desc "Install the Composer dependencies"
     task :install do

data/lib/capistrano/tasks/db.rake

@@ -28,7 +28,7 @@ namespace :db do
     task :wp_db_backup do
         # Backup the database with a timestamp
         on roles :all do
-            if (fetch(:wp_backup) == "true")
+            if (fetch(:wp_backup).to_s == "true")
                 info "Backing up WordPress database."
                 execute :n98magerun, 'db:dump', "--root-dir='#{fetch(:mage_root)}'",
                                             '--compression="gzip"',

data/lib/capistrano/tasks/deploy.rake

@@ -41,7 +41,12 @@ namespace :deploy do
     task :failed do
         on release_roles :all do |host|
             on roles :production, :staging, :testing do
-                execute :rm, '-rf', release_path
+                # Hold for a few seconds to make sure all disk related actions have completed
+                info "Waiting for file / disk writing to complete"
+                sleep(3)
+                # Added sudo to make sure we can clear everything
+                info "Removing failed deployment"
+                execute :sudo, 'rm', '-rf', release_path
                 info "Removed failed deployment"
             end
         end

data/lib/capistrano/tasks/magento2.rake

@@ -1,5 +1,31 @@
 namespace :magento do
 
+    namespace :cron do
+        desc 'Remove cron'
+        task :remove do
+            on release_roles :all do
+                info "Disabling cron"
+                if (fetch(:handle_cron).to_s == "true")
+                    execute :php, '-f', "#{fetch(:deploy_root)}/magento2/bin/magento", 'cron:remove'
+                else
+                    info "Cron not controlled by capistrano"
+                end
+            end
+        end
+
+        desc 'Install cron'
+        task :install do
+            on release_roles :all do
+                info "Enabling cron"
+                if (fetch(:handle_cron).to_s == "true")
+                    execute :php, '-f', "#{fetch(:deploy_root)}/magento2/bin/magento", 'cron:install', '-d'
+                else
+                    info "Cron not controlled by capistrano"
+                end
+            end
+        end
+    end
+
     namespace :cache do
         desc 'Flush Magento cache storage'
         task :flush do
@@ -195,22 +221,14 @@ namespace :magento do
         desc 'Enable maintenance mode'
         task :enable do
             on release_roles :all do
-                within current_path do
-                    if File.exist?("magento/bin/magento")
-                        execute :php, '-f', 'magento/bin/magento', 'maintenance:enable'
-                    end
-                end
+                execute :php, '-f', "#{fetch(:deploy_root)}/magento2/bin/magento", 'maintenance:enable'
             end
         end
 
         desc 'Disable maintenance mode'
         task :disable do
             on release_roles :all do
-                within current_path do
-                    if File.exist?("magento/bin/magento")
-                        execute :php, '-f', 'magento/bin/magento', 'maintenance:disable'
-                    end
-                end
+                execute :php, '-f', "#{fetch(:deploy_root)}/magento2/bin/magento", 'maintenance:disable'
             end
         end
 

data/lib/capistrano/tasks/sozo.rake

@@ -1,5 +1,32 @@
+require 'capistrano/sozo_magento2/info'
+
+include SozoMagento2::Info
+
 namespace :sozo do
 
+    desc "Info"
+    task :info do
+        on roles(:all) do
+            SozoMagento2::Info::Info.new.call
+        end
+    end
+
+    namespace :git do
+        desc "Git branch Check"
+        task :check do
+            on roles(:all) do
+                check = capture(:git, 'ls-remote', '--heads', fetch(:repo_url), fetch(:branch), '|', 'wc', '-l')
+
+                if check.to_i == 1
+                    info "Branch is available for deployment."
+                else
+                    error "Branch does not exist in git repository, have you pushed your changes?"
+                    exit 1
+                end
+            end
+        end
+    end
+
     desc "Fix current directory if needed"
     task :fix_current do
         on roles(:all) do
@@ -64,7 +91,6 @@ namespace :sozo do
         end
         on roles :production do
             within release_path do
-                invoke 'magento:cache:enable'
                 invoke 'magento:cache:flush'
                 invoke 'magento:indexer:reindex'
             end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: capistrano-sozo_magento2
 version: !ruby/object:Gem::Version
-  version: 1.3.1
+  version: 1.4.0
 platform: ruby
 authors:
 - Clive Walkden
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-07-30 00:00:00.000000000 Z
+date: 2021-08-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capistrano
@@ -32,6 +32,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".yardopts"
 - BUILD.md
 - CHANGELOG.md
 - Gemfile
@@ -40,6 +41,7 @@ files:
 - capistrano-sozo_magento.gemspec
 - lib/capistrano/sozo_magento2.rb
 - lib/capistrano/sozo_magento2/defaults.rb
+- lib/capistrano/sozo_magento2/info.rb
 - lib/capistrano/sozo_magento2/slack.rb
 - lib/capistrano/sozo_magento2/version.rb
 - lib/capistrano/tasks/composer.rake