Merge pull request #18 from TalkingQuickly/feature/refactor

Feature/refactor

Author: TalkingQuickly

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

capistrano-cookbook.gemspec

@@ -19,6 +19,7 @@ Gem::Specification.new do |spec|
 
   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"

lib/capistrano/cookbook.rb

@@ -9,6 +9,7 @@ module Cookbook
     require 'capistrano/cookbook/run_tests'
     require 'capistrano/cookbook/setup_config'
     require 'capistrano/cookbook/create_database'
-    require 'capistrano/cookbook/systemd'
+    require 'capistrano/cookbook/puma_systemd'
+    require 'capistrano/cookbook/sidekiq_systemd'
   end
 end

lib/capistrano/cookbook/helpers/setup_config_values.rb

@@ -1,59 +1,46 @@
 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: "log_rotation",
-            link: "/etc/logrotate.d/{{full_app_name}}"
+            source: 'log_rotation',
+            destination: "/etc/logrotate.d/#{fetch(:full_app_name)}",
+            executable: false,
+            as_root: true 
+          },
+          {
+            source: 'database.example.yml',
+            destination: "#{shared_path}/config/database.example.yml",
+            executable: false,
+            as_root: false
           }
         ]
+
         return base unless sidekiq_enabled?
 
         base + [
           {
-            source: "sidekiq.service.capistrano",
-            link: "/etc/systemd/system/#{fetch(:sidekiq_service_unit_name)}.service"
+            source: 'sidekiq.service.capistrano',
+            destination: "/home/#{fetch(:deploy_user)}/.config/systemd/user/#{fetch(:sidekiq_service_unit_name)}.service",
+            executable: false,
+            as_root: false
           },
           {
             source: "sidekiq_monit",
-            link: "/etc/monit/conf.d/#{fetch(:full_app_name)}_sidekiq.conf"
+            destination: "/etc/monit/conf.d/#{fetch(:full_app_name)}_sidekiq.conf",
+            executable: false,
+            as_root: true
           }
         ]
       end
 
-      def executable_config_files_defaults
-        %w(
-        )
-      end
-
-      def config_files_defaults
-        base = %w(
-          database.example.yml
-          log_rotation
-        )
-        return base unless sidekiq_enabled?
-
-        base + %w(
-          sidekiq.service.capistrano
-          sidekiq_monit
-        )
-      end
-
       def sidekiq_enabled?
         defined?(Capistrano::Sidekiq) == 'constant' && Capistrano::Sidekiq.class == Class
       end

lib/capistrano/cookbook/helpers/template.rb renamed to lib/capistrano/cookbook/helpers/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,13 +14,12 @@
 # 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
@@ -35,3 +37,14 @@ def template_file(name)
   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

lib/capistrano/cookbook/puma_systemd.rb

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

lib/capistrano/cookbook/sidekiq_systemd.rb

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

lib/capistrano/cookbook/systemd.rb

@@ -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

lib/capistrano/cookbook/tasks/nginx.cap

@@ -6,8 +6,8 @@ namespace :puma do
         if fetch(:puma_systemctl_user) == :system
           sudo "#{fetch(:puma_systemctl_bin)} reload-or-restart #{fetch(:puma_service_unit_name)}"
         else
-          execute "#{fetch(:puma_systemctl_bin)}", "--user", "reload", fetch(:puma_service_unit_name)
           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