Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -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 <stage> 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

Expand Down
4 changes: 2 additions & 2 deletions lib/capistrano/solid_queue.rb
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
27 changes: 3 additions & 24 deletions test/capistrano/test_service_unit.rb
Original file line number Diff line number Diff line change
@@ -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"')

Expand All @@ -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"))
Expand Down
34 changes: 34 additions & 0 deletions test/capistrano/test_systemctl_failure.rb
Original file line number Diff line number Diff line change
@@ -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
31 changes: 31 additions & 0 deletions test/test_helper.rb
Original file line number Diff line number Diff line change
Expand Up @@ -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
Loading