capistrano-systemd-multiservice 0.1.0.beta1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 591db5664fb74cd3907eb8052f2c47dd38862e61
+  data.tar.gz: a60a6fac2cc72fc6bcd75a144748140de4dc4684
+SHA512:
+  metadata.gz: 9b4e0017a66b0cd651fdbb77f0ca95db322ba8797c0295b63d78ad33e5972be3aa68b2dab0a003df09ef1b21db57ee6243f6ae360bf08cdba0b6ce864c081544
+  data.tar.gz: 8bd2f3c38372ed90d71ec23dd29e4ddf27b3b374e763d54e6e159217d73f39465230fde509312a5b80d89b0387c716bffe4cf21b55641270aef0618e22b663a6

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,6 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.2.6
+  - 2.3.3
+before_install: gem install bundler -v 1.13.6

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in capistrano-systemd-multiservice.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2016 YAMADA Tsuyoshi
+
+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,265 @@
+# capistrano-systemd-multiservice
+
+[![Gem Version](https://badge.fury.io/rb/capistrano-systemd-multiservice.png)](https://rubygems.org/gems/capistrano-system) [![Build Status](https://secure.travis-ci.org/groovenauts/capistrano-systemd-multiservice.png)](https://travis-ci.org/groovenauts/capistrano-systemd-multiservice)
+
+This gem adds capistrano tasks to control multiple services with systemd.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'capistrano-systemd-multiservice', require: false
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install capistrano-systemd-multiservice
+
+## Usage
+
+Add these lines to your Capfile:
+
+```ruby
+require "capistrano/systemd/multiservice"
+install_plugin Capistrano::Systemd::MultiService.new("example1")
+install_plugin Capistrano::Systemd::MultiService.new("example2")
+```
+
+And put `config/systemd/example1.service.erb` (and `config/systemd/example2.service.erb`, ...) like this
+(see [systemd.service(5)](https://www.freedesktop.org/software/systemd/man/systemd.service.html) for details) :
+
+```
+[Unit]
+Description = <%= fetch(:application) %> application server example1
+
+[Service]
+Environment = RAILS_ENV=<%= fetch(:rails_env) %>
+Environment = PWD=<%= current_path %>
+WorkingDirectory = <%= current_path %>
+ExecStart = bundle exec some-application-server start
+User = exampleuser
+Group = examplegroup
+
+[Install]
+WantedBy = multi-user.target
+```
+
+And add these lines to config/deploy.rb if you want to reload/restart services on deploy:
+
+```ruby
+after 'deploy:publishing', 'systemd:example1:restart'
+after 'deploy:publishing', 'systemd:example2:reload-or-restart'
+```
+
+And then deploy.
+
+```shell
+# Upload and install systemd service unit files before deploy
+cap STAGE systemd:example1:setup systemd:example2:setup
+
+# Deploy as usual
+cap STAGE deploy
+```
+
+## Capistrano Tasks
+
+With `install_plugin Capistrano::Systemd::MultiService.new("example1")`,
+following tasks are defined.
+
+- `systemd:example1:setup`
+- `systemd:example1:remove`
+- `systemd:example1:validate`
+- `systemd:example1:daemon-reload`
+- `systemd:example1:start`
+- `systemd:example1:stop`
+- `systemd:example1:reload`
+- `systemd:example1:restart`
+- `systemd:example1:reload-or-restart`
+- `systemd:example1:enable`
+- `systemd:example1:disable`
+
+See lib/capistrano/tasks/systemd/multiservice.rake, lib/capistrano/systemd/multiservice.rb for details.
+
+## Configuration Variables
+
+With `install_plugin Capistrano::Systemd::MultiService.new("example1")`,
+following Configuration variables are defined.
+
+- `:systemd_example1_role`
+- `:systemd_example1_units_src`
+- `:systemd_example1_units_dir`
+- `:systemd_example1_units_dest`
+- `:systemd_example1_instances`
+- `:systemd_example1_service`
+- `:systemd_example1_instance_services`
+
+See lib/capistrano/systemd/multiservice.rb for details.
+
+## Examples
+
+### Rails application with unicorn and delayed\_job
+
+#### `Capfile`
+
+```ruby
+## ...snip...
+
+require 'capistrano/systemd/multiservice'
+install_plugin Capistrano::Systemd::MultiService.new('unicorn')
+install_plugin Capistrano::Systemd::MultiService.new('delayed_job')
+
+## ...snip...
+```
+
+#### `config/deploy.rb`
+
+```ruby
+## ...snip...
+
+set :systemd_delayed_job_instances, ->{ 3.times.to_a }
+
+after 'deploy:restart', 'systemd:unicorn:reload-or-restart'
+after 'deploy:restart', 'systemd:delayed_job:restart'
+
+after 'deploy:publishing', 'deploy:restart'
+
+## ...snip...
+```
+
+#### `config/systemd/unicorn.service.erb`
+
+```
+[Unit]
+Description = <%= fetch(:application) %> unicorn rack server
+
+[Service]
+Environment = PATH=<%= fetch(:rbenv_path) %>/shims:/usr/local/bin:/usr/bin:/bin
+Environment = RBENV_VERSION=<%= fetch(:rbenv_ruby) %>
+Environment = RBENV_ROOT=<%= fetch(:rbenv_path) %>
+Environment = RAILS_ENV=<%= fetch(:rails_env) %>
+Environment = PWD=<%= current_path %>
+
+WorkingDirectory = <%= current_path %>
+
+ExecStart = <%= fetch(:rbenv_path) %>/bin/rbenv exec bundle exec unicorn -c <%= current_path %>/config/unicorn.rb
+ExecReload = /bin/kill -USR2 $MAINPID
+
+PIDFile = <%= shared_path %>/tmp/pids/unicorn.pid
+KillSignal = SIGQUIT
+KillMode = process
+TimeoutStopSec = 62
+Restart = always
+
+User = app-user
+Group = app-group
+
+[Install]
+WantedBy = multi-user.target
+```
+
+#### `config/systemd/delayed_job.service.erb`
+
+```
+[Unit]
+Description = <%= fetch(:application) %> delayed_job
+Requires = <%= fetch(:"#{prefix}_instance_services").join(" ") %>
+
+[Service]
+Type = oneshot
+RemainAfterExit = yes
+ExecStart  = /bin/true
+ExecReload = /bin/true
+
+[Install]
+WantedBy = multi-user.target
+```
+
+#### `config/systemd/delayed_job@.service.erb`
+
+```
+[Unit]
+Description = <%= fetch(:application) %> delayed_job (instance %i)
+PartOf = <%= fetch(:"#{prefix}_service") %>
+ReloadPropagatedFrom = <%= fetch(:"#{prefix}_service") %>
+
+[Service]
+Type = forking
+
+Environment = PATH=<%= fetch(:rbenv_path) %>/shims:/usr/local/bin:/usr/bin:/bin
+Environment = RBENV_VERSION=<%= fetch(:rbenv_ruby) %>
+Environment = RBENV_ROOT=<%= fetch(:rbenv_path) %>
+Environment = RAILS_ENV=<%= fetch(:rails_env) %>
+Environment = PWD=<%= current_path %>
+
+WorkingDirectory = <%= current_path %>
+
+ExecStart  = <%= fetch(:rbenv_path) %>/bin/rbenv exec bundle exec bin/delayed_job -p <%= fetch(:application) %> -i %i start
+ExecStop   = <%= fetch(:rbenv_path) %>/bin/rbenv exec bundle exec bin/delayed_job -p <%= fetch(:application) %> -i %i stop
+ExecReload = /bin/kill -HUP $MAINPID
+
+PIDFile = <%= shared_path %>/tmp/pids/delayed_job.%i.pid
+TimeoutStopSec = 22
+Restart = always
+
+User = app-user
+Group = app-group
+
+[Install]
+WantedBy = multi-user.target
+```
+
+#### `config/unicorn.rb`
+
+```ruby
+shared_path = "/path/to/shared"
+
+worker_processes   5
+listen             "#{shared_path}/tmp/sockets/unicorn.sock"
+pid                "#{shared_path}/tmp/pids/unicorn.pid"
+stderr_path        "#{shared_path}/log/unicorn_stderr.log"
+stdout_path        "#{shared_path}/log/unicorn_stdout.log"
+preload_app        true
+
+before_exec do |server|
+  ENV["BUNDLE_GEMFILE"] = "/path/to/current/Gemfile"
+end
+
+before_fork do |server, worker|
+  if defined? ActiveRecord::Base
+    ActiveRecord::Base.connection.disconnect!
+  end
+
+  old_pid = "#{server.config[:pid]}.oldbin"
+  if old_pid != server.pid
+    begin
+      sig = (worker.nr + 1) >= server.worker_processes ? :QUIT : :TTOU
+      Process.kill(sig, File.read(old_pid).to_i)
+    rescue Errno::ENOENT, Errno::ESRCH
+    end
+  end
+
+  sleep 1
+end
+
+after_fork do |server, worker|
+  if defined?(ActiveRecord::Base)
+    ActiveRecord::Base.establish_connection
+  end
+end
+```
+
+## 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 tags, 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/groovenauts/capistrano-systemd-multiservice.
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "capistrano/systemd/multiservice"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/capistrano-systemd-multiservice.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'capistrano/systemd/multiservice/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "capistrano-systemd-multiservice"
+  spec.version       = Capistrano::Systemd::MultiService::VERSION
+  spec.authors       = ["YAMADA Tsuyoshi"]
+  spec.email         = ["tyamada@minimum2scp.org"]
+
+  spec.summary       = %q{Capistrano Plugin to control services by systemd}
+  spec.description   = %q{Capistrano Plugin to control services by systemd}
+  spec.homepage      = "https://github.com/groovenauts/capistrano-systemd-multiservice"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "capistrano", "~> 3.7.0"
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "mocha", "~> 1.2"
+end

data/lib/capistrano/systemd/multiservice.rb

@@ -0,0 +1,112 @@
+require "erb"
+require "stringio"
+require "capistrano/plugin"
+require "capistrano/systemd/multiservice/version"
+
+module Capistrano
+  module Systemd
+    class MultiService < ::Capistrano::Plugin
+      attr_reader :app
+
+      def initialize(app)
+        @app = app
+        super()
+      end
+
+      def nsp
+        @app.to_sym
+      end
+
+      def prefix
+        "systemd_#{@app}"
+      end
+
+      def define_tasks
+        eval_rakefile File.expand_path("../../tasks/systemd/multiservice.rake", __FILE__)
+      end
+
+      def register_hooks
+        after   "deploy:check",          "systemd:#{nsp}:validate"
+        after   "systemd:#{nsp}:setup",  "systemd:#{nsp}:daemon-reload"
+        after   "systemd:#{nsp}:setup",  "systemd:#{nsp}:enable"
+        before  "systemd:#{nsp}:remove", "systemd:#{nsp}:disable"
+        after   "systemd:#{nsp}:remove", "systemd:#{nsp}:daemon-reload"
+      end
+
+      def set_defaults
+        set_if_empty :"#{prefix}_role", ->{ :app }
+
+        set_if_empty :"#{prefix}_units_src", ->{ Dir["config/systemd/#{@app}{,@}.*.erb"].sort }
+
+        set_if_empty :"#{prefix}_units_dir", ->{ "/etc/systemd/system" }
+
+        set_if_empty :"#{prefix}_units_dest", ->{
+          fetch(:"#{prefix}_units_src").map{|src|
+            "%s/%s_%s" % [ fetch(:"#{prefix}_units_dir"), fetch(:application), File.basename(src, ".erb") ]
+          }
+        }
+
+        set_if_empty :"#{prefix}_instances", ->{
+          if fetch(:"#{prefix}_units_dest").map{|dst| File.basename(dst) }.find{|f| f =~ /@\.service\z/ }
+            1.times.to_a
+          else
+            nil
+          end
+        }
+
+        set_if_empty :"#{prefix}_service", ->{
+          service = fetch(:"#{prefix}_units_dest").map{|dst| File.basename(dst) }.find{|f| f =~ /\.service\z/ && f !~ /@\.service\z/ }
+          service || fetch(:"#{prefix}_instance_services")
+        }
+
+        set_if_empty :"#{prefix}_instance_services", ->{
+          if fetch(:"#{prefix}_instances")
+            fetch(:"#{prefix}_instances").map{|i|
+              service_template = fetch(:"#{prefix}_units_dest").map{|dst| File.basename(dst) }.find{|f| f =~ /@\.service\z/ }
+              service_template && service_template.sub(/@\.service\z/, "@#{i}.service")
+            }
+          else
+            []
+          end
+        }
+      end
+
+      def setup
+        fetch(:"#{prefix}_units_src").zip(fetch(:"#{prefix}_units_dest")).each do |src, dest|
+          remote_tmp  = "#{fetch(:tmp_dir)}/#{File.basename(src, ".erb")}"
+          backend.upload! StringIO.new(ERB.new(File.read(src), nil, 2).result(binding)), remote_tmp
+          backend.sudo :install, '-m 644 -o root -g root -D', remote_tmp, dest
+          backend.execute :rm, remote_tmp
+        end
+      end
+
+      def remove
+        backend.sudo :rm, '-f', '--', fetch(:"#{prefix}_units_dest")
+      end
+
+      def validate
+        fetch(:"#{prefix}_units_dest").each do |dest|
+          unless backend.test("[ -f #{dest} ]")
+            backend.error "#{dest} not found"
+            exit 1
+          end
+        end
+      end
+
+      def daemon_reload
+        systemctl :"daemon-reload"
+      end
+
+      %i[start stop reload restart reload-or-restart enable disable].each do |act|
+        define_method act.to_s.tr('-','_') do
+          systemctl act, fetch(:"#{prefix}_service")
+        end
+      end
+
+      def systemctl(*args)
+        args.unshift :sudo, :systemctl
+        backend.execute(*args)
+      end
+    end
+  end
+end

data/lib/capistrano/systemd/multiservice/version.rb

@@ -0,0 +1,15 @@
+begin
+  require "capistrano/plugin"
+rescue LoadError
+  module Capistrano
+    class Plugin; end
+  end
+end
+
+module Capistrano
+  module Systemd
+    class MultiService < ::Capistrano::Plugin
+      VERSION = "0.1.0.beta1"
+    end
+  end
+end

data/lib/capistrano/tasks/systemd/multiservice.rake

@@ -0,0 +1,28 @@
+# This trick lets us access the Capistrano::Systemd::MultiService plugin within `on` blocks
+svc = self
+
+namespace :systemd do
+  namespace svc.nsp do
+    {
+      setup:                "Setup %{app} systemd unit file",
+      remove:               "Remove %{app} systemd unit file",
+      validate:             "Validate %{app} systemd unit file",
+      "daemon-reload":      "Run systemctl daemon-reload",
+      start:                "Run systemctl %{task_name} for %{app}",
+      stop:                 "Run systemctl %{task_name} for %{app}",
+      reload:               "Run systemctl %{task_name} for %{app}",
+      restart:              "Run systemctl %{task_name} for %{app}",
+      "reload-or-restart":  "Run systemctl %{task_name} for %{app}",
+      enable:               "Run systemctl %{task_name} for %{app}",
+      disable:              "Run systemctl %{task_name} for %{app}",
+    }.each do |task_name, desc_template|
+      desc(desc_template % { app: svc.app, task_name: task_name})
+      task task_name do
+        on roles(fetch(:"#{svc.prefix}_role")) do
+          svc.__send__ task_name.to_s.tr('-', '_')
+        end
+      end
+    end
+  end
+end
+

metadata

@@ -0,0 +1,127 @@
+--- !ruby/object:Gem::Specification
+name: capistrano-systemd-multiservice
+version: !ruby/object:Gem::Version
+  version: 0.1.0.beta1
+platform: ruby
+authors:
+- YAMADA Tsuyoshi
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-12-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: capistrano
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.7.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.7.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+description: Capistrano Plugin to control services by systemd
+email:
+- tyamada@minimum2scp.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- capistrano-systemd-multiservice.gemspec
+- lib/capistrano/systemd/multiservice.rb
+- lib/capistrano/systemd/multiservice/version.rb
+- lib/capistrano/tasks/systemd/multiservice.rake
+homepage: https://github.com/groovenauts/capistrano-systemd-multiservice
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">"
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5.2
+signing_key: 
+specification_version: 4
+summary: Capistrano Plugin to control services by systemd
+test_files: []