tomo-plugin-good_job 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e06b8143748c4cbac1f8fd4bcb9c1377ba4f8c0c4b2128f0e4f4c1c87cd69edb
+  data.tar.gz: 8f8738057daf529320d0642cc23422f19779122d24122ae1cf5fc509ddf35537
+SHA512:
+  metadata.gz: 3ebca4f89c2f2b70424a7b7e93df468bea3ca000e4521e060a1d8ebff9927501bdf6d913dfa10a0b64af9387990cf1befe26dded235940c7e3e273cd59cd7039
+  data.tar.gz: 15a2a7f681a34b5034397970a43095278c89043ac9fda2f62269ab6cbb724b91b58455be290bc0eebb92b6ebdca5fa14134f16b1d06b95ea6af90055aa329db9

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Matt Brictson
+
+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,140 @@
+# tomo-plugin-good_job
+
+[![Gem Version](https://badge.fury.io/rb/tomo-plugin-good_job.svg)](https://rubygems.org/gems/tomo-plugin-good_job)
+[![Circle](https://circleci.com/gh/gauravtiwari/tomo-plugin-good_job/tree/main.svg?style=shield)](https://app.circleci.com/pipelines/github/gauravtiwari/tomo-plugin-good_job?branch=main)
+[![Code Climate](https://codeclimate.com/github/gauravtiwari/tomo-plugin-good_job/badges/gpa.svg)](https://codeclimate.com/github/gauravtiwari/tomo-plugin-good_job)
+
+This is a [tomo](https://github.com/mattbrictson/tomo) plugin that provides tasks for managing [good_job](https://github.com/bensheldon/good_job) via [systemd](https://en.wikipedia.org/wiki/Systemd), based on the recommendations in the good_job documentation. This plugin assumes that you are also using the tomo `rbenv` and `env` plugins, and that you are using a systemd-based Linux distribution like Ubuntu 18 LTS.
+
+---
+
+- [Installation](#installation)
+- [Settings](#settings)
+- [Tasks](#tasks)
+- [Support](#support)
+- [License](#license)
+- [Code of conduct](#code-of-conduct)
+- [Contribution guide](#contribution-guide)
+
+## Installation
+
+Run:
+
+```
+$ gem install tomo-plugin-good_job
+```
+
+Or add it to your Gemfile:
+
+```ruby
+gem "tomo-plugin-good_job"
+```
+
+Then add the following to `.tomo/config.rb`:
+
+```ruby
+plugin "good_job"
+
+setup do
+  # ...
+  run "good_job:setup_systemd"
+end
+
+deploy do
+  # ...
+  # Place this task at *after* core:symlink_current
+  run "good_job:restart"
+end
+```
+
+### enable-linger
+
+This plugin installs good_job as a user-level service using systemctl --user. This allows good_job to be installed, started, stopped, and restarted without a root user or sudo. However, when provisioning the host you must make sure to run the following command as root to allow the good_job process to continue running even after the tomo deploy user disconnects:
+
+```
+# run as root
+$ loginctl enable-linger <DEPLOY_USER>
+```
+
+## Settings
+
+| Name                                     | Purpose                                                                                                                                                                                                         |
+| ---------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `good_job_systemd_service`               | Name of the systemd unit that will be used to manage good*job <br>**Default:** `"good_job*%{application}.service"`                                                                                              |
+| `good_job_systemd_service_path`          | Location where the systemd unit will be installed <br>**Default:** `".config/systemd/user/%{good_job_systemd_service}"`                                                                                         |
+| `good_job_systemd_service_template_path` | Local path to the ERB template that will be used to create the systemd unit <br>**Default:** [service.erb](https://github.com/gauravtiwari/tomo-plugin-good_job/blob/main/lib/tomo/plugin/good_job/service.erb) |
+
+## Tasks
+
+### good_job:setup_systemd
+
+Configures systemd to manage good_job. This means that good_job will automatically be restarted if it crashes, or if the host is rebooted. This task essentially does two things:
+
+1. Installs a `good_job.service` systemd unit
+1. Enables it using `systemctl --user enable`
+
+Note that these units will be installed and run for the deploy user. You can use `:good_job_systemd_service_template_path` to provide your own template and customize how good_job and systemd are configured.
+
+`good_job:setup_systemd` is intended for use as a [setup](https://tomo-deploy.com/commands/setup/) task. It must be run before good_job can be started during a deploy.
+
+### good_job:restart
+
+Gracefully restarts the good_job service via systemd, or starts it if it isn't running already. Equivalent to:
+
+```
+systemctl --user restart good_job.service
+```
+
+### good_job:start
+
+Starts the good_job service via systemd, if it isn't running already. Equivalent to:
+
+```
+systemctl --user start good_job.service
+```
+
+### good_job:stop
+
+Stops the good_job service via systemd. Equivalent to:
+
+```
+systemctl --user stop good_job.service
+```
+
+### good_job:status
+
+Prints the status of the good_job systemd service. Equivalent to:
+
+```
+systemctl --user status good_job.service
+```
+
+### good_job:log
+
+Uses `journalctl` (part of systemd) to view the log output of the good_job service. This task is intended for use as a [run](https://tomo-deploy.com/commands/run/) task and accepts command-line arguments. The arguments are passed through to the `journalctl` command. For example:
+
+```
+$ tomo run -- good_job:log -f
+```
+
+Will run this remote script:
+
+```
+journalctl -q --user-unit=good_job.service -f
+```
+
+## Support
+
+If you want to report a bug, or have ideas, feedback or questions about the gem, [let me know via GitHub issues](https://github.com/gauravtiwari/tomo-plugin-good_job/issues/new) and I will do my best to provide a helpful answer. Happy hacking!
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](LICENSE.txt).
+
+## Code of conduct
+
+Everyone interacting in this project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](CODE_OF_CONDUCT.md).
+
+## Contribution guide
+
+Pull requests are welcome! Thanks @mattbrictson for Tomo 🙏

data/lib/tomo/plugin/good_job/service.erb

@@ -0,0 +1,22 @@
+[Unit]
+Description=GoodJob for <%= settings[:application] %>
+After=syslog.target network.target
+ConditionPathExists=<%= paths.current %>
+
+[Service]
+ExecReload=/usr/bin/kill -TSTP $MAINPID
+ExecStart=/bin/bash -lc 'exec bundle exec good_job start'
+Restart=on-failure
+RestartSec=1
+StandardError=syslog
+StandardOutput=syslog
+SyslogIdentifier=%n
+Type=simple
+WorkingDirectory=<%= paths.current %>
+
+# Greatly reduce Ruby memory fragmentation and heap usage
+# https://www.mikeperham.com/2018/04/25/taming-rails-memory-bloat/
+Environment=MALLOC_ARENA_MAX=2
+
+[Install]
+WantedBy=default.target

data/lib/tomo/plugin/good_job/tasks.rb

@@ -0,0 +1,48 @@
+module Tomo::Plugin::GoodJob
+  class Tasks < Tomo::TaskLibrary
+    SystemdUnit = Struct.new(:name, :template, :path)
+
+    def setup_systemd
+      linger_must_be_enabled!
+
+      remote.mkdir_p service.path.dirname
+      remote.write template: service.template, to: service.path
+
+      remote.run "systemctl --user daemon-reload"
+      remote.run "systemctl", "--user", "enable", service.name
+    end
+
+    %i[reload restart start stop status].each do |action|
+      define_method(action) do
+        remote.run "systemctl", "--user", action, service.name
+      end
+    end
+
+    def log
+      remote.attach "journalctl", "-q", raw("--user-unit=#{service.name.shellescape}"), *settings[:run_args]
+    end
+
+    private
+
+    def service
+      SystemdUnit.new(
+        settings[:good_job_systemd_service],
+        paths.good_job_systemd_service_template,
+        paths.good_job_systemd_service
+      )
+    end
+
+    def linger_must_be_enabled!
+      linger_users = remote.list_files("/var/lib/systemd/linger", raise_on_error: false)
+      return if dry_run? || linger_users.include?(remote.host.user)
+
+      die <<~ERROR.strip
+        Linger must be enabled for the #{remote.host.user} user in order for
+        good_job to stay running in the background via systemd. Run the following
+        command as root:
+
+          loginctl enable-linger #{remote.host.user}
+      ERROR
+    end
+  end
+end

data/lib/tomo/plugin/good_job/version.rb

@@ -0,0 +1,8 @@
+module Tomo
+  module Plugin
+  end
+end
+
+module Tomo::Plugin::GoodJob
+  VERSION = "1.0.0".freeze
+end

data/lib/tomo/plugin/good_job.rb

@@ -0,0 +1,12 @@
+require "tomo"
+require_relative "good_job/tasks"
+require_relative "good_job/version"
+
+module Tomo::Plugin::GoodJob
+  extend Tomo::PluginDSL
+
+  tasks Tomo::Plugin::GoodJob::Tasks
+  defaults good_job_systemd_service: "good_job_%{application}.service",
+           good_job_systemd_service_path: ".config/systemd/user/%{good_job_systemd_service}",
+           good_job_systemd_service_template_path: File.expand_path("good_job/service.erb", __dir__)
+end

metadata

@@ -0,0 +1,69 @@
+--- !ruby/object:Gem::Specification
+name: tomo-plugin-good_job
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Matt Brictson
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-04-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: tomo
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description:
+email:
+- opensource@gauravtiwari.com
+- gaurav@gauravtiwari.co.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- lib/tomo/plugin/good_job.rb
+- lib/tomo/plugin/good_job/service.erb
+- lib/tomo/plugin/good_job/tasks.rb
+- lib/tomo/plugin/good_job/version.rb
+homepage: https://github.com/gauravtiwari/tomo-plugin-good_job
+licenses:
+- MIT
+metadata:
+  bug_tracker_uri: https://github.com/gauravtiwari/tomo-plugin-good_job/issues
+  changelog_uri: https://github.com/gauravtiwari/tomo-plugin-good_job/releases
+  source_code_uri: https://github.com/gauravtiwari/tomo-plugin-good_job
+  homepage_uri: https://github.com/gauravtiwari/tomo-plugin-good_job
+  rubygems_mfa_required: 'true'
+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.3.3
+signing_key:
+specification_version: 4
+summary: GoodJob background tasks for tomo
+test_files: []