capistrano-procsd 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3750ba4bc43d0a0bbb89551c6fe7b8a7aed6256d0ee80eff0d30da7b104fb814
+  data.tar.gz: 50eb8cada745c68fe0f4c3f795f85228831a413a5c87ffa666efaade8541a540
+SHA512:
+  metadata.gz: ae68476dbfd4e433134b0c39907c6b4ccf5aad6599f80985af3faca56a76cf3422423e39679107dba7301ea1e2b285f11df980cd37fb555f30091573097514b8
+  data.tar.gz: aad52774d9cd39733df3fd11779b90bc44b7948420c2f0c01d861d67050198dab0bb73198ab2b115a8925f386d4a296e6b381768afe611a05401affb91a5cbf7

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in capistrano-procsd.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Victor Afanasev
+
+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,132 @@
+# Capistrano::Procsd
+
+Capistrano integration for [Procsd](https://github.com/vifreefly/procsd). All available tasks:
+
+```
+cap procsd:create[arguments]       # Create app services
+cap procsd:create_or_restart       # Create or restart (if already created) app services
+cap procsd:destroy                 # Destroy app services
+cap procsd:list                    # List all services
+cap procsd:logs[arguments]         # Check app services logs
+cap procsd:restart                 # Restart app services
+cap procsd:run[cmd]                # Run command on the remote server
+cap procsd:start                   # Start app services
+cap procsd:status[arguments]       # Check status of app services
+cap procsd:stop                    # Stop app services
+```
+
+## Configuration
+
+Add to your application `Gemfile` somewhere:
+
+```ruby
+# Gemfile
+
+group :development do
+  gem 'capistrano-procsd' require: false
+end
+```
+
+Require procsd tasks inside `Capfile`:
+
+```ruby
+# Capfile
+
+require 'capistrano/procsd'
+```
+
+And finally add hook to call `procsd:create_or_restart` task each time after publishing:
+
+```ruby
+# config/deploy.rb
+
+after "deploy:publishing", "procsd:create_or_restart"
+```
+
+Done!
+
+### Note about procsd location on the remote server
+
+Configuration above assumes that you have `$ procsd` executable somewhere in the system path on your remote server. You can install gem system-wide this way:
+
+```bash
+# Install ruby system-wide from apt repositories:
+$ sudo apt install ruby
+
+# Install procsd gem system-wide:
+$ sudo gem install procsd
+```
+
+Or, if you already use [Rbenv](https://github.com/rbenv/rbenv) you can do instead following:
+
+Add `procsd` gem to your application Gemfile:
+
+```ruby
+# Gemfile
+
+group :development do
+  # You're probably already have it
+  gem 'capistrano-rbenv', require: false
+  gem 'capistrano-bundler', require: false
+end
+
+# Add procsd gem
+gem 'procsd', require: false
+```
+
+Require `capistrano/rbenv` and `capistrano/bundler` inside Capfile (if not required yet):
+
+```ruby
+# Capfile
+
+require 'capistrano/rbenv'
+require 'capistrano/bundler'
+```
+
+And finally add `procsd` to rbenv and bundle bins:
+
+```ruby
+# config/deploy.rb
+
+append :rbenv_map_bins, "procsd"
+append :bundle_bins, "procsd"
+```
+
+## Usage
+
+At the first deploy `$ bundle exec cap production deploy` app services will be created and started. You will be prompted to fill in remote user password (make sure that your deploy user added to the sudo group `adduser deploy sudo`).
+
+If you don't want to type password each time while deploying, you can add start/stop/restart commands to the sudoers file:
+
+1. Login to the remote server, `cd` into application folder, and type `$ procsd config sudoers`. Example:
+
+```
+deploy@server:~/sample_app/current$ procsd config sudoers
+
+deploy ALL=NOPASSWD: /bin/systemctl start sample_app.target, /bin/systemctl stop sample_app.target, /bin/systemctl restart sample_app.target
+```
+
+2. Copy sudoers rule from above to the sudoers file (just type `$ sudo visudo` and paste line at the bottom then save and exit). Logout from the server.
+
+Now try to call restart task `$ bundle exec cap production procsd:restart`. If all is fine, task will execute without password prompt.
+
+
+**Also, steps above can be done automatically:**
+
+```ruby
+# config/deploy.rb
+
+# pass `--add-to-sudoers` option to the `procsd create` command:
+set :procsd_sudoers_at_create_or_restart, true
+```
+
+Now sudoers rule will be added at the first deploy automatically.
+
+## Examples
+
+* `bundle exec cap production procsd:logs[-t]` - Tail application logs
+* `bundle exec cap production procsd:run[bash]` - `ssh` into app server, `cd` into app directory and leave the bash session open
+
+## 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,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/capistrano-procsd.gemspec

@@ -0,0 +1,29 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name     = "capistrano-procsd"
+  spec.version  = "0.1.0"
+  spec.authors  = ["Victor Afanasev"]
+  spec.email    = ["vicfreefly@gmail.com"]
+
+  spec.summary      = "Capistrano integration for Procsd"
+  spec.description  = "Capistrano integration for Procsd"
+  spec.homepage     = "https://github.com/vifreefly/capistrano-procsd"
+  spec.license      = "MIT"
+
+  # 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.require_paths = ["lib"]
+
+  spec.add_dependency "capistrano", "~> 3.1"
+  spec.add_dependency "sshkit-sudo", "~> 0.1"
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+end

data/lib/capistrano/procsd.rb

@@ -0,0 +1 @@
+load File.expand_path("../tasks/procsd.rake", __FILE__)

data/lib/capistrano/tasks/procsd.rake

@@ -0,0 +1,126 @@
+require 'sshkit/sudo'
+
+namespace :procsd do
+  desc "Create or restart (if already created) app services"
+  task :create_or_restart do
+    on roles(:all) do
+      within "#{deploy_to}/current" do
+        cmd = %i(procsd create --or-restart)
+        cmd << :'--add-to-sudoers' if fetch(:procsd_sudoers_at_create_or_restart)
+
+        execute! *cmd
+      end
+    end
+  end
+
+  desc "Create app services"
+  task :create, :arguments do |t, args|
+    arguments = args[:arguments]
+
+    on roles(:all) do
+      within "#{deploy_to}/current" do
+        execute! :procsd, :create, arguments
+      end
+    end
+  end
+
+  desc "Destroy app services"
+  task :destroy do
+    on roles(:all) do
+      within release_path do
+        execute! :procsd, :destroy
+      end
+    end
+  end
+
+  ###
+
+  desc "Start app services"
+  task :start do
+    on roles(:all) do
+      within release_path do
+        execute! :procsd, :start
+      end
+    end
+  end
+
+  desc "Stop app services"
+  task :stop do
+    on roles(:all) do
+      within release_path do
+        execute! :procsd, :stop
+      end
+    end
+  end
+
+  desc "Restart app services"
+  task :restart do
+    on roles(:all) do
+      within release_path do
+        execute! :procsd, :restart
+      end
+    end
+  end
+
+  ###
+
+  desc "Check status of app services"
+  task :status, :arguments do |t, args|
+    arguments = args[:arguments]
+
+    on roles(:all) do
+      ssh_exec cmd_with_env("procsd status #{arguments}")
+    end
+  end
+
+  desc "Check app services logs"
+  task :logs, :arguments do |t, args|
+    arguments = args[:arguments]
+
+    on roles(:all) do
+      ssh_exec cmd_with_env("procsd logs #{arguments}")
+    end
+  end
+
+  desc "List all services"
+  task :list do
+    on roles(:all) do
+      ssh_exec cmd_with_env("procsd list")
+    end
+  end
+
+  ###
+
+  desc "Run command on a remote server"
+  task :run, :cmd do |t, args|
+    cmd = args[:cmd]
+    raise "Please provide a command to run" if cmd.nil? || cmd.empty?
+
+    on roles(:all) do
+      ssh_exec cmd_with_env(cmd)
+    end
+  end
+
+  ###
+
+  private def cmd_with_env(cmd)
+    cmd = cmd.split(" ", 2)
+    cmd[0] = cmd[0].to_sym
+    command(cmd, {}).to_s
+  end
+
+  private def ssh_exec(command)
+    full_command = %W(ssh #{host.user}@#{host.hostname} -t)
+
+    ssh_options = fetch(:ssh_options, {})
+    ssh_options[:keys]&.each { |key_path| full_command.push("-i", key_path) }
+    full_command.push("-A") unless ssh_options[:forward_agent] == false
+    full_command.push("-p", ssh_options[:port]) if ssh_options[:port]
+
+    command = "'cd #{release_path} && #{command}'"
+    full_command << command
+
+    puts "Executing: `#{full_command.join(' ')}`\n\n"
+    exec full_command.join(" ")
+  end
+end

metadata

@@ -0,0 +1,122 @@
+--- !ruby/object:Gem::Specification
+name: capistrano-procsd
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Victor Afanasev
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-11-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: capistrano
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !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: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: Capistrano integration for Procsd
+email:
+- vicfreefly@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- capistrano-procsd.gemspec
+- lib/capistrano/procsd.rb
+- lib/capistrano/tasks/procsd.rake
+homepage: https://github.com/vifreefly/capistrano-procsd
+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: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: Capistrano integration for Procsd
+test_files: []