capistrano-sozo_magento2 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 067f69be7940139b39853f161c2cdccfaf59bc3efe7c889a3c4282b7a6c91191
-  data.tar.gz: b235fcf83c747dcdb843e64bdddd44df30366bdc84a363a90e0425571b8a04f4
+  metadata.gz: 57d66531993d668be8a75fef480862d07035dcf0750f7831912f71bc749d5201
+  data.tar.gz: 5032e4073c3eed84ce9030206c0e9c3cfbdfbf29e8d12d1968802f48df3fa42b
 SHA512:
-  metadata.gz: 4015c5c7f9cf4be49d35cda7732803d4e7bd240c7d4b5f85470c8a05587c452fcb48452509561b9d55ef3fa0330ce41582c63f965e427addc5590001c64f9360
-  data.tar.gz: 60fc48f2e8a1b5437749978e887eec9d7ff28601a27742199826ba9a60101931ace0b6bed9ed44d91858561b79c6bd90c1fe52eb7e0989efbcc47668ae984f35
+  metadata.gz: 3550c64e691e692c9e896078f269ecc8ef5035b3ce4c110df0020aa47cdd6d6c5e3b1bb47b58f06ef57db16b57a96510d6ac8509713fd3ff4f299519810842f1
+  data.tar.gz: 2e6f979c104a3c2d175894d0cc3e0ad08531abdc9bbfb8faa19cc2714c4d0e92bf18a2c2c6fa042f7a30a8228842167ea44ece6350482a4d886d2e344fedce98

data/CHANGELOG.md

@@ -21,6 +21,23 @@ Given a version number MAJOR.MINOR.PATCH, increment the:
 
 ## [Unreleased]
 
+## [v1.2.0] - 2020-03-25
+### Added
+- New variable `clear_failures` for future use.
+- New Slack class to control the message template.
+
+### Changed
+- Updated Slack messaging to newer version to future proof.
+- Current directory fix now updates MAGE_ROOT as well.
+- Standardised tasks order based on key capistrano core tasks.
+
+### Removed
+- Removed dotenv from the gem.
+
+### Fixed
+- Fix issue when there were less than CAP_KEEP_BACKUPS available.
+
+
 ## [v1.1.0] - 2020-02-24
 ### Added
 - Added defaults for the :wp_backup, :keep_backups and :slack_channel instead of using ENV's

data/README.md

@@ -7,7 +7,7 @@ It is advised to use bundler.
 
 1. Add the following to your projects `Gemfile`
 ```
-gem "capistrano-sozo_magento2", "~> 1.1"
+gem "capistrano-sozo_magento2", "~> 1.2"
 ```
 2. Install
 ```

data/capistrano-sozo_magento.gemspec

@@ -17,7 +17,8 @@ Gem::Specification.new do |spec|
     spec.bindir        = "bin"
     spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
     spec.require_paths = ["lib"]
+
+    spec.required_ruby_version = '>= 2.5.3'
     
     spec.add_dependency "capistrano", "~> 3.9"
-    spec.add_dependency "dotenv", "~> 2.2"
 end

data/lib/capistrano/sozo_magento2.rb

@@ -1,6 +1,4 @@
 require 'date'
-require 'dotenv'
-Dotenv.load
 
 SSHKit.config.command_map[:composer] = 'php -dmemory_limit=-1 -f /usr/local/bin/composer'
 SSHKit.config.command_map[:n98magerun] = '/usr/local/bin/n98-magerun'
@@ -19,33 +17,33 @@ load File.expand_path('../tasks/server.rake', __FILE__)
 load File.expand_path('../tasks/wordpress.rake', __FILE__)
 
 after 'deploy:updating', 'composer:install'
-after 'composer:install', 'magento:setup:permissions'
+after 'deploy:updating', 'magento:setup:permissions'
 
 before 'deploy:updated', 'slack:deploying'
-after 'slack:deploying', 'db:backup'
-after 'db:backup', 'sozo:config:setup'
-after 'sozo:config:setup', 'magento:maintenance:enable'
+before 'deploy:updated', 'db:backup'
+before 'deploy:updated', 'sozo:config:setup'
+before 'deploy:updated', 'magento:maintenance:enable'
 
 after 'deploy:updated', 'provision:setup_dir'
-after 'provision:setup_dir', 'magento:setup:upgrade'
-after 'magento:setup:upgrade', 'magento:setup:di:compile'
-after 'magento:setup:di:compile', 'magento:setup:static-content:deploy'
-after 'magento:setup:static-content:deploy', 'provision:permissions'
+after 'deploy:updated', 'magento:setup:upgrade'
+after 'deploy:updated', 'magento:setup:di:compile'
+after 'deploy:updated', 'magento:setup:static-content:deploy'
+after 'deploy:updated', 'provision:permissions'
 
 after 'deploy:finishing', 'sozo:symlink'
-after 'sozo:symlink', 'fishpig:setup:install_theme' 
-after 'fishpig:setup:install_theme', 'wordpress:sozo_mu'
-after 'wordpress:sozo_mu', 'wordpress:cleanup'
-after 'wordpress:cleanup', 'sozo:optimise'
-after 'sozo:optimise', 'server:service:restart'
-after 'server:service:restart', 'magento:maintenance:disable'
+after 'deploy:finishing', 'fishpig:setup:install_theme' 
+after 'deploy:finishing', 'wordpress:sozo_mu'
+after 'deploy:finishing', 'wordpress:cleanup'
+after 'deploy:finishing', 'sozo:optimise'
+after 'deploy:finishing', 'server:service:restart'
+after 'deploy:finishing', 'magento:maintenance:disable'
 
 after 'deploy:finished', "slack:deployed"
-after 'slack:deployed', "db:cleanup"
+after 'deploy:finished', "db:cleanup"
 
 after 'deploy:failed', "slack:failed"
-after 'slack:failed', "sozo:fix_current"
-after 'sozo:fix_current', 'magento:maintenance:disable'
+after 'deploy:failed', "sozo:fix_current"
+after 'deploy:failed', 'magento:maintenance:disable'
 
 namespace :load do
     task :defaults do

data/lib/capistrano/sozo_magento2/defaults.rb

@@ -35,4 +35,8 @@ set :slack_channel,                 fetch(:slack_channel, '#deployments')
 set :slack_webhook,                 'https://hooks.slack.com/services/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'
 
 # Deployment defaults
-set :magento_deploy_confirm_roles,  fetch(:magento_deploy_confirm_roles, [])
+set :magento_deploy_confirm_roles,  fetch(:magento_deploy_confirm_roles, [])
+
+# Other defaults (for future use)
+# Clear or leave the failed deployment dirs
+set :clear_failures,                fetch(:clear_failures, true)

data/lib/capistrano/sozo_magento2/slack.rb

@@ -0,0 +1,64 @@
+require 'json'
+
+include Capistrano::DSL
+
+module SozoMagento2
+    module Slack
+        def message_hash
+            {
+                "channel" => fetch(:slack_channel), 
+                "username" => "SOZO Deploy Bot", 
+                "icon_emoji" => ":satellite:", 
+                "color" => "good", 
+                "blocks" => [
+                    {
+                        "type" => "header", 
+                        "text" => {
+                            "type" => "plain_text", 
+                            "text" => "Deployment Process Begun"
+                        }
+                    }, 
+                    {
+                        "type" => "divider"
+                    }, 
+                    { 
+                        "type" => "section", 
+                        "text" => {
+                            "type" => "mrkdwn", 
+                            "text" => "#{fetch(:url)} is being Deployed"
+                        }, 
+                        "accessory" => {
+                            "type" => "button", 
+                            "style" => "primary", 
+                            "text" => {
+                                "type" => "plain_text", 
+                                "text" => "Visit Site", 
+                                "emoji" => true
+                            },
+                            "value" => "click_me_123", 
+                            "url" => fetch(:url), 
+                            "action_id" => "button-action"
+                        }
+                    }, 
+                    {
+                        "type" => "section", 
+                        "fields" => [
+                            {
+                                "type" => "mrkdwn", 
+                                "text" => "*Branch:*\n#{fetch(:branch)}"
+                            }, 
+                            {
+                                "type" => "mrkdwn", 
+                                "text" => "*Developer:*\n#{fetch(:local_user)}"
+                            }, 
+                            {
+                                "type" => "mrkdwn", 
+                                "text" => "*Environment:*\n#{fetch(:environment)}"
+                            }
+                        ]
+                    }
+                ]
+            }
+        end
+    end
+end

data/lib/capistrano/sozo_magento2/version.rb

@@ -1,5 +1,5 @@
 module Capistrano
     module SozoMagento2
-        VERSION = "1.1.0"
+        VERSION = "1.2.0"
     end
 end

data/lib/capistrano/tasks/db.rake

@@ -49,11 +49,11 @@ namespace :db do
                 files = (valid - valid.last(fetch(:keep_backups).to_i)).map do |backup|
                     "#{fetch(:backupdir)}" + "/" + (backup).to_s
                 end
-            end
 
-            if files.any?
-                files.each_slice(100) do |files_batch|
-                    execute :rm, "-f", *files_batch
+                if files.any?
+                    files.each_slice(100) do |files_batch|
+                        execute :rm, "-f", *files_batch
+                    end
                 end
             end
         end

data/lib/capistrano/tasks/slack.rake

@@ -1,29 +1,46 @@
+require 'capistrano/sozo_magento2/slack'
+require 'json'
+
+include SozoMagento2::Slack
+
 namespace :slack do
     desc "Post to channel that the site has been deployed"
     task :deployed do
         on roles(:all) do
-            execute :curl, "-X", "POST", "--data-urlencode", "'payload={\"channel\": \"#{fetch(:slack_channel)}\", \"username\": \"SOZO Deploy Bot\", \"pretext\": \"Deployment Successful\", \"text\": \"<#{fetch(:url)}> Deployed\", \"icon_emoji\": \":satellite:\", \"color\": \"good\", \"fields\": [{ \"title\": \"Branch\", \"value\": \"#{fetch(:branch)}\", \"short\": \"true\" },{ \"title\": \"Environment\", \"value\": \"#{fetch(:environment)}\", \"short\": \"true\" }]}'", "#{fetch(:slack_webhook)}"
+            slack_template = message_hash
+            slack_template['blocks'][0]['text']['text'] = ":smile: Deployment Successful :smile:"
+            slack_template['blocks'][2]['text']['text'] = "#{fetch(:url)} Deployed."
+            execute :curl, "--request", "POST", "--header", "'Content-Type: application/json'", "--data", "'" + JSON.generate(slack_template) + "'", fetch(:slack_webhook)
         end
     end
 
     desc "Post to channel that the site is being deployed"
     task :deploying do
         on roles(:all) do
-            execute :curl, "-X", "POST", "--data-urlencode", "'payload={\"channel\": \"#{fetch(:slack_channel)}\", \"username\": \"SOZO Deploy Bot\", \"pretext\": \"Deployment Process Begun\", \"text\": \"<#{fetch(:url)}> is being Deployed\", \"icon_emoji\": \":satellite:\", \"color\": \"warning\", \"fields\": [{ \"title\": \"Branch\", \"value\": \"#{fetch(:branch)}\", \"short\": \"true\" },{ \"title\": \"Environment\", \"value\": \"#{fetch(:environment)}\", \"short\": \"true\" }]}'", "#{fetch(:slack_webhook)}"
+            slack_template = message_hash
+            slack_template['blocks'][0]['text']['text'] = ":crossed_fingers: Deployment Process Begun :crossed_fingers:"
+            slack_template['blocks'][2]['text']['text'] = "#{fetch(:url)} is being Deployed."
+            execute :curl, "--request", "POST", "--header", "'Content-Type: application/json'", "--data", "'" + JSON.generate(slack_template) + "'", fetch(:slack_webhook)
         end
     end
 
     desc "Post to channel that something is happening"
     task :message do
         on roles(:all) do
-            execute :curl, "-X", "POST", "--data-urlencode", "'payload={\"channel\": \"#{fetch(:slack_channel)}\", \"username\": \"SOZO Deploy Bot\", \"pretext\": \"Next stage\", \"text\": \"<#{fetch(:url)}> is stage change\", \"icon_emoji\": \":satellite:\", \"color\": \"good\", \"fields\": [{ \"title\": \"Branch\", \"value\": \"#{fetch(:branch)}\", \"short\": \"true\" },{ \"title\": \"Environment\", \"value\": \"#{fetch(:environment)}\", \"short\": \"true\" }]}'", "#{fetch(:slack_webhook)}"
+            slack_template = message_hash
+            slack_template['blocks'][0]['text']['text'] = "Message"
+            slack_template['blocks'][2]['text']['text'] = "Some message to go here"
+            execute :curl, "--request", "POST", "--header", "'Content-Type: application/json'", "--data", "'" + JSON.generate(slack_template) + "'", fetch(:slack_webhook)
         end
     end
 
     desc "Post to channel that the site deployment has failed"
     task :failed do
         on roles(:all) do
-            execute :curl, "-X", "POST", "--data-urlencode", "'payload={\"channel\": \"#{fetch(:slack_channel)}\", \"username\": \"SOZO Deploy Bot\", \"pretext\": \"Deployment Process Failed\", \"text\": \"<#{fetch(:url)}> deployment has failed\", \"icon_emoji\": \":satellite:\", \"color\": \"warning\", \"fields\": [{ \"title\": \"Branch\", \"value\": \"#{fetch(:branch)}\", \"short\": \"true\" },{ \"title\": \"Environment\", \"value\": \"#{fetch(:environment)}\", \"short\": \"true\" }]}'", "#{fetch(:slack_webhook)}"
+            slack_template = message_hash
+            slack_template['blocks'][0]['text']['text'] = ":boom: Deployment Process Failed :boom:"
+            slack_template['blocks'][2]['text']['text'] = "#{fetch(:url)} deployment has failed."
+            execute :curl, "--request", "POST", "--header", "'Content-Type: application/json'", "--data", "'" + JSON.generate(slack_template) + "'", fetch(:slack_webhook)
         end
     end
 end

data/lib/capistrano/tasks/sozo.rake

@@ -10,6 +10,7 @@ namespace :sozo do
             info "Creating symlink from #{fetch(:deploy_to)}/releases/#{valid.last} to #{fetch(:deploy_to)}/current"
 
             execute :ln, "-sf", "#{fetch(:deploy_to)}/releases/#{valid.last}", "#{fetch(:deploy_to)}/current"
+            execute :ln, "-sf", "#{fetch(:deploy_to)}/releases/#{valid.last}", "#{fetch(:mage_root)}"
         end
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: capistrano-sozo_magento2
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Clive Walkden
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-02-24 00:00:00.000000000 Z
+date: 2021-03-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capistrano
@@ -24,20 +24,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.9'
-- !ruby/object:Gem::Dependency
-  name: dotenv
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.2'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.2'
 description: Magento 2 support for Capistrano 3.x in SOZO hosted environments
 email:
 - clive@sozodesign.co.uk
@@ -54,6 +40,7 @@ files:
 - capistrano-sozo_magento.gemspec
 - lib/capistrano/sozo_magento2.rb
 - lib/capistrano/sozo_magento2/defaults.rb
+- lib/capistrano/sozo_magento2/slack.rb
 - lib/capistrano/sozo_magento2/version.rb
 - lib/capistrano/tasks/composer.rake
 - lib/capistrano/tasks/db.rake
@@ -78,7 +65,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.5.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="