capistrano-passenger 0.0.2 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 4f8fd2477d085bb6bdc41b2a2eec100fa3a92b2e
-  data.tar.gz: e4cf76f579ecb5d76c50d7da1d260335a1f6550e
+SHA256:
+  metadata.gz: e2ad7cbc81a6b3ba09065f752e9d3f0d5dc0d082d0f728d6b47211c494d92442
+  data.tar.gz: 22793cd5dc2245698ded45b556472f93c41ffb7bb9e08f8339c1adc28e3dc6bd
 SHA512:
-  metadata.gz: 948bf4c42d4cf7975a17e92479c1d2f055ecd9310a7cdf18a19d1c68f48d6154ea04ef0f18254983c15997589faaa2254a0c2c12e5df52ba04ff8afec4be2081
-  data.tar.gz: 70b6e897b3e4ca05f2e9e16f5742964e54d5b56ec28f70400bffaca74e4c974aa241310d9c6175a0f5a934179b2fbb9352b577184a597a8fde240ce19d0de5fb
+  metadata.gz: 26633fb785143309de16735414d4d9e5c895a46e7fd6b8a721658a5159c291f4f0238176b7e7d129cc6fedfb11b6b57f3cf8d0f0c801fdad0f55f7609a6947dc
+  data.tar.gz: c2078c3c341b4f7adbf5a231ceae1968ff7c131d2730159a81fde57e05d62e758bf95f0fcd666e9788a65b115f01065f7d6b4bb90f151b4400311838592fc5f9

data/CHANGELOG.md

@@ -1,7 +1,49 @@
+# Not released yet
+
+# 0.2.1 (5 Apr 2021)
+* Made passenger-status use the same Command Map prefixes as passenger and passenger-config.
+  Even though it's not used in this project by default, it may be useful in some cases,
+  such as when someone needs to determine the passenger instance ID
+* Only run passenger commands from the release_path if passenger is in the Gemfile.
+  Otherwise, it may be in a gemset that conflicts with a .ruby-gemset file in release_path.
+
+# 0.2.0 (8 Dec 2015)
+* Added support for passenger versions > 5.0.20
+
+# 0.1.1 (30 June 2015)
+* Bug fixes:
+  * When detecting passenger version, we account for the fact the the version may not be on the first line of the captured output (@pzgz, capistrano/passenger#20)
+  * When executing the restart command without sudo, we make sure the first argument to execute is still a Symbol so that the command is executed in the appropriate directory (@FooBarWidget, capistrano/passenger#27)
+
+# 0.1.0 (3 June 2015)
+
+* BREAKING CHANGES
+  * On version of passenger that support both restarting by touch and restarting with passenger-config, the default is to use passenger-config.  set :passenger_restart_with_touch to true to opt out of this.
+* Bug fixes:
+  * Restored support for CHRuby (@aeons, capistrano/passenger#16)
+  * Restored support for passenger installed by bundle (@betesh, capistrano/passenger#10)
+
+# 0.0.5 (12 Apr 2015)
+
+* Bug fixes:
+  * When restarting passenger without sudo, made it nevertheless use command map (@betesh, capistrano/passenger#8)
+  * We now check whether passenger is installed outside of RVM and use the system installation if it is found.  Otherwise, the user can specify which version of RVM passenger was installed with if it is not the default.
+
+* Command map prefixes for rbenv are automatically added now
+
+# 0.0.4 (26 Mar 2015)
+
+* Bug fixes:
+  * rvm:hook task was being called even if it wasn't defined (@betesh, capistrano/passenger#5)
+
+# 0.0.3 (25 Mar 2015)
+
+* Passenger 5 support (@pjkelly, capistrano/passenger#4)
+
 # 0.0.2 (10 Feb 2015)
 
 Bugfixes:
-  * If directory doesn't exist, it's created during task (@powertoaster, #1)
+  * If directory doesn't exist, it's created during task (@powertoaster, capistrano/passenger#1)
 
 # 0.0.1 (7 Aug 2014)
 

data/README.md

@@ -1,51 +1,111 @@
 # Capistrano::Passenger
 
-Adds a task to restart your application after deployment via Capistrano:
-
-   * cap production deploy:restart
+Adds a task to restart your application after deployment via Capistrano. Supports Passenger versions 6 and lower.
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
-    gem 'capistrano-passenger'
+``` ruby
+gem 'capistrano-passenger'
+```
 
 And then execute:
 
-    $ bundle
+``` bash
+$ bundle
+```
 
 Or install it yourself as:
 
-    $ gem install capistrano-passenger
+``` bash
+$ gem install capistrano-passenger
+```
 
 ## Usage
 
-Adding this line to your `Capfile` will load the default configuration and make the task run after `deploy:publishing`:
+Add this line to your `Capfile` and `deploy:restart` will be setup to automatically run after `:publishing` is complete:
+
+``` ruby
+require 'capistrano/passenger'
+```
+
+You can also run the underlying task in isolation:
+
+``` bash
+# Restart your Passenger application.
+# The restart mechanism used is based on the version of Passenger installed on your server.
+$ cap production passenger:restart
+# Alternatively:
+$ cap production deploy:restart
+```
+
+If you want the task to run at a different point in your deployment, require `capistrano/passenger/no_hook` instead of `capistrano/passenger` and then add your own hook in `config/deploy.rb`.  When using this gem in this way, you must use `passenger:restart`--the `deploy:restart` alias is not available.  Example:
 
-    require 'capistrano/passenger'
+``` ruby
+# Capfile
+require 'capistrano/passenger/no_hook'
 
-You can also run the task in isolation:
+# config/deploy.rb
+after :some_other_task, :'passenger:restart'
+```
 
-    $ cap production deploy:restart
+Configurable options and their defaults:
 
-Configurable options:
+``` ruby
+set :passenger_roles, :app
+set :passenger_restart_runner, :sequence
+set :passenger_restart_wait, 5
+set :passenger_restart_limit, 2
+set :passenger_restart_with_sudo, false
+set :passenger_environment_variables, {}
+set :passenger_restart_command, 'passenger-config restart-app'
+set :passenger_restart_options, -> { "#{deploy_to} --ignore-app-not-running" }
+```
 
-    set :passenger_roles, :app                  # this is default
-    set :passenger_restart_runner, :sequence    # this is default
-    set :passenger_restart_wait, 5              # this is default
-    set :passenger_restart_limit, 2             # this is default
+### Restarting Your Passenger Application
+
+In most cases, the default settings should just work for most people. This plugin checks the version of passenger you're running on your server(s) and invokes the appropriate restart mechanism based on that.
 
 `passenger_restart_wait` and `passenger_restart_limit` are passed to the `on` block when restarting the application:
 
-    on roles(fetch(:passenger_roles)), in: fetch(:passenger_restart_runner), wait: fetch(:passenger_restart_wait), limit: fetch(:passenger_restart_limit) do
-      execute :touch, release_path.join('tmp/restart.txt')
-    end
+``` ruby
+on roles(fetch(:passenger_roles)), in: fetch(:passenger_restart_runner), wait: fetch(:passenger_restart_wait), limit: fetch(:passenger_restart_limit) do
+  with fetch(:passenger_environment_variables) do
+    # Version-specific restart happens here.
+  end
+end
+```
+
+Note that `passenger_restart_limit` has no effect if you are using the default `passenger_restart_runner` of `:sequence`.  sshkit only looks at it when the runner is `:groups`.
+
+`:passenger_environment_variables` is available if anything about your environment is not available to the user deploying your application. One use-case for this is when `passenger-config` isn't available in your user's `PATH` on the server. You could override it like so:
+
+``` ruby
+set :passenger_environment_variables, { :path => '/your/path/to/passenger/bin:$PATH' }
+```
+
+### Note for RVM users
+
+https://www.phusionpassenger.com/documentation/Users%20guide%20Apache.html#_when_the_system_has_multiple_ruby_interpreters descibes how "Once installed, you can run Phusion Passenger’s Ruby parts under any Ruby interpreter you want, even if that Ruby interpreter was not the one you originally installed Phusion Passenger with. [...] There is however one caveat if you happen to be using RVM or RVM gemsets. When you gem install Phusion Passenger using RVM," it is available only to the Ruby version where it was installed.  Therefore, if you are using RVM **AND** passenger was installed via RVM **AND** it was installed under a different version of RVM than `fetch(:rvm_ruby_version)`, you need to `set :passenger_rvm_ruby_version` in your `config/deploy.rb`.
+
+### Note for Standalone Passenger users
+
+If you are running passenger in standalone mode, it is possible for you to put passenger in your Gemfile and rely on capistrano-bundler to install it with the rest of your bundle.  If you are installing passenger during your deployment **AND** you are using the new restart method (see below), you need to set `:passenger_in_gemfile` to `true` in your `config/deploy.rb`.
+
+### Restarting Passenger >= 4.0.33 Applications
+
+Passenger 4.0.33 introduced a new way to restart your application, and thus has some additional configuration options to accomodate for various server environments.
+
+If you need to pass additional/different options to `:passenger_restart_command`, simply override `:passenger_restart_options`.
+
+If you require `sudo` when restarting passenger, set `:passenger_restart_with_sudo` to `true`. **Note**: This option has no effect when restarting Passenger <= 4.0.32 applications.
 
-Note that `passenger_restart_limit` has no effect if you are using the default `passenger_restart_runner` of `:sequence`.  sshkit only looks at it when the runner is `:group`.
+To opt out of the new way to restart, and use the deprecated approach instead, set `:passenger_restart_with_touch` to `true`.
 
 ## Contributing
 
-1. Fork it ( https://github.com/betesh/capistrano-passenger/fork )
+1. Fork it ( https://github.com/capistrano/passenger/fork )
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)

data/capistrano-passenger.gemspec

@@ -21,4 +21,32 @@ Gem::Specification.new do |spec|
   spec.add_dependency "capistrano", "~> 3.0"
   spec.add_development_dependency "bundler", "~> 1.6"
   spec.add_development_dependency "rake"
+  spec.post_install_message = <<PIM
+==== Release notes for capistrano-passenger ====
+passenger once had only one way to restart: `touch tmp/restart.txt`
+Beginning with passenger v4.0.33, a new way was introduced: `passenger-config restart-app`
+
+The new way to restart was not initially practical for everyone,
+since for versions of passenger prior to v5.0.10,
+it required your deployment user to have sudo access for some server configurations.
+
+capistrano-passenger gives you the flexibility to choose your restart approach, or to rely on reasonable defaults.
+
+If you want to restart using `touch tmp/restart.txt`, add this to your config/deploy.rb:
+
+    set :passenger_restart_with_touch, true
+
+If you want to restart using `passenger-config restart-app`, add this to your config/deploy.rb:
+
+    set :passenger_restart_with_touch, false # Note that `nil` is NOT the same as `false` here
+
+If you don't set `:passenger_restart_with_touch`, capistrano-passenger will check what version of passenger you are running
+and use `passenger-config restart-app` if it is available in that version.
+
+If you are running passenger in standalone mode, it is possible for you to put passenger in your
+Gemfile and rely on capistrano-bundler to install it with the rest of your bundle.
+If you are installing passenger during your deployment AND you want to restart using `passenger-config restart-app`,
+you need to set `:passenger_in_gemfile` to `true` in your `config/deploy.rb`.
+================================================
+PIM
 end

data/lib/capistrano/passenger.rb

@@ -1 +1 @@
-load File.expand_path('../tasks/passenger.cap', __FILE__)
+load File.expand_path('../tasks/deploy_passenger.cap', __FILE__)

data/lib/capistrano/passenger/no_hook.rb

@@ -0,0 +1 @@
+load File.expand_path('../../tasks/passenger.cap', __FILE__)

data/lib/capistrano/passenger/version.rb

@@ -1,5 +1,5 @@
 module Capistrano
   module Passenger
-    VERSION = "0.0.2"
+    VERSION = "0.2.1"
   end
 end

data/lib/capistrano/tasks/deploy_passenger.cap

@@ -0,0 +1,9 @@
+load File.expand_path('../passenger.cap', __FILE__)
+
+namespace :deploy do
+  desc 'Restart your Passenger application'
+  task :restart do
+    invoke('passenger:restart')
+  end
+  after :publishing, :'deploy:restart'
+end

data/lib/capistrano/tasks/passenger.cap

@@ -1,12 +1,86 @@
-namespace :deploy do
-  desc 'Restart application'
+namespace :passenger do
+  desc 'Restart your Passenger application'
   task :restart do
+    restart_with_touch = fetch(:passenger_restart_with_touch, nil)
+    if restart_with_touch.nil? && fetch(:sshkit_backend) == SSHKit::Backend::Printer
+      run_locally do
+        fatal "In a dry run, we cannot check the passenger version, and therefore can't guess which passenger restart method to use.  Therefore, using --dry-run without setting `passenger_restart_with_touch` to either `true` or `false` is not supported."
+      end
+      exit
+    end
     on roles(fetch(:passenger_roles)), in: fetch(:passenger_restart_runner), wait: fetch(:passenger_restart_wait), limit: fetch(:passenger_restart_limit) do
-      execute :mkdir, '-p', release_path.join('tmp')
-      execute :touch, release_path.join('tmp/restart.txt')
+      with fetch(:passenger_environment_variables) do
+        within(fetch(:passenger_in_gemfile, false) ? release_path : capture(:pwd)) do
+          if restart_with_touch.nil?
+            # 'passenger -v' may output one of the following depending on the version:
+            # Phusion Passenger version x.x.x
+            # Phusion Passenger Enterprise version x.x.x
+            # Phusion Passenger x.x.x
+            # Phusion Passenger Enterprise x.x.x
+            # and it may have a (R) after Passenger
+            passenger_version = capture(:passenger, '-v').match(/^Phusion Passenger(\(R\))? (Enterprise )?(version )?(.*)$/)[4]
+            restart_with_touch = Gem::Version.new(passenger_version) < Gem::Version.new('4.0.33')
+          end
+
+          if restart_with_touch
+            execute :mkdir, '-p', release_path.join('tmp')
+            execute :touch, release_path.join('tmp/restart.txt')
+          else
+            restart_command = fetch(:passenger_restart_command).split(" ").collect(&:to_sym) << fetch(:passenger_restart_options)
+            if fetch(:passenger_restart_with_sudo)
+              # We preprocess the command with SSHKit::Command to allow 'passenger-config' to be transformed with the command map.
+              restart_command = [:sudo, SSHKit::Command.new(*restart_command).to_s]
+            end
+            execute *restart_command
+          end
+        end
+      end
+    end
+  end
+
+  task :test_which_passenger do
+    on roles(fetch(:passenger_roles)) do
+      set(:passenger_in_path, test(:which, :passenger))
+    end
+  end
+
+  namespace :rvm do
+    task hook: :"passenger:test_which_passenger" do
+      unless fetch(:passenger_in_path)
+        if fetch(:passenger_rvm_ruby_version) == fetch(:rvm_ruby_version)
+          set :rvm_map_bins, fetch(:rvm_map_bins) + [:passenger, :'passenger-config', :'passenger-status']
+        else
+          after :'rvm:hook', :'passenger:rvm:after_rvm_path_is_set'
+        end
+      end
+    end
+
+    task :after_rvm_path_is_set do
+      # This is very similar to code in capistrano-rvm.  Ideally, there would be a way to hook into that code instead of duplicating it with only minor changes.
+      passenger_rvm_prefix = "#{fetch(:rvm_path)}/bin/rvm #{fetch(:passenger_rvm_ruby_version)} do"
+      [:passenger, :'passenger-config', :'passenger-status'].each do |command|
+        SSHKit.config.command_map.prefix[command.to_sym].unshift(passenger_rvm_prefix)
+      end
+    end
+  end
+
+  namespace :rbenv do
+    task hook: :"passenger:test_which_passenger" do
+      set :rbenv_map_bins, fetch(:rbenv_map_bins) + [:passenger, :'passenger-config', :'passenger-status'] unless fetch(:passenger_in_path)
+    end
+  end
+
+  namespace :chruby do
+    task hook: :"passenger:test_which_passenger" do
+      set :chruby_map_bins, fetch(:chruby_map_bins) + [:passenger, :'passenger-config', :'passenger-status'] unless fetch(:passenger_in_path)
+    end
+  end
+
+  namespace :bundler do
+    task :hook do
+      set :bundle_bins, fetch(:bundle_bins) + [:passenger, :'passenger-config', :'passenger-status'] if fetch(:passenger_in_gemfile, false)
     end
   end
-  after :publishing, :restart
 end
 
 namespace :load do
@@ -15,5 +89,21 @@ namespace :load do
     set :passenger_restart_runner, :sequence
     set :passenger_restart_wait, 5
     set :passenger_restart_limit, 2
+    set :passenger_restart_with_sudo, false
+    set :passenger_environment_variables, {}
+    set :passenger_restart_command, 'passenger-config restart-app'
+    set :passenger_restart_options, -> { "#{deploy_to} --ignore-app-not-running" }
+    set :passenger_rvm_ruby_version, ->{ fetch(:rvm_ruby_version) }
+    _tasks = Rake.application.tasks.collect(&:to_s)
+    if _tasks.include?("bundler:map_bins")
+      before :'bundler:map_bins', :'passenger:bundler:hook'
+    end
+    if _tasks.include?("rvm:hook")
+      before :'rvm:hook', :'passenger:rvm:hook'
+    elsif _tasks.include?("rbenv:map_bins")
+      before :'rbenv:map_bins', :'passenger:rbenv:hook'
+    elsif _tasks.include?("chruby:map_bins")
+      before :'chruby:map_bins', :'passenger:chruby:hook'
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: capistrano-passenger
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.2.1
 platform: ruby
 authors:
 - Isaac Betesh
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-10 00:00:00.000000000 Z
+date: 2021-04-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capistrano
@@ -68,13 +68,41 @@ files:
 - capistrano-passenger.gemspec
 - lib/capistrano-passenger.rb
 - lib/capistrano/passenger.rb
+- lib/capistrano/passenger/no_hook.rb
 - lib/capistrano/passenger/version.rb
+- lib/capistrano/tasks/deploy_passenger.cap
 - lib/capistrano/tasks/passenger.cap
 homepage: https://github.com/capistrano/passenger
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message: |
+  ==== Release notes for capistrano-passenger ====
+  passenger once had only one way to restart: `touch tmp/restart.txt`
+  Beginning with passenger v4.0.33, a new way was introduced: `passenger-config restart-app`
+
+  The new way to restart was not initially practical for everyone,
+  since for versions of passenger prior to v5.0.10,
+  it required your deployment user to have sudo access for some server configurations.
+
+  capistrano-passenger gives you the flexibility to choose your restart approach, or to rely on reasonable defaults.
+
+  If you want to restart using `touch tmp/restart.txt`, add this to your config/deploy.rb:
+
+      set :passenger_restart_with_touch, true
+
+  If you want to restart using `passenger-config restart-app`, add this to your config/deploy.rb:
+
+      set :passenger_restart_with_touch, false # Note that `nil` is NOT the same as `false` here
+
+  If you don't set `:passenger_restart_with_touch`, capistrano-passenger will check what version of passenger you are running
+  and use `passenger-config restart-app` if it is available in that version.
+
+  If you are running passenger in standalone mode, it is possible for you to put passenger in your
+  Gemfile and rely on capistrano-bundler to install it with the rest of your bundle.
+  If you are installing passenger during your deployment AND you want to restart using `passenger-config restart-app`,
+  you need to set `:passenger_in_gemfile` to `true` in your `config/deploy.rb`.
+  ================================================
 rdoc_options: []
 require_paths:
 - lib
@@ -89,8 +117,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.3
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: Passenger support for Capistrano 3.x