capistrano-magento2 0.1.3 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e07f9eb98c1eaba3b2aefcb1839d2a46b403a04b
-  data.tar.gz: 69547dbde12c91453e71631c4ee25e04c51ec357
+  metadata.gz: 7c26fa9d5aee2efa6058343f4778e782cf3bd819
+  data.tar.gz: 9b0df9b6a112a8d1426bb6d952d5e88bde7720b0
 SHA512:
-  metadata.gz: 31b44b23d3f662de96572ae8342b341c4ddd06c78db0d7840c912e541b0ad1ee575391fa3abc533c690663c4dc8ae043bc6da6541cbe320b07ea2ec2251e9f58
-  data.tar.gz: 5b57a780ba0b2b0b4f206408dd320095e7b1d73efaccc4e03a243c1bb157f1708202b08deb4d4b7a4e65a1a6e70580be2ed2e6f1d107fb0b4658c5553da1b6da
+  metadata.gz: 3fbce42ba76649f409114fabe570d5c5403feb556e031d08a7d002c76f2d21e1e47a2b74e4d00f51b7d479312e67ca5d9aeabde739d5a1b8c6c0bc43b40821c6
+  data.tar.gz: ae50da8be58fc6e35c8b11a0b62615897c13bc2d6cd9af178da4ceffaaece366e076b06895f3d61f8dc38f9a93c65aa68a96be177c5262b88bb338cf82e82c3d

data/CHANGELOG.md

@@ -1,5 +1,25 @@
 # Capistrano::Magento2 Change Log
 
+0.2.0
+==========
+
+* Added "smart" magento:setup:di:compile task which uses multi-tenant if available (for compatibility with 2.0 release)
+* Added a command_map for the bin/magento tool to simplify rake files
+* Added indexer:info, indexer:status, indexer:show-mode, indexer:set-mode
+* Added maintenance:status and maintenance:allow-ips, exposes maintenance:disable
+* Fixed broken error detection logic on setup:static-content:deploy
+* Fixed bug where magento:setup:upgrade was not using the --keep-generated flag
+* Fixed log bloat caused by chatty static-content:deploy
+* Fixed missing dependency include in deploy.rb
+* Fixed output of magento:cache:varnish:ban command
+* Fixed potential issue where if a botched release was in production, one could not roll back
+* Fixed technical dependency bug preventing projects from overriding the deploy.rake with a custom one
+* Renamed capistrano/magento2/deploy/notify to capistrano/magento2/notifier
+* Renamed magento:reset_permissions to magento:setup:permissions
+* Renamed magento:setup:static_content:deploy to magento:setup:static-content:deploy
+* Updated composer calls to explicitly set  --prefer-dist and --no-interaction
+* Updated README to reflect current setup instructions
+
 0.1.3
 ==========
 

data/README.md

@@ -1,5 +1,7 @@
 # Capistrano::Magento2
 
+[![Gem Version](https://badge.fury.io/rb/capistrano-magento2.svg)](https://badge.fury.io/rb/capistrano-magento2)
+
 A Capistrano extension for Magento 2 deployments. Takes care of specific Magento 2 requirements and adds tasks specific to the Magento 2 application.
 
 ## Installation
@@ -22,10 +24,12 @@ Or install it yourself as:
 
 Install Capistrano in your Magento project:
 
-    $ cd <project_root>
-    $ mkdir -p tools/cap
-    $ cd ./tools/cap
-    $ cap install
+```shell
+$ cd <project_root>
+$ mkdir -p tools/cap
+$ cd ./tools/cap
+$ cap install
+```
 
 Update your project `Capfile` to look like the following:
 
@@ -34,20 +38,86 @@ Update your project `Capfile` to look like the following:
 require 'capistrano/setup'
 
 # Load Magento deployment tasks
-require 'capistrano/magento'
+require 'capistrano/magento2/deploy'
 ```
 
-This gem requires [terminal-notifier](https://rubygems.org/gems/terminal-notifier) and adds notifications to the deployment process via an optional include. To use terminal-notifier, add the following line to your `Capfile`:
+## Default Configuration
+
+### Capistrano Built-Ins
+
+For the sake of simplicity in new project setups `:linked_dirs` and `:linked_files` are pre-configured per the following.
 
 ```ruby
-require 'capistrano/magento2/deploy/notify'
+    set :linked_files, [
+      'app/etc/env.php',
+      'var/.setup_cronjob_status',
+      'var/.update_cronjob_status',
+      'sitemap.xml'
+    ]
+    
+    set :linked_dirs, [
+      'pub/media', 
+      'var/backups', 
+      'var/composer_home', 
+      'var/importexport', 
+      'var/import_history', 
+      'var/log',
+      'var/session', 
+      'var/tmp'
+    ]
+```
+
+### Magento 2 Deploy Routine
+
+A pre-built deploy routine is available out-of-the-box. This can be overriden on a per-project basis by including only the Magento 2 specific tasks and defining your own `deploy.rake` file under `lib/capistrano/tasks` in your projects capistrano install location.
+
+To see what process the built-in routine runs, take a look at the included rake file here: https://github.com/davidalger/capistrano-magento2/blob/master/lib/capistrano/tasks/deploy.rake
+
+## Magento Specific Tasks
+
+All Magento 2 tasks used by the built-in `deploy.rake` file as well as some additional commands are implimented 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.
+
+| cap command                           | what it does                                       |
+| ------------------------------------- | -------------------------------------------------- |
+| magento:cache:clean                   | Clean Magento cache by types                       |
+| magento:cache:disable                 | Disable Magento cache                              |
+| magento:cache:enable                  | Enable Magento cache                               |
+| magento:cache:flush                   | Flush Magento cache storage                        |
+| magento:cache:status                  | Check Magento cache enabled status                 |
+| magento:cache:varnish:ban             | Add ban to Varnish for url(s)                      |
+| magento:composer:install              | Run composer install                               |
+| magento:indexer:info                  | Shows allowed indexers                             |
+| magento:indexer:reindex               | Reindex data by all indexers                       |
+| magento:indexer:set-mode[mode,index]  | Sets mode of all indexers                          |
+| magento:indexer:show-mode[index]      | Shows mode of all indexers                         |
+| magento:indexer:status                | Shows status of all indexers                       |
+| magento:maintenance:allow-ips[ip]     | Sets maintenance mode exempt IPs                   |
+| magento:maintenance:disable           | Disable maintenance mode                           |
+| magento:maintenance:enable            | Enable maintenance mode                            |
+| magento:maintenance:status            | Displays maintenance mode status                   |
+| magento:setup:di:compile              | Runs dependency injection compilation routine      |
+| magento:setup:permissions             | Sets proper permissions on application             |
+| magento:setup:static-content:deploy   | Deploys static view files                          |
+| magento:setup:upgrade                 | Run the Magento upgrade process                    |
+
+## Using Capistrano
+
+For inrformation on how to use Capistrano and setup deployment take a look at the [Capistrano documentation](http://capistranorb.com) and [README](https://github.com/capistrano/capistrano/blob/master/README.md) file.
+
+## Terminal Notifier on OS X
+This gem specifies [terminal-notifier](https://rubygems.org/gems/terminal-notifier) as a dependency in order to support notifications on OS X via an optional include. To use the built-in notifications, add the following line to your `Capfile`:
+
+```ruby
+require 'capistrano/magento2/notifier'
 ```
 
 ## Development
 
-After checking out the repo, run `bundle install` to install dependencies.
+After checking out the repo, run `bundle install` to install dependencies. Make the neccesary changes, then run `bundle exec rake install` to install a modified version of the gem on your local system.
+
+To release a new version, update the version number in `capistrano/magento2/version.rb`, merge all changes to master, and then run `bundle exec rake release`. This will create a git tag for the version (the tag will apply to the current HEAD), push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
-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).
+_Note: Releasing a new version of the gem is only possible for those with maintainer access to the gem on rubygems.org._
 
 ## Contributing
 

data/lib/capistrano/magento2.rb

@@ -7,6 +7,4 @@
  # http://davidalger.com/contact/
  ##
 
-require 'capistrano/magento2/deploy'
-
 load File.expand_path('../tasks/magento.rake', __FILE__)

data/lib/capistrano/magento2/deploy.rb

@@ -8,5 +8,6 @@
  ##
 
 require 'capistrano/deploy'
+require 'capistrano/magento2'
 
 load File.expand_path('../../tasks/deploy.rake', __FILE__)

data/lib/capistrano/magento2/{deploy/notify.rb → notifier.rb}

@@ -7,6 +7,6 @@
  # http://davidalger.com/contact/
  ##
 
-require 'capistrano/magento2/deploy'
+require 'capistrano/deploy'
 
-load File.expand_path('../../../tasks/deploy/notify.rake', __FILE__)
+load File.expand_path('../../tasks/notifier.rake', __FILE__)

data/lib/capistrano/magento2/version.rb

@@ -9,6 +9,6 @@
 
 module Capistrano
   module Magento2
-    VERSION = '0.1.3'
+    VERSION = '0.2.0'
   end
 end

data/lib/capistrano/tasks/deploy.rake

@@ -11,10 +11,13 @@ 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:setup:permissions'
+      invoke 'magento:setup:static-content:deploy'
+      invoke 'magento:setup:di:compile'
+      invoke 'magento:setup:permissions'
+      within current_path do
+        execute :magento, 'maintenance:enable'
+      end
       invoke 'magento:maintenance:enable'
       invoke 'magento:setup:upgrade'
     end

data/lib/capistrano/tasks/magento.rake

@@ -14,7 +14,7 @@ namespace :magento do
     task :flush do
       on release_roles :all do
         within release_path do
-          execute :php, '-f bin/magento -- cache:flush'
+          execute :magento, 'cache:flush'
         end
       end
     end
@@ -23,7 +23,7 @@ namespace :magento do
     task :clean do
       on release_roles :all do
         within release_path do
-          execute :php, '-f bin/magento -- cache:clean'
+          execute :magento, 'cache:clean'
         end
       end
     end
@@ -32,7 +32,7 @@ namespace :magento do
     task :enable do
       on release_roles :all do
         within release_path do
-          execute :php, '-f bin/magento -- cache:enable'
+          execute :magento, 'cache:enable'
         end
       end
     end
@@ -41,7 +41,7 @@ namespace :magento do
     task :disable do
       on release_roles :all do
         within release_path do
-          execute :php, '-f bin/magento -- cache:disable'
+          execute :magento, 'cache:disable'
         end
       end
     end
@@ -50,7 +50,7 @@ namespace :magento do
     task :status do
       on release_roles :all do
         within release_path do
-          execute :php, '-f bin/magento -- cache:status'
+          execute :magento, 'cache:status'
         end
       end
     end
@@ -59,19 +59,14 @@ namespace :magento do
       desc 'Add ban to Varnish for url(s)'
       task :ban do
         on release_roles :all do
+          # TODO: Document use of :ban_pools and :varnish_cache_hosts in project config file
           next unless any? :ban_pools
           next unless any? :varnish_cache_hosts
           
           within release_path do
             for pool in fetch(:ban_pools) do
               for cache_host in fetch(:varnish_cache_hosts) do
-                response = capture :curl, %W{-svk -H 'X-Pool: #{pool}' -X PURGE #{cache_host}}
-                if response.include? '<title>200 Purged</title>'
-                  puts "    200 Purged: #{pool}"
-                elsif
-                  puts "\e[0;31m    Warning: Failed to ban '#{pool}' pool on cache host '#{cache_host}'!\n"
-                  puts "#{response}\n\e[0m\n"
-                end
+                execute :curl, %W{-s -H 'X-Pool: #{pool}' -X PURGE #{cache_host}}
               end
             end
           end
@@ -85,11 +80,11 @@ namespace :magento do
     task :install do
       on release_roles :all do
         within release_path do
-          execute :composer, 'install --no-interaction 2>&1'
+          execute :composer, 'install --prefer-dist --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'
+            execute :composer, 'install --prefer-dist --no-interaction -d ./update 2>&1'
           else
             puts "\e[0;31m    Warning: ./update dir does not exist in repository!\n\e[0m\n"
           end
@@ -103,45 +98,51 @@ namespace :magento do
     task :upgrade do
       on release_roles :all do
         within release_path do
-          execute :php, '-f bin/magento -- setup:upgrade'
+          execute :magento, 'setup:upgrade --keep-generated'
+        end
+      end
+    end
+    
+    desc 'Sets proper permissions on application'
+    task :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
     
-    # 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
+      desc 'Runs dependency injection compilation routine'
+      task :compile 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)
+            # Due to a bug in the single-tenant compiler released in 2.0 (see here for details: http://bit.ly/21eMPtt)
+            # we have to use multi-tenant currently. However, the multi-tenant is being dropped in 2.1 and is no longer
+            # present in the develop mainline, so we are testing for multi-tenant presence for long-term portability.
+            if test :magento, 'setup:di:compile-multi-tenant --help'
+              execute :magento, 'setup:di:compile-multi-tenant'
+              execute :rm, '-f var/di/relations.ser'   # TODO: Workaround broken DI compilation on PHP 7.0.5 (GH #4070)
+            else
+              execute :magento, 'setup:di:compile'
+            end
           end
         end
       end
     end
     
-    namespace :static_content do
+    namespace 'static-content' do
+      desc 'Deploys static view files'
       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"
+            # TODO: Remove custom error detection logic once magento/magento2#3060 is resolved
+            # Currently the cli tool is not reporting failures via the exit code, so manual detection is neccesary
+            output = capture :magento, 'setup:static-content:deploy | stdbuf -o0 tr -d .', verbosity: Logger::INFO
+            if not output.to_s.include? 'New version of deployed files'
               raise Exception, 'Failed to compile static assets'
             end
           end
@@ -154,33 +155,36 @@ namespace :magento 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
+        within release_path do
+          execute :magento, 'maintenance:enable'
         end
       end
     end
     
+    desc 'Disable maintenance mode'
     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
+        within release_path do
+          execute :magento, 'maintenance:disable'
         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'
+
+    desc 'Displays maintenance mode status'
+    task :status do
+      on release_roles :all do
+        within release_path do
+          execute :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 release_path do
+          execute :magento, 'maintenance:allow-ips', args[:ip]
+        end
       end
     end
   end
@@ -190,7 +194,43 @@ namespace :magento do
     task :reindex do
       on release_roles :all do
         within release_path do
-          execute :php, '-f bin/magento -- indexer:reindex'
+          execute :magento, 'indexer:reindex'
+        end
+      end
+    end
+
+    desc 'Shows allowed indexers'
+    task :info do
+      on release_roles :all do
+        within release_path do
+          execute :magento, 'indexer:info'
+        end
+      end
+    end
+
+    desc 'Shows status of all indexers'
+    task :status do
+      on release_roles :all do
+        within release_path do
+          execute :magento, 'indexer:status'
+        end
+      end
+    end
+
+    desc 'Shows mode of all indexers'
+    task 'show-mode', :index do |t, args|
+      on release_roles :all do
+        within release_path do
+          execute :magento, 'indexer:show-mode', args[:index]
+        end
+      end
+    end
+
+    desc 'Sets mode of all indexers'
+    task 'set-mode', :mode, :index do |t, args|
+      on release_roles :all do
+        within release_path do
+          execute :magento, 'indexer:set-mode', args[:mode], args[:index]
         end
       end
     end
@@ -200,6 +240,9 @@ end
 
 namespace :load do
   task :defaults do
+
+    SSHKit.config.command_map[:magento] = "/usr/bin/env php -f bin/magento --"
+
     set :linked_files, fetch(:linked_files, []).push(
       'app/etc/env.php',
       'var/.setup_cronjob_status',

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: capistrano-magento2
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.0
 platform: ruby
 authors:
 - David Alger
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-20 00:00:00.000000000 Z
+date: 2016-04-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capistrano
@@ -84,11 +84,11 @@ files:
 - lib/capistrano-magento2.rb
 - lib/capistrano/magento2.rb
 - lib/capistrano/magento2/deploy.rb
-- lib/capistrano/magento2/deploy/notify.rb
+- lib/capistrano/magento2/notifier.rb
 - lib/capistrano/magento2/version.rb
 - lib/capistrano/tasks/deploy.rake
-- lib/capistrano/tasks/deploy/notify.rake
 - lib/capistrano/tasks/magento.rake
+- lib/capistrano/tasks/notifier.rake
 homepage: https://github.com/davidalger/capistrano-magento2
 licenses:
 - OSL-3.0