immosquare-capistrano 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: fd4a36233e060600fceaf3284d69e888a1cc2e878f0f2989e2ee84133b109dbc
+  data.tar.gz: 86d11c5ff55f124e30e032983c87473beb5cde9026f89870b1bd7a812d2583be
+SHA512:
+  metadata.gz: 14f0e82c609fc01e275979e552bb43ff5c59c87162cb036968b53796e44c3197f69f41f0217545108b3fbf7923e9a05715e09d94e7715338cdf5832ebffd9df7
+  data.tar.gz: 391981483ca9e86340f7386805b46058e3ac06feafd20a63db3dc8dc4d9649a644288e68df52fd87d999acaa640bf68125adc804fbbb60ecb76d22fda9af3659

data/lib/immosquare/capistrano/defaults.rb

@@ -0,0 +1,5 @@
+namespace :load do
+  task :defaults do
+    set_if_empty :solid_queue_service_unit_name, -> { "solid_queue_#{fetch(:application)}_puma_#{fetch(:stage)}" }
+  end
+end

data/lib/immosquare/capistrano/helpers.rb

@@ -0,0 +1,24 @@
+module Capistrano
+  module SolidQueue
+    module Helpers
+      ##============================================================##
+      ## Get the path to bundle command
+      ##============================================================##
+      def self.expanded_bundle_command
+        SSHKit.config.command_map[:bundle].to_s
+      end
+
+      def self.template_path(service)
+        "#{File.dirname(__FILE__)}/templates/#{service}.service.erb"
+      end
+
+      def self.service_name
+        "#{fetch(:solid_queue_service_unit_name)}.service"
+      end
+
+      def self.result_path
+        "#{fetch(:tmp_dir)}/#{service_name}"
+      end
+    end
+  end
+end

data/lib/immosquare/capistrano/solid_queue.rb

@@ -0,0 +1,9 @@
+require_relative "defaults"
+require_relative "helpers"
+
+load File.expand_path("tasks/solid_queue.rake", __dir__)
+
+# SolidQueue hooks
+after "deploy:starting",  "solid_queue:stop"
+after "deploy:published", "solid_queue:start"
+after "deploy:failed",    "solid_queue:restart"

data/lib/immosquare/capistrano/tasks/solid_queue.rake

@@ -0,0 +1,80 @@
+
+namespace :solid_queue do
+  ##============================================================##
+  ## Install SolidQueue service
+  ##============================================================##
+  desc "Install SolidQueue service"
+  task :install do
+    on roles(:app) do
+      template_path = File.read(Capistrano::SolidQueue::Helpers.template_path("solid_queue"))
+      result        = ERB.new(template_path).result(binding)
+      result_path   = Capistrano::SolidQueue::Helpers.result_path
+
+      ##============================================================##
+      ## Upload the service file to the server
+      ##============================================================##
+      upload!(StringIO.new(result), result_path)
+
+      ##============================================================##
+      ## Move the service file to the systemd directory
+      ##============================================================##
+      sudo "mv #{result_path} /etc/systemd/system/#{Capistrano::SolidQueue::Helpers.service_name}"
+
+      ##============================================================##
+      ## Reload the systemd daemon and quiet the service
+      ##============================================================##
+      sudo "systemctl daemon-reload"
+      sudo "systemctl enable #{Capistrano::SolidQueue::Helpers.service_name}"
+    end
+  end
+
+  ##============================================================##
+  ## Uninstall SolidQueue service
+  ##============================================================##
+  desc "Uninstall SolidQueue service"
+  task :uninstall do
+    on roles(:app) do
+      service_name = Capistrano::SolidQueue::Helpers.service_name
+
+      if test("systemctl list-units --full -all | grep -Fq '#{service_name}'")
+        sudo("systemctl stop #{service_name}")
+        sudo("systemctl disable #{service_name}")
+        sudo("rm -f /etc/systemd/system/#{service_name}")
+        sudo("systemctl daemon-reload")
+      else
+        info("Service #{service_name} does not exist and does not need to be disabled.")
+      end
+    end
+  end
+
+
+  ##============================================================##
+  ## Start solid_queue
+  ##============================================================##
+  desc "Start solid_queue"
+  task :start do
+    on roles(:app) do
+      sudo "systemctl start #{Capistrano::SolidQueue::Helpers.service_name}"
+    end
+  end
+
+  ##============================================================##
+  ## Stop solid_queue (force immediate termination)
+  ##============================================================##
+  desc "Stop solid_queue (force immediate termination)"
+  task :stop do
+    on roles(:app) do
+      sudo "systemctl stop #{Capistrano::SolidQueue::Helpers.service_name}"
+    end
+  end
+
+  ##============================================================##
+  ## Restart solid_queue
+  ##============================================================##
+  desc "Restart solid_queue"
+  task :restart do
+    on roles(:app) do
+      sudo "systemctl restart #{Capistrano::SolidQueue::Helpers.service_name}"
+    end
+  end
+end

data/lib/immosquare/capistrano/templates/solid_queue.service.erb

@@ -0,0 +1,25 @@
+[Unit]
+Description=SolidQueue for <%= "#{fetch(:application)} (#{fetch(:stage)})" %>
+After=syslog.target network.target
+
+[Service]
+Type=simple
+Environment=RAILS_ENV=<%= fetch(:stage) %>
+User=<%= fetch(:solid_queue_user) %>
+WorkingDirectory=<%= current_path %>
+
+ExecStart=<%= Capistrano::SolidQueue::Helpers.expanded_bundle_command %> exec rake solid_queue:start
+ExecReload=/bin/kill -HUP $MAINPID
+ExecStop=/bin/kill -TERM $MAINPID
+
+
+StandardOutput=append:<%= shared_path %>/log/solidqueue_access.log
+StandardError=append:<%= shared_path %>/log/solidqueue_error.log
+
+RestartSec=1
+Restart=on-failure
+
+SyslogIdentifier=<%= fetch(:solid_queue_service_unit_name) %>
+
+[Install]
+WantedBy=multi-user.target

data/lib/immosquare-capistrano/version.rb

@@ -0,0 +1,3 @@
+module ImmosquareCapistrano
+  VERSION = "0.1.0".freeze
+end

metadata

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification
+name: immosquare-capistrano
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- IMMO SQUARE
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-04-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: capistrano
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Puma, Sidekiq & SolidQueue services integrations for Capistrano
+email:
+- jules@immosquare.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/immosquare-capistrano.rb
+- lib/immosquare-capistrano/version.rb
+- lib/immosquare/capistrano/defaults.rb
+- lib/immosquare/capistrano/helpers.rb
+- lib/immosquare/capistrano/solid_queue.rb
+- lib/immosquare/capistrano/tasks/solid_queue.rake
+- lib/immosquare/capistrano/templates/solid_queue.service.erb
+homepage: https://github.com/IMMOSQUARE/immosquare-capistrano
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.2
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.7
+signing_key:
+specification_version: 4
+summary: Puma, Sidekiq & SolidQueue services integrations for Capistrano
+test_files: []