capistrano-simple_systemd 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4ad107438dc47d0e0e3d7836a650c9e01872de82ba39779f446376d8389f7829
+  data.tar.gz: 102cd883ec4fcb1532a738aa6bafd0462d96a76ece0e28f66f545818a152500a
+SHA512:
+  metadata.gz: d98c57cbfb516d45fe82c7b8e977acea67aaf61a9e43cdab2b9fbc1a76ae3114573587d7fca708c65e6369ded23b3231a643a36f14c86ec04bef108f6325219a
+  data.tar.gz: ac10230dc31e647bbf19c835ba58ba9a2a6bb0bb5dc7b0a3d55051a5ffa91b73b8ab998ad7c9a0e7b3415f0f93e28f0750d0527b18a70634d80d2d24af658df1

data/.gitignore

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

data/CHANGELOG.md

@@ -0,0 +1,4 @@
+# Changelog
+
+### v0.1.0, 2019-09-20 (Feature Release)
+- Initial release

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,41 @@
+PATH
+  remote: .
+  specs:
+    capistrano-simple_systemd (0.1.0)
+      capistrano (~> 3.7)
+      sshkit (~> 1.2)
+      sshkit-sudo (~> 0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    airbrussh (1.3.4)
+      sshkit (>= 1.6.1, != 1.7.0)
+    capistrano (3.11.1)
+      airbrussh (>= 1.0.0)
+      i18n
+      rake (>= 10.0.0)
+      sshkit (>= 1.9.0)
+    concurrent-ruby (1.1.5)
+    i18n (1.6.0)
+      concurrent-ruby (~> 1.0)
+    net-scp (2.0.0)
+      net-ssh (>= 2.6.5, < 6.0.0)
+    net-ssh (5.2.0)
+    rake (10.5.0)
+    sshkit (1.20.0)
+      net-scp (>= 1.1.2)
+      net-ssh (>= 2.8.0)
+    sshkit-sudo (0.1.0)
+      sshkit (~> 1.8)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  capistrano-simple_systemd!
+  rake (~> 10.0)
+
+BUNDLED WITH
+   2.0.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 DarkWasp
+
+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,93 @@
+# capistrano-simple_systemd
+
+Capistrano tasks to control mutiple services with systemd
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'capistrano-simple_systemd'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install capistrano-simple_systemd
+
+## Usage
+
+Add this line to your Capfile:
+
+```ruby
+require "capistrano/simple_systemd"
+```
+
+Service files are defined as ERB templates ending with `.service.erb` in `config/systemd`. <br>
+PLEASE NOTE: Currently only files with the  `.service.erb` extension are considered as service file templates. Others like `.target.erb` aren't supported yet
+
+The following tasks are provided out of the box
+```ruby
+cap systemd:reload-daemons
+cap systemd:upload
+```
+
+The following tasks will be created for each service template detected in the `config/systemd` directory
+
+```ruby
+cap systemd:{service}:disable
+cap systemd:{service}:enable
+cap systemd:{service}:reload
+cap systemd:{service}:reload-or-restart
+cap systemd:{service}:restart
+cap systemd:{service}:start
+cap systemd:{service}:stop
+```
+Where `service` is the base name of the service template. <br>
+For example, placing `puma.service.erb` in the template directory will yield the following tasks
+```ruby
+cap systemd:puma:disable
+cap systemd:puma:enable
+cap systemd:puma:reload
+cap systemd:puma:reload-or-restart
+cap systemd:puma:restart
+cap systemd:puma:start
+cap systemd:puma:stop
+```
+
+Run 
+```ruby
+cap {stage} systemd:upload
+```
+Or
+```ruby
+cap {stage} setup
+```
+
+to compile and upload the service files. Service files will be prefixed with whichever value is in `service_file_prefix` and uploaded to `/etc/systemd/system`. The variable `service_file_prefix` by default is set to whatever is in the `application` configuration variable. <br>So if `application` is set to `paypoint` then `puma.service.erb` will be uploaded to `/etc/systemd/system/paypoint-puma.service`. <br>
+`service_file_prefix` can be configured. E.g.
+```ruby
+set :service_file_prefix, 'paypoint-app'
+```
+
+Services are enabled after upload by invoking `systemd:{service}:enable`. This behaviour can be disabled by setting `enable_services_after_upload` to false.
+```ruby
+set :enable_services_after_upload, false
+```
+
+## Development
+
+After checking out the repo, run `bundle`
+
+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/darkwasp99/capistrano-simple_systemd.
+
+## 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,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/capistrano-simple_systemd.gemspec

@@ -0,0 +1,36 @@
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "capistrano/simple_systemd/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "capistrano-simple_systemd"
+  spec.version       = Capistrano::SimpleSystemd::VERSION
+  spec.authors       = ["DarkWasp"]
+  spec.email         = ["coderwasp@gmail.com"]
+
+  spec.summary       = "Simple systemd integration for Capistrano."
+  spec.description   = "Simple systemd integration for Capistrano. Uploads service files"
+  spec.homepage      = "https://github.com/darkwasp99/capistrano-simple_systemd"
+  spec.license       = "MIT"
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/darkwasp99/capistrano-simple_systemd"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |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_runtime_dependency "capistrano", "~> 3.7"
+  spec.add_runtime_dependency "sshkit", "~> 1.2"
+  spec.add_runtime_dependency "sshkit-sudo", "~> 0.1"
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/lib/capistrano/simple_systemd.rb

@@ -0,0 +1,4 @@
+require 'capistrano/simple_systemd/paths'
+require 'capistrano/simple_systemd/helpers'
+load File.expand_path('../tasks/simple_systemd/global_tasks.rake', __FILE__)
+load File.expand_path('../tasks/simple_systemd/specific_tasks.rake', __FILE__)

data/lib/capistrano/simple_systemd/helpers.rb

@@ -0,0 +1,25 @@
+module Capistrano
+  module SimpleSystemd
+    module Helpers
+      def each_service_template(&block)
+        service_file_local_dir = Capistrano::SimpleSystemd::Paths.service_file_local_dir
+
+        Dir
+          .glob(File.join(service_file_local_dir, '*.service.erb'))
+          .each do |template_file|
+            block.call(template_file)
+          end
+      end
+      
+      def compile(template_file_path)
+        ERB.new(File.new(template_file_path).read).result(binding)
+      end
+      
+      def upload_service_file(file_content, file_name, destination_dir)
+        tmp_path = "#{fetch(:tmp_dir)}/#{file_name}"
+        upload! StringIO.new(file_content), tmp_path
+        sudo :mv, tmp_path, "#{destination_dir}/#{file_name}"
+      end
+    end
+  end
+end

data/lib/capistrano/simple_systemd/paths.rb

@@ -0,0 +1,13 @@
+module Capistrano
+  module SimpleSystemd
+    module Paths
+      def self.service_file_local_dir
+        'config/systemd'
+      end
+
+      def self.service_file_remote_dir
+        '/etc/systemd/system'
+      end
+    end
+  end
+end

data/lib/capistrano/simple_systemd/version.rb

@@ -0,0 +1,5 @@
+module Capistrano
+  module SimpleSystemd
+    VERSION = "0.1.0"
+  end
+end

data/lib/capistrano/tasks/simple_systemd/global_tasks.rake

@@ -0,0 +1,45 @@
+include Capistrano::SimpleSystemd::Helpers
+load "#{File.dirname(__FILE__)}/task_defaults.rake"
+
+namespace :systemd do
+  task :upload do
+    original_pty_value = fetch(:pty)
+    set :pty, true
+
+    each_service_template do |template|
+      template_basename = File.basename(template, '.service.erb')
+      
+      service_basename = [
+        fetch(:service_file_prefix),
+        template_basename
+      ].join('-')
+
+      service_filename = "#{service_basename}.service"
+      enable_services_after_upload = fetch(:enable_services_after_upload)
+
+      on release_roles :all do
+        upload_service_file(
+          compile(File.absolute_path(template)),
+          service_filename,
+          fetch(:service_file_remote_dir)
+        )
+
+        invoke "systemd:#{template_basename}:enable" if enable_services_after_upload
+      end
+    end
+
+    set :pty, original_pty_value
+  end
+
+  task :'reload-daemons' do
+    on release_roles :all do
+      sudo :systemctl, :'daemon-reload'
+      # puts fetch(:service_file_local_dir)
+    end
+  end
+end
+
+task :setup do
+  invoke 'systemd:upload'
+  invoke 'systemd:reload-daemons'
+end

data/lib/capistrano/tasks/simple_systemd/specific_tasks.rake

@@ -0,0 +1,32 @@
+include Capistrano::SimpleSystemd::Helpers
+load "#{File.dirname(__FILE__)}/task_defaults.rake"
+
+namespace :systemd do
+  each_service_template do |template|
+    template_basename = File.basename(template, '.service.erb')
+
+    namespace template_basename do
+      {
+        start:                "Run systemctl %{task_name} for %{service} service",
+        stop:                 "Run systemctl %{task_name} for %{service} service",
+        reload:               "Run systemctl %{task_name} for %{service} service",
+        restart:              "Run systemctl %{task_name} for %{service} service",
+        "reload-or-restart":  "Run systemctl %{task_name} for %{service} service",
+        enable:               "Run systemctl %{task_name} for %{service} service",
+        disable:              "Run systemctl %{task_name} for %{service} service",
+      }.each do |task_name, desc_template|
+        desc(desc_template % { service: template_basename, task_name: task_name})
+        task task_name do
+          on release_roles :all do
+            service_basename = [
+              fetch(:service_file_prefix),
+              template_basename
+            ].join('-')
+
+            sudo :systemctl, task_name, "#{service_basename}.service"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/capistrano/tasks/simple_systemd/task_defaults.rake

@@ -0,0 +1,8 @@
+namespace :load do
+  task :defaults do
+    set :service_file_local_dir,       Capistrano::SimpleSystemd::Paths.service_file_local_dir
+    set :service_file_remote_dir,      Capistrano::SimpleSystemd::Paths.service_file_remote_dir
+    set :service_file_prefix,          -> { fetch(:application) }
+    set :enable_services_after_upload, true
+  end
+end

metadata

@@ -0,0 +1,132 @@
+--- !ruby/object:Gem::Specification
+name: capistrano-simple_systemd
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- DarkWasp
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-09-20 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'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+- !ruby/object:Gem::Dependency
+  name: sshkit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: sshkit-sudo
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !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'
+description: Simple systemd integration for Capistrano. Uploads service files
+email:
+- coderwasp@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- capistrano-simple_systemd.gemspec
+- lib/capistrano-simple_systemd.rb
+- lib/capistrano/simple_systemd.rb
+- lib/capistrano/simple_systemd/helpers.rb
+- lib/capistrano/simple_systemd/paths.rb
+- lib/capistrano/simple_systemd/version.rb
+- lib/capistrano/tasks/simple_systemd/global_tasks.rake
+- lib/capistrano/tasks/simple_systemd/specific_tasks.rake
+- lib/capistrano/tasks/simple_systemd/task_defaults.rake
+homepage: https://github.com/darkwasp99/capistrano-simple_systemd
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/darkwasp99/capistrano-simple_systemd
+  source_code_uri: https://github.com/darkwasp99/capistrano-simple_systemd
+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: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Simple systemd integration for Capistrano.
+test_files: []