portertech-sensu-spawn 2.6.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: dc6df05e8c6e108291827db4c0562b0ac0d69e793f69bd049a4a2fe4c7209b43
+  data.tar.gz: cebaf8bbca9bc1f07004509c6b81ed1a68d43cc64da687ef6a97b78b8296563b
+SHA512:
+  metadata.gz: 5a7d77b7df604a77bd52a8ba50bf68a34c096211f0f76b93c47e641a6739fa4d5f8a2f1d5c47903431b315f0c809ccebb8729d667c37fceef08bd429707a542e
+  data.tar.gz: '0568e9075095b44cb18fb3118efcff1dd01303cf4216fa9e96ac448085810c64eb5986186803c7e6ee04c9829b25743d9f5acf1c3f441768c5ef63f9aecf9ce3'

data/CHANGELOG.md

@@ -0,0 +1,148 @@
+# Change Log
+
+## [Unreleased](https://github.com/sensu/sensu-spawn/tree/HEAD)
+
+[Full Changelog](https://github.com/sensu/sensu-spawn/compare/v2.4.1...HEAD)
+
+**Merged pull requests:**
+
+- Include stop error message in timeout output [\#25](https://github.com/sensu/sensu-spawn/pull/25) ([portertech](https://github.com/portertech))
+
+## [v2.4.1](https://github.com/sensu/sensu-spawn/tree/v2.4.1) (2018-04-18)
+[Full Changelog](https://github.com/sensu/sensu-spawn/compare/v2.4.0...v2.4.1)
+
+**Merged pull requests:**
+
+- Pin FFI version on load \(as well as install\) [\#28](https://github.com/sensu/sensu-spawn/pull/28) ([portertech](https://github.com/portertech))
+
+## [v2.4.0](https://github.com/sensu/sensu-spawn/tree/v2.4.0) (2018-04-18)
+[Full Changelog](https://github.com/sensu/sensu-spawn/compare/v2.3.0...v2.4.0)
+
+**Merged pull requests:**
+
+- Revert "Revert "Only enable posix spawn on x86\_64 and i386"" [\#27](https://github.com/sensu/sensu-spawn/pull/27) ([portertech](https://github.com/portertech))
+- Pin FFI at 1.9.21, newer versions segfault on CentOS [\#26](https://github.com/sensu/sensu-spawn/pull/26) ([portertech](https://github.com/portertech))
+- Revert "Only enable posix spawn on x86\_64 and i386" [\#24](https://github.com/sensu/sensu-spawn/pull/24) ([portertech](https://github.com/portertech))
+
+## [v2.3.0](https://github.com/sensu/sensu-spawn/tree/v2.3.0) (2018-04-12)
+[Full Changelog](https://github.com/sensu/sensu-spawn/compare/v2.2.2...v2.3.0)
+
+**Merged pull requests:**
+
+- Only enable posix spawn on x86\_64 and i386 [\#23](https://github.com/sensu/sensu-spawn/pull/23) ([portertech](https://github.com/portertech))
+
+## [v2.2.2](https://github.com/sensu/sensu-spawn/tree/v2.2.2) (2018-03-08)
+[Full Changelog](https://github.com/sensu/sensu-spawn/compare/v2.2.1...v2.2.2)
+
+**Merged pull requests:**
+
+- Sign the sensu-spawn Ruby gem [\#22](https://github.com/sensu/sensu-spawn/pull/22) ([portertech](https://github.com/portertech))
+- Implement automated changelog generation [\#21](https://github.com/sensu/sensu-spawn/pull/21) ([cwjohnston](https://github.com/cwjohnston))
+
+## [v2.2.1](https://github.com/sensu/sensu-spawn/tree/v2.2.1) (2016-09-12)
+[Full Changelog](https://github.com/sensu/sensu-spawn/compare/v2.2.0...v2.2.1)
+
+**Merged pull requests:**
+
+- Only include necessary gem files [\#19](https://github.com/sensu/sensu-spawn/pull/19) ([amdprophet](https://github.com/amdprophet))
+
+## [v2.2.0](https://github.com/sensu/sensu-spawn/tree/v2.2.0) (2016-05-27)
+[Full Changelog](https://github.com/sensu/sensu-spawn/compare/v2.1.0...v2.2.0)
+
+**Merged pull requests:**
+
+- Fixed child process large STDIN writes [\#17](https://github.com/sensu/sensu-spawn/pull/17) ([portertech](https://github.com/portertech))
+
+## [v2.1.0](https://github.com/sensu/sensu-spawn/tree/v2.1.0) (2016-05-26)
+[Full Changelog](https://github.com/sensu/sensu-spawn/compare/v2.0.0...v2.1.0)
+
+**Closed issues:**
+
+- Command with large output \( larger than STDOUT buffer\) times out if any timeout is set [\#14](https://github.com/sensu/sensu-spawn/issues/14)
+
+**Merged pull requests:**
+
+- Replace poll\_for\_exit with stdlib Timeout to fix large output deadlock [\#15](https://github.com/sensu/sensu-spawn/pull/15) ([tbriggs-curse](https://github.com/tbriggs-curse))
+
+## [v2.0.0](https://github.com/sensu/sensu-spawn/tree/v2.0.0) (2016-05-17)
+[Full Changelog](https://github.com/sensu/sensu-spawn/compare/v1.8.0...v2.0.0)
+
+**Merged pull requests:**
+
+- Configurable spawn child process limit [\#16](https://github.com/sensu/sensu-spawn/pull/16) ([portertech](https://github.com/portertech))
+
+## [v1.8.0](https://github.com/sensu/sensu-spawn/tree/v1.8.0) (2016-03-10)
+[Full Changelog](https://github.com/sensu/sensu-spawn/compare/v1.7.0...v1.8.0)
+
+**Merged pull requests:**
+
+- Moved FFI require into load error rescue block, fixing AIX build [\#13](https://github.com/sensu/sensu-spawn/pull/13) ([portertech](https://github.com/portertech))
+
+## [v1.7.0](https://github.com/sensu/sensu-spawn/tree/v1.7.0) (2016-03-01)
+[Full Changelog](https://github.com/sensu/sensu-spawn/compare/v1.6.0...v1.7.0)
+
+**Closed issues:**
+
+- childprocess posix\_spawn does not support freebsd [\#9](https://github.com/sensu/sensu-spawn/issues/9)
+
+**Merged pull requests:**
+
+- Only enable POSIX Spawn for Linux & OS X [\#10](https://github.com/sensu/sensu-spawn/pull/10) ([portertech](https://github.com/portertech))
+
+## [v1.6.0](https://github.com/sensu/sensu-spawn/tree/v1.6.0) (2015-11-13)
+[Full Changelog](https://github.com/sensu/sensu-spawn/compare/v1.5.0...v1.6.0)
+
+**Merged pull requests:**
+
+- Fix Windows job handle leak [\#8](https://github.com/sensu/sensu-spawn/pull/8) ([portertech](https://github.com/portertech))
+
+## [v1.5.0](https://github.com/sensu/sensu-spawn/tree/v1.5.0) (2015-09-16)
+[Full Changelog](https://github.com/sensu/sensu-spawn/compare/v1.4.0...v1.5.0)
+
+**Merged pull requests:**
+
+- Remove sensu-em as a dependency, let Sensu core determine which em to use [\#7](https://github.com/sensu/sensu-spawn/pull/7) ([portertech](https://github.com/portertech))
+
+## [v1.4.0](https://github.com/sensu/sensu-spawn/tree/v1.4.0) (2015-09-09)
+[Full Changelog](https://github.com/sensu/sensu-spawn/compare/v1.3.0...v1.4.0)
+
+**Merged pull requests:**
+
+- Use a mutex for childprocess posix spawn [\#6](https://github.com/sensu/sensu-spawn/pull/6) ([portertech](https://github.com/portertech))
+
+## [v1.3.0](https://github.com/sensu/sensu-spawn/tree/v1.3.0) (2015-07-09)
+[Full Changelog](https://github.com/sensu/sensu-spawn/compare/v1.2.0...v1.3.0)
+
+**Merged pull requests:**
+
+- Bump childprocess to latest available \(0.5.6\) [\#5](https://github.com/sensu/sensu-spawn/pull/5) ([darix](https://github.com/darix))
+
+## [v1.2.0](https://github.com/sensu/sensu-spawn/tree/v1.2.0) (2015-05-29)
+[Full Changelog](https://github.com/sensu/sensu-spawn/compare/v1.1.0...v1.2.0)
+
+**Merged pull requests:**
+
+- Require POSIX spawn libs immediately [\#4](https://github.com/sensu/sensu-spawn/pull/4) ([portertech](https://github.com/portertech))
+
+## [v1.1.0](https://github.com/sensu/sensu-spawn/tree/v1.1.0) (2014-09-15)
+[Full Changelog](https://github.com/sensu/sensu-spawn/compare/v1.0.0...v1.1.0)
+
+**Merged pull requests:**
+
+- use a spec asset for testing output larger than 64KB \(ascii\) [\#3](https://github.com/sensu/sensu-spawn/pull/3) ([portertech](https://github.com/portertech))
+- lock java-jars for travis-ci jruby build [\#2](https://github.com/sensu/sensu-spawn/pull/2) ([portertech](https://github.com/portertech))
+- Parent should not wait for child before closing its write end of pipe [\#1](https://github.com/sensu/sensu-spawn/pull/1) ([nlim](https://github.com/nlim))
+
+## [v1.0.0](https://github.com/sensu/sensu-spawn/tree/v1.0.0) (2014-06-12)
+[Full Changelog](https://github.com/sensu/sensu-spawn/compare/v0.0.3...v1.0.0)
+
+## [v0.0.3](https://github.com/sensu/sensu-spawn/tree/v0.0.3) (2014-05-24)
+[Full Changelog](https://github.com/sensu/sensu-spawn/compare/v0.0.2...v0.0.3)
+
+## [v0.0.2](https://github.com/sensu/sensu-spawn/tree/v0.0.2) (2014-05-24)
+[Full Changelog](https://github.com/sensu/sensu-spawn/compare/v0.0.1...v0.0.2)
+
+## [v0.0.1](https://github.com/sensu/sensu-spawn/tree/v0.0.1) (2014-05-19)
+
+
+\* *This Change Log was automatically generated by [github_changelog_generator](https://github.com/skywinder/Github-Changelog-Generator)*

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,28 @@
+# Sensu::Spawn
+
+[![Build Status](https://travis-ci.org/sensu/sensu-spawn.svg?branch=master)](https://travis-ci.org/sensu/sensu-spawn)
+![Gem Version](https://img.shields.io/gem/v/sensu-spawn.svg)
+![MIT Licensed](https://img.shields.io/github/license/sensu/sensu.svg)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'sensu-spawn'
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+Documentation can be found [here](http://rubydoc.info/github/sensu/sensu-spawn/Sensu/Spawn).
+
+## Contributing
+
+0. By contributing to this project you agree to abide by the [code of conduct](https://sensuapp.org/conduct).
+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/lib/sensu/spawn.rb

@@ -0,0 +1,180 @@
+gem "em-worker", "0.0.2"
+gem "childprocess", "4.1.0"
+gem "ffi", "1.16.3"
+
+require "eventmachine"
+require "em/worker"
+require "childprocess"
+require "rbconfig"
+require "timeout"
+
+# Attempt an upfront loading of FFI and POSIX spawn libraries. These
+# libraries may fail to load on certain platforms, load errors are
+# silenced, and the libraries are not used by Sensu Spawn.
+begin
+  require "ffi"
+  require "childprocess/unix/platform/#{ChildProcess.platform_name}"
+  require "childprocess/unix/lib"
+  require "childprocess/unix/posix_spawn_process"
+rescue LoadError; end
+
+module Sensu
+  module Spawn
+    POSIX_SPAWN_PLATFORMS = [:linux, :macosx].freeze
+    POSIX_SPAWN_ARCHS = ["x86_64", "i386"].freeze
+
+    @@mutex = Mutex.new
+
+    class << self
+      # Setup a spawn process worker, to limit the number of
+      # concurrent child processes allowed at one time. This method
+      # creates the spawn process worker instance variable:
+      # `@process_worker`.
+      #
+      # @param [Hash] options to create a process worker with.
+      # @option options [Integer] :limit max number of child processes
+      #   at a time.
+      def setup(options={})
+        limit = options[:limit] || 12
+        @process_worker ||= EM::Worker.new(:concurrency => limit)
+      end
+
+      # Spawn a child process. 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
+        setup(options) unless @process_worker
+        @process_worker.enqueue(create, callback)
+      end
+
+      # Determine if POSIX Spawn is used to create child processes on
+      # the current platform. ChildProcess supports POSIX Spawn for
+      # several platforms (OSs & architectures), however, Sensu only
+      # enables the use of POSIX Spawn on a select few.
+      #
+      # @return [TrueClass, FalseClass]
+      def posix_spawn?
+        return @posix_spawn unless @posix_spawn.nil?
+        platform_supported = POSIX_SPAWN_PLATFORMS.include?(ChildProcess.os)
+        arch_supported = POSIX_SPAWN_ARCHS.include?(ChildProcess.arch)
+        @posix_spawn = platform_supported && arch_supported
+      end
+
+      # Determine if the current platform is Windows.
+      #
+      # @return [TrueClass, FalseClass]
+      def on_windows?
+        return @on_windows unless @on_windows.nil?
+        @on_windows = ChildProcess.windows?
+      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
+        when on_windows?
+          ["cmd", "/c"]
+        else
+          ["sh", "-c"]
+        end
+        ChildProcess.posix_spawn = posix_spawn?
+        shell_command = shell + [command]
+        child = ChildProcess.build(*shell_command)
+        child.io.stdout = child.io.stderr = writer
+        child.leader = true
+        [child, reader, writer]
+      end
+
+      # Write data to a stream/file and read a stream/file
+      # until end of file (EOF).
+      #
+      # @param writer [Object] to write data to (optional).
+      # @param reader [Object] to read contents of until EOF.
+      # @param data [String] to be written to writer.
+      # @return [String] the reader stream/file contents.
+      def write_and_read(writer, reader, data)
+        buffer = (data || "").dup
+        output = ""
+        loop do
+          unless buffer.empty?
+            writer.write(buffer.slice!(0, 8191))
+            writer.close if buffer.empty?
+          end
+          begin
+            readable, _ = IO.select([reader], nil, nil, 0)
+            if readable || buffer.empty?
+              output << reader.readpartial(8192)
+            end
+          rescue EOFError
+            reader.close
+            break
+          end
+        end
+        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.
+      # ChildProcess Unix POSIX spawn (`start()`) is not thread safe,
+      # so a mutex is used to allow safe execution on Ruby runtimes
+      # with real threads (JRuby).
+      #
+      # Using stdlib's Timeout instead of child.poll_for_exit to
+      # avoid a deadlock, when the child output is greater than
+      # the OS max buffer size.
+      #
+      # @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]
+        @@mutex.synchronize do
+          child.start
+        end
+        writer.close
+        output = ""
+        if options[:timeout]
+          Timeout::timeout(options[:timeout], ChildProcess::TimeoutError) do
+            output = write_and_read(child.io.stdin, reader, options[:data])
+            child.wait
+          end
+        else
+          output = write_and_read(child.io.stdin, reader, options[:data])
+          child.wait
+        end
+        [output, child.exit_code]
+      rescue ChildProcess::TimeoutError
+        output = "Execution timed out"
+        begin
+          child.stop
+        rescue => error
+          pid = child.pid rescue "?"
+          output += " - Unable to TERM/KILL the process: ##{pid}, #{error}"
+        end
+        [output, 2]
+      rescue => error
+        child.stop rescue nil
+        ["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          = "portertech-sensu-spawn"
+  spec.version       = "2.6.0"
+  spec.authors       = ["Sean Porter"]
+  spec.email         = ["portertech@gmail.com", "engineering@sensu.io"]
+  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         = Dir.glob("lib/**/*") + %w[sensu-spawn.gemspec README.md CHANGELOG.md LICENSE.txt]
+  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 "eventmachine"
+  spec.add_dependency "em-worker", "0.0.2"
+  spec.add_dependency "childprocess", "4.1.0"
+  spec.add_dependency "ffi", "1.16.3"
+
+  spec.add_development_dependency "bundler", "~> 2.4"
+  spec.add_development_dependency "rake", "13.0.6"
+  spec.add_development_dependency "rspec"
+end

metadata

@@ -0,0 +1,147 @@
+--- !ruby/object:Gem::Specification
+name: portertech-sensu-spawn
+version: !ruby/object:Gem::Version
+  version: 2.6.0
+platform: ruby
+authors:
+- Sean Porter
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-10-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: eventmachine
+  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: 4.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 4.1.0
+- !ruby/object:Gem::Dependency
+  name: ffi
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.16.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.16.3
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 13.0.6
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 13.0.6
+- !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'
+description: The Sensu spawn process library
+email:
+- portertech@gmail.com
+- engineering@sensu.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- lib/sensu/spawn.rb
+- sensu-spawn.gemspec
+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: []
+rubygems_version: 3.4.10
+signing_key:
+specification_version: 4
+summary: The Sensu spawn process library
+test_files: []