capistrano-init-exporter 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2da48c75cdd13276bf3cdf9ce8324fb08ecdb2a8
+  data.tar.gz: 50d3d4a55a17021a98e96f78a9e20979884d9e02
+SHA512:
+  metadata.gz: f4da4a52107e43b79e90d21c160ba5940edced8f9855cc8894ba282d8e6f321fc02e77d66fac74008b78a584bd9401ecc56766bd8b9254927c27e91fae4fa536
+  data.tar.gz: b39a0c53c91a17e065daabd90a3763ea35d09fe8558e0bb743293a5c08f8e516e4025dbfe33c4c6b772a72c1b21aa79fa32def91723125deac89b797a09ce380

data/.gitignore

@@ -0,0 +1,55 @@
+.idea
+
+# Created by .ignore support plugin (hsz.mobi)
+### Ruby template
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+

data/Gemfile

@@ -0,0 +1,3 @@
+source 'http://rubygems.org'
+
+gemspec

data/README.md

@@ -0,0 +1,31 @@
+## `capistrano-init-exporter`
+
+Capistrano bindings for the [init-exporter utility](https://github.com/funbox/init-exporter).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'capistrano-init-exporter'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install capistrano-init-exporter
+
+## Usage
+
+Capify your project as described [here](https://github.com/capistrano/capistrano#capify-your-project).
+
+Configure the project as a normal project which uses capistrano for deployment. Then add to your ``Capfile`` :
+
+    require 'capistrano/init_exporter'
+
+Install [init-exporter utility](https://github.com/funbox/init-exporter) on your server and configure it.
+
+Use [procfiles version 2](https://github.com/funbox/init-exporter#procfile-v2) to describe how your project should be started .

data/Rakefile

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'bundler'
+Bundler::GemHelper.install_tasks
+Bundler.setup(:default, :development)
+require 'rake'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/VERSION

@@ -0,0 +1 @@
+2.6.0

data/capistrano-init-exporter.gemspec

@@ -0,0 +1,27 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'init_exporter/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'capistrano-init-exporter'
+  spec.version       = InitExporter::VERSION
+  spec.authors       = ['funbox']
+  spec.email         = ['a.ilyin@fun-box.ru', 'i.kushmantsev@fun-box.ru']
+
+  spec.summary       = 'Capistrano bindings for exporting services described by Procfile to init system'
+  spec.homepage      = 'https://github.com/funbox/capistrano-init-exporter'
+  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.0')
+
+  spec.add_development_dependency 'bundler', '~> 1.15'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+end

data/lib/capistrano/init_exporter.rb

@@ -0,0 +1,23 @@
+require 'capistrano/setup'
+require 'capistrano/deploy'
+# require 'capistrano/rbenv'
+# require 'capistrano/bundler'
+# require 'capistrano/overrides/dsl'
+
+# require 'capistrano/funbox/access'
+# require 'capistrano/funbox/bundler'
+# require 'capistrano/funbox/config'
+# require 'capistrano/funbox/secrets'
+# require 'capistrano/funbox/database'
+# require 'capistrano/funbox/deploy'
+# require 'capistrano/funbox/folders'
+# require 'capistrano/funbox/git'
+# require 'capistrano/funbox/nginx'
+# require 'capistrano/funbox/release'
+# require 'capistrano/funbox/unicorn'
+# require 'capistrano/funbox/unicorn_god'
+# require 'capistrano/funbox/puma_god'
+require 'capistrano/init_exporter/init'
+# require 'capistrano/funbox/whenever'
+# require 'capistrano/funbox/logrotator'
+# require 'capistrano/funbox/slack'

data/lib/capistrano/init_exporter/init.rb

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

data/lib/capistrano/tasks/init.rake

@@ -0,0 +1,121 @@
+require 'init_exporter/helpers/init'
+
+include InitExporter::Helpers::Init
+
+namespace :init do
+  desc 'Ensure all procfiles are correct'
+  task :ensure_correct_procfiles do
+    current_procfiles = procfiles_for(fetch(:stage))
+
+    ambiguous_procfiles = current_procfiles.group_by { |p| p[:role] }
+    ambiguous_procfiles.each do |role, procfiles|
+      next if procfiles.size == 1
+
+      paths = procfiles.map { |p| p[:path] }
+
+      warn "Several procfiles for role '#{role}' and stage '#{fetch(:stage)}' have been detected:"
+      paths.each do |path|
+        warn "  #{path}"
+      end
+      warn "Don't know which to use. You must solve this disambiguation prior to deploy."
+
+      raise 'Ambiguous procfiles'
+    end
+
+    on release_roles(init_roles.first || []) do
+      within release_path do
+        empty_procfiles = current_procfiles.map { |p| p[:path] }.select do |path|
+          contents = capture(:cat, path).gsub(/\s/, '')
+          contents.empty?
+        end
+
+        unless empty_procfiles.empty?
+          warn 'Empty procfiles have been detected:'
+          empty_procfiles.each do |path|
+            warn " - #{path}"
+          end
+          warn 'Empty procfiles are not allowed.'
+
+          raise 'Empty procfiles'
+        end
+      end
+    end
+  end
+
+  desc 'Stop init jobs'
+  task :stop do
+    init_roles.each do |role|
+      next unless procfile_exists?(fetch(:stage), role)
+      on release_roles(role) do
+        backend = detect_backend(self)
+        job_name = init_job_name(fetch(:application), role)
+        backend.stop(job_name) if backend.running?(job_name)
+      end
+    end
+  end
+
+  desc 'Start init jobs'
+  task :start do
+    init_roles.each do |role|
+      next unless procfile_exists?(fetch(:stage), role)
+      on release_roles(role) do
+        backend = detect_backend(self)
+        job_name = init_job_name(fetch(:application), role)
+        backend.start(job_name) unless backend.running?(job_name)
+      end
+    end
+  end
+
+  desc 'Install init jobs'
+  task :install do
+    procfiles_for(fetch(:stage)).each do |procfile|
+      on release_roles(procfile[:role]) do
+        backend = detect_backend(self)
+
+        procfile_path = release_path.join(procfile[:path])
+        if test "[ -f #{procfile_path} ]"
+          app_name = application_init_name(fetch(:application), procfile[:role])
+          backend.install(app_name, procfile_path)
+        end
+      end
+    end
+  end
+
+  desc 'Uninstall init jobs'
+  task :uninstall => :stop do
+    init_roles.each do |role|
+      on release_roles role do
+        backend = detect_backend(self)
+
+        app_name = application_init_name(fetch(:application), role)
+        backend.uninstall(app_name)
+      end
+    end
+  end
+
+  desc 'Dry run init-exporter'
+  task :dry_run do
+    procfiles_for(fetch(:stage)).each do |procfile|
+      on release_roles(procfile[:role]) do
+        backend = detect_backend(self)
+
+        procfile_path = release_path.join(procfile[:path])
+        if test "[ -f #{procfile_path} ]"
+          app_name = application_init_name(fetch(:application), procfile[:role])
+          backend.dry_run(app_name, procfile_path)
+        end
+      end
+    end
+  end
+
+  desc 'Publish init jobs (install && run)'
+  task :publish do
+    invoke 'init:ensure_correct_procfiles'
+    invoke 'init:install'
+    invoke 'init:start'
+  end
+end
+
+before 'deploy:publishing', 'init:dry_run'
+before 'deploy:publishing', 'init:stop'
+before 'deploy:published',  'init:publish'

data/lib/init_exporter/helpers/init.rb

@@ -0,0 +1,121 @@
+require 'init_exporter/helpers/init/upstart_backend'
+require 'init_exporter/helpers/init/systemd_backend'
+
+module InitExporter
+  module Helpers
+    module Init
+      module_function
+
+      def detect_backend(ssh)
+        if ssh.test 'which', 'systemctl'
+          InitExporter::Helpers::Init::SystemdBackend.new(ssh)
+        elsif ssh.test 'which', 'initctl'
+          InitExporter::Helpers::Init::UpstartBackend.new(ssh)
+        else
+          raise 'No init system found (both systemctl and initctl are not found in path)'
+        end
+      end
+
+      def application_init_name(application, role)
+        suffix = role.to_s == 'all' ? '' : "_#{role}"
+
+        application.tr('-', '_').gsub(/\W/, '') + suffix
+      end
+
+      def init_job_name(application, role)
+        init_job_prefix + application_init_name(application, role)
+      end
+
+      def all_procfiles
+        @all_procfiles ||= begin
+          list_procfiles.map do |path|
+            stage, role = extract_stage_and_role(path)
+            {stage: stage, role: role, path: path}
+          end
+        end
+      end
+
+      def known_procfiles
+        all_procfiles.reject do |p|
+          p[:stage] == :unknown || p[:role] == :unknown
+        end
+      end
+
+      def procfile_exists?(stage, role)
+        all_procfiles.find { |p| p[:stage] == stage && p[:role] == role }
+      end
+
+      def procfiles_for(stage)
+        known_procfiles.select { |p| p[:stage] == stage }
+      end
+
+      def init_roles
+        known_procfiles.map { |p| p[:role] }.uniq
+      end
+
+      protected
+
+      def list_procfiles
+        paths = []
+        on release_roles :all do
+          within release_path do
+            paths = procfile_paths('config/init') + procfile_paths('config/upstart')
+            break
+          end
+        end
+        paths
+      end
+
+      def procfile_paths(root)
+        capture(:find, root, '-type f', '-name "Procfile.*"', '2>/dev/null').lines.map(&:strip)
+      rescue SSHKit::Command::Failed
+        []
+      end
+
+      def extract_stage_and_role(procfile_path)
+        case procfile_path
+        when %r{\Aconfig/(?:init|upstart)/Procfile\.(\w+)\z}
+          [Regexp.last_match(1), :all]
+        when %r{\Aconfig/(?:init|upstart)/Procfile\.(\w+)\.(\w+)\z}
+          [Regexp.last_match(2), Regexp.last_match(1)]
+        when %r{\Aconfig/(?:init|upstart)/(\w+)/Procfile\.(\w+)\z}
+          [Regexp.last_match(1), Regexp.last_match(2)]
+        else
+          [:unknown, :unknown]
+        end.map(&:to_sym)
+      end
+
+      def init_job_prefix
+        config = nil
+        on release_roles :all do
+          config = capture(:cat, '/etc/init-exporter.conf').split("\n").map(&:strip)
+        end
+        get_prefix(config)
+      end
+
+      COMMENT_SYMBOL = '#'.freeze
+      SECTION_SYMBOL = '['.freeze
+      DELIMITER      = ':'.freeze
+      MAIN_SECTION   = '[main]'.freeze
+      PREFIX_KEY     = 'prefix'.freeze
+
+      def get_prefix(config_lines)
+        main_section = false
+        prefix = nil
+        config_lines.each do |line|
+          next if line == '' || line[0] == COMMENT_SYMBOL
+          if line[0] == SECTION_SYMBOL
+            main_section = (line == MAIN_SECTION)
+            next
+          end
+          next unless main_section
+          key, value = line.split(DELIMITER)
+          next unless key == PREFIX_KEY
+          prefix = value.strip!
+          break
+        end
+        prefix
+      end
+    end
+  end
+end

data/lib/init_exporter/helpers/init/base_backend.rb

@@ -0,0 +1,33 @@
+module InitExporter
+  module Helpers
+    module Init
+      class BaseBackend
+        def initialize(ssh)
+          @ssh = ssh
+        end
+
+        def install(app_name, procfile_path)
+          run_init_exporter(app_name, '-p', procfile_path)
+        end
+
+        def dry_run(app_name, procfile_path)
+          run_init_exporter(app_name, '-p', procfile_path, '--dry-start')
+        end
+
+        def uninstall(app_name)
+          run_init_exporter(app_name, '-c')
+        end
+
+        def init_type
+          raise NotImplementedError
+        end
+
+        private
+
+        def run_init_exporter(app_name, *args)
+          @ssh.execute :sudo, 'init-exporter', '-n', app_name, '-f', init_type, *args
+        end
+      end
+    end
+  end
+end

data/lib/init_exporter/helpers/init/systemd_backend.rb

@@ -0,0 +1,29 @@
+require 'init_exporter/helpers/init/base_backend'
+
+module InitExporter
+  module Helpers
+    module Init
+      class SystemdBackend < BaseBackend
+        def initialize(ssh)
+          @ssh = ssh
+        end
+
+        def init_type
+          'systemd'
+        end
+
+        def start(job_name)
+          @ssh.execute :sudo, 'systemctl', 'start', job_name
+        end
+
+        def stop(job_name)
+          @ssh.execute :sudo, 'systemctl', 'stop', job_name
+        end
+
+        def running?(job_name)
+          @ssh.test :sudo, 'systemctl', 'status', job_name
+        end
+      end
+    end
+  end
+end

data/lib/init_exporter/helpers/init/upstart_backend.rb

@@ -0,0 +1,51 @@
+require 'init_exporter/helpers/init/base_backend'
+
+module InitExporter
+  module Helpers
+    module Init
+      class UpstartBackend < BaseBackend
+        def initialize(ssh)
+          @ssh = ssh
+        end
+
+        def init_type
+          'upstart'
+        end
+
+        def install(app_name, procfile_path)
+          init_exporter_installed? ? super : run_upstart_exporter(app_name, '-p', procfile_path)
+        end
+
+        def dry_run(app_name, procfile_path)
+          init_exporter_installed? ? super : true
+        end
+
+        def uninstall(app_name, procfile_path)
+          init_exporter_installed? ? super : run_upstart_exporter(app_name, '-c')
+        end
+
+        def start(job_name)
+          @ssh.execute :sudo, 'start', job_name
+        end
+
+        def stop(job_name)
+          @ssh.execute :sudo, 'stop', job_name
+        end
+
+        def running?(job_name)
+          @ssh.test :sudo, "/sbin/initctl status #{job_name} | grep start"
+        end
+
+        private
+
+        def init_exporter_installed?
+          @ssh.test 'which', 'init-exporter'
+        end
+
+        def run_upstart_exporter(app_name, *args)
+          @ssh.execute :sudo, 'upstart-export', '-n', app_name, *args
+        end
+      end
+    end
+  end
+end

data/lib/init_exporter/version.rb

@@ -0,0 +1,3 @@
+module InitExporter
+  VERSION = '0.1.0'.freeze
+end

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification
+name: capistrano-init-exporter
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- funbox
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-01-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: capistrano
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !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'
+description: 
+email:
+- a.ilyin@fun-box.ru
+- i.kushmantsev@fun-box.ru
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- VERSION
+- capistrano-init-exporter.gemspec
+- lib/capistrano/init_exporter.rb
+- lib/capistrano/init_exporter/init.rb
+- lib/capistrano/tasks/init.rake
+- lib/init_exporter.rb
+- lib/init_exporter/helpers/init.rb
+- lib/init_exporter/helpers/init/base_backend.rb
+- lib/init_exporter/helpers/init/systemd_backend.rb
+- lib/init_exporter/helpers/init/upstart_backend.rb
+- lib/init_exporter/version.rb
+homepage: https://github.com/funbox/capistrano-init-exporter
+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.5.2
+signing_key: 
+specification_version: 4
+summary: Capistrano bindings for exporting services described by Procfile to init
+  system
+test_files: []