sensu-spawn 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ba8734244c981a6acf5d366a6e0ee890251c7b9b
+  data.tar.gz: de35257b0ebca2fe72e009ed76ce3ce8cf6f85f3
+SHA512:
+  metadata.gz: 6a1012cfe26fc965aa1f722d108f71ccbd93edf358c83aac5d18b93f0ad4f511c837e8a6b1728db70456da20bf20f5bf8fd604e08bfaf7ddc3154dd9459d8e3a
+  data.tar.gz: 5d714f4e75834070d2642645a24d8bc0de11688356e312a499b5b45d7eeff56c9f4cb3ce79b9141f99783daa419e2f0d046348b3f85a0218387378cc0a98c541

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.travis.yml

@@ -0,0 +1,14 @@
+language: ruby
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - 1.9.3
+  - 2.0.0
+  - 2.1.0
+  - jruby
+notifications:
+  irc:
+    - "irc.freenode.net#sensu"
+addons:
+  code_climate:
+    repo_token: 6e0d725a7d86b1565bc5a8cfa218cf9fb59811b8d4b030e62b6a4745da9f0f96

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2014 Heavy Water Operations, LLC.
+
+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,18 @@
+# Sensu::Spawn
+
+[![Build Status](https://travis-ci.org/sensu/sensu-spawn.svg?branch=master)](https://travis-ci.org/sensu/sensu-spawn)
+
+[![Code Climate](https://codeclimate.com/github/sensu/sensu-spawn.png)](https://codeclimate.com/github/sensu/sensu-spawn)
+[![Code Climate Coverage](https://codeclimate.com/github/sensu/sensu-spawn/coverage.png)](https://codeclimate.com/github/sensu/sensu-spawn)
+
+## Usage
+
+Documentation can be found [here](http://rubydoc.info/github/sensu/sensu-spawn/Sensu/Spawn).
+
+## Contributing
+
+1. [Fork it](https://github.com/sensu/sensu-spawn/fork)
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/sensu/spawn.rb

@@ -0,0 +1,101 @@
+gem "sensu-em"
+gem "em-worker", "0.0.2"
+gem "childprocess", "0.5.3"
+
+require "eventmachine"
+require "em/worker"
+require "childprocess"
+
+module Sensu
+  module Spawn
+    class << self
+      # Spawn a child process. A maximum of 12 processes will be
+      # spawned at a time. The EventMachine reactor (loop) must be
+      # running for this method to work.
+      #
+      # @param [String] command to run.
+      # @param [Hash] options to create a child process with.
+      # @option options [String] :data to write to STDIN.
+      # @option options [Integer] :timeout in seconds.
+      # @param [Proc] callback called when the child process exits,
+      #   its output and exit status are passed as parameters.
+      def process(command, options={}, &callback)
+        create = Proc.new do
+          child_process(command, options)
+        end
+        @process_worker ||= EM::Worker.new(:concurrency => 12)
+        @process_worker.enqueue(create, callback)
+      end
+
+      # Build a child process attached to a pipe, in order to capture
+      # its output (STDERR, STDOUT). The child process will be a
+      # platform dependent shell, that is responsible for executing
+      # the provided command.
+      #
+      # @param [String] command to run.
+      # @return [Array] child object, pipe reader, pipe writer.
+      def build_child_process(command)
+        reader, writer = IO.pipe
+        shell = case RUBY_PLATFORM
+        when /(ms|cyg|bcc)win|mingw|win32/
+          ["cmd", "/c"]
+        else
+          ["sh", "-c"]
+        end
+        ChildProcess.posix_spawn = true
+        shell_command = shell + [command]
+        child = ChildProcess.build(*shell_command)
+        child.io.stdout = child.io.stderr = writer
+        child.leader = true
+        [child, reader, writer]
+      end
+
+      # Read a stream/file until end of file (EOF).
+      #
+      # @param [Object] reader to read contents of until EOF.
+      # @return [String] the stream/file contents.
+      def read_until_eof(reader)
+        output = ""
+        begin
+          loop { output << reader.readpartial(8192) }
+        rescue EOFError
+        end
+        reader.close
+        output
+      end
+
+      # Create a child process, return its output (STDERR & STDOUT),
+      # and exit status. The child process will have its own process
+      # group, may accept data via STDIN, and have a timeout.
+      #
+      # @param [String] command to run.
+      # @param [Hash] options to create a child process with.
+      # @option options [String] :data to write to STDIN.
+      # @option options [Integer] :timeout in seconds.
+      # @return [Array] child process output and exit status.
+      def child_process(command, options={})
+        child, reader, writer = build_child_process(command)
+        child.duplex = true if options[:data]
+        child.start
+        if options[:data]
+          child.io.stdin.write(options[:data])
+          child.io.stdin.close
+        end
+        if options[:timeout]
+          child.poll_for_exit(options[:timeout])
+        else
+          child.wait
+        end
+        writer.close
+        output = read_until_eof(reader)
+        [output, child.exit_code]
+      rescue ChildProcess::TimeoutError
+        child.stop
+        ["Execution timed out", 2]
+      rescue => error
+        child.stop
+        ["Unexpected error: #{error}", 3]
+      end
+    end
+  end
+end

data/sensu-spawn.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+
+Gem::Specification.new do |spec|
+  spec.name          = "sensu-spawn"
+  spec.version       = "0.0.1"
+  spec.authors       = ["Sean Porter"]
+  spec.email         = ["portertech@gmail.com"]
+  spec.summary       = "The Sensu spawn process library"
+  spec.description   = "The Sensu spawn process library"
+  spec.homepage      = "https://github.com/sensu/sensu-spawn"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "sensu-em"
+  spec.add_dependency "em-worker", "0.0.2"
+  spec.add_dependency "childprocess", "0.5.3"
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "codeclimate-test-reporter"
+end

data/spec/helpers.rb

@@ -0,0 +1,29 @@
+require "rspec"
+require "eventmachine"
+
+unless RUBY_VERSION < "1.9" || RUBY_PLATFORM =~ /java/
+  require "codeclimate-test-reporter"
+  CodeClimate::TestReporter.start
+end
+
+module Helpers
+  def timer(delay, &callback)
+    periodic_timer = EM::PeriodicTimer.new(delay) do
+      callback.call
+      periodic_timer.cancel
+    end
+  end
+
+  def async_wrapper(&callback)
+    EM.run do
+      timer(10) do
+        raise "test timed out"
+      end
+      callback.call
+    end
+  end
+
+  def async_done
+    EM.stop_event_loop
+  end
+end

data/spec/spawn_spec.rb

@@ -0,0 +1,56 @@
+require File.join(File.dirname(__FILE__), "helpers")
+require "sensu/spawn"
+
+describe "Sensu::Spawn" do
+  include Helpers
+
+  it "can spawn a process" do
+    async_wrapper do
+      Sensu::Spawn.process("echo foo") do |output, status|
+        expect(output).to eq("foo\n")
+        expect(status).to eq(0)
+        async_done
+      end
+    end
+  end
+
+  it "can spawn a process with a non-zero exit status" do
+    async_wrapper do
+      Sensu::Spawn.process("echo foo && exit 1") do |output, status|
+        expect(output).to eq("foo\n")
+        expect(status).to eq(1)
+        async_done
+      end
+    end
+  end
+
+  it "can spawn a process using an unknown command" do
+    async_wrapper do
+      Sensu::Spawn.process("unknown.command") do |output, status|
+        expect(output).to include("unknown")
+        expect(status).to eq(127)
+        async_done
+      end
+    end
+  end
+
+  it "can spawn a process with a timeout" do
+    async_wrapper do
+      Sensu::Spawn.process("sleep 5", :timeout => 0.5) do |output, status|
+        expect(output).to eq("Execution timed out")
+        expect(status).to eq(2)
+        async_done
+      end
+    end
+  end
+
+  it "can spawn a process that reads from STDIN" do
+    async_wrapper do
+      Sensu::Spawn.process("cat", :data => "bar") do |output, status|
+        expect(output).to eq("bar")
+        expect(status).to eq(0)
+        async_done
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,154 @@
+--- !ruby/object:Gem::Specification
+name: sensu-spawn
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Sean Porter
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-05-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sensu-em
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: em-worker
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.0.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.0.2
+- !ruby/object:Gem::Dependency
+  name: childprocess
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.5.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.5.3
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: The Sensu spawn process library
+email:
+- portertech@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/sensu/spawn.rb
+- sensu-spawn.gemspec
+- spec/helpers.rb
+- spec/spawn_spec.rb
+homepage: https://github.com/sensu/sensu-spawn
+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.2.0
+signing_key: 
+specification_version: 4
+summary: The Sensu spawn process library
+test_files:
+- spec/helpers.rb
+- spec/spawn_spec.rb