diff --git a/CHANGELOG.md b/CHANGELOG.md index 4c5cbdc..6a6b227 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,6 +1,7 @@ ## [Unreleased] - `RAILS_ENV` of the systemd service now comes from `:rails_env`, falling back to `:stage` [#8](https://github.com/codeur/capistrano-solid_queue/issues/8). Run `cap solid_queue:install` again to update an installed service. +- `solid_queue:quiet` no longer aborts the deploy when `systemctl` fails, as before 0.1.1. ## [0.1.2] - 2025-06-12 diff --git a/lib/capistrano/solid_queue.rb b/lib/capistrano/solid_queue.rb index b270890..cf190b3 100644 --- a/lib/capistrano/solid_queue.rb +++ b/lib/capistrano/solid_queue.rb @@ -25,12 +25,12 @@ def register_hooks end def execute_systemd(*args, raise_on_non_zero_exit: true) - sudo_if_needed(*systemd_command(*args), raise_on_non_zero_exit: true) + sudo_if_needed(*systemd_command(*args), raise_on_non_zero_exit: raise_on_non_zero_exit) end def sudo_if_needed(*command, raise_on_non_zero_exit: true) if fetch(:solid_queue_systemctl_user) == :system - backend.sudo command.join(" ") + backend.sudo command.join(" "), raise_on_non_zero_exit: raise_on_non_zero_exit else backend.execute(*command, raise_on_non_zero_exit: raise_on_non_zero_exit) end diff --git a/test/capistrano/test_service_unit.rb b/test/capistrano/test_service_unit.rb index f9f006a..6815659 100644 --- a/test/capistrano/test_service_unit.rb +++ b/test/capistrano/test_service_unit.rb @@ -1,11 +1,10 @@ # frozen_string_literal: true require "test_helper" -require "fileutils" -require "open3" -require "tmpdir" class Capistrano::TestServiceUnit < Minitest::Test + include CapistranoProject + def test_rails_env_is_capistrano_rails_env unit = generate_unit(stage_config: 'set :rails_env, "production"') @@ -21,27 +20,7 @@ def test_rails_env_defaults_to_stage private def generate_unit(stage_config: "") - Dir.mktmpdir do |dir| - FileUtils.mkdir_p(File.join(dir, "config", "deploy")) - File.write(File.join(dir, "Capfile"), <<~RUBY) - require "capistrano/setup" - require "capistrano/deploy" - require "capistrano/scm/git" - install_plugin Capistrano::SCM::Git - require "capistrano/solid_queue" - install_plugin Capistrano::SolidQueue::Systemd - RUBY - File.write(File.join(dir, "config", "deploy.rb"), <<~RUBY) - set :application, "app" - set :deploy_to, "/var/www/app" - set :sshkit_backend, SSHKit::Backend::Local - RUBY - File.write(File.join(dir, "config", "deploy", "preprod.rb"), <<~RUBY) - server "localhost", roles: %w[db] - #{stage_config} - RUBY - - output, status = Open3.capture2e(RbConfig.ruby, Gem.bin_path("capistrano", "cap"), "preprod", "solid_queue:generate", chdir: dir) + run_cap("solid_queue:generate", stage_config: stage_config) do |output, status, dir| assert status.success?, output File.read(File.join(dir, "solid_queue.service")) diff --git a/test/capistrano/test_systemctl_failure.rb b/test/capistrano/test_systemctl_failure.rb new file mode 100644 index 0000000..07d2c0b --- /dev/null +++ b/test/capistrano/test_systemctl_failure.rb @@ -0,0 +1,34 @@ +# frozen_string_literal: true + +require "test_helper" + +class Capistrano::TestSystemctlFailure < Minitest::Test + include CapistranoProject + + def test_quiet_goes_on_when_systemctl_fails + run_cap("solid_queue:quiet", stage_config: 'SSHKit.config.command_map[:"/bin/systemctl"] = "false"') do |output, status| + assert_includes output, "false --user kill -s SIGTERM app_solid_queue_preprod" + assert status.success?, output + end + end + + def test_quiet_goes_on_when_systemctl_fails_as_system_user + stage_config = <<~RUBY + set :solid_queue_systemctl_user, :system + SSHKit.config.command_map[:sudo] = "false" + RUBY + + run_cap("solid_queue:quiet", stage_config: stage_config) do |output, status| + assert_includes output, "false /bin/systemctl kill -s SIGTERM app_solid_queue_preprod" + assert status.success?, output + end + end + + def test_stop_aborts_when_systemctl_fails + run_cap("solid_queue:stop", stage_config: 'SSHKit.config.command_map[:"/bin/systemctl"] = "false"') do |output, status| + assert_includes output, "false --user stop app_solid_queue_preprod" + assert_includes output, "SSHKit::Command::Failed: /bin/systemctl exit status" + refute status.success?, output + end + end +end diff --git a/test/test_helper.rb b/test/test_helper.rb index b12b588..cc73451 100644 --- a/test/test_helper.rb +++ b/test/test_helper.rb @@ -3,4 +3,35 @@ $LOAD_PATH.unshift File.expand_path("../lib", __dir__) require "capistrano/solid_queue" +require "fileutils" require "minitest/autorun" +require "open3" +require "tmpdir" + +module CapistranoProject + def run_cap(task, stage_config: "") + Dir.mktmpdir do |dir| + FileUtils.mkdir_p(File.join(dir, "config", "deploy")) + File.write(File.join(dir, "Capfile"), <<~RUBY) + require "capistrano/setup" + require "capistrano/deploy" + require "capistrano/scm/git" + install_plugin Capistrano::SCM::Git + require "capistrano/solid_queue" + install_plugin Capistrano::SolidQueue::Systemd + RUBY + File.write(File.join(dir, "config", "deploy.rb"), <<~RUBY) + set :application, "app" + set :deploy_to, "/var/www/app" + set :sshkit_backend, SSHKit::Backend::Local + RUBY + File.write(File.join(dir, "config", "deploy", "preprod.rb"), <<~RUBY) + server "localhost", roles: %w[db] + #{stage_config} + RUBY + + output, status = Open3.capture2e(RbConfig.ruby, Gem.bin_path("capistrano", "cap"), "preprod", task, chdir: dir) + yield output, status, dir + end + end +end