capistrano-magento2 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 42102b43347b2087e0383a7aa039639edc4bac3a
-  data.tar.gz: 17044e8f48813b2abf403528ea989d50a6dcb94e
+  metadata.gz: b2b0a1e41429c327605f46c5394844088388a3c0
+  data.tar.gz: 8cd6ab0068b94dc74ccd32a8286206088c61b35b
 SHA512:
-  metadata.gz: c08fce018ef60b42f9932268855b9152d6edff2c0f539c69b0c6564daa814e645defafca1c742b87abef45e357bc8390abd592c3bc11bec03e35f93e41f027f4
-  data.tar.gz: 1a11d0296476492af459c95c41fe98fe9a80f4ea63bcf00eee559c8ea117bfb8aaa0f707df6ceac60a8b32d5a09423e719d3dc3dc83d512f776e35ba04b44a84
+  metadata.gz: be3f2be47149eb0a34353c82cbe3526907c918f4d94baea712d7a08be2c81cbc7679e5718e17ca0562cd505f7042fd2418ae813f13754b9f195c6ef1578b4cb2
+  data.tar.gz: ba9baf7b4ea8f6cbd90d921341aa22344302a1deb35c41c35ea6b884d831b53543302e34fbd68f2e14d30c51ca84a9423b6eaffa06a6a7c9c8f2693b45280937

data/README.md

@@ -20,11 +20,26 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+Install Capistrano in your Magento project:
+
+    $ cd <project_root>
+    $ mkdir -p tools/cap
+    $ cd ./tools/cap
+    $ cap install
+
+Update your project `Capfile` to look like the following:
+
+```ruby
+# Load DSL and set up stages
+require 'capistrano/setup'
+
+# Load Magento deployment tasks
+require 'capistrano/magento'
+```
 
 ## Development
 
-After checking out the repo, run `bundle install` to install dependencies. Then, run `rake spec` to run the tests.
+After checking out the repo, run `bundle install` to install dependencies.
 
 To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `capistrano/magento2/version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 

data/Rakefile

@@ -8,8 +8,3 @@
  ##
 
 require 'bundler/gem_tasks'
-require 'rspec/core/rake_task'
-
-RSpec::Core::RakeTask.new(:spec)
-
-task :default => :spec

data/capistrano-magento2.gemspec

@@ -9,11 +9,11 @@
 
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'capistrano/magento/version'
+require 'capistrano/magento2/version'
 
 Gem::Specification.new do |spec|
   spec.name          = 'capistrano-magento2'
-  spec.version       = Capistrano::Magento::VERSION
+  spec.version       = Capistrano::Magento2::VERSION
   spec.authors       = ['David Alger']
   spec.email         = ['davidmalger@gmail.com']
 
@@ -28,8 +28,8 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_dependency 'capistrano', '~> 3.1'
+  spec.add_dependency 'terminal-notifier', '~> 1.6'
 
   spec.add_development_dependency 'bundler', '~> 1.11'
   spec.add_development_dependency 'rake', '~> 10.0'
-  spec.add_development_dependency 'rspec', '~> 3.0'
 end

data/lib/capistrano/magento2.rb

@@ -0,0 +1,12 @@
+##
+ # Copyright © 2016 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/magento2/deploy'
+
+load File.expand_path('../tasks/magento.rake', __FILE__)

data/lib/capistrano/magento2/deploy.rb

@@ -0,0 +1,12 @@
+##
+ # Copyright © 2016 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'
+
+load File.expand_path('../../tasks/deploy.rake', __FILE__)

data/lib/capistrano/magento2/deploy/notify.rb

@@ -0,0 +1,12 @@
+##
+ # Copyright © 2016 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/magento2/deploy'
+
+load File.expand_path('../../../tasks/deploy/notify.rake', __FILE__)

data/lib/capistrano/{magento → magento2}/version.rb

@@ -8,7 +8,7 @@
  ##
 
 module Capistrano
-  module Magento
-    VERSION = '0.1.0'
+  module Magento2
+    VERSION = '0.1.1'
   end
 end

data/lib/capistrano/tasks/deploy.rake

@@ -0,0 +1,38 @@
+##
+ # Copyright © 2016 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/
+ ##
+
+namespace :deploy do
+  task :updated do
+    on release_roles :all do
+      invoke 'magento:composer:install'
+      invoke 'magento:reset_permissions'
+      invoke 'magento:setup:static_content:deploy'
+      invoke 'magento:setup:di:compile_multi_tenant'
+      invoke 'magento:reset_permissions'
+      invoke 'magento:maintenance:enable'
+      invoke 'magento:setup:upgrade'
+    end
+  end
+
+  task :published do
+    on release_roles :all do
+      invoke 'magento:cache:flush'
+      invoke 'magento:cache:varnish:ban'    # TODO: this should not be needed after magento/magento2#3339 is released
+      invoke 'magento:maintenance:disable'
+    end
+  end
+
+  task :reverted do
+    on release_roles :all do
+      invoke 'magento:maintenance:disable'
+      invoke 'magento:cache:flush'
+      invoke 'magento:cache:varnish:ban'
+    end
+  end
+end

data/lib/capistrano/tasks/deploy/notify.rake

@@ -0,0 +1,47 @@
+##
+ # Copyright © 2016 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 'terminal-notifier'
+
+namespace :deploy do
+  before :starting, :confirm_action do
+    if fetch(:deploy_warn_stages).include? fetch(:stage).to_s
+      message = "Are you sure you want to deploy to #{fetch(:stage).to_s}? [y/N]".center(66)
+      
+      puts "\n\e[0;31m"
+      puts "    ######################################################################"
+      puts "    #                                                                    #"
+      puts "    # #{message} #"
+      puts "    #                                                                    #"
+      puts "    ######################################################################\e[0m\n"
+      proceed = STDIN.gets[0..0] rescue nil
+      exit unless proceed == 'y' || proceed == 'Y'
+    end
+  end
+
+  after 'deploy:failed', :notify_user_failure do
+    run_locally do
+      set :message, "ERROR in deploying " + fetch(:application).to_s + " to " + fetch(:stage).to_s
+      TerminalNotifier.notify(fetch(:message), :title => 'Capistrano')
+    end
+  end
+
+  after :finished, :notify_user do
+    run_locally do
+      set :message, "Finished deploying " + fetch(:application).to_s + " to " + fetch(:stage).to_s
+      TerminalNotifier.notify(fetch(:message), :title => 'Capistrano')
+    end
+  end
+end
+
+namespace :load do
+  task :defaults do
+    set :deploy_warn_stages, fetch(:deploy_warn_stages, []).push('prod', 'production')
+  end
+end

data/lib/capistrano/tasks/magento.rake

@@ -0,0 +1,216 @@
+##
+ # Copyright © 2016 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/
+ ##
+
+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, '-f 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, '-f bin/magento -- cache:clean'
+        end
+      end
+    end
+    
+    desc 'Enable Magento cache'
+    task :enable do
+      on release_roles :all do
+        within release_path do
+          execute :php, '-f bin/magento -- cache:enable'
+        end
+      end
+    end
+    
+    desc 'Disable Magento cache'
+    task :disable do
+      on release_roles :all do
+        within release_path do
+          execute :php, '-f 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, '-f bin/magento -- cache:status'
+        end
+      end
+    end
+  
+    namespace :varnish do
+      desc 'Add ban to Varnish for url(s)'
+      task :ban do
+        on release_roles :all do
+          next unless any? :ban_pools
+          within release_path do
+            for pool in fetch(:ban_pools) do
+              response = capture :curl, %W{-svk -H 'X-Pool: #{pool}' -X PURGE 127.0.0.1:6081}
+              if response.include? '<title>200 Purged</title>'
+                puts "    200 Purged: #{pool}"
+              elsif
+                puts "\e[0;31m    Warning: Failed to ban '#{pool}' pool!\n#{response}\n\e[0m\n"
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+  
+  namespace :composer do
+    desc 'Run composer install'
+    task :install do
+      on release_roles :all do
+        within release_path do
+          execute :composer, 'install --no-interaction 2>&1'
+            
+          # Dir should be here if properly setup, but check for it anyways just in case
+          if test "[ -d #{release_path}/update ]"
+            execute :composer, 'install -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 :setup do
+    desc 'Run the Magento upgrade process'
+    task :upgrade do
+      on release_roles :all do
+        within release_path do
+          execute :php, '-f bin/magento -- setup:upgrade'
+        end
+      end
+    end
+    
+    # TODO: Change this once the bug with single tenant compiler is fixed http://devdocs.magento.com/guides/v2.0/config-guide/cli/config-cli-subcommands-compiler.html#config-cli-subcommands-single
+    namespace :di do
+      task :compile_multi_tenant do
+        on release_roles :all do
+          within release_path do
+            execute :php, '-f bin/magento -- setup:di:compile-multi-tenant -q'
+            execute :rm, '-f var/di/relations.ser'   # TODO: Workaround for broken DI compilation in 2.0.4 (GH #4070)
+          end
+        end
+      end
+    end
+    
+    namespace :static_content do
+      task :deploy do
+        on release_roles :all do
+          within release_path do
+            
+            # Due to a bug (https://github.com/magento/magento2/issues/3060) in bin/magento, errors in the
+            # compilation will not result in a non-zero exit code, so Capistrano is not aware an error has occurred.
+            # As a result, we must capture the output and manually search for an error string to determine whether
+            # compilation is successful. Once the aforementioned bug is fixed, pass a "-q" flag to
+            # 'setup:static-content:deploy' to silence verbose output, as right now the log is being filled with
+            # thousands of extraneous lines, per this issue: https://github.com/magento/magento2/issues/3692
+            output = capture :php, '-f bin/magento -- setup:static-content:deploy', verbosity: Logger::INFO
+            
+            # TODO: add method to output heading messages such as this
+            if output.to_s.include? 'Compilation from source'
+              puts "\n\e[0;31m" \
+                "    ######################################################################\n" \
+                "    #                                                                    #\n" \
+                "    #                 Failed to compile static assets                    #\n" \
+                "    #                                                                    #\n" \
+                "    ######################################################################\n\n"
+              puts output + "\e[0m\n"
+              raise Exception, 'Failed to compile static assets'
+            end
+          end
+        end
+      end
+    end
+  end
+  
+  namespace :maintenance do
+    desc 'Enable maintenance mode'
+    task :enable do
+      on release_roles :all do
+        for path in [current_path, release_path].uniq
+          within path do
+            execute :php, '-f bin/magento -- maintenance:enable'
+          end
+        end
+      end
+    end
+    
+    task :disable do
+      on release_roles :all do
+        for path in [current_path, release_path].uniq
+          within path do
+            execute :php, '-f bin/magento -- maintenance:disable'
+          end
+        end
+      end
+    end
+  end
+  
+  desc 'Reset permissions'
+  task :reset_permissions do
+    on release_roles :all do
+      within release_path do
+        execute :find, release_path, '-type d -exec chmod 770 {} +'
+        execute :find, release_path, '-type f -exec chmod 660 {} +'
+        execute :chmod, '-R g+s', release_path
+        execute :chmod, '+x ./bin/magento'
+      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, '-f bin/magento -- indexer:reindex'
+        end
+      end
+    end
+  end
+
+end
+
+namespace :load do
+  task :defaults do
+    set :linked_files, fetch(:linked_files, []).push(
+      'app/etc/env.php',
+      'var/.setup_cronjob_status',
+      'var/.update_cronjob_status',
+      'sitemap.xml'
+    )
+
+    set :linked_dirs, fetch(:linked_dirs, []).push(
+      'pub/media', 
+      'var/backups', 
+      'var/composer_home', 
+      'var/importexport', 
+      'var/import_history', 
+      'var/log',
+      'var/session', 
+      'var/tmp'
+    )
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: capistrano-magento2
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - David Alger
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-31 00:00:00.000000000 Z
+date: 2016-04-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capistrano
@@ -25,47 +25,47 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3.1'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: terminal-notifier
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.11'
-  type: :development
+        version: '1.6'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.11'
+        version: '1.6'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '1.11'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '1.11'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '10.0'
 description: A Capistrano extension for Magento 2 deployments. Takes care of specific
   Magento 2 requirements and adds tasks specific to the Magento 2 application.
 email:
@@ -81,7 +81,13 @@ files:
 - Rakefile
 - capistrano-magento2.gemspec
 - lib/capistrano-magento2.rb
-- lib/capistrano/magento/version.rb
+- lib/capistrano/magento2.rb
+- lib/capistrano/magento2/deploy.rb
+- lib/capistrano/magento2/deploy/notify.rb
+- lib/capistrano/magento2/version.rb
+- lib/capistrano/tasks/deploy.rake
+- lib/capistrano/tasks/deploy/notify.rake
+- lib/capistrano/tasks/magento.rake
 homepage: https://github.com/davidalger/capistrano-magento2
 licenses:
 - OSL-3.0