daemon_runner 0.2.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 113e941352f0f027e74475522fbf103a2e2ab2b2
+  data.tar.gz: c0fe5567cab12d9db836c618a52295a7a1e4e5d2
+SHA512:
+  metadata.gz: a72c199d673e3edcb3af7ea87c307ea85325a76441eaa7aca735d76a30a6f4589e26cd87343fe5cbef7a20d10345d30da3bf830d3554d3d7620a3d7a9f5cdab9
+  data.tar.gz: bd0fa329b8ebea978f1344e63eccf15cb416c3770f573d3fd73d0fb35cf2049c670400bd7212a694dcbd6e9226238f35cf2cf997c6481b298b6b71eb44d01642

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.2.4
+before_install: gem install bundler -v 1.12.5

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+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.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at Andrew_Thompson@rapid7.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in daemon_runner.gemspec
+gemspec
+
+group :development do
+  gem 'bundler', '~> 1.7'
+  gem 'thor-scmversion', '= 1.7.0'
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Andrew Thompson
+
+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,119 @@
+# DaemonRunner
+
+This is a library that will assist you in writing long running services that are composed of discrete tasks.  For example you may want to check that a service is running, or run some command and send it's output somewhere.
+
+The basic design consists of a list of tasks that loop forever.  The user is responsible to defining what those tasks are and what they do in a subclass.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'daemon_runner'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install daemon_runner
+
+## Usage
+
+In order to use this gem you must subclass `DaemonRunner::Client` and add a few methods:
+
+* `tasks` - This is an array of tasks to run (**required**)
+
+```ruby
+[
+  [ClassName1, method_name, args],
+  [ClassName2, method_name, args]
+]
+  ```
+
+* `wait` - Setup hook to run before starting tasks (**optional**)
+
+* `options` - Options hash to pass to `initialize` (**required**)
+    * :loop_sleep_time - Number of seconds to sleep before starting tasks again (**optional**, _default_: 5 seconds)
+    * :error_sleep_time - Number of seconds to sleep before retying a failed task (**optional**, _default_: 5 seconds)
+    * :post_task_sleep_time - Number of seconds to sleep after each task (**optional**, _default_: 1 seconds)
+
+### Example
+
+```ruby
+#!/usr/bin/env ruby
+
+require_relative '../lib/daemon_runner'
+
+class MyService
+  class Tasks
+    class Foo
+      def run!
+        puts 'foo'
+        'foo'
+      end
+    end
+  end
+end
+
+class MyService
+  class Tasks
+    class Bar
+      def run!(name)
+        puts name
+        name
+      end
+    end
+  end
+end
+
+class MyService
+  class Tasks
+    class Baz
+      class << self
+        def run!(args)
+          name = args[0]
+          reason = args[1]
+          puts name
+          puts reason
+          name
+        end
+      end
+    end
+  end
+end
+
+class MyService
+  class Client < DaemonRunner::Client
+    def tasks
+      [
+        [::MyService::Tasks::Foo.new, 'run!'],
+        [::MyService::Tasks::Bar.new, 'run!', 'bar'],
+        [::MyService::Tasks::Baz, 'run!', 'baz', 'because']
+      ]
+    end
+  end
+end
+
+options = {}
+service = MyService::Client.new(options)
+service.start!
+```
+
+
+## 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/rapid7/daemon_runner. 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](http://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/Thorfile

@@ -0,0 +1,5 @@
+# encoding: utf-8
+
+require 'bundler'
+require 'bundler/setup'
+require 'thor/scmversion'

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "daemon_runner"
+
+# 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/daemon_runner.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'daemon_runner/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "daemon_runner"
+  spec.version       = DaemonRunner::VERSION
+  spec.authors       = ["Andrew Thompson"]
+  spec.email         = ["Andrew_Thompson@rapid7.com"]
+
+  spec.summary       = %q{Small library to make writing long running services easy}
+  spec.homepage      = "https://github.com/rapid7/daemon_runner/"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "logging", "~> 2.1"
+  spec.add_dependency "mixlib-shellout", "~> 2.2"
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "yard", "~> 0.8.7"
+end

data/examples/example1.rb

@@ -0,0 +1,57 @@
+#!/usr/bin/env ruby
+
+require_relative '../lib/daemon_runner'
+
+class MyService
+  class Tasks
+    class Foo
+      def run!
+        puts 'foo'
+        'foo'
+      end
+    end
+  end
+end
+
+class MyService
+  class Tasks
+    class Bar
+      def run!(name)
+        puts name
+        name
+      end
+    end
+  end
+end
+
+class MyService
+  class Tasks
+    class Baz
+      class << self
+        def run!(args)
+          name = args[0]
+          reason = args[1]
+          puts name
+          puts reason
+          name
+        end
+      end
+    end
+  end
+end
+
+class MyService
+  class Client < DaemonRunner::Client
+    def tasks
+      [
+        [::MyService::Tasks::Foo.new, 'run!'],
+        [::MyService::Tasks::Bar.new, 'run!', 'bar'],
+        [::MyService::Tasks::Baz, 'run!', 'baz', 'because']
+      ]
+    end
+  end
+end
+
+options = {}
+service = MyService::Client.new(options)
+service.start!

data/lib/daemon_runner/client.rb

@@ -0,0 +1,132 @@
+module DaemonRunner
+  class Client
+    include Logger
+
+    # @attribute [r]
+    # Options hash
+    attr_reader :options
+
+
+    def initialize(options)
+      @options = options
+    end
+
+    # Hook to allow initial setup tasks before running tasks.
+    # @abstract Override {#wait} to pause before starting.
+    # @return [void]
+    def wait
+    end
+
+    # List of tasks that get executed in {#start!}
+    # @abstract Override {#tasks} in a subclass.
+    # @return [Array<Array>]
+    # @example Example tasks method
+    #    def tasks
+    #      [
+    #        [::MyService::Tasks::Foo.new, 'run!'],
+    #        [::MyService::Tasks::Bar.new, 'run!', 'bar'],
+    #        [::MyService::Tasks::Baz, 'run!', 'baz', 'because']
+    #      ]
+    #    end
+    def tasks
+      raise NotImplementedError, 'Must implement this in a subclass.  \
+      This must be an array of methods for the runner to call'
+    end
+
+    # @return [Fixnum] Number of seconds to sleep between loop interations.
+    def loop_sleep_time
+      return @loop_sleep_time unless @loop_sleep_time.nil?
+      @loop_sleep_time = if options[:loop_sleep_time].nil?
+                           5
+                         else
+                           options[:loop_sleep_time]
+                         end
+    end
+
+    # @return [Fixnum] Number of seconds to sleep before retrying an error
+    def error_sleep_time
+      return @error_sleep_time unless @error_sleep_time.nil?
+      @error_sleep_time = if options[:error_sleep_time].nil?
+                            5
+                          else
+                            options[:error_sleep_time]
+                          end
+    end
+
+    # @return [Fixnum] Number of seconds to sleep after each task
+    def post_task_sleep_time
+      return @post_task_sleep_time unless @post_task_sleep_time.nil?
+      @post_task_sleep_time = if options[:post_task_sleep_time].nil?
+                                1
+                              else
+                                options[:post_task_sleep_time]
+                              end
+    end
+
+    # Start the service
+    # @return [nil]
+    def start!
+      wait
+
+      loop do # Loop on tasks
+        logger.warn 'Tasks list is empty' if tasks.empty?
+        tasks.each do |task|
+          run_task(task)
+          sleep post_task_sleep_time
+        end
+
+        sleep loop_sleep_time
+      end
+
+    rescue StandardError => e
+      # Don't exit the process if initialization fails.
+      logger.error(e)
+
+      sleep error_sleep_time
+      retry
+    end
+
+    private
+
+    # @private
+    # @param [Array] task task to parse
+    # @return [Array<String, String, Array>] task parsed in parts: Class, method, and arguments
+    def parse_task(task)
+      raise ArgumentError, 'Not enough elements in the Array' if task.length < 2
+      out = {}
+      out[:instance] = task[0]
+
+      out[:class_name] = if out[:instance].class.to_s == 'Class'
+                           out[:instance].name.to_s
+                         else
+                           out[:instance].class.to_s
+                         end
+
+      out[:method] = task[1]
+      out[:args] = task[2..-1].flatten
+      out
+    end
+
+    # @private
+    # @param [Array<String, String, Array>] task to run
+    # @return [String] output returned from task
+    def run_task(task)
+      parsed_task = parse_task(task)
+      instance = parsed_task[:instance]
+      class_name = parsed_task[:class_name]
+      method = parsed_task[:method]
+      args = parsed_task[:args]
+      log_line = "Running #{class_name}.#{method}"
+      log_line += "(#{args})" unless args.empty?
+      logger.debug log_line
+
+      out = if args.empty?
+              instance.send(method.to_sym)
+            else
+              instance.send(method.to_sym, args)
+            end
+      logger.debug "Got: #{out}"
+      out
+    end
+  end
+end

data/lib/daemon_runner/logger.rb

@@ -0,0 +1,17 @@
+require 'logging'
+
+module DaemonRunner
+  #
+  # Logging module
+  #
+  module Logger
+
+    def logger_name
+      STDOUT
+    end
+
+    def logger
+      @logger ||= ::Logging.logger(logger_name)
+    end
+  end
+end

data/lib/daemon_runner/shell_out.rb

@@ -0,0 +1,79 @@
+require 'mixlib/shellout'
+
+module DaemonRunner
+  class ShellOut
+    attr_reader :runner, :stdout
+    attr_reader :command, :cwd, :timeout, :wait
+
+    # @param command [String] the command to run
+    # @param cwd [String] the working directory to run the command
+    # @param timeout [Fixnum] the command timeout
+    # @param wait [Boolean] wheather to wait for the command to finish
+    def initialize(command: nil, cwd: '/tmp', timeout: 15, wait: true)
+      @command = command
+      @cwd = cwd
+      @timeout = timeout
+      @wait = wait
+    end
+
+    # Run command
+    # @return [Mixlib::ShellOut, Fixnum] mixlib shellout client or a pid depending on the value of {#wait}
+    def run!
+      validate_command
+      if wait
+        run_and_wait
+      else
+        run_and_detach
+      end
+    end
+
+    private
+
+    # Run a command and wait for it to finish
+    # @return [Mixlib::ShellOut] client
+    def run_and_wait
+      validate_args
+      runner
+      @runner.run_command
+      @runner.error!
+      @stdout = @runner.stdout
+      @runner
+    end
+
+    # Run a command in a new process group, thus ignoring any furthur
+    # updates about the status of the process
+    # @return [Fixnum] process id
+    def run_and_detach
+      log_r, log_w = IO.pipe
+      Process.spawn(command, pgroup: true, err: :out, out: log_w)
+      log_r.close
+      log_w.close
+    end
+
+    # Validate command is defined before trying to start the command
+    # @ raise [ArgumentError] if any of the arguments are missing
+    def validate_command
+      if @command.nil? && !respond_to?(:command)
+        raise ArgumentError, 'Must pass a command or implement a command method'
+      end
+    end
+
+    # Validate arguments before trying to start the command
+    # @ raise [ArgumentError] if any of the arguments are missing
+    def validate_args
+      if @cwd.nil? && !respond_to?(:cwd)
+        raise ArgumentError, 'Must pass a cwd or implement a cwd method'
+      end
+
+      if @timeout.nil? && !respond_to?(:timeout)
+        raise ArgumentError, 'Must pass a timeout or implement a timeout method'
+      end
+    end
+
+    # Setup a new Mixlib::ShellOut client runner
+    # @return [Mixlib::ShellOut] client
+    def runner
+      @runner ||= Mixlib::ShellOut.new(command, :cwd => cwd, :timeout => timeout)
+    end
+  end
+end

data/lib/daemon_runner/version.rb

@@ -0,0 +1,3 @@
+module DaemonRunner
+  VERSION = IO.read(File.expand_path('../../../VERSION', __FILE__)) rescue '0.0.1'
+end

data/lib/daemon_runner.rb

@@ -0,0 +1,4 @@
+require_relative 'daemon_runner/version'
+require_relative 'daemon_runner/logger'
+require_relative 'daemon_runner/client'
+require_relative 'daemon_runner/shell_out'

metadata

@@ -0,0 +1,146 @@
+--- !ruby/object:Gem::Specification
+name: daemon_runner
+version: !ruby/object:Gem::Version
+  version: 0.2.2
+platform: ruby
+authors:
+- Andrew Thompson
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-10-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: logging
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: mixlib-shellout
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.7
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.7
+description: 
+email:
+- Andrew_Thompson@rapid7.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- Thorfile
+- bin/console
+- bin/setup
+- daemon_runner.gemspec
+- examples/example1.rb
+- lib/daemon_runner.rb
+- lib/daemon_runner/client.rb
+- lib/daemon_runner/logger.rb
+- lib/daemon_runner/shell_out.rb
+- lib/daemon_runner/version.rb
+homepage: https://github.com/rapid7/daemon_runner/
+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.4.3
+signing_key: 
+specification_version: 4
+summary: Small library to make writing long running services easy
+test_files: []
+has_rdoc: