spawn_passthrough 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6641f177c464baa7135f4ac9236d28e586eb28f3
+  data.tar.gz: 4475773efd3da912635e5c257aea2080af497dd5
+SHA512:
+  metadata.gz: 28fe135f8a8d0d9510e0692c88bc2aee5e0d5a93d86f2a3cba4590e1ef8926e73e8cc95601f821284b42d811c401afc40dfa7ae81da04ab41e32b9557cb1db71
+  data.tar.gz: d6cf408e39ead4abd165f1743b16103b7d18805782d13e254b99392d4f36b796363c5f16193d6732f740eccce7094a8c0b6b3d27632fd18f3f805d86060aa3fd

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,10 @@
+sudo: false
+language: ruby
+
+rvm:
+  - "2.0"
+  - "2.1"
+  - "2.2"
+  - "2.3"
+
+before_install: gem install bundler -v 1.13.6

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Aptible, Inc.
+
+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,14 @@
+# SpawnPassthrough
+
+A gem to spawn processes in a passthrough fashion.
+
+## Usage
+
+```
+exit_code = SpawnPassthrough.spawn_passthrough(*command)
+```
+
+## 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,8 @@
+require 'bundler/gem_tasks'
+
+begin
+  require 'aptible/tasks'
+  Aptible::Tasks.load_tasks
+rescue LoadError
+  puts 'Skipping Aptible::Tasks initialization...'
+end

data/appveyor.yml

@@ -0,0 +1,22 @@
+version: 1.0.{build}-{branch}
+
+environment:
+  matrix:
+    - RUBY_VERSION: 200
+    - RUBY_VERSION: 21
+    - RUBY_VERSION: 22
+    - RUBY_VERSION: 23
+
+install:
+  - set PATH=C:\Ruby%RUBY_VERSION%-x64\bin;%PATH%
+  - bundle install
+
+build: off
+
+before_test:
+  - ruby -v
+  - gem -v
+  - bundle -v
+
+test_script:
+  - bundle exec rake ci

data/lib/spawn_passthrough.rb

@@ -0,0 +1,74 @@
+require 'spawn_passthrough/version'
+
+module SpawnPassthrough
+  # There are a few gotchas in spawning processes and passing through the
+  # current FDs and signals:
+  #
+  # First, we cannot use Kernel.exec, because we need to return control to the
+  # caller.
+  #
+  # Second, we need to somehow capture the exit status, because we assume the
+  # caller cares.
+  #
+  # Third, we don't want to use a separate process group, because the caller
+  # might be used non-interactively, and we want to let other processes signal
+  # the caller and let this reach the subprocess we're spawning here.
+  #
+  # To do this, we have to handle interrutps as a signal, as opposed to handle
+  # an Interrupt exception. The reason for this has to do with how Ruby's wait
+  # is implemented (this happens in process.c's rb_waitpid). There are two main
+  # considerations here:
+  #
+  # - It automatically resumes when it receives EINTR, so our control is pretty
+  # high-level here.
+  # - It handles interrupts prior to setting $? (this appears to have changed
+  # between Ruby 2.2 and 2.3, perhaps the newer implementation behaves
+  # differently).
+  #
+  # Unfortunately, this means that if we receive SIGINT while in
+  # Process::wait2, then we never get access to SSH's exitstatus: Ruby throws a
+  # Interrupt so we don't have a return value, and it doesn't set $?, so we
+  # can't read it back there.
+  #
+  # Of course, we can't just call Proces::wait2 again, because at this point,
+  # we've reaped our child.
+  #
+  # To solve this, we add our own signal handler on SIGINT, which simply
+  # proxies SIGINT to SSH if we happen to have a different process group (which
+  # shouldn't be the case), just to be safe and let users exit the CLI.
+  #
+  # This code was originally implemented for the Aptible CLI.
+  def self.spawn_passthrough(command)
+    redirection = { in: :in, out: :out, err: :err, close_others: true }
+    pid = Process.spawn(*command, redirection)
+
+    reset = Signal.trap('SIGINT') do
+      # FIXME: If we're on Windows, we don't really know whether SSH
+      # received SIGINT or not, so for now, we just ignore it.
+      next if Gem.win_platform?
+
+      begin
+        # SSH should be running in our process group, which means that
+        # if the user sends CTRL+C, we'll both receive it. In this
+        # case, just ignore the signal and let SSH handle it.
+        next if Process.getpgid(Process.pid) == Process.getpgid(pid)
+
+        # If we get here, then oddly, SSH is not running in our process
+        # group and yet we got the signal. In this case, let's simply
+        # ignore it.
+        Process.kill(:SIGINT, pid)
+      rescue Errno::ESRCH
+        # This could happen if SSH exited after receiving the SIGINT,
+        # Ruby waited it, then ran our signal handler. In this case, we
+        # don't need to do anything, so we proceed.
+      end
+    end
+
+    begin
+      _, status = Process.wait2(pid)
+      return status.exited? ? status.exitstatus : 128 + status.termsig
+    ensure
+      Signal.trap('SIGINT', reset)
+    end
+  end
+end

data/lib/spawn_passthrough/version.rb

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

data/spawn_passthrough.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'spawn_passthrough/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'spawn_passthrough'
+  spec.version       = SpawnPassthrough::VERSION
+  spec.authors       = ['Thomas Orozco']
+  spec.email         = ['thomas@orozco.fr']
+
+  spec.summary       = 'Spawn passthrough processes'
+  spec.description   = spec.summary
+  spec.homepage      = 'https://github.com/aptible/spawn_passthrough'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+
+  spec.bindir        = 'bin'
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.13'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'aptible-tasks', '~> 0.5.3'
+end

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification
+name: spawn_passthrough
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Thomas Orozco
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-09-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: aptible-tasks
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.3
+description: Spawn passthrough processes
+email:
+- thomas@orozco.fr
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- appveyor.yml
+- lib/spawn_passthrough.rb
+- lib/spawn_passthrough/version.rb
+- spawn_passthrough.gemspec
+homepage: https://github.com/aptible/spawn_passthrough
+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.6.13
+signing_key: 
+specification_version: 4
+summary: Spawn passthrough processes
+test_files: []