capistrano-sozo_magento2 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c002ac19f8884287b44aadbb34cf283f58b3d601482a636f43ad2de645815608
+  data.tar.gz: c0f0053697d68c11921417d67f0a1ed27a193322be4b2d892db8789c41f9084b
+SHA512:
+  metadata.gz: 946959dc1c096e3eb3417791c6c9662e450632a16acb08b4119821823692b8531933c0a6c9ad6adaf1131abef3211354a4ebaf06f3610b5a779965d234706259
+  data.tar.gz: 9075f0fdd973e7bde74ef954dd40220642016219693b910fade75a513279845c512c8421411d49c454d93926efebc24c473c5000b0749f55ae9f44c9fe5f0207

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/README.md

@@ -0,0 +1,34 @@
+#Capistrano::SozoMagento2
+
+## Installation
+It is advised to use bundler.
+
+1. Add the following to your projects `Gemfile`
+```
+gem 'capistrano-sozo-magento2'
+```
+2. Install
+```
+bundle install
+```
+
+## Usage
+Make sure the following lines are added to your project's `Capfile`:
+```
+# Load SOZO Magento tasks
+require 'capistrano/sozo-magento2'
+```
+We recommend putting them in the following location:
+```
+# Load DSL and set up stages
+require 'capistrano/setup'
+
+# Load SOZO Magento tasks
+require 'capistrano/sozo-magento2'
+
+# Include default deployment tasks
+require 'capistrano/deploy'
+
+require "capistrano/scm/git"
+install_plugin Capistrano::SCM::Git
+```

data/capistrano-sozo_magento.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "capistrano/sozo_magento2/version"
+
+Gem::Specification.new do |spec|
+    spec.name       = "capistrano-sozo_magento2"
+    spec.version    = Capistrano::SozoMagento2::VERSION
+    spec.authors    = ["Clive Walkden"]
+    spec.email      = ["clive@sozodesign.co.uk"]
+    spec.description    = %q{Magento 2 support for Capistrano 3.x in SOZO hosted environments}
+    spec.summary        = %q{Magento 2 support for Capistrano 3.x in SOZO hosted environments}
+    spec.homepage       = "https://github.com/sozodesign/capistrano-sozo-magento2"
+    spec.license        = "Proprietary"
+    
+    spec.files          = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(build|test|spec|features)/}) }
+    spec.bindir        = "bin"
+    spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+    spec.require_paths = ["lib"]
+    
+    spec.add_dependency "capistrano", "~> 3.9"
+    spec.add_dependency "dotenv", "~> 2.2"
+end

data/lib/capistrano/sozo_magento2.rb

@@ -0,0 +1,53 @@
+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'
+SSHKit.config.command_map[:magento] = "/usr/bin/env php -d memory_limit=1G -f bin/magento --"
+
+load File.expand_path('../tasks/sozo_magento2.rake', __FILE__)
+load File.expand_path('../tasks/deploy.rake', __FILE__)
+load File.expand_path('../tasks/composer.rake', __FILE__)
+load File.expand_path('../tasks/sozo.rake', __FILE__)
+load File.expand_path('../tasks/slack.rake', __FILE__)
+load File.expand_path('../tasks/db.rake', __FILE__)
+load File.expand_path('../tasks/fishpig.rake', __FILE__)
+load File.expand_path('../tasks/magento2.rake', __FILE__)
+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:updating', 'composer:install'
+after 'composer:install', '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'
+
+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: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:finished', "slack:deployed"
+after 'slack:deployed', "db:cleanup"
+
+after 'deploy:failed', "slack:failed"
+after 'slack:failed', 'magento:maintenance:disable'
+
+namespace :load do
+    task :defaults do
+        load 'capistrano/sozo_magento2/defaults.rb'
+    end
+end

data/lib/capistrano/sozo_magento2/defaults.rb

@@ -0,0 +1,39 @@
+set :linked_files, fetch(:linked_files, []).push()
+
+set :linked_dirs, fetch(:linked_dirs, []).push(
+    'magento/pub/media',
+    'magento/pub/sitemap',
+    'magento/var/amasty/geoip',
+    'magento/var/backups',
+    'magento/var/composer_home',
+    'magento/var/importexport',
+    'magento/var/import_history',
+    'magento/var/export',
+    'magento/var/log',
+    'magento/var/nginx',
+    'magento/var/report',
+    'magento/var/session', 
+    'magento/var/tmp',
+    'magento/wp/wp-content/uploads'
+)
+
+# Composer defaults
+set :composer_flags,                '--no-dev --optimize-autoloader --prefer-dist --no-interaction --no-suggest'
+set :composer_dev_flags,            '--prefer-dist --no-interaction --no-suggest'
+set :composer_require_flags,        '--update-no-dev --optimize-autoloader --prefer-dist --no-suggest'
+set :composer_require_dev_flags,    '--optimize-autoloader --prefer-dist'
+
+# DB defaults
+set :date_path,                     Time.now.strftime("%Y%m%d%H%M%S")
+set :backupdir,                     ->{ "#{fetch(:deploy_root)}/backups" }
+set :backupdirdate,                 ->{ "#{fetch(:backupdir)}/#{fetch(:date_path)}" }
+set :wp_db,                         ->{ ENV['WPDB_DATABASE'] }
+set :wp_backup,                     ->{ ENV['WPDB_BACKUP'] }
+set :keep_backups,                  ->{ ENV['CAP_KEEP_BACKUPS'] }
+
+# Slack defaults
+set :slack_channel,                 ENV['SLACK_CHANNEL']
+set :slack_webhook,                 'https://hooks.slack.com/services/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'
+
+# Deployment defaults
+set :confirm_deploy,                fetch(:magento_deploy_confirm, [])

data/lib/capistrano/sozo_magento2/version.rb

@@ -0,0 +1,5 @@
+module Capistrano
+    module SozoMagento2
+        VERSION = "1.0.0"
+    end
+end

data/lib/capistrano/tasks/composer.rake

@@ -0,0 +1,32 @@
+namespace :composer do
+    desc "Install the Composer dependencies"
+    task :install do
+        on roles :testing, :staging do
+            within release_path + 'magento/' do
+                execute :composer, "install", fetch(:composer_dev_flags)
+            end
+        end
+
+        on roles(:production) do
+            within release_path + 'magento/' do
+                execute :composer, "install", fetch(:composer_flags)
+            end
+        end
+    end
+
+    desc "Update the Composer dependencies"
+    task :update do
+        on roles :testing, :staging do
+            within release_path + 'magento/' do
+                execute :composer, "update", fetch(:composer_dev_flags)
+            end
+        end
+
+        on roles(:production) do
+            within release_path + 'magento/' do
+                execute :composer, "update", fetch(:composer_flags)
+            end
+        end
+    end
+
+end

data/lib/capistrano/tasks/db.rake

@@ -0,0 +1,50 @@
+namespace :db do
+    desc "Backup Magento 2 database"
+    task :backup do
+        # Backup the database with a timestamp
+        on roles :all do
+            # Check if the backup directory exists and if not create it
+            if test("[ ! -d #{fetch(:backupdir)} ]")
+                execute :mkdir, "-p", fetch(:backupdir)
+            end
+
+            # Backup using n98-magerun but don't include the logs or sessions data
+            info "Backing up Magento database."
+            execute :n98magerun, 'db:dump', "--root-dir='#{fetch(:mage_root)}'",
+                                            '--compression="gzip"',
+                                            '--strip="@log @sessions"',
+                                            '--force', "#{fetch(:backupdir)}/#{fetch(:date_path)}_m2.sql.gz"
+
+            if ENV['WPDB_BACKUP'] == "true"
+                info "Backing up WordPress database."
+                execute :n98magerun, 'db:dump', "--root-dir='#{fetch(:mage_root)}'",
+                                            '--compression="gzip"',
+                                            '--connection="wordpress"',
+                                            '--force', "#{fetch(:backupdir)}/#{fetch(:date_path)}_wp.sql.gz"
+            end
+        end
+    end
+
+    desc "Clean up old backups"
+    task :cleanup do
+        on roles :all do
+            backups = capture(:ls, "-x", "#{fetch(:backupdir)}").split
+            valid, invalid = backups.partition { |e| /^\d{14}/ =~ e }
+
+            info "Found #{valid.count} valid backups."
+
+            if (valid.count >= fetch(:keep_backups).to_i)
+                info "Keeping #{fetch(:keep_backups)} of #{valid.count} backups."
+                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
+                end
+            end
+        end
+    end
+end

data/lib/capistrano/tasks/deploy.rake

@@ -0,0 +1,49 @@
+namespace :deploy do
+    before :starting, :confirm_action do
+        if fetch(:magento_deploy_confirm).include? fetch(:stage).to_s
+            print "\e[0;31m      Are you sure you want to deploy to #{fetch(:stage).to_s}? [y/n] \e[0m"
+            proceed = STDIN.gets[0..0] rescue nil
+            exit unless proceed == 'y' || proceed == 'Y'
+        end
+    end
+
+
+    Rake::Task["cleanup"].clear_actions
+
+    desc "Clean up old releases"
+    task :cleanup do
+        on release_roles :all do |host|
+            releases = capture(:ls, "-x", releases_path).split
+            valid, invalid = releases.partition { |e| /^\d{14}$/ =~ e }
+            keep = fetch(:keep_releases).to_i
+
+            warn t(:skip_cleanup, host: host.to_s) if invalid.any?
+
+            if valid.count >= keep
+                info t(:keeping_releases, host: host.to_s, keep_releases: keep, releases: valid.count)
+                directories = (valid - valid.last(keep))
+                if directories.any?
+                    directories_str = directories.map do |release|
+                    releases_path.join(release)
+                    end.join(" ")
+                    execute :sudo, 'rm', "-rf", directories_str
+                    # TODO re-symlink the old directory
+                else
+                    info t(:no_old_releases, host: host.to_s, keep_releases: keep)
+                end
+            end
+        end
+    end
+
+    Rake::Task["failed"].clear_actions
+
+    desc "Failed deployment tasks"
+    task :failed do
+        on release_roles :all do |host|
+            on roles :production, :staging, :testing do
+                execute :rm, '-rf', release_path
+                info "Removed failed deployment"
+            end
+        end
+    end
+end

data/lib/capistrano/tasks/fishpig.rake

@@ -0,0 +1,16 @@
+namespace :fishpig do
+	namespace :setup do
+		desc "Install the Wordpress Fishpig theme"
+	    task :install_theme do
+	        on roles :all do |host|
+  				within release_path do
+  					execute :mkdir, "-p", "#{release_path}/magento/wp/wp-content/themes/fishpig"
+	            end
+	        end
+
+	        on roles(:all) do
+	            execute :sudo, 'cp', '-a', "#{release_path}/environments/global/wp/wp-content/themes/fishpig/.", "#{release_path}/magento/wp/wp-content/themes/fishpig/"
+	        end
+	    end
+	end
+end

data/lib/capistrano/tasks/magento2.rake

@@ -0,0 +1,247 @@
+namespace :magento do
+
+    namespace :cache do
+        desc 'Flush Magento cache storage'
+        task :flush do
+            on release_roles :all do
+                within release_path do
+                    execute :php, '-dmemory_limit=-1', '-f', 'magento/bin/magento', 'cache:flush'
+                end
+            end
+        end
+
+        desc 'Clean Magento cache by types'
+        task :clean do
+            on release_roles :all do
+                within release_path do
+                    execute :php, '-dmemory_limit=-1', '-f', 'magento/bin/magento', 'cache:clean'
+                end
+            end
+        end
+
+        desc 'Enable all Magento cache'
+        task :enable do
+            on release_roles :all do
+                within release_path do
+                    if File.exist?("magento/bin/magento")
+                        execute :php, '-dmemory_limit=-1', '-f', 'magento/bin/magento', 'cache:enable', 'config layout block_html collections reflection db_ddl eav config_integration config_integration_api full_page translate config_webservice'
+                    end
+                end
+            end
+        end
+
+        desc 'Disable Magento cache'
+        task :disable do
+            on release_roles :all do
+                within release_path do
+                    execute :php, '-dmemory_limit=-1', '-f', 'magento/bin/magento', 'cache:disable'
+                end
+            end
+        end
+
+        desc 'Check Magento cache enabled status'
+        task :status do
+            on release_roles :all do
+                within release_path do
+                    execute :php, '-dmemory_limit=-1', '-f', 'magento/bin/magento', 'cache:status'
+                end
+            end
+        end
+    end
+
+    namespace :composer do
+        desc 'Run composer install'
+        task :install do
+            on release_roles :all do
+                within release_path + 'magento/' do
+                    execute :composer, 'install --prefer-dist --no-interaction --no-dev 2>&1'
+                    execute :composer, "#{fetch(:composer_requirements)}"
+
+                    # Dir should be here if properly setup, but check for it anyways just in case
+                    if test "[ -d #{release_path}/update ]"
+                        execute :composer, 'install --prefer-dist --no-interaction --no-dev -d ./update 2>&1'
+                    else
+                        puts "\e[0;31m    Warning: ./update dir does not exist in repository!\n\e[0m\n"
+                    end
+                end
+            end
+        end
+    end
+
+    namespace :modules do
+        desc 'Make sure modules are enabled'
+        task :enable_all do
+            on release_roles :staging do
+                within release_path + 'magento/' do
+                    if test("[ -f #{release_path}/magento/app/etc/config.php ]")
+                        # Exists, carry on
+                    else
+                        execute :php, '-dmemory_limit=-1', '-f', 'bin/magento', "module:enable", "--all"
+                    end
+                end
+            end
+        end
+
+        desc 'Disable a module'
+        task 'disable', :module_name do |t, args|
+            on release_roles :staging do
+                within release_path + 'magento/' do
+                    execute :php, '-dmemory_limit=-1', '-f', 'bin/magento', "module:disable", args[:module_name]
+                end
+            end
+        end
+
+        desc 'Enable a module'
+        task 'enable', :module_name do |t, args|
+            on release_roles :staging do
+                within release_path + 'magento/' do
+                    execute :php, '-dmemory_limit=-1', '-f', 'bin/magento', "module:enable", args[:module_name], '-f'
+                    invoke 'magento:setup:upgrade'
+                    invoke 'magento:setup:static-content:deploy'
+                end
+            end
+        end
+    end
+
+    namespace :setup do
+
+        namespace :config do
+            desc 'Set a config item'
+            task :set do
+                on roles(:all) do
+                    within release_path + 'magento/' do
+                        ask(:parameter, '')
+                        ask(:value, '')
+                        execute :php, '-dmemory_limit=-1', '-f', 'magento/bin/magento', "setup:config:set", "--#{fetch(:parameter)}=#{fetch(:value)}", "--no-interaction"
+                    end
+                end
+            end
+        end
+
+        desc 'Composer install the deployed version of the composer file'
+        task :deployment do
+            on roles(:all) do
+                within release_path + 'magento/' do
+                    invoke 'composer:install'
+                end
+            end
+        end
+
+        desc 'Run the Magento upgrade process'
+        task :upgrade do
+            on release_roles :all do
+                within release_path do
+                    execute :php, '-dmemory_limit=-1', '-f', 'magento/bin/magento', 'setup:upgrade', '-n'
+                end
+            end
+        end
+
+        desc 'Sets proper permissions on application'
+        task :permissions do
+            on release_roles(:staging, :production) do
+                within release_path do
+                    execute :find, release_path, '-type d -print0 | sudo xargs --no-run-if-empty --null --max-procs=0 chmod 770'
+                    execute :find, release_path, '-type f -print0 | sudo xargs --no-run-if-empty --null --max-procs=0 chmod 660'
+                    execute :chmod, '-R g+s', release_path
+                    execute :chmod, '+x', "#{release_path}/magento/bin/magento"
+                end
+            end
+
+            on release_roles(:testing) do
+                within release_path do
+                    execute :find, release_path, '-type d -print0 | sudo xargs --no-run-if-empty --null --max-procs=0 chmod 777'
+                    execute :find, release_path, '-type f -print0 | sudo xargs --no-run-if-empty --null --max-procs=0 chmod 666'
+                    execute :chmod, '-R g+s', release_path
+                    execute :chmod, '+x', "#{release_path}/magento/bin/magento"
+                end
+            end
+        end
+
+        desc 'Sets proper permissions on application'
+        task :ownership do
+            on roles(:testing, :production) do
+                within release_path do
+                    execute :sudo, 'chown', "#{fetch(:username)}:#{fetch(:group)}", '-R', "#{release_path}"
+                    execute :sudo, 'chown', "#{fetch(:username)}:#{fetch(:group)}", '-R', "#{deploy_to}/shared"
+                end
+            end
+        end
+
+        namespace :di do
+            desc 'Runs dependency injection compilation routine'
+            task :compile do
+                on release_roles :all do
+                    within release_path do
+                        execute :php, '-dmemory_limit=-1', '-f', 'magento/bin/magento', 'setup:di:compile'
+                    end
+                end
+            end
+        end
+
+        namespace 'static-content' do
+            desc 'Deploys static view files'
+            task :deploy do
+                on release_roles :all do
+                    within release_path do
+                        execute :php, '-dmemory_limit=-1', '-f', 'magento/bin/magento', 'setup:static-content:deploy -f en_US en_GB -j6'
+                    end
+                end
+            end
+        end
+    end
+
+    # @TODO these below functions target the current directory which may not exist on first deployment
+    namespace :maintenance 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, '-dmemory_limit=-1', '-f', 'magento/bin/magento', 'maintenance:enable'
+                    end
+                end
+            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, '-dmemory_limit=-1', '-f', 'magento/bin/magento', 'maintenance:disable'
+                    end
+                end
+            end
+        end
+
+        desc 'Displays maintenance mode status'
+        task :status do
+            on release_roles :all do
+                within current_path do
+                    execute :php, '-dmemory_limit=-1', '-f', 'magento/bin/magento', 'maintenance:status'
+                end
+            end
+        end
+
+        desc 'Sets maintenance mode exempt IPs'
+        task 'allow-ips', :ip do |t, args|
+            on release_roles :all do
+                within current_path do
+                    execute :php, '-dmemory_limit=-1', '-f', 'magento/bin/magento', 'maintenance:allow-ips', args[:ip]
+                end
+            end
+        end
+    end
+
+    namespace :indexer do
+        desc 'Reindex data by all indexers'
+        task :reindex do
+            on release_roles :all do
+                within release_path do
+                    execute :php, '-dmemory_limit=-1', '-f', 'magento/bin/magento', 'indexer:reindex'
+                end
+            end
+        end
+    end
+
+end

data/lib/capistrano/tasks/provision.rake

@@ -0,0 +1,43 @@
+namespace :provision do
+    desc "Setup the shared directory content"
+    task :shared do
+        invoke 'sozo:upload:dirs'
+        invoke 'sozo:upload:files'
+    end
+
+    desc "Setup permissions on the account"
+    task :permissions do
+        on release_roles :all do
+            within release_path do
+                execute :sudo, 'chown', "#{fetch(:username)}:#{fetch(:group)}", "#{release_path}/"
+                execute :sudo, "find", "#{deploy_to}/shared", '-not \(', "-name '#{fetch(:username)}' -or -group '#{fetch(:group)}'", '\) -print0 | sudo xargs --no-run-if-empty --null --max-procs=0 chown', "#{fetch(:username)}:#{fetch(:group)}"
+                execute :sudo, "chmod", "770 #{release_path}/"
+                execute :sudo, "find", "#{release_path}/magento", '-type d -print0 | sudo xargs --no-run-if-empty --null --max-procs=0 chmod 770'
+                execute :sudo, "find", "#{release_path}/magento", '-type f -print0 | sudo xargs --no-run-if-empty --null --max-procs=0 chmod 660'
+
+                if test("[ -f #{release_path}/magento/bin/magento ]")
+                    execute :sudo, "chmod", "+x", "#{release_path}/magento/bin/magento"
+                end
+
+                execute :sudo, "find", "#{release_path}/magento", '-print0 | sudo xargs --no-run-if-empty --null --max-procs=0 chown', "#{fetch(:username)}:#{fetch(:group)}"
+
+                # Update symlinks permission
+                execute :sudo, "find", "#{release_path}/magento", '-type l', '-not \(', "-name '#{fetch(:username)}' -or -group '#{fetch(:group)}'", '\) -print0 | sudo xargs --no-run-if-empty --null --max-procs=0 chown', '-h', "#{fetch(:username)}:#{fetch(:group)}"
+            end
+        end
+    end
+
+    desc "Missing setup directory fix"
+    task :setup_dir do
+        on roles :app do
+            info ("Checking for setup directory - #{release_path}/magento/setup")
+
+            if test("[ -d #{release_path}/magento/setup/ ]")
+            else
+                upload! "#{fetch(:magento_dir)}/setup", "#{release_path}/magento/", recursive: true
+                invoke 'provision:permissions'
+            end
+        end
+    end
+
+end

data/lib/capistrano/tasks/server.rake

@@ -0,0 +1,18 @@
+namespace :server do
+    namespace :service do
+        desc "Restart the server services"
+        task :restart do
+            on roles(:gcloud, :aws, :cloud, :dedicated) do
+                within release_path do
+                    execute :sudo, "systemctl", "restart", "php-fpm"
+                    execute :sudo, "systemctl", "restart", "nginx"
+                end
+            end
+            on roles(:cluster) do
+                within release_path do
+                    execute :sudo, "nginx", "-s", "reload"
+                end
+            end
+        end
+    end
+end

data/lib/capistrano/tasks/slack.rake

@@ -0,0 +1,29 @@
+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)}"
+        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)}"
+        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)}"
+        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)}"
+        end
+    end
+end

data/lib/capistrano/tasks/sozo.rake

@@ -0,0 +1,143 @@
+namespace :sozo do
+
+    desc "Fix current directory if needed"
+    task :fix_current do
+        on roles(:all) do
+            releases = capture(:ls, "-x", releases_path).split
+            valid, invalid = releases.partition { |e| /^\d{14}$/ =~ e }
+
+            info "last release #{valid.last}"
+            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"
+        end
+    end
+
+    desc "Move database connection files into place"
+    task :db_conn do
+        on roles(:all) do
+            within release_path do
+                execute :cp, "#{release_path}/environments/#{fetch(:environment)}/app/etc/env.php", "#{release_path}/magento/app/etc/"
+            end
+        end
+    end
+
+    desc "Symlink the deployment to live"
+    task :symlink do
+        on roles :all do |host|
+            within release_path do
+                execute :rm, "-rf", "#{fetch(:mage_root)}", "&&", "ln", "-s", "#{release_path}/magento/", "#{fetch(:mage_root)}"
+
+                # Setup uploads
+                execute :ln, "-s", "#{fetch(:deploy_to)}/shared/magento/wp/wp-content/uploads", "#{release_path}/magento/wp/wp-content"
+
+                # Sitemap
+                execute :ln, "-sf", "#{fetch(:deploy_to)}/shared/magento/sitemap/", "#{release_path}/magento/"
+                execute :ln, "-sf", "#{fetch(:deploy_to)}/shared/magento/sitemap/", "#{release_path}/magento/pub/"
+            end
+        end
+
+        on roles :all do |host|
+            execute :ln, "-s", "#{fetch(:deploy_to)}/shared/magento/pub/.well-known", "#{release_path}/magento/pub/.well-known"
+        end
+
+        invoke! "sozo:fix_current"
+    end
+
+    desc "Production tasks"
+    task :optimise do
+        on roles :all do |host|
+            within release_path do
+                execute :rm, "-rf", "{.git*,*.sample,.ruby-version,*.md,Capfile,Gemfile*,deployment,dev,development,magento/*.sample}"
+
+                invoke!('provision:permissions')
+            end
+        end
+        on roles :production do
+            within release_path do
+                invoke 'magento:cache:enable'
+                invoke 'magento:cache:flush'
+                invoke 'magento:indexer:reindex'
+            end
+        end
+    end
+
+    namespace :config do
+        desc "Config file updates"
+        task :setup do
+            on roles(:all) do
+                within release_path do
+                    execute :cp, "#{release_path}/environments/#{fetch(:environment)}/pub/robots.txt", "#{release_path}/magento/pub/"
+                    execute :cp, "#{release_path}/environments/#{fetch(:environment)}/app/etc/env.php", "#{release_path}/magento/app/etc/"
+                    execute :cp, "#{release_path}/environments/#{fetch(:environment)}/pub/errors/local.xml", "#{release_path}/magento/pub/errors/"
+                    execute :cp, "#{release_path}/environments/#{fetch(:environment)}/wp/wp-config.php", "#{release_path}/magento/wp/wp-config.php"
+                end
+            end
+            on roles(:staging) do
+                within release_path do
+                    execute :cp, "#{release_path}/environments/#{fetch(:environment)}/.htpasswd", "#{release_path}/magento/.htpasswd"
+                end
+            end
+        end
+
+        desc "Git Check"
+        task :git do
+            run_locally do
+                git = capture('git rev-parse HEAD')
+                last = capture('git rev-parse HEAD~1')
+            end
+        end
+    end
+
+    desc "Check to see if the setup directory has content"
+    task :setup_check do
+        on roles(:all) do
+            f = "#{fetch(:deploy_to)}/.setup"
+
+            within release_path do
+                if test("[ -f #{f} ]")
+                    info "First Deploy File Exists"
+                    set :first_deploy, 1
+                end
+            end
+        end
+    end
+
+    desc 'Upload linked files and directories'
+    task :upload do
+        invoke 'sozo:upload:dirs'
+        invoke 'sozo:upload:files'
+    end
+
+    task :upload_files do
+        invoke 'sozo:upload:files'
+    end
+
+    task :upload_dirs do
+        invoke 'sozo:upload:dirs'
+    end
+
+    namespace :upload do
+
+        task :files do
+            on roles :app do
+                fetch(:linked_files, []).each do |file|
+                    upload! "#{file}", "#{shared_path}/#{file}"
+                end
+            end
+        end
+
+        task :dirs do
+            on roles :app do
+                fetch(:linked_dirs, []).each do |dir|
+                    info "DIR: #{dir}"
+                    upload! "#{dir}", "#{shared_path}/", recursive: true
+                end
+            end
+        end
+
+    end
+
+    before 'sozo:upload', 'deploy:check:make_linked_dirs'
+
+end

data/lib/capistrano/tasks/wordpress.rake

@@ -0,0 +1,24 @@
+namespace :wordpress do
+
+    desc "Install the SOZO MU plugins to stop frontend output when logged into WordPress"
+    task :sozo_mu do
+        on roles(:all) do
+            execute :cp, '-a', "#{release_path}/environments/global/wp/wp-content/mu-plugins/.", "#{release_path}/magento/wp/wp-content/mu-plugins/"
+        end
+    end
+
+    desc "Tidy up the installation (remove un-needed files)"
+    task :cleanup do
+        on roles :all do |host|
+            within release_path + "magento/wp/" do
+                info "Removing default unused WordPress Plugins and Themes"
+                execute :wp, 'plugin', 'delete', 'hello'
+                execute :wp, 'theme', 'delete', 'twentyseventeen'
+                execute :wp, 'theme', 'delete', 'twentynineteen'
+                execute :wp, 'theme', 'delete', 'twentytwenty'
+                execute :rm, '-f', 'readme.html'
+            end
+        end
+    end
+
+end

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification
+name: capistrano-sozo_magento2
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Clive Walkden
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-02-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: capistrano
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !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
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE
+- README.md
+- capistrano-sozo_magento.gemspec
+- lib/capistrano/sozo_magento2.rb
+- lib/capistrano/sozo_magento2/defaults.rb
+- lib/capistrano/sozo_magento2/version.rb
+- lib/capistrano/tasks/composer.rake
+- lib/capistrano/tasks/db.rake
+- lib/capistrano/tasks/deploy.rake
+- lib/capistrano/tasks/fishpig.rake
+- lib/capistrano/tasks/magento2.rake
+- lib/capistrano/tasks/provision.rake
+- lib/capistrano/tasks/server.rake
+- lib/capistrano/tasks/slack.rake
+- lib/capistrano/tasks/sozo.rake
+- lib/capistrano/tasks/sozo_magento2.rake
+- lib/capistrano/tasks/wordpress.rake
+homepage: https://github.com/sozodesign/capistrano-sozo-magento2
+licenses:
+- Proprietary
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: Magento 2 support for Capistrano 3.x in SOZO hosted environments
+test_files: []