sproc 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4ac0687b964181bd44d7c34228c256b251643e535f698575ae74bf95cef213d7
-  data.tar.gz: 29f4903a79f3535bf4b86aa1b324a211c2dd3d94ff3afd571f9ae192e3187d6e
+  metadata.gz: b21c852197676569f95bf84f37a1e2d070a06ee5fb1bbe1b627e2eb9f83500da
+  data.tar.gz: 3f8fe794b2afcb54d50af93e774091ef1fd72e27c221eb2f38a82686ec214f89
 SHA512:
-  metadata.gz: ecbf92993cd338dec5463529da1abe25da308d6f0b6860f8b80d0ceca55fcd36aa59906fcc744ea9c87e616df8c915cf0980ec5dba1c70253833dea81a324983
-  data.tar.gz: 8acd7eb691cd5b601b4c6858b2adfa9e2988e72a9b21a4969bad0c227527e2339c31748a2d762e009d01a4c90c4836b37c62feb0ac75eab4a2c05d4e7337a6f1
+  metadata.gz: e76140b5a74de9977e60a657ce8c40ad5cf070f3b8c856f954d87ecda0b2cc61a601016b8c8beafd6dd5840dc6dd4cac81eb44b85a3c811fbb38612ea97b0236
+  data.tar.gz: e8999dfdf2a0aa3f577d9c3ed49184989595ac545088b506befcea989782f502c8776fbb851746d696679a2dd84453ef8ebce732e69c53346283c01e024e9fd6

data/README.adoc

@@ -41,4 +41,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 == Code of Conduct
 
 Everyone interacting in the Sproc project's codebases, issue trackers, chat rooms and mailing lists is expected 
-to follow the [code of conduct](https://github.com/[USERNAME]/sproc/blob/master/CODE_OF_CONDUCT.adoc).
+to follow the [code of conduct](https://github.com/rillbert/sproc/blob/master/CODE_OF_CONDUCT.adoc).

data/lib/sproc/core.rb

@@ -4,8 +4,17 @@ require 'shellwords'
 require 'open3'
 
 module SProc
+  # Defines the shell under which to invoke the sub-process
   module ShellType
-    SHELL_TYPES = [NATIVE = 0, BASH = 1].freeze
+    SHELL_TYPES = [
+      # Use the default shell for the platform we're on.
+      # - For Windows, it seems to be the 'cmd prompt'
+      # - For current ubuntu, it seems to be 'dash'
+      NATIVE = 0, 
+      # Will create a 'bash' instance and run the subprocess
+      # within that instance.
+      BASH = 1
+    ].freeze
   end
 
   # The possible states of this subprocess
@@ -62,20 +71,6 @@ module SProc
       @execution_thread = nil
     end
 
-    # @return the TaskInfo representing this SubProcess, nil if
-    #         process has not started
-    def task_info
-      @runner.task_info
-    end
-
-    # check if this process has completed with exit code 0
-    # (success) or not
-    def exit_zero?
-      return false unless execution_state == ExecutionState::COMPLETED
-
-      task_info[:process_status].exitstatus.zero?
-    end
-
     # Return the execution state of this SubProcess. Note that it is not
     # identical with the life-cycle of the underlying ProcessStatus object
     # @return current ExecutionState
@@ -105,7 +100,10 @@ module SProc
       return ExecutionState::COMPLETED if status.exited?
 
       # We don't currently handle a process that has been stopped...
-      # status.stopped?
+      raise NotImplementedError("Unhandled process 'stopped' status!") if status.stopped?
+
+      # We should never come here
+      raise RuntimeError("Unhandled process status: #{status.inspect}")
     end
 
     # Start the process non-blocking. Use one of the wait... methods
@@ -122,6 +120,14 @@ module SProc
       exec(false, cmd, *args, **opts)
     end
 
+    # check if this process has completed with exit code 0
+    # (success) or not
+    def exit_zero?
+      return false unless execution_state == ExecutionState::COMPLETED
+
+      task_info[:process_status].exitstatus.zero?
+    end
+
     # Block caller until this subprocess has completed or aborted
     # @return the TaskInfo struct of the completed process
     def wait_on_completion
@@ -195,6 +201,12 @@ module SProc
       all_proc
     end
 
+    # @return the TaskInfo representing this SubProcess, nil if
+    #         process has not started
+    def task_info
+      @runner.task_info
+    end
+
     # return processes that are no longer running
     def self.get_finished(running_proc)
       running_proc.select do |p|
@@ -207,6 +219,10 @@ module SProc
     private
 
     def exec(synch, cmd, *args, **opts)
+      raise RuntimeError,"Subprocess already running!" unless @execution_thread.nil? || !@execution_thread.alive?
+
+      # kick-off a fresh task runner and execution thread
+      @runner = TaskRunner.new(@run_opts)
       @execution_thread = Thread.new do
         @runner.execute(cmd, *args, **opts)
       end
@@ -258,7 +274,8 @@ module SProc
                end
         SProc.logger&.debug { "Start: #{task_info[:cmd_str]}" }
         Open3.popen3(*args) do |stdin, stdout, stderr, thread|
-          threads = do_while_process_running(stdin, stdout, stderr, thread)
+          @task_info[:popen_thread] = thread
+          threads = do_while_process_running(stdin, stdout, stderr)
           @task_info[:process_status] = thread.value
           threads.each(&:join)
         end
@@ -277,8 +294,7 @@ module SProc
         [@task_info[:cmd_str], opts]
       end
 
-      def do_while_process_running(_stdin, stdout, stderr, thread)
-        @task_info[:popen_thread] = thread
+      def do_while_process_running(_stdin, stdout, stderr)
         th1 = process_output_stream(stdout,
                                     @task_info[:stdout], @opts[:stdout_callback])
         th2 = process_output_stream(stderr,

data/lib/sproc/utils.rb

@@ -0,0 +1,53 @@
+require 'rbconfig'
+
+# utility to find out info about our execution environment
+module OSInfo
+  # the supported exec environments
+  module OS
+    WINDOWS = 0
+    LINUX = 1
+    MINGW = 2
+    CYGWIN = 3
+    OSX = 4
+    BSD = 5
+    UNKNOWN = 100
+  end
+
+  # returns the current execution environment
+  def self.os_context
+    case RbConfig::CONFIG['host_os']
+    when /mswin/ then OS::WINDOWS
+    when /mingw/ then OS::MINGW
+    when /cygwin/ then OS::CYGWIN
+    when /darwin/ then OS::OSX
+    when /linux/ then OS::LINUX
+    when /bsd/ then OS::BSD
+    else OS::UNKNOWN
+    end
+  end
+
+  # return the current underlying operating system
+  def self.host_os
+    if [OS::WINDOWS, OS::MINGW, OS::CYGWIN].include?(os_context)
+      OS::WINDOWS
+    else
+      os_context
+    end
+  end
+
+  def on_windows?
+    host_os == OS::WINDOWS
+  end
+
+  def on_linux?
+    os_context == OS::LINUX
+  end
+
+  def on_bsd?
+    os_context == OS::BSD
+  end
+
+  def on_osx?
+    os_context == OS::OSX
+  end
+end

data/lib/sproc/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SProc
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sproc
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Anders Rillbert
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-02-18 00:00:00.000000000 Z
+date: 2021-02-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -42,6 +42,7 @@ files:
 - bin/setup
 - lib/sproc.rb
 - lib/sproc/core.rb
+- lib/sproc/utils.rb
 - lib/sproc/version.rb
 - sproc.gemspec
 homepage: https://github.com/rillbert/sproc