capistrano-magento2 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ccafa2eeb272e5124e13f302daca97acdf41e9ad
-  data.tar.gz: 69888babe9fa29f97400350dc877f5897db6fe0d
+  metadata.gz: a091e5f5eae6baf2c936cefe403e8383444c6f6e
+  data.tar.gz: 5f951908a10ec8018a5c3b806dc7dac13f334860
 SHA512:
-  metadata.gz: 49a423449c33c366b55aefc12157495a9efaadf82321b5237435710fa2f5f1dc399e0d05932f8b0b3cb27819994d852f30b61eb88428f600b525c85f7137f7f2
-  data.tar.gz: 091d8d13cc69479a2a2965e83dda6389e6011453e3405cb6c561b2ec5dc741fe5fb1d917bbcfc61b16b4e59582f1105949861ca7c03561bd62fa1faae5c7c4e0
+  metadata.gz: f8c63e7428739a9b571c898db91f76d0817e124284764fa9db4e18ccbed7eed2d6628382509ae17fc46889c2836835f5b595e3d4d32f89d32110d509163bca68
+  data.tar.gz: bfdef14c680d81fb9e32d66cb7a8842a26087f920ee7fb15eb140e3a2bad231b8f3fe361cfcd348631b62384031a169e495874b369a0ea881071ff49c1bfe2e3

data/CHANGELOG.md

@@ -1,5 +1,19 @@
 # Capistrano::Magento2 Change Log
 
+0.5.0
+==========
+
+* Added ability to only deploy specific themes via the new `:magento_deploy_themes` array
+* Added `:magento_deploy_confim` setting which requires user confirmation of deployment to specific capistrano stages
+* Added call to pre-generate secure RequireJS config (issue #21)
+* Added workaround for Magento 2.1 specific bug where lack of a deployed_version.txt file would fail static asset deploy
+* Added error check on output of setup:di:compile-multi-tenant since Magento 2.0 doesn't return error codes (issue #25)
+* Updated formatting of pending deployment messaging
+* Updated composer calls to specify --no-dev and --optimize-autoloader when `:magento_deploy_production` is not set (issue #22, #23)
+* Fixed bug causing maintenance mode to be enabled on deploy even when `:magento_deploy_maintenance` was set to false
+* Fixed bug preventing the second call to `magento:setup:permissions` from being executed (issue #18)
+* Removed the undocumented `:deploy_warn_stages` setting from the notifier
+
 0.4.0
 ==========
 

data/README.md

@@ -111,10 +111,12 @@ Before you can use Capistrano to deploy, you must configure the `config/deploy.r
 
 | setting                       | default | what it does
 | ----------------------------- | ------- | ---
-| `:magento_deploy_languages`   | `['en_US']` | Array of languages passed to static content deploy routine          |
-| `:magento_deploy_composer`    | `true` | Enables composer install behaviour in the built-in deploy routine        |
-| `:magento_deploy_production`  | `true` | Enables production specific DI compilation and static content generation |
-| `:magento_deploy_maintenance` | `true` | Enables use of maintenance mode while magento:setup:upgrade runs.        |
+| `:magento_deploy_languages`   | `['en_US']` | Array of languages passed to static content deploy routine
+| `:magento_deploy_themes`      | `[]`   | Array of themes passed to static content deploy routine (Magento 2.1+ only)
+| `:magento_deploy_composer`    | `true` | Enables composer install behaviour in the built-in deploy routine
+| `:magento_deploy_production`  | `true` | Enables production specific DI compilation and static content generation
+| `:magento_deploy_maintenance` | `true` | Enables use of maintenance mode while magento:setup:upgrade runs
+| `:magento_deploy_confirm`     | `[]`   | Used to require confirmation of deployment to a set of capistrano stages
 
 #### Example Usage
 

data/capistrano-magento2.gemspec

@@ -28,6 +28,8 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_dependency 'capistrano', '~> 3.1'
+
+  # TODO explore removing these from gemspec per issue #19
   spec.add_dependency 'terminal-notifier', '~> 1.6'
   spec.add_dependency 'capistrano-pending', '~> 0.1'
 

data/lib/capistrano/magento2/version.rb

@@ -9,6 +9,6 @@
 
 module Capistrano
   module Magento2
-    VERSION = '0.4.0'
+    VERSION = '0.5.0'
   end
 end

data/lib/capistrano/tasks/deploy.rake

@@ -10,6 +10,14 @@
 namespace :deploy do
   before 'deploy:check:linked_files', 'magento:deploy:check'
 
+  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
+
   task :updated do
     on release_roles :all do
       invoke 'magento:deploy:verify'
@@ -20,12 +28,12 @@ namespace :deploy do
         invoke 'magento:setup:di:compile'
       end
       invoke 'magento:setup:permissions'
-      if test '-d #{current_path}'
+      invoke 'magento:maintenance:enable' if fetch(:magento_deploy_maintenance)
+      if test "[ -d #{current_path} ]"
         within current_path do
-          execute :magento, 'maintenance:enable'
+          execute :magento, 'maintenance:enable' if fetch(:magento_deploy_maintenance)
         end
       end
-      invoke 'magento:maintenance:enable' if fetch(:magento_deploy_maintenance)
       invoke 'magento:setup:upgrade'
     end
   end
@@ -50,7 +58,8 @@ end
 namespace :load do
   task :defaults do
     set :magento_deploy_composer, fetch(:magento_deploy_composer, true)
-    set :magento_deploy_production, fetch(:magento_deploy_production, true)
+    set :magento_deploy_confirm, fetch(:magento_deploy_confirm, [])
     set :magento_deploy_maintenance, fetch(:magento_deploy_maintenance, true)
+    set :magento_deploy_production, fetch(:magento_deploy_production, true)
   end
 end

data/lib/capistrano/tasks/magento.rake

@@ -79,13 +79,28 @@ namespace :magento do
   namespace :composer do
     desc 'Run composer install'
     task :install do
+
       on release_roles :all do
         within release_path do
-          execute :composer, 'install --prefer-dist --no-interaction 2>&1'
+          composer_flags = '--prefer-dist --no-interaction'
+
+          if fetch(:magento_deploy_production)
+            composer_flags += ' --optimize-autoloader'
+          end
+
+          execute :composer, "install #{composer_flags} 2>&1"
+
+          if fetch(:magento_deploy_production)
+            feature_version = capture :magento, "-V | cut -d' ' -f4 | cut -d. -f1-2"
             
-          # 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 -d ./update 2>&1'
+            if feature_version.to_f > 2.0
+              composer_flags += ' --no-dev'
+              execute :composer, "install #{composer_flags} 2>&1" # removes require-dev components from prev command
+            end
+          end
+
+          if test "[ -d #{release_path}/update ]"   # can't count on this, but emit warning if not present
+            execute :composer, "install #{composer_flags} -d ./update 2>&1"
           else
             puts "\e[0;31m    Warning: ./update dir does not exist in repository!\n\e[0m\n"
           end
@@ -146,6 +161,7 @@ namespace :magento do
           execute :chmod, '+x ./bin/magento'
         end
       end
+      Rake::Task['magento:setup:permissions'].reenable  ## make task perpetually callable
     end
     
     namespace :di do
@@ -156,8 +172,12 @@ namespace :magento do
             # 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'
+            if test :magento, 'setup:di:compile-multi-tenant --help >/dev/null 2>&1'
+              output = capture :magento, 'setup:di:compile-multi-tenant', verbosity: Logger::INFO
+              
+              if output.to_s.include? 'Errors during compilation'
+                raise Exception, 'setup:di:compile-multi-tenant command execution failed'
+              end
             else
               execute :magento, 'setup:di:compile'
             end
@@ -171,16 +191,46 @@ namespace :magento do
       task :deploy do
         on release_roles :all do
           deploy_languages = fetch(:magento_deploy_languages).join(' ')
+          deploy_themes = fetch(:magento_deploy_themes)
+
+          if deploy_themes.count() > 0
+            deploy_themes = ' -t ' + deploy_themes.join(' -t ')   # prepare value for cli command if theme(s) specified
+          else
+            deploy_themes = ''
+          end
+
+          # Output is being checked for a success message because this command may easily fail due to customizations
+          # and 2.0.x CLI commands do not return error exit codes on failure. See magento/magento2#3060 for details.
           within release_path do
-            # 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
+
+            # Workaround for 2.1 specific issue: https://github.com/magento/magento2/pull/6437
+            execute "touch #{release_path}/pub/static/deployed_version.txt"
+
             output = capture :magento,
-              "setup:static-content:deploy #{deploy_languages}| stdbuf -o0 tr -d .",
+              "setup:static-content:deploy #{deploy_languages}#{deploy_themes} | 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
+
+            with(https: 'on') {
+              deploy_flags = ''
+
+              # Magento 2.0 does not have these flags, so only way to generate secure files is to do all of them :/
+              if test :magento, 'setup:static-content:deploy --help | grep -- --theme'
+                deploy_flags = " --no-javascript --no-css --no-less --no-images" \
+                  + " --no-fonts --no-html --no-misc --no-html-minify"
+              end
+
+              output = capture :magento,
+                "setup:static-content:deploy #{deploy_languages}#{deploy_themes}#{deploy_flags} | stdbuf -o0 tr -d .",
+                verbosity: Logger::INFO
+
+              if not output.to_s.include? 'New version of deployed files'
+                raise Exception, 'Failed to compile (secure) static assets'
+              end
+            }
           end
         end
       end
@@ -305,5 +355,6 @@ namespace :load do
     )
 
     set :magento_deploy_languages, fetch(:magento_deploy_languages, ['en_US'])
+    set :magento_deploy_themes, fetch(:magento_deploy_themes, [])
   end
 end

data/lib/capistrano/tasks/notifier.rake

@@ -10,21 +10,6 @@
 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
@@ -39,10 +24,3 @@ namespace :deploy do
     end
   end
 end
-
-namespace :load do
-  task :defaults do
-    # TODO: Document the :deploy_warn_stages option
-    set :deploy_warn_stages, fetch(:deploy_warn_stages, []).push('prod', 'production')
-  end
-end

data/lib/capistrano/tasks/pending.rake

@@ -23,15 +23,16 @@ namespace :deploy do
 
           output = _scm.log(from, to, true)
           if output.to_s.strip.empty?
-            puts "\e[0;31m"
-            puts "    No changes to deploy (from and to are the same: #{from}..#{to})"
-            print "    Are you sure you want to continue deploying? [y/n] \e[0m"
+            puts "\e[0;31m      No changes to deploy (from and to are the same: #{from}..#{to})"
+            print "      Are you sure you want to continue? [y/n] \e[0m"
 
             proceed = STDIN.gets[0..0] rescue nil
             exit unless proceed == 'y' || proceed == 'Y'
           else
-            puts "Deploying changes between #{from}..#{to}"
-            puts output
+            puts "\e[0;90m      Deploying changes #{from}..#{to}:\e[0m"
+            output.each_line do |s|
+              puts "      " + s
+            end
           end
         end
       end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: capistrano-magento2
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - David Alger
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-26 00:00:00.000000000 Z
+date: 2016-09-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capistrano