capistrano-cookbook 0.0.4 → 5.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 192d0bf014509cb56e6c84c30fd8be3a76719913
-  data.tar.gz: 2e9ab7ae1a1190ab67a3163d2dbc4e0f823296d5
+SHA256:
+  metadata.gz: ccf86ecd4d2c04f71dd86f6aaf38877d57c1b7482e21435986b58dcbd768e18c
+  data.tar.gz: 1a9f6bc210c07faf2c998ad13f438b97ac4efbccdb3734993e173f94cf7953be
 SHA512:
-  metadata.gz: e0cefe15ebd19d73f8db9c3708f39e21c4a4d1164e97193b4dc279397ffbdd3cadbf33cd1bfa86792a17ea6abe5bce4bb334ba9573f79acf424aba39c6ea804e
-  data.tar.gz: d62605469084670f78a9184e7274bd146283ab8b66817e491371b85b38329884e9ee2929b710fcd6eb798a186d3a26d457f29f6eaae26df1d58ad85b9a993986
+  metadata.gz: 936557739c95b9b6c4d2f7bc92fa300778437e0c335b84670c7b4d9e67dce28daa65196f0713cf2e9babdb3fe913777c181bf5587f9378880b4567f091453893
+  data.tar.gz: e55cb0581cfdde734cdea13b675ccb89aea40f1fab79c1280b1eda86590b37fb0cb3c22af6565d56e94d7fb4466b80d6823cb398ccb39d5b16e4277bd85066a2

data/CHANGELOG.md

@@ -0,0 +1,13 @@
+# Changelog
+
+## 5.0.1 (March 2021)
+
+- Adds full support for deploy (but not config creation) without sudo access
+- Refactor config files to use single array of hashes with flags
+- Refactor Sidekiq and Monit configurations to copy files directly rather than using symlinks to avoid potential root access leak
+- Fixes bug where object identifier was outputted in logs rather than filename
+- Fixes nginx not being reloaded after `setup_config` due to shared log directory not yet existing
+
+## 5.0.0 (March 2021)
+
+- Full overhaul to support Rails 6 and Ubuntu 20.04

data/README.md

@@ -6,7 +6,7 @@ A collection of Capistrano 3 Compatible tasks to make deploying Rails and Sinatr
 
 Add this line to your application's Gemfile:
 
-    gem 'capistrano-cookbook'
+    gem 'capistrano-cookbook', require: false, group: :development
 
 And then execute:
 
@@ -16,9 +16,44 @@ Or install it yourself as:
 
     $ gem install capistrano-cookbook
 
+## Versioning
+
+This gem is primarily intended to provide a batteries included approach to getting Rails applications up and running. It is tested with the server configuration in <https://github.com/TalkingQuickly/rails-server-template>.
+
+Major versions of the rails server template above and this gem stay in sync. So Version X.*.* of this gem should provide a working out of the box capistrano configuration when used with version X.*.* of the server template.
+
+Major and minor versions of this gem, the server template and the book [Reliably Deploying Rails Applications](https://leanpub.com/deploying_rails_applications) also stay in sync. Updates to the book are free for life so on a new project, it's always advisable to make sure you have the latest version.
+
 ## Usage
 
-### Including Tasks
+### Boostrap
+
+To generate a complete Capistrano configuration include the gem in your Gemfile and then use the following Rails Generator:
+
+```
+bundle exec rails g capistrano:reliably_deploying_rails:bootstrap --sidekiq --production_hostname='YOUR_PRODUCTION_DOMAIN' --production_server_address='YOUR_PRODUCTION_SERVER'
+```
+
+Replacing `YOUR_PRODUCTION_DOMAIN` with the domain name people will access the Rails app on and `YOUR_PRODUCTION_SERVER` with the address or ip that can be used to access the server via SSH, these may be the same thing but often will not be (e.g. if the domain has a CDN or Load Balancer between it and the server you're deploying to),
+
+This will generate a complete Capistrano configuration.
+
+You can then execute:
+
+```
+bundle exec cap production deploy:setup_config
+bundle exec cap production database:create
+```
+
+To perform setup tasks and create a new empty database. Followed by:
+
+```
+bundle exec cap production deploy
+```
+
+To kick off you first deploy.
+
+### Including Tasks Manually
 
 To include all tasks from the gem, add the following to your `Capfile`:
 
@@ -35,7 +70,6 @@ require 'capistrano/cookbook/create_database'
 require 'capistrano/cookbook/logs'
 require 'capistrano/cookbook/monit'
 require 'capistrano/cookbook/nginx'
-require 'capistrano/cookbook/restart'
 require 'capistrano/cookbook/run_tests'
 require 'capistrano/cookbook/setup_config'
 ```
@@ -66,7 +100,8 @@ Add the following to `deploy.rb`
 
 Currently only works with Postgresql on configurations where your web server and db server are the same machine, e.g. single box deployments. This task will:
 
-* Check to see if a remote `database.yml` exists in `APP_PATH/shared/config`, if not attempt to copy one from `APP_PATH/shared/config`.
+* Check to see if a remote `database.yml` exists in `APP_PATH/shared/config`, if not attempt to copy one from `APP_PATH/shared/config`
+* If a new `database.yml` is created, it will include a username and database name based on the application name and a random password
 * Download the remote `database.yml`
 * Create the Postgres user specified in `database.yml` if it doesn't already exist
 * Create the Database specified in `database.yml` if it doesn't already exist
@@ -125,20 +160,6 @@ cap STAGE nginx:restart
 cap STAGE nginx:remove_default_vhost
 ```
 
-#### Restart
-
-Provides Commands for interacting with the Unicorn app server via an `init.d` script.
-
-Usage:
-
-``` bash
-cap STAGE deploy:start
-cap STAGE deploy:stop
-cap STAGE deploy:force-stop
-cap STAGE deploy:restart
-cap STAGE deploy:upgrade
-```
-
 #### Run Tests
 
 Allows a test suite to be automatically run with `rspec`, if the tests pass the deploy will continue, if they fail, the deploy will halt and the test output will be displayed.

data/capistrano-cookbook.gemspec

@@ -17,7 +17,9 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_dependency 'capistrano', '~> 3.1'
+  spec.add_dependency 'capistrano', '~>  3.16'
+  spec.add_dependency 'capistrano3-puma', '~>  5.0.4'
+  spec.add_dependency 'capistrano-sidekiq', '~> 2.0'
 
   spec.add_development_dependency "bundler", "~> 1.5"
   spec.add_development_dependency "rake"

data/lib/capistrano/cookbook.rb

@@ -3,13 +3,13 @@ require "capistrano/cookbook/version"
 module Capistrano
   module Cookbook
     require 'capistrano/cookbook/check_revision'
-    require 'capistrano/cookbook/compile_assets_locally'
     require 'capistrano/cookbook/logs'
     require 'capistrano/cookbook/monit'
     require 'capistrano/cookbook/nginx'
-    require 'capistrano/cookbook/restart'
     require 'capistrano/cookbook/run_tests'
     require 'capistrano/cookbook/setup_config'
     require 'capistrano/cookbook/create_database'
+    require 'capistrano/cookbook/puma_systemd'
+    require 'capistrano/cookbook/sidekiq_systemd'
   end
 end

data/lib/capistrano/cookbook/helpers/setup_config_values.rb

@@ -1,57 +1,49 @@
 module Capistrano
   module Cookbook
     class SetupConfigValues
-      def symlinks
-        fetch(:symlinks) || symlinks_defaults
-      end
-
-      def executable_config_files
-        fetch(:executable_config_files) || executable_config_files_defaults
-      end
-
       def config_files
         fetch(:config_files) || config_files_defaults
       end
 
       private
 
-      def symlinks_defaults
-        [
+      def config_files_defaults
+        base = [
           {
-            source: "nginx.conf",
-            link: "/etc/nginx/sites-enabled/{{full_app_name}}"
+            source: 'log_rotation',
+            destination: "/etc/logrotate.d/#{fetch(:full_app_name)}",
+            executable: false,
+            as_root: true 
           },
           {
-            source: "unicorn_init.sh",
-            link: "/etc/init.d/unicorn_{{full_app_name}}"
-          },
+            source: 'database.example.yml',
+            destination: "#{shared_path}/config/database.example.yml",
+            executable: false,
+            as_root: false
+          }
+        ]
+
+        return base unless sidekiq_enabled?
+
+        base + [
           {
-            source: "log_rotation",
-           link: "/etc/logrotate.d/{{full_app_name}}"
+            source: 'sidekiq.service.capistrano',
+            destination: "/home/#{fetch(:deploy_user)}/.config/systemd/user/#{fetch(:sidekiq_service_unit_name)}.service",
+            executable: false,
+            as_root: false
           },
           {
-            source: "monit",
-            link: "/etc/monit/conf.d/{{full_app_name}}.conf"
+            source: "sidekiq_monit",
+            destination: "/etc/monit/conf.d/#{fetch(:full_app_name)}_sidekiq.conf",
+            executable: false,
+            as_root: true
           }
         ]
       end
 
-      def executable_config_files_defaults
-        %w(
-          unicorn_init.sh
-        )
-      end
-
-      def config_files_defaults
-        %w(
-          nginx.conf
-          database.example.yml
-          log_rotation
-          monit
-          unicorn.rb
-          unicorn_init.sh
-        )
+      def sidekiq_enabled?
+        defined?(Capistrano::Sidekiq) == 'constant' && Capistrano::Sidekiq.class == Class
       end
     end
   end
-end
+end

data/lib/capistrano/cookbook/helpers/{template.rb → smart_template.rb}

@@ -1,3 +1,6 @@
+require 'securerandom'
+require 'stringio'
+
 # will first try and copy the file:
 # config/deploy/#{full_app_name}/#{from}.erb
 # to:
@@ -11,25 +14,37 @@
 # ones to be over-ridden
 # if the target file name is the same as the source then
 # the second parameter can be left out
-def smart_template(from, to=nil)
-  to ||= from
-  full_to_path = "#{shared_path}/config/#{to}"
+def smart_template(from, to, as_root=false)
   if from_erb_path = template_file(from)
     from_erb = StringIO.new(ERB.new(File.read(from_erb_path)).result(binding))
-    upload! from_erb, full_to_path
-    info "copying: #{from_erb} to: #{full_to_path}"
+    upload!(from_erb, to) unless as_root
+    sudo_upload!(from_erb, to) if as_root
+    info "copying: #{from} to: #{to}"
   else
     error "error #{from} not found"
   end
 end
 
 def template_file(name)
-  if File.exist?((file = "config/deploy/#{fetch(:full_app_name)}/#{name}.erb"))
+  if File.exist?((file = "config/deploy/#{fetch(:stage)}/#{name}.erb"))
     return file
   elsif File.exist?((file = "config/deploy/shared/#{name}.erb"))
     return file
+  elsif File.exist?((file = "config/deploy/templates/#{name}.erb"))
+    return file
   elsif File.exist?(file = File.expand_path("../templates/#{name}.erb",File.dirname(__FILE__)))
     return file    
   end
   return nil
 end
+
+def sudo_upload!(file_path, remote_path, mode: '644', owner: 'root:root')
+  tmp_path = "/tmp/#{SecureRandom.uuid}"
+
+  upload!(file_path, tmp_path)
+
+  execute(:sudo, :mkdir, '-p', File.dirname(remote_path))
+  execute(:sudo, :mv, '-f', tmp_path, remote_path)
+  execute(:sudo, :chmod, mode, remote_path)
+  execute(:sudo, :chown, owner, remote_path)
+end

data/lib/capistrano/cookbook/puma_systemd.rb

@@ -0,0 +1 @@
+load File.expand_path("tasks/puma_systemd.cap", File.dirname(__FILE__))

data/lib/capistrano/cookbook/sidekiq_systemd.rb

@@ -0,0 +1 @@
+load File.expand_path("tasks/sidekiq_systemd.cap", File.dirname(__FILE__))

data/lib/capistrano/cookbook/tasks/compile_assets_locally.cap

@@ -8,6 +8,7 @@ namespace :deploy do
       run_locally do
         execute"rsync -av ./public/assets/ #{role.user}@#{role.hostname}:#{release_path}/public/assets/;"
       end
+      sudo "chmod -R 755 #{release_path}/public/assets/"
     end
     run_locally do
       execute "rm -rf ./public/assets"

data/lib/capistrano/cookbook/tasks/monit.cap

@@ -1,4 +1,5 @@
 namespace :monit do
+  
   %w(start stop restart).each do |task_name|
     desc "#{task_name} Monit"
     task task_name do
@@ -7,4 +8,12 @@ namespace :monit do
       end
     end
   end
-end
+  
+  desc "Reload Monit"
+  task 'reload' do
+    on roles(:app), in: :sequence, wait: 5 do
+      sudo "monit reload"
+    end
+  end
+  
+end

data/lib/capistrano/cookbook/tasks/nginx.cap

@@ -3,7 +3,7 @@ namespace :nginx do
     desc "#{task } Nginx"
     task task_name do
       on roles(:app), in: :sequence, wait: 5 do
-        sudo "/etc/init.d/nginx #{task_name}"
+        sudo "systemctl #{task_name} nginx"
       end
     end
   end
@@ -11,11 +11,13 @@ namespace :nginx do
   desc "Remove default Nginx Virtual Host"
   task "remove_default_vhost" do 
     on roles(:app) do
-      if test("[ -f /etc/nginx/sites-enabled/default ]")
-      sudo "rm /etc/nginx/sites-enabled/default"
-      puts "removed default Nginx Virtualhost"
-      else
-        puts "No default Nginx Virtualhost to remove"
+      %w(/etc/nginx/sites-enabled/default /etc/nginx/sites-enabled/000-default).each do |default_filename|
+        if test("[ -f #{default_filename} ]")
+          sudo "rm #{default_filename}"
+          puts "Removed default Nginx Virtualhost: #{default_filename}"
+        else
+          puts "Default: #{default_filename} not found, not removed"
+        end
       end
     end
   end

data/lib/capistrano/cookbook/tasks/puma_systemd.cap

@@ -0,0 +1,17 @@
+namespace :puma do
+  namespace :systemd do
+    desc 'Reload the puma service via systemd by sending USR1 (e.g. trigger a zero downtime deploy)'
+    task :reload do
+      on roles(fetch(:puma_role)) do
+        if fetch(:puma_systemctl_user) == :system
+          sudo "#{fetch(:puma_systemctl_bin)} reload-or-restart #{fetch(:puma_service_unit_name)}"
+        else
+          execute :loginctl, "enable-linger", fetch(:puma_lingering_user) if fetch(:puma_enable_lingering)
+          execute "#{fetch(:puma_systemctl_bin)}", "--user", "reload-or-restart", fetch(:puma_service_unit_name)
+        end
+      end
+    end
+  end
+end
+
+after 'deploy:finished', 'puma:systemd:reload'

data/lib/capistrano/cookbook/tasks/setup_config.cap

@@ -1,6 +1,7 @@
+require 'capistrano/dsl'
 require 'capistrano/cookbook/helpers/setup_config_values'
 require 'capistrano/cookbook/helpers/substitute_strings'
-require 'capistrano/cookbook/helpers/template'
+require 'capistrano/cookbook/helpers/smart_template'
 require 'capistrano/cookbook/nginx'
 require 'capistrano/cookbook/monit'
 require 'securerandom'
@@ -8,38 +9,61 @@ require 'securerandom'
 namespace :deploy do
   task :setup_config do
     conf = ::Capistrano::Cookbook::SetupConfigValues.new
+
     on roles(:app) do
       # make the config dir
       execute :mkdir, "-p #{shared_path}/config"
-      full_app_name = fetch(:full_app_name)
+      execute :mkdir, "-p /home/#{fetch(:deploy_user)}/.config/systemd/user"
 
       # config files to be uploaded to shared/config, see the
       # definition of smart_template for details of operation.
       conf.config_files.each do |file|
-        smart_template file
+        smart_template(file[:source], file[:destination], file[:as_root])
+        execute(:chmod, "+x #{file[:destination]}") if file[:executable]
       end
 
       # which of the above files should be marked as executable
-      conf.executable_config_files.each do |file|
-        execute :chmod, "+x #{shared_path}/config/#{file}"
-      end
+      # conf.executable_config_files.each do |file|
+      #   execute :chmod, "+x #{shared_path}/config/#{file}"
+      # end
 
       # symlink stuff which should be... symlinked
-      conf.symlinks.each do |symlink|
-        sudo "ln -nfs #{shared_path}/config/#{symlink[:source]} #{sub_strings(symlink[:link])}"
+      # conf.symlinks.each do |symlink|
+      #   sudo "ln -nfs #{shared_path}/config/#{symlink[:source]} #{sub_strings(symlink[:link])}"
+      # end
+
+      if File.exists?(File.join('config', 'master.key'))
+        upload! File.join('config', 'master.key'), File.join(shared_path, 'config', 'master.key')
       end
     end
   end
 end
 
-# remove the default nginx configuration as it will tend
-# to conflict with our configs.
+
+# remove the default nginx configuration as it will tend to conflict with our configs
 before 'deploy:setup_config', 'nginx:remove_default_vhost'
 
-# reload nginx to it will pick up any modified vhosts from
-# setup_config
+# make sure that shared directories etc exist before running otherwise the
+# initial nginx reload won't work because of the nginx log file directory path
+# not existing
+before 'deploy:setup_config', 'deploy:check:directories'
+before 'deploy:setup_config', 'deploy:check:linked_dirs'
+
+# After setup config has generated and setup initial files, run the Capistrano Puma
+# tasks responsible for uploading config files. Note that `setup_config` creates overrides
+# for these in `config/deploy/templates` so we're not using the default ones from the gem
+after 'deploy:setup_config', 'puma:config'
+after 'deploy:setup_config', 'puma:nginx_config'
+after 'deploy:setup_config', 'puma:monit:config'
+after 'deploy:setup_config', 'puma:systemd:config'
+after 'deploy:setup_config', 'puma:systemd:enable'
+
+# Enable the sidekiq systemd service so that it's started automatically on (re)boot
+after 'deploy:setup_config', 'sidekiq:systemd:enable' if (defined?(Capistrano::Sidekiq) == 'constant' && Capistrano::Sidekiq.class == Class)
+
+# reload nginx to it will pick up any modified vhosts from setup_config
 after 'deploy:setup_config', 'nginx:reload'
 
-# Restart monit so it will pick up any monit configurations
-# we've added
-after 'deploy:setup_config', 'monit:restart'
+# Restart monit so it will pick up any monit configurations we've added
+after 'deploy:setup_config', 'monit:reload'
+