multi_daemons 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e9f3fa45368cb760d0004b51bcda3081d1856597b8c14d717acf84031ec618c7
+  data.tar.gz: c01dc7b03c4980d62533a2c74e12b9f41995083d79b9a5c77622802c37cbdda5
+SHA512:
+  metadata.gz: 7f8b14e13ab996ab4e0b74d13cf833926a0818be37484b9e3330fc83fe5b723190a3d417e1de3dcd231a4fbeb48d330cf54bf76345ac13bb230800039c0788d2
+  data.tar.gz: dfc6fc3bfce2bd7b6e19641a6d8215f6b664e227aefdc643dbe39a6688f1d73ffcff09f581cddec1fb4627ae30f02cfafcd21f403304fd7d5e006d64bc86120d

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,75 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at
+santhanakarthikeyan.s@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

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 multi_daemons.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,28 @@
+PATH
+  remote: .
+  specs:
+    multi_daemons (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    byebug (10.0.2)
+    metaclass (0.0.4)
+    minitest (5.11.3)
+    mocha (1.7.0)
+      metaclass (~> 0.0.1)
+    rake (10.5.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  byebug (~> 10.0)
+  minitest (~> 5.0)
+  mocha (~> 1.7)
+  multi_daemons!
+  rake (~> 10.0)
+
+BUNDLED WITH
+   1.16.2

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 santhanakarthikeyan
+
+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/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 santhanakarthikeyan
+
+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,91 @@
+# MultiDaemons
+
+It provides an easy way to run multiple ruby scripts as daemon. Daemon can be controlled by start, stop and restart. It also supports blocks as daemons. It even supports running single daemon process like other popular daemonzing gems.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'multi_daemons'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install multi_daemons
+
+## Usage
+To run multiple daemons.
+
+```ruby
+# this is server.rb
+
+proc_code = Proc do
+  loop do
+    sleep 5
+  end
+end
+
+scheduler = MultiDaemons::Daemon.new('scripts/scheduler', name: 'scheduler', type: :script, {})
+looper = MultiDaemons::Daemon.new(proc_code, name: 'looper', type: :proc, {})
+MultiDaemons.runner([scheduler, looper], { force_kill_timeout: 60 })
+```
+
+To run as daemon
+```ruby
+ruby server.rb start
+ruby server.rb stop
+ruby server.rb restart
+```
+
+To run single daemon within a script.
+```ruby
+proc_code = Proc do
+  loop do
+    sleep 5
+  end
+end
+looper = MultiDaemons::Daemon.new(proc_code, name: 'looper', type: :proc, {})
+looper.start # start daemon
+# Do some other activity
+looper.stop # stop daemon
+```
+
+To run single daemon.
+```ruby
+proc_code = Proc do
+  loop do
+    sleep 5
+  end
+end
+looper = MultiDaemons::Daemon.new(proc_code, name: 'looper', type: :proc, {})
+MultiDaemons.runner([looper], { force_kill_timeout: 60 })
+```
+
+### Supported options for runner:
+force_kill_timeout: <integer> # To kill all running daemons within the specified time.
+
+### Supported option for Daemon:
+force_kill_timeout, log_dir, pid_dir
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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/santhanakarthikeyan/multi_daemons. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the MultiDaemons project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/multi_daemons/blob/master/CODE_OF_CONDUCT.md).

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/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'multi_daemons'
+
+# 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(__FILE__)

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/lib/multi_daemons/controller.rb

@@ -0,0 +1,34 @@
+module MultiDaemons
+  # To control daemons
+  class Controller
+    attr_accessor :daemons, :options
+
+    def initialize(daemons, options = {})
+      @daemons = daemons
+      @options = options
+    end
+
+    def start
+      daemons.each(&:start)
+    end
+
+    def stop
+      pids = []
+      pid_files = []
+      daemons.each do |daemon|
+        daemon.multiple = true
+        daemon.stop
+        pids << daemon.pids
+        pid_files << daemon.pid_file
+      end
+      Pid.force_kill(pids.flatten, force_kill_timeout)
+      PidStore.cleanup(pid_files)
+    end
+
+    private
+
+    def force_kill_timeout
+      options[:force_kill_timeout] || 30
+    end
+  end
+end

data/lib/multi_daemons/daemon.rb

@@ -0,0 +1,95 @@
+module MultiDaemons
+  class Daemon
+    KILL_TIMEOUT = 30
+    attr_accessor :daemon, :type, :name, :options, :multiple, :errors
+
+    def initialize(daemon, name:, type:, options: {})
+      @daemon   = daemon
+      @name     = name
+      @type     = type
+      @options  = options
+      raise unless Validate.valid_daemon?(self)
+    end
+
+    def start
+      case type
+      when :proc, 'proc'
+        safe_fork do
+          daemon.call
+        end
+      when :script, 'script'
+        safe_fork do
+          Kernel.exec(daemon)
+        end
+      else
+        puts 'Unsupported type'
+      end
+    end
+
+    def stop
+      if File.file?(pid_file)
+        pids.each do |pid|
+          begin
+            Process.kill('TERM', pid)
+          rescue Errno::ESRCH => e
+            puts "#{e} #{pid}"
+          end
+        end
+
+        return if multiple
+
+        Pid.force_kill(pids, options[:force_kill_timeout])
+        PidStore.cleanup(pid_file)
+      else
+        puts 'Pid file not found. Is daemon running?'
+      end
+    end
+
+    def pids
+      PidStore.get(pid_file)
+    end
+
+    def pid_file
+      "#{pid_dir}#{name}.pid"
+    end
+
+    private
+
+    def log_file
+      "#{log_dir}#{name}.log"
+    end
+
+    def safe_fork
+      Process.fork do
+        begin
+          Process.setsid
+
+          $0 = name || $PROGRAM_NAME
+
+          PidStore.store(pid_file, Process.pid)
+
+          log = File.new(log_file, 'a')
+          STDIN.reopen '/dev/null'
+          STDOUT.reopen log
+          STDERR.reopen STDOUT
+
+          yield
+        rescue Exception => e
+          puts e
+        end
+      end
+    end
+
+    def log_dir
+      return '' if options[:log_dir].to_s.empty?
+
+      options[:log_dir][-1] == '/' ? options[:log_dir] : "#{options[:log_dir]}/"
+    end
+
+    def pid_dir
+      return '' if options[:pid_dir].to_s.empty?
+
+      options[:pid_dir][-1] == '/' ? options[:pid_dir] : "#{options[:pid_dir]}/"
+    end
+  end
+end

data/lib/multi_daemons/pid.rb

@@ -0,0 +1,54 @@
+module MultiDaemons
+  class Pid
+    KILL_TIMEOUT = 30
+
+    def self.running?(pid)
+      return false unless pid
+
+      begin
+        Process.kill(0, pid)
+        return true
+      rescue Errno::ESRCH
+        return false
+      rescue Exception
+        return true
+      end
+    end
+
+    def self.force_kill(pids, timeout = KILL_TIMEOUT)
+      Timeout.timeout(force_kill_timeout(timeout), Timeout::Error) do
+        pids.each do |pid|
+          sleep(0.5) while Pid.running?(pid)
+        end
+      end
+      true
+    rescue Timeout::Error
+      puts 'Force stopping processes'
+      pids.each do |pid|
+        begin
+          Process.kill('KILL', pid)
+        rescue Errno::ESRCH
+        end
+      end
+
+      begin
+        Timeout.timeout(default_timeout, Timeout::Error) do
+          pids.each do |pid|
+            sleep 1 while Pid.running?(pid)
+          end
+        end
+      rescue Timeout::Error
+        puts 'Can not stop processes'
+        return false
+      end
+    end
+
+    def self.force_kill_timeout(timeout)
+      timeout || KILL_TIMEOUT
+    end
+
+    def self.default_timeout
+      KILL_TIMEOUT
+    end
+  end
+end

data/lib/multi_daemons/pid_store.rb

@@ -0,0 +1,28 @@
+module MultiDaemons
+  module PidStore
+    def self.store(file_name, pid)
+      File.open(file_name, 'a') { |f| f << "#{pid}\n" }
+    end
+
+    def self.get(file_name)
+      [].tap do |pids|
+        unless File.exist?(file_name)
+          pids << nil
+          next
+        end
+        File.read(file_name).each_line do |line|
+          pids << line.to_i
+        end
+      end
+    end
+
+    def self.cleanup(file_names)
+      file_names = [file_names].flatten
+      file_names.each do |file_name|
+        next unless File.exist?(file_name)
+
+        FileUtils.rm(file_name)
+      end
+    end
+  end
+end

data/lib/multi_daemons/validate.rb

@@ -0,0 +1,43 @@
+module MultiDaemons
+  class Validate
+    class << self
+      def valid_daemon?(daemon)
+        name = daemon.name
+        return daemon_name_error unless name && name.length > 1
+
+        daemon.name = name.to_s if name.is_a?(Symbol)
+        case daemon.type
+        when :proc, 'proc'
+          return daemon_proc_error unless daemon.daemon.is_a?(Proc)
+        end
+        true
+      end
+
+      def valid_multi_daemon?(multi_daemon)
+        if multi_daemon.is_a?(Array) && !multi_daemon.empty?
+          if multi_daemon.all? { |daemon| daemon.is_a?(MultiDaemons::Daemon) }
+            return true
+          end
+        end
+        invalid_multi_daemon_option
+        false
+      end
+
+      private
+
+      def invalid_multi_daemon_option
+        puts 'Daemons are not present or invalid'
+      end
+
+      def daemon_name_error
+        puts 'Daemon name should not be empty'
+        false
+      end
+
+      def daemon_proc_error
+        puts 'Daemons type is proc but proc block has not been passed'
+        false
+      end
+    end
+  end
+end

data/lib/multi_daemons/version.rb

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

data/lib/multi_daemons.rb

@@ -0,0 +1,32 @@
+# require 'multi_daemons/version'
+require_relative 'multi_daemons/controller'
+require_relative 'multi_daemons/pid_store'
+require_relative 'multi_daemons/pid'
+require_relative 'multi_daemons/daemon'
+require_relative 'multi_daemons/validate'
+require 'fileutils'
+require 'byebug'
+require 'timeout'
+
+module MultiDaemons
+  def self.runner(daemons, options = {})
+    raise unless Validate.valid_multi_daemon?(daemons)
+
+    controller = Controller.new(daemons, options)
+    daemonize(controller)
+  end
+
+  def self.daemonize(controller)
+    case !ARGV.empty? && ARGV[0]
+    when 'start'
+      controller.start
+    when 'stop'
+      controller.stop
+    when 'restart'
+      controller.stop
+      controller.start
+    else
+      raise 'Invalid argument. Specify start, stop or restart'
+    end
+  end
+end

data/multi_daemons.gemspec

@@ -0,0 +1,38 @@
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'multi_daemons/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'multi_daemons'
+  spec.version       = MultiDaemons::VERSION
+  spec.authors       = ['santhanakarthikeyan']
+  spec.email         = ['santhanakarthikeyan.s@gmail.com']
+
+  spec.summary       = 'MultiDaemon provides an wrapper to run multiple daemon scripts'
+  spec.description   = 'MultiDaemon provides an warpper to run multiple daemon scripts which can be controlled by start/stop and restart commands'
+  spec.homepage      = %q{https://github.com/santhanakarthikeyan/multi_daemons}
+  spec.license       = 'MIT'
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+  else
+    raise 'RubyGems 2.0 or newer is required to protect against ' \
+      'public gem pushes.'
+  end
+
+  # 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(__dir__)) 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_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'byebug', ' ~> 10.0'
+  spec.add_development_dependency 'minitest', '~> 5.0'
+  spec.add_development_dependency 'mocha', '~> 1.7'
+  spec.add_development_dependency 'rake', '~> 10.0'
+end

metadata

@@ -0,0 +1,132 @@
+--- !ruby/object:Gem::Specification
+name: multi_daemons
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- santhanakarthikeyan
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-11-14 00:00:00.000000000 Z
+dependencies:
+- !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: byebug
+  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'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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: MultiDaemon provides an warpper to run multiple daemon scripts which
+  can be controlled by start/stop and restart commands
+email:
+- santhanakarthikeyan.s@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/multi_daemons.rb
+- lib/multi_daemons/controller.rb
+- lib/multi_daemons/daemon.rb
+- lib/multi_daemons/pid.rb
+- lib/multi_daemons/pid_store.rb
+- lib/multi_daemons/validate.rb
+- lib/multi_daemons/version.rb
+- multi_daemons.gemspec
+homepage: https://github.com/santhanakarthikeyan/multi_daemons
+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.7
+signing_key: 
+specification_version: 4
+summary: MultiDaemon provides an wrapper to run multiple daemon scripts
+test_files: []