capistrano-magento2 0.5.9 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8898c62e930f71d3b30804d3c0d3834bb75f22c0
-  data.tar.gz: 71af2dbbe39540c476c38ba6bdb47d8d95ea1666
+  metadata.gz: 8469b82d98864aafd3331f72e0b5082243f835c8
+  data.tar.gz: 8eeb51698b72e2a102ef151bfd2d14546c916232
 SHA512:
-  metadata.gz: 7c8f3cdc2b99db147d0f0da84f886c65d91ef38c82e26aeb8e47d12366dd3d8efe86e8a8b366ca90257e7b5d45e549e75d0253ab40f48fc1ecd0e41f6385347b
-  data.tar.gz: 209ce16d410078b31ddcc68bee40529792654fd77e029f8ace6e982286a79a1cd21736eaa197cdf94aa5d02d215f339e850940700f9906644b4ca316894188c2
+  metadata.gz: 3afa6eb01bbb5425ba083bc58c0f7efaead6307183847eebc01fb4b89ed3a5501b117e7d71679bcfb016fae5ec60a9b252dd04a1f60bfd87c984e28b10a2663c
+  data.tar.gz: ce1bb3f5b21ce33a6d1fcdeb3b5733481109d415bf83afffb2f9ab2bd72ce5c8ffef675c1c8a53527f84aa875cf7df31c18772f184e23e730b1d18a93a675dbd

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Capistrano::Magento2 Change Log
 
+0.6.0
+==========
+
+* Added full-featured pending change logging functionality. See README for details (issue #58)
+* Fixed inability to set PATH in capistrano configuration vs `.bashrc` file (issue #62)
+* Updated README to reflect removing the `terminal-notifier` gem as a hard dependency (issue #19)
+* Removed `capistrano-pending` as a dependency (issue #58)
+
 0.5.9
 ==========
 

data/README.md

@@ -43,6 +43,7 @@ _Note: By default, Capistrano creates "staging" and "production" stages. If you
     
     # Load Magento deployment tasks
     require 'capistrano/magento2/deploy'
+    require 'capistrano/magento2/pending'
     
     # Load Git plugin
     require "capistrano/scm/git"
@@ -179,7 +180,7 @@ To see what process the built-in routine runs, take a look at the included rake
 
 ### Web Server Root Path
 
-Before deploying with Capistrano, you must update each of your web servers to point to a `current` directory inside of the `:deploy_to` directory. For example: `/var/www/html/current` Refer to the [Capistrano Structure](http://capistranorb.com/documentation/getting-started/structure/) to learn more about Capistrano's folder structure.
+Before deploying with Capistrano, you must update each of your web servers to point to the `current` directory inside of the configured `:deploy_to` directory. For example: `/var/www/html/current/pub` Refer to the [Capistrano Structure](http://capistranorb.com/documentation/getting-started/structure/) to learn more about Capistrano's folder structure.
 
 ## Magento Specific Tasks
 
@@ -208,21 +209,64 @@ All Magento 2 tasks used by the built-in `deploy.rake` file as well as some addi
 | magento:setup:static-content:deploy   | Deploys static view files                          |
 | magento:setup:upgrade                 | Run the Magento upgrade process                    |
 
-## 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`:
+## Pending Changes Support
+
+When the line `require 'capistrano/magento2/pending'` is included in your `Capfile` per the recommended configuration above, this gem will report changes pending deployment in an abbreviated git log style format. Here is an example:
+
+```
+00:00 deploy:pending:log
+      01 git fetch origin
+    ✔ 01 dalger@localhost 1.241s
+    ✔ 01 dalger@localhost 1.259s
+      Changes pending deployment on web1 (tags/2.1.2 -> 2.1):
+      f511288 Thu Feb 23 12:19:20 2017 -0600 David Alger (HEAD -> 2.1, tag: 2.1.4, origin/2.1) Magento 2.1.4
+      7fb219c Thu Feb 23 12:17:11 2017 -0600 David Alger (tag: 2.1.3) Magento 2.1.3
+      570c9b3 Thu Feb 23 12:12:43 2017 -0600 David Alger Updated capistrano configuration
+      No changes to deploy on web2 (from and to are the same: 2.1 -> 2.1)
+```
+
+When there are no changes due for deployment to any host, a warning requiring confirmation will be emitted by default:
+
+```
+No changes to deploy on web1 (from and to are the same: 2.1 -> 2.1)
+No changes to deploy on web2 (from and to are the same: 2.1 -> 2.1)
+Are you sure you want to continue? [y/n]
+```
+
+This conformational warning can be disabled by including the following in your project's configuration:
 
 ```ruby
-require 'capistrano/magento2/notifier'
+set :magento_deploy_pending_warn, false
 ```
 
-## Pending Changes
+### Pending Changes Configuration
+
+| setting                          | what it does
+| -------------------------------- | ------- | ---
+| `:magento_deploy_pending_role`   | Roles to check for pending changes on. This defaults to `:all`
+| `:magento_deploy_pending_warn`   | Set this to `false` to disable the conformational warning on zero-change deployment
+| `:magento_deploy_pending_format` | Can be used to set a custom change log format. See `defaults.rb` for example.
 
-This gem specifies [capistrano-pending](https://rubygems.org/gems/capistrano-pending) as a dependency and adds some (optional) custom functionality on top of that gem: Any time the `deploy` command is run, a one line summary of git commits that will be deployed will be displayed. If the server(s) you are deploying to already have the latest changes, you will be warned of this and a prompt will appear confirming that you want to continue deploying.
+### Pending Changes Tasks
+
+| cap command                           | what it does                                       |
+| ------------------------------------- | -------------------------------------------------- |
+| deploy:pending                        | Displays a summary of commits pending deployment   |
+
+Note: For more details including screenshots of what this functionality does, reference [this post](https://github.com/davidalger/capistrano-magento2/issues/58#issuecomment-282404477).
+
+## Terminal Notifier on OS X
+
+This gem includes an optional configuration file include which adds notification support via the [terminal-notifier](https://rubygems.org/gems/terminal-notifier) gem. To configure notifications, simply add the following line to your `Capfile`:
+
+```ruby
+require 'capistrano/magento2/notifier'
+```
 
-To add the `capistrano-pending` gem and additional functionality to you project, add the following line to your `Capfile`:
+**Notice:** The `terminal-notifier` gem is currently macOS specific and thus can not be used on generic *nix environments. Because this gem has been known to cause ruby stability issues on certain non-macOS environments, it is not specified as a hard requirement in this gem's gemspec. When using this functionality, it is expected the gem either be already present on your working environment or be added to your project's `Gemfile`:
 
 ```ruby
-require 'capistrano/magento2/pending'
+gem 'terminal-notifier'
 ```
 
 ## Development

data/capistrano-magento2.gemspec

@@ -29,10 +29,6 @@ Gem::Specification.new do |spec|
 
   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'
-
   spec.add_development_dependency 'bundler', '~> 1.7'
   spec.add_development_dependency 'rake', '~> 10.0'
 end

data/lib/capistrano/magento2.rb

@@ -13,7 +13,7 @@ module Capistrano
   module Magento2
     module Helpers
       def magento_version
-        return Gem::Version::new((capture "/usr/bin/env php -f #{release_path}/bin/magento -- -V").split(' ').pop)
+        return Gem::Version::new((capture :php, "-f #{release_path}/bin/magento -- -V").split(' ').pop)
       end
 
       def disabled_modules

data/lib/capistrano/magento2/defaults.rb

@@ -47,3 +47,11 @@ set :magento_deploy_themes, fetch(:magento_deploy_themes, [])
 # deploy targetting defaults
 set :magento_deploy_setup_role, fetch(:magento_deploy_setup_role, :all)
 set :magento_deploy_cache_shared, fetch(:magento_deploy_cache_shared, true)
+
+# pending deploy check defaults
+set :magento_deploy_pending_role, fetch(:magento_deploy_pending_role, :all)
+set :magento_deploy_pending_warn, fetch(:magento_deploy_pending_warn, true)
+set :magento_deploy_pending_format, fetch(
+  :magento_deploy_pending_format,
+  '--pretty="format:%C(yellow)%h %Cblue%>(12)%ad %Cgreen%<(7)%aN%Cred%d %Creset%s"'
+)

data/lib/capistrano/magento2/pending.rb

@@ -8,46 +8,42 @@
  ##
 
 require 'capistrano/deploy'
-require 'capistrano/pending/scm/base'
+require 'capistrano/magento2'
 
 module Capistrano
-  module Pending
-    module SCM
-      class Git < Base
-
-        # Enhance capistrano-pending gem's native deploy:pending:log command by updating repository and then
-        # showing the actual changes that will be deployed. Also changes log output to oneline for easy reading
-        #
-        # Params:
-        # +from+            - commit-ish to compare from
-        # +to+              - commit-ish to compare to
-        # +returnOutput+    - whether to return or print the output
-        #
-        def log(from, to, returnOutput=false)
+  module Magento2
+    module Pending
+      def ensure_revision inform_user = false
+        if test "[ -f #{current_path}/REVISION ]"
+          yield
+        else
+          warn "\e[0;31mSkipping pending changes check on #{host} (no REVISION file found)\e[0m" if inform_user
+          return false
+        end
+        return true
+      end
+
+      def from_rev
+        within current_path do
+          current_revision = capture(:cat, "REVISION")
+
           run_locally do
-            execute :git, :fetch, :origin   # update repository to ensure accuracy of pending changes report
-
-            # Since the :branch to deploy from may be behind the upstream branch, get name of upstream branch
-            # and use it for comparison. We are using the test command in case the :branch is set to a specific
-            # commit hash, in which case there is no upstream branch.
-
-            if test(:git, 'rev-parse', '--abbrev-ref', '--symbolic-full-name', to + '@{u}')
-              to = capture(:git, 'rev-parse', '--abbrev-ref', '--symbolic-full-name',  to + '@{u}')
-            end
-
-            output = capture(
-              :git,
-              :log,
-              "#{from}..#{to}",
-              '--pretty="format:%C(yellow)%h %Cblue%>(12)%ad %Cgreen%<(7)%aN%Cred%d %Creset%s"'
-            )
-
-            if returnOutput
-              return output
-            else
-              puts output
-            end
+            return capture(:git, "name-rev --always --name-only #{current_revision}") # find symbolic name for ref
+          end
+        end
+      end
+
+      def to_rev
+        run_locally do
+          to = fetch(:branch)
+
+          # get target branch upstream if there is one
+          if test(:git, "rev-parse --abbrev-ref --symbolic-full-name #{to}@{u}")
+            to = capture(:git, "rev-parse --abbrev-ref --symbolic-full-name #{to}@{u}")
           end
+
+          # find symbolic name for revision
+          to = capture(:git, "name-rev --always --name-only #{to}")
         end
       end
     end

data/lib/capistrano/magento2/version.rb

@@ -9,6 +9,6 @@
 
 module Capistrano
   module Magento2
-    VERSION = '0.5.9'
+    VERSION = '0.6.0'
   end
 end

data/lib/capistrano/tasks/pending.rake

@@ -7,33 +7,73 @@
  # http://davidalger.com/contact/
  ##
 
-require 'capistrano-pending'
+include Capistrano::Magento2::Pending
+
+before :deploy, 'deploy:pending:warn'
 
-before :deploy, 'deploy:pending:check_changes'
 namespace :deploy do
+  desc "Displays a summary of commits pending deployment"
+  task :pending => 'deploy:pending:log'
 
-  # Check for pending changes on the primary node and then notify user of any incoming
-  # changes and/or warn that there is nothing to deploy
   namespace :pending do
-    task :check_changes do
-      on primary fetch(:magento_deploy_setup_role) do
-        # check for pending changes only if REVISION file exists to prevent error
-        if test "[ -f #{current_path}/REVISION ]"
-          invoke 'deploy:pending:setup'
-          from = fetch(:revision)
-          to = fetch(:branch)
-
-          output = _scm.log(from, to, true)
-          if output.to_s.strip.empty?
-            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'
+    task :warn => :log do
+      if fetch(:magento_deploy_pending_warn)
+        need_warning = true
+
+        on roles fetch(:magento_deploy_pending_role) do |host|
+          has_revision = ensure_revision do
+            # if any host has a change in revision, do not warn user
+            need_warning = false if from_rev != to_rev
+          end
+
+          # if a host does not have a revision, do not warn user
+          need_warning = false if not has_revision
+        end
+
+        # if there is nothing to deploy on any host, prompt user for confirmation
+        if need_warning
+          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'
+        end
+      end
+    end
+
+    task :log do
+      on roles fetch(:magento_deploy_pending_role) do |host|
+        ensure_revision true do
+          # update local repository to ensure accuracy of report
+          run_locally do
+            execute :git, :fetch, :origin
+          end
+
+          # fetch current revision and revision to be deployed
+          from = from_rev
+          to = to_rev
+
+          # if there is nothing to deploy on this host, inform the user
+          if from == to
+            info "\e[0;31mNo changes to deploy on #{host} (from and to are the same: #{from} -> #{to})\e[0m"
           else
-            puts "\e[0;90m      Deploying changes #{from}..#{to}:\e[0m"
-            output.each_line do |s|
-              puts "      " + s
+            run_locally do
+              header = "\e[0;90mChanges pending deployment on #{host} (#{from} -> #{to}):\e[0m\n"
+
+              # capture log of commits between current revision and revision for deploy
+              output = capture :git, :log, "#{from}..#{to}", fetch(:magento_deploy_pending_format)
+
+              # if we get no results, flip refs to look at reverse log in case of rollback deployments
+              if output.to_s.strip.empty?
+                output = capture :git, :log, "#{to}..#{from}", fetch(:magento_deploy_pending_format)
+                if not output.to_s.strip.empty?
+                  header += "\e[0;31mWarning: It appears you may be going backwards in time on #{host} with this deployment!\e[0m\n"
+                end
+              end
+
+              # write pending changes log
+              (header + output).each_line do |line|
+                info line
+              end
             end
           end
         end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: capistrano-magento2
 version: !ruby/object:Gem::Version
-  version: 0.5.9
+  version: 0.6.0
 platform: ruby
 authors:
 - David Alger
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-02-07 00:00:00.000000000 Z
+date: 2017-02-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capistrano
@@ -24,34 +24,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.1'
-- !ruby/object:Gem::Dependency
-  name: terminal-notifier
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.6'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.6'
-- !ruby/object:Gem::Dependency
-  name: capistrano-pending
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.1'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.1'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement