qbash 0.4.3 → 0.4.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: df6e6d3493e78bba7aa90acd7e51c84b8b869e5fac3e1fe696ed67e29a50219c
-  data.tar.gz: 7b5b9e9ae374085166d01b17ddf16c7ba740b50f5f0c4dfb407bb9da2ffcc6bc
+  metadata.gz: 1ca64f77c050b51b02164ffab0c532d6d915fe0ba76ed4d311894b150eac963f
+  data.tar.gz: 4082a2f3aadf655a8fe6a6b7df67a85212f0fe9b8221bf64a26329abdfb8218a
 SHA512:
-  metadata.gz: 348fabb99cb7a962b51d354b0b668e08e009f9c82db7433c91fa738336e19f0e51c9cd319d0dae522a73813e7a80344a54e717cca09d9f67ad1068e403058966
-  data.tar.gz: 3c72c3b7a39d5e3523cda49ed38be201147e07d15f8cae5b69bfd74b5f2cec6b8a8ac3f4d7d78ffc321a415893ed1c46005372030aa651a15679d8686523eac3
+  metadata.gz: 80535d4feebc803f62b1da69da63f2412330cc8f21a8ca9a5cfc344535b2c15c6816df65fcaa16db40efff702b8628dcd7817a4b93003a423b8928ea3df82d25
+  data.tar.gz: 609155111977c724663a6ba5c6a90718252d0c520f608c3dcadf0abc80dc0bf5d135f27a1204cfc9a002371461c9ff2e8cff85b9862dc6404fc2baf0a9a70932

data/lib/qbash.rb

@@ -75,17 +75,19 @@ module Kernel
   #
   # @param [String, Array] cmd The command to run (String or Array of arguments)
   # @param [String] stdin The +stdin+ to provide to the command
+  # @param [Array] opts List of bash options, like "--login" and "--noprofile"
   # @param [Hash] env Hash of environment variables
   # @param [Loog|IO] log Logging facility with +.debug()+ method (or +$stdout+, or nil if should go to +/dev/null+)
   # @param [Array] accept List of accepted exit codes (accepts all if the list is +nil+)
   # @param [Boolean] both If set to TRUE, the function returns an array +(stdout, code)+
   # @param [Integer] level Logging level (use +Logger::DEBUG+, +Logger::INFO+, +Logger::WARN+, or +Logger::ERROR+)
   # @return [String] Everything that was printed to the +stdout+ by the command
-  def qbash(cmd, stdin: '', env: {}, log: Loog::NULL, accept: [0], both: false, level: Logger::DEBUG)
+  def qbash(cmd, opts: [], stdin: '', env: {}, log: Loog::NULL, accept: [0], both: false, level: Logger::DEBUG)
     env.each { |k, v| raise "env[#{k}] is nil" if v.nil? }
     cmd = cmd.reject { |a| a.nil? || (a.is_a?(String) && a.empty?) }.join(' ') if cmd.is_a?(Array)
     logit =
       lambda do |msg|
+        msg = msg.gsub(/\n$/, '')
         mtd =
           case level
           when Logger::DEBUG
@@ -107,16 +109,18 @@ module Kernel
           log.print("#{msg}\n")
         end
       end
-    logit["+ #{cmd}"]
     buf = ''
     e = 1
     start = Time.now
-    Open3.popen2e(env, "/bin/bash -c #{Shellwords.escape(cmd)}") do |sin, sout, ctrl|
+    bash = ['exec', '/bin/bash'] + opts + ['-c', Shellwords.escape(cmd)]
+    Open3.popen2e(env, bash.join(' ')) do |sin, sout, ctrl|
+      pid = ctrl.pid
+      logit["+ #{cmd} /##{pid}"]
       consume =
         lambda do
           loop do
             break if sout.eof?
-            ln = sout.gets
+            ln = sout.gets # together with the \n at the end
             next if ln.nil?
             next if ln.empty?
             buf += ln
@@ -132,22 +136,24 @@ module Kernel
       if block_given?
         watch = Thread.new { consume.call }
         watch.abort_on_exception = true
-        pid = ctrl.pid
-        yield pid
-        sout.close
-        watch.join(0.01)
-        watch.kill if watch.alive?
-        attempt = 1
-        since = Time.now
-        loop do
-          Process.kill(0, pid) # should be dead already (raising Errno::ESRCH)
-          Process.kill('TERM', pid) # let's try to kill it
-          logit["Tried to stop ##{pid} with SIGTERM (attempt no.#{attempt}, #{since.ago}): #{cmd}"]
-          sleep(0.1)
-          attempt += 1
-        rescue Errno::ESRCH
-          logit["Process ##{pid} exited gracefully"]
-          break
+        begin
+          yield pid
+        ensure
+          sout.close
+          watch.join(0.01)
+          watch.kill if watch.alive?
+          attempt = 1
+          since = Time.now
+          loop do
+            Process.kill(0, pid) # should be dead already (raising Errno::ESRCH)
+            Process.kill('TERM', pid) # let's try to kill it
+            logit["Tried to stop ##{pid} with SIGTERM (attempt no.#{attempt}, #{since.ago}): #{cmd}"]
+            sleep(0.1)
+            attempt += 1
+          rescue Errno::ESRCH
+            logit["Process ##{pid} reacted to SIGTERM, after #{attempt} attempts and #{since.ago}"] if attempt > 1
+            break
+          end
         end
       else
         consume.call

data/qbash.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |s|
   s.required_rubygems_version = Gem::Requirement.new('>= 0') if s.respond_to? :required_rubygems_version=
   s.required_ruby_version = '>=3.2'
   s.name = 'qbash'
-  s.version = '0.4.3'
+  s.version = '0.4.5'
   s.license = 'MIT'
   s.summary = 'Quick Executor of a BASH Command'
   s.description =

data/test/test_qbash.rb

@@ -79,6 +79,14 @@ class TestQbash < Minitest::Test
     end
   end
 
+  def test_lets_exception_float_up
+    assert_raises(StandardError) do
+      qbash('sleep 767676', accept: nil, log: $stdout) do
+        raise 'intentional'
+      end
+    end
+  end
+
   def test_kills_in_thread
     Thread.new do
       qbash('sleep 9999', accept: nil) do |pid|
@@ -87,6 +95,21 @@ class TestQbash < Minitest::Test
     end.join
   end
 
+  def test_truly_kills
+    qbash('sleep 9876543', accept: nil) do
+      sleep(0.1)
+    end
+    refute_empty(qbash('ps ax | grep -v 9876543'))
+  end
+
+  def test_executes_without_sh_only_bash
+    qbash('sleep 89898989', accept: nil) do
+      refute_empty(qbash('ps ax | grep -v "sh -c exec /bin/bash -c sleep 89898989" | grep -v grep'))
+      refute_empty(qbash('ps ax | grep "sleep 89898989" | grep -v grep'))
+      sleep(0.1)
+    end
+  end
+
   def test_logs_in_background
     stdout = nil
     buf = Loog::Buffer.new
@@ -107,6 +130,26 @@ class TestQbash < Minitest::Test
     refute_includes(buf.to_s, "\n\n")
   end
 
+  def test_logs_multi_line_print
+    buf = Loog::Buffer.new
+    pid = nil
+    qbash('echo one; echo two', log: buf, accept: nil) do |i|
+      sleep(0.1)
+      pid = i
+    end
+    assert_equal(buf.to_s, "+ echo one; echo two /##{pid}\n##{pid}: one\n##{pid}: two\n")
+  end
+
+  def test_logs_multi_line_to_console
+    console = FakeConsole.new
+    pid = nil
+    qbash('echo one; echo two', log: console, accept: nil) do |i|
+      sleep(0.1)
+      pid = i
+    end
+    assert_equal(console.to_s, "+ echo one; echo two /##{pid}\n##{pid}: one\n##{pid}: two\n")
+  end
+
   def test_with_both
     Dir.mktmpdir do |home|
       stdout, code = qbash("cat #{Shellwords.escape(File.join(home, 'foo.txt'))}", accept: nil, both: true)
@@ -131,4 +174,18 @@ class TestQbash < Minitest::Test
     refute(t.join(0.1))
     t.kill
   end
+
+  class FakeConsole
+    def initialize
+      @buf = ''
+    end
+
+    def to_s
+      @buf
+    end
+
+    def print(ln)
+      @buf += ln
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: qbash
 version: !ruby/object:Gem::Version
-  version: 0.4.3
+  version: 0.4.5
 platform: ruby
 authors:
 - Yegor Bugayenko