test-cmd.rb 2.4.0 → 2.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b091ee25f1e890969728e516747d3104c20076d2a71973e02ccc346a9eb1cc8e
-  data.tar.gz: 4dbb449b245f30e89285b7cae84de42564e352a4f0790fcc3a8a048e21b3ede2
+  metadata.gz: a0790a7e8e68709204aeb42611543db79e3575615d6ed77ee0b166fff7827825
+  data.tar.gz: 7965cd9baf53560ff8648f0652876b3d31a969528b1419b5b975406ec37c13fc
 SHA512:
-  metadata.gz: 43fb7bb3700e9f384c253c8ab36ec3a1ebb2ec5e807b3af1d57883a64bddb132838086fc15b242ce3a65b85092941d23a040b866b3e173bed4bf5254e2829690
-  data.tar.gz: c314163ab04470596296e8644414bec98414955b7423a1cc5affe202184befedffaff5f1f63427b18dd192b356fe491d3ec85e1b1c5140857c185b3a7ea37402
+  metadata.gz: f0f7c63d381cbbd8c603c8fc7a1c22e7c73509b0a51965107c2fe2c23adf3c2b8cf5f243712b4f297f90aeb0535c01477ddd4518c10be6afd6a29b248c30af18
+  data.tar.gz: aee5d21c5948e17b29f0df43636bb18d396d6919efdc3a0fe6c03628ba85d5f3ae0e04cd03e61e51c33ad30aa88a2e7a840051cc704d3ac384957ea75d6f1cd1

data/README.md

@@ -60,6 +60,15 @@ p Test::Command
   .new("tr", "a-z", "A-Z")
   .stdin("hello")
   .stdout  # => "HELLO"
+
+##
+# Limit how much data is read from stdout and
+# stderr. At most 20k chars is read from both:
+p Test::Command
+  .new("git")
+  .limit(stdout: 20_000, stderr: 20_000)
+  .argv("diff", "--cached")
+  .stdout
 ```
 
 <details>

data/lib/test/command/version.rb

@@ -4,5 +4,5 @@ end unless defined?(Test)
 class Test::Command
   ##
   # @string [String]
-  VERSION = "2.4.0"
+  VERSION = "2.5.0"
 end

data/lib/test/command.rb

@@ -34,6 +34,7 @@ class Test::Command
     @stdout = ""
     @stderr = ""
     @enoent = false
+    @limit = {stdout: nil, stderr: nil}
   end
 
   ##
@@ -67,6 +68,19 @@ class Test::Command
     tap { @stdin = data }
   end
 
+  ##
+  # Limits how many bytes of each stream are captured.
+  # A stream output beyond the limit is discarded, keeping
+  # memory bounded even for a command that streams a lot.
+  # @param [Integer, nil] stdout
+  #  Max bytes of stdout to read, or nil for unlimited
+  # @param [Integer, nil] stderr
+  #  Max bytes of stderr to read, or nil for unlimited
+  # @return [Test::Command]
+  def limit(stdout: nil, stderr: nil)
+    tap { @limit = {stdout:, stderr:} }
+  end
+
   ##
   # Spawns a command
   # @return [Test::Command]
@@ -85,8 +99,8 @@ class Test::Command
       @out.w.close
       @err.w.close
       @producer = Thread.new do
-        @stdout = @out.r.read
-        @stderr = @err.r.read
+        @stdout = read_limited(@out.r, @limit[:stdout])
+        @stderr = read_limited(@err.r, @limit[:stderr])
         Process.wait
         @status = $?
       ensure
@@ -232,6 +246,31 @@ class Test::Command
 
   private
 
+  ##
+  # Reads up to +max+ bytes from a stream, then drains
+  # the remainder so a child writing more than the limit
+  # does not block on a full pipe. When +max+ is nil the
+  # entire stream is read.
+  # @param [IO] io
+  # @param [Integer, nil] max
+  # @return [String]
+  def read_limited(io, max)
+    return io.read if max.nil?
+    buf = +""
+    remaining = max
+    while remaining > 0 && (chunk = io.read(remaining))
+      buf << chunk
+      remaining -= chunk.bytesize
+    end
+    ##
+    # Drain whatever is left so the child can exit:
+    # the drained bytes are discarded, keeping memory
+    # bounded.
+    while (chunk = io.read(16_384))
+    end
+    buf
+  end
+
   ##
   # Returns a pipe pair used for the command's
   # standard input. When no input is set, the child

data/test/cmd_test.rb

@@ -58,6 +58,43 @@ class Test::Command
     end
   end
 
+  ##
+  # Test::Command#limit
+  class LimitTest < Test
+    def test_ruby_limit_stdout
+      assert_equal "happy",
+                   ::Test::Command.new("printf", "%s", "happy days")
+                     .limit(stdout: 5)
+                     .stdout
+    end
+
+    def test_ruby_limit_stderr
+      assert_equal "smile",
+                   ::Test::Command.new("sh", "-c", "echo smile >&2")
+                     .limit(stderr: 5)
+                     .stderr
+    end
+
+    def test_ruby_limit_nil_is_unlimited
+      expect = "a" * 20_000
+      assert_equal expect,
+                   ::Test::Command.new("ruby", "-e", "print 'a' * 20_000")
+                     .stdout
+    end
+
+    def test_ruby_limit_drains_remaining_output
+      cmd = ::Test::Command.new("sh", "-c", "printf 'happy days'")
+        .limit(stdout: 5)
+        .spawn
+      assert_equal true, cmd.spawned?
+      ##
+      # A full pipe would block forever: the
+      # drain lets the child finish and capture
+      # its status
+      assert_equal 0, cmd.exit_status
+    end
+  end
+
   ##
   # Test::Command#{exit_status, status, success?}
   class ExitStatusTest < Test

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: test-cmd.rb
 version: !ruby/object:Gem::Version
-  version: 2.4.0
+  version: 2.5.0
 platform: ruby
 authors:
 - Robert Gleeson