process_bot 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f1bb2b0296a51e0b52b952f49f6724d95d7478181539b75fac529ff3ab3d82de
+  data.tar.gz: d7ec454928d4e72f40e9a5d5cf05e2fff930cf73de754c47fb344209173294aa
+SHA512:
+  metadata.gz: c0183b4d9a6f4023393467dc1fb794b2c1fc1c30d481a24b1cbb9728f714be5b2bd1f5e2620c71e60394e59aa79a5fef65f42cc152553007939dda0244635507
+  data.tar.gz: 8ee7928cf14abedbda792e50653fad619c9ac89196dc7effb0869fcda37141dd637fd63085075e7068cec50d1d903ff69b6216fb446939405654683b000bf4bc

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,13 @@
+AllCops:
+  TargetRubyVersion: 2.6
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2022-04-03
+
+- Initial release

data/Gemfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in process_bot.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"
+
+gem "rubocop", "~> 1.21"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 kaspernj
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,39 @@
+# ProcessBot
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/process_bot`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'process_bot'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install process_bot
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/kaspernj/process_bot.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/lib/process_bot/capistrano/puma.rake

@@ -0,0 +1,90 @@
+git_plugin = self
+
+namespace :process_bot do
+  namespace :puma do
+    desc "Start Puma through ProcessBot"
+    task :start do
+      on roles(fetch(:puma_role)) do |role|
+        git_plugin.puma_switch_user(role) do
+          if test "[ -f #{fetch(:puma_pid)} ]" and test :kill, "-0 $( cat #{fetch(:puma_pid)} )"
+            info "Puma is already running"
+          else
+            within current_path do
+              with rack_env: fetch(:puma_env) do
+                releases = capture(:ls, "-x", releases_path).split
+                releases << release_timestamp.to_s if release_timestamp
+                releases.uniq
+
+                latest_release_version = releases.last
+                raise "Invalid release timestamp: #{release_timestamp}" unless latest_release_version
+
+                puma_args = [
+                  "-C #{fetch(:puma_conf)}",
+                  "--control-url tcp://127.0.0.1:9293",
+                  "--control-token foobar"
+                ]
+
+                command = "/usr/bin/screen -dmS puma-#{latest_release_version} bash -c 'cd #{release_path} && #{SSHKit.config.command_map.prefix[:puma].join(" ")} puma #{puma_args.join(" ")}'"
+                execute command
+              end
+            end
+          end
+        end
+      end
+    end
+
+    %w[halt stop status].map do |command|
+      desc "#{command} puma"
+      task command do
+        on roles (fetch(:puma_role)) do |role|
+          within current_path do
+            git_plugin.puma_switch_user(role) do
+              with rack_env: fetch(:puma_env) do
+                if test "[ -f #{fetch(:puma_pid)} ]"
+                  if git_plugin.stop_puma
+                    git_plugin.run_puma_command(command)
+                  else
+                    # delete invalid pid file , process is not running.
+                    execute :rm, fetch(:puma_pid)
+                  end
+                else
+                  #pid file not found, so puma is probably not running or it using another pidfile
+                  warn "Puma not running"
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+
+    %w[phased-restart restart].map do |command|
+      desc "#{command} puma"
+      task command do
+        on roles (fetch(:puma_role)) do |role|
+          within current_path do
+            git_plugin.puma_switch_user(role) do
+              with rack_env: fetch(:puma_env) do
+                if git_plugin.puma_running?
+                  # NOTE pid exist but state file is nonsense, so ignore that case
+                  git_plugin.run_puma_command(command)
+                else
+                  # Puma is not running or state file is not present : Run it
+                  invoke "process_bot:puma:start"
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+
+    task :smart_restart do
+      if !fetch(:puma_preload_app) && fetch(:puma_workers, 0).to_i > 1
+        invoke "process_bot:puma:phased-restart"
+      else
+        invoke "process_bot:puma:restart"
+      end
+    end
+  end
+end

data/lib/process_bot/capistrano/puma.rb

@@ -0,0 +1,23 @@
+module ProcessBot::Capistrano::Puma < Capistrano::Plugin
+  include PumaCommon
+
+  def register_hooks
+    after 'deploy:finished', 'process_bot:puma:smart_restart'
+  end
+
+  def define_tasks
+    eval_rakefile File.expand_path('./puma.rake', __FILE__)
+  end
+
+  def puma_running?
+    backend.test("[ -f #{fetch(:puma_pid)} ]") && backend.test(:kill, "-0 $( cat #{fetch(:puma_pid)} )")
+  end
+
+  def run_puma_command(command)
+    backend.execute :pumactl, "--control-url 'tcp://127.0.0.1:9293'", "--control-token foobar", "-F #{fetch(:puma_conf)} #{command}"
+  end
+
+  def stop_puma
+    run_puma_command("stop")
+  end
+end

data/lib/process_bot/capistrano/sidekiq.rake

@@ -0,0 +1,81 @@
+git_plugin = self
+
+namespace :load do
+  task :defaults do
+    set :sidekiq_default_hooks, true
+
+    set :sidekiq_pid, -> { File.join(shared_path, "tmp", "pids", "sidekiq.pid") }
+    set :sidekiq_env, -> { fetch(:rack_env, fetch(:rails_env, fetch(:stage))) }
+    set :sidekiq_log, -> { File.join(shared_path, "log", "sidekiq.log") }
+    set :sidekiq_timeout, 10
+    set :sidekiq_roles, fetch(:sidekiq_role, :app)
+    set :sidekiq_processes, 1
+    set :sidekiq_options_per_process, nil
+    set :sidekiq_user, nil
+    # Rbenv, Chruby, and RVM integration
+    set :rbenv_map_bins, fetch(:rbenv_map_bins).to_a.concat(%w[sidekiq sidekiqctl])
+    set :rvm_map_bins, fetch(:rvm_map_bins).to_a.concat(%w[sidekiq sidekiqctl])
+    set :chruby_map_bins, fetch(:chruby_map_bins).to_a.concat(%w[sidekiq sidekiqctl])
+    # Bundler integration
+    set :bundle_bins, fetch(:bundle_bins).to_a.concat(%w[sidekiq sidekiqctl])
+    # Init system integration
+    set :init_system, -> { nil }
+    # systemd integration
+    set :service_unit_name, "sidekiq-#{fetch(:stage)}.service"
+    set :upstart_service_name, "sidekiq"
+  end
+end
+
+namespace :process_bot do
+  namespace :sidekiq do
+    desc 'Quiet sidekiq (stop fetching new tasks from Redis)'
+    task :quiet do
+      on roles fetch(:sidekiq_roles) do |role|
+        git_plugin.switch_user(role) do
+          git_plugin.running_sidekiq_processes.each do |sidekiq_process|
+            git_plugin.stop_sidekiq(pid: sidekiq_process.fetch(:pid), signal: "TSTP")
+          end
+        end
+      end
+    end
+
+    desc 'Stop sidekiq (graceful shutdown within timeout, put unfinished tasks back to Redis)'
+    task :stop do
+      on roles fetch(:sidekiq_roles) do |role|
+        git_plugin.switch_user(role) do
+          git_plugin.running_sidekiq_processes.each do |sidekiq_process|
+            git_plugin.stop_sidekiq(pid: sidekiq_process.fetch(:pid), signal: "TERM")
+          end
+        end
+      end
+    end
+
+    task :stop_after_time do
+      on roles fetch(:sidekiq_roles) do |role|
+        git_plugin.switch_user(role) do
+          git_plugin.running_sidekiq_processes.each do |sidekiq_process|
+            git_plugin.stop_sidekiq_after_time(pid: sidekiq_process.fetch(:pid), signal: "TERM")
+          end
+        end
+      end
+    end
+
+    desc 'Start sidekiq'
+    task :start do
+      on roles fetch(:sidekiq_roles) do |role|
+        git_plugin.switch_user(role) do
+          fetch(:sidekiq_processes).times do |idx|
+            puts "Starting Sidekiq #{idx}"
+            git_plugin.start_sidekiq(idx)
+          end
+        end
+      end
+    end
+
+    desc 'Restart sidekiq'
+    task :restart do
+      invoke! "process_bot:sidekiq:stop"
+      invoke! "process_bot:sidekiq:start"
+    end
+  end
+end

data/lib/process_bot/capistrano/sidekiq.rb

@@ -0,0 +1,7 @@
+module ProcessBot::Capistrano::Sidekiq < Capistrano::Plugin
+  include ProcessBot::Sidekiq::Helpers
+
+  def define_tasks
+    eval_rakefile File.expand_path("./sidekiq.rake", __FILE__)
+  end
+end

data/lib/process_bot/capistrano/sidekiq_helpers.rb

@@ -0,0 +1,131 @@
+module ProcessBot::Sidekiq::Helpers
+  def sidekiq_require
+    if fetch(:sidekiq_require)
+      "--require #{fetch(:sidekiq_require)}"
+    end
+  end
+
+  def sidekiq_config
+    if fetch(:sidekiq_config)
+      "--config #{fetch(:sidekiq_config)}"
+    end
+  end
+
+  def sidekiq_concurrency
+    if fetch(:sidekiq_concurrency)
+      "--concurrency #{fetch(:sidekiq_concurrency)}"
+    end
+  end
+
+  def sidekiq_queues
+    Array(fetch(:sidekiq_queue)).map do |queue|
+      "--queue #{queue}"
+    end.join(' ')
+  end
+
+  def sidekiq_logfile
+    fetch(:sidekiq_log)
+  end
+
+  def switch_user(role)
+    su_user = sidekiq_user(role)
+    if su_user == role.user
+      yield
+    else
+      as su_user do
+        yield
+      end
+    end
+  end
+
+  VALID_SIGNALS = ["TERM", "TSTP"]
+  def stop_sidekiq(pid:, signal:)
+    raise "Invalid PID: #{pid}" unless pid.to_s.match?(/\A\d+\Z/)
+    raise "Invalid signal: #{signal}" unless VALID_SIGNALS.include?(signal)
+
+    backend.execute "kill -#{signal} #{pid}"
+  end
+
+  def stop_sidekiq_after_time(pid:, signal:)
+    raise "Invalid PID: #{pid}" unless pid.to_s.match?(/\A\d+\Z/)
+    raise "Invalid signal: #{signal}" unless VALID_SIGNALS.include?(signal)
+
+    time = ENV["STOP_AFTER_TIME"] || fetch(:sidekiq_stop_after_time)
+    raise "Invalid time: #{time}" unless time.to_s.match?(/\A\d+\Z/)
+
+    backend.execute "screen -dmS stopsidekiq#{pid} sleep #{time}; kill -#{signal} #{pid}"
+  end
+
+  def running_sidekiq_processes
+    sidekiq_app_name = fetch(:sidekiq_app_name, fetch(:application))
+    raise "No :sidekiq_app_name was set" unless sidekiq_app_name
+
+    begin
+      processes_output = backend.capture("ps a | egrep 'sidekiq ([0-9]+\.[0-9]+\.[0-9]+) #{Regexp.escape(sidekiq_app_name)}'")
+    rescue SSHKit::Command::Failed
+      # Fails when output is empty (when no processes found through grep)
+      puts "No Sidekiq processes found"
+      return []
+    end
+
+    processes = []
+    processes_output.scan(/^\s*(\d+)\s+(\S+)\s+(\S+)\s+(\S+)\s+(.+)$/).each do |process_output|
+      sidekiq_pid = process_output[0]
+
+      processes << {pid: sidekiq_pid}
+    end
+
+    processes
+  end
+
+  def sidekiq_user(role = nil)
+    if role.nil?
+      fetch(:sidekiq_user)
+    else
+      properties = role.properties
+      properties.fetch(:sidekiq_user) || # local property for sidekiq only
+        fetch(:sidekiq_user) ||
+        properties.fetch(:run_as) || # global property across multiple capistrano gems
+        role.user
+    end
+  end
+
+  def expanded_bundle_path
+    backend.capture(:echo, SSHKit.config.command_map[:bundle]).strip
+  end
+
+  def start_sidekiq(idx = 0)
+    args = []
+    args.push "--environment #{fetch(:sidekiq_env)}"
+    #args.push "--logfile #{fetch(:sidekiq_log)}" if fetch(:sidekiq_log)
+    args.push "--require #{fetch(:sidekiq_require)}" if fetch(:sidekiq_require)
+    args.push "--tag #{fetch(:sidekiq_tag)}" if fetch(:sidekiq_tag)
+    Array(fetch(:sidekiq_queue)).each do |queue|
+      args.push "--queue #{queue}"
+    end
+    args.push "--config #{fetch(:sidekiq_config)}" if fetch(:sidekiq_config)
+    args.push "--concurrency #{fetch(:sidekiq_concurrency)}" if fetch(:sidekiq_concurrency)
+    if (process_options = fetch(:sidekiq_options_per_process))
+      args.push process_options[idx]
+    end
+    # use sidekiq_options for special options
+    args.push fetch(:sidekiq_options) if fetch(:sidekiq_options)
+
+    releases = backend.capture(:ls, "-x", releases_path).split
+    releases << release_timestamp.to_s if release_timestamp
+    releases.uniq
+
+    latest_release_version = releases.last
+    raise "Invalid release timestamp: #{release_timestamp}" unless latest_release_version
+
+    screen_args = ["-dmS sidekiq-#{idx}-#{latest_release_version}"]
+    screen_args << "-L -Logfile #{fetch(:sidekiq_log)}" if fetch(:sidekiq_log)
+
+    # command = "/usr/bin/tmux new -d -s sidekiq#{idx} '#{SSHKit.config.command_map.prefix[:sidekiq].join(" ")} sidekiq #{args.compact.join(' ')}'"
+    command = "/usr/bin/screen #{screen_args.join(" ")} bash -c 'cd #{release_path} && #{SSHKit.config.command_map.prefix[:sidekiq].join(" ")} sidekiq #{args.compact.join(' ')}'"
+
+    puts "WARNING: A known bug prevents Sidekiq from starting when pty is set (which it is)" if fetch(:pty)
+
+    backend.execute command
+  end
+end

data/lib/process_bot/process.rb

@@ -0,0 +1,5 @@
+class ProcessBot::Process
+  def initialize(command)
+    @command = command
+  end
+end

data/lib/process_bot/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module ProcessBot
+  VERSION = "0.1.0"
+end

data/lib/process_bot.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require_relative "process_bot/version"
+
+module ProcessBot
+  class Error < StandardError; end
+  # Your code goes here...
+end

data/sig/process_bot.rbs

@@ -0,0 +1,4 @@
+module ProcessBot
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,63 @@
+--- !ruby/object:Gem::Specification
+name: process_bot
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- kaspernj
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2022-04-03 00:00:00.000000000 Z
+dependencies: []
+description: Run and control processes.
+email:
+- k@spernj.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/process_bot.rb
+- lib/process_bot/capistrano/puma.rake
+- lib/process_bot/capistrano/puma.rb
+- lib/process_bot/capistrano/sidekiq.rake
+- lib/process_bot/capistrano/sidekiq.rb
+- lib/process_bot/capistrano/sidekiq_helpers.rb
+- lib/process_bot/process.rb
+- lib/process_bot/version.rb
+- sig/process_bot.rbs
+homepage: https://github.com/kaspernj/process_bot
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/kaspernj/process_bot
+  source_code_uri: https://github.com/kaspernj/process_bot
+  changelog_uri: https://github.com/kaspernj/process_bot/blob/master/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.32
+signing_key: 
+specification_version: 4
+summary: Run and control processes.
+test_files: []