test-cmd.rb 2.0.0 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c6c0bc0c0b5e20d51b2455762362ee54301e95c6171a6427dbdf6ea85acdc834
-  data.tar.gz: 9bcbbe35149e54547b7e01a678de58a068e4a35a0728d454fa613f26d2d9c3ee
+  metadata.gz: e57955db2ea9f64997167878e30449b920c1746751e493b54c1ff549b852d55d
+  data.tar.gz: 3e2527cb8deedc6205726ff8900aa2e23c15b69c9662debfb9322ebbc38e7ee3
 SHA512:
-  metadata.gz: ec35ba65fefe5c978fe9d467d90f1c9719a984078f2bafb22f1a9e1757ca322533ee99c7f77d4268bbb051986230685058da3da88ca2674567b264d915b5f97b
-  data.tar.gz: 517746b21cb1edd44a3d96216ae3b842b88acec38c6b3fad389d3748ef8cacc241f4baf205aa1fe285a2aea92c5775e359a04d6fd89f5f9f2e205a7e13784bf8
+  metadata.gz: 782b41654883c063415e13191a28fdaf719123db4c4980a1f69102d23ad2026a61e8ce0b2c927cde4e12b321426cdcf1ecd25fce528fca5d586fe627160c8373
+  data.tar.gz: 442fb73c9759f458c448729a2893b507ab0c8e6db2d5d8bea4d465b2b117c01794f9b501bb910460dbbc9a56f627c8147dea53a7e0814c1ae503133b4cc2774a

data/README.md

@@ -36,14 +36,59 @@ A command is created with
 which takes the name or path of a command, and given additional
 arguments with
 [`Test::Command#argv`](https://r.uby.dev/api-docs/test-cmd.rb/Test/Command.html#argv-instance_method).
+Environment variables can be set for the spawned process with
+[`Test::Command#env`](https://r.uby.dev/api-docs/test-cmd.rb/Test/Command.html#env-instance_method),
+and standard input with
+[`Test::Command#stdin`](https://r.uby.dev/api-docs/test-cmd.rb/Test/Command.html#stdin-instance_method).
 The instance has access to the command's process ID, exit status,
 standard output stream, and standard error stream.
 
 ```ruby
 require "test-cmd"
-Test::Command.new("ls").argv("-l").stdout
+puts Test::Command.new("ls").argv("-l").stdout
+puts Test::Command.new("env").env("FOO" => "bar").stdout
+test_cmd = Test::Command.new("tr", "a-z", "A-Z").stdin("hello").stdout  # => "HELLO"
 ```
 
+<details>
+<summary>Environment</summary>
+<br>
+
+Environment variables for the spawned process are set with
+[`Test::Command#env`](https://r.uby.dev/api-docs/test-cmd.rb/Test/Command.html#env-instance_method),
+which merges the given variables into the child's environment and
+returns the command for chaining.
+
+```ruby
+require "test-cmd"
+puts Test::Command
+  .new("ruby", "-e", "puts ENV['FOO']")
+  .env("FOO" => "42")
+  .stdout  # => "42\n"
+```
+</details>
+
+<details>
+<summary>Standard input</summary>
+<br>
+
+Standard input for the spawned process is set with
+[`Test::Command#stdin`](https://r.uby.dev/api-docs/test-cmd.rb/Test/Command.html#stdin-instance_method).
+Pass a String to write it to the child's standard input, or another
+[Test::Command](https://r.uby.dev/api-docs/test-cmd.rb/Test/Command.html)
+whose standard output will be used as the standard input.
+
+```ruby
+require "test-cmd"
+puts Test::Command.new("cat").stdin("hello world").stdout  # => "hello world"
+
+# Pipe one command's standard output into another's standard input
+puts Test::Command.new("tr", "a-z", "A-Z")
+  .stdin(Test::Command.new("echo", "hello"))
+  .stdout  # => "HELLO\n"
+```
+</details>
+
 <details>
 <summary>Callbacks</summary>
 <br>

data/lib/test/cmd.rb

@@ -26,6 +26,7 @@ class Test::Command
   def initialize(cmd, *argv)
     @cmd = cmd
     @argv = argv.dup
+    @env = {}
     @status = nil
     @spawned = false
     @stdout = ""
@@ -41,25 +42,44 @@ class Test::Command
     tap { @argv.concat(argv) }
   end
 
+  ##
+  # @param [Hash{String => String}] env
+  #  Environment variables to set for the spawned command
+  # @return [Test::Command]
+  def env(env)
+    tap { @env.merge!(env) }
+  end
+
+  ##
+  # Presets the standard input that will be sent to the
+  # spawned process. Pass a String, or another
+  # {Test::Command Test::Command} whose standard output
+  # will be used as the standard input.
+  # @param [String, Test::Command] data
+  #  The standard input of the spawned process
+  # @example
+  #   cmd = Test::Command.new("cat").stdin("hello world")
+  #   puts cmd.stdout
+  # @return [Test::Command]
+  def stdin(data)
+    tap { @stdin = data }
+  end
+
   ##
   # Spawns a command
   # @return [Test::Command]
   def spawn
     return self if @spawned
+    @in_r = input_pipe
     tap do
       @spawned = true
       @out, @err = Pipe.pair, Pipe.pair
-      ##
-      # Spawn in the calling thread so the command's fds are
-      # wired up before the reader thread starts. We then close
-      # our own copies of the write ends so the reader thread
-      # observes EOF the moment the child exits, and reads both
-      # streams with whole-buffer reads rather than a byte at
-      # a time.
       @pid = Process.spawn(
+        @env,
         @cmd, *@argv,
-        {out: @out.w, err: @err.w, in: IO::NULL}
+        {in: @in_r, out: @out.w, err: @err.w}
       )
+      @in_r.close unless @in_r.equal?(IO::NULL)
       @out.w.close
       @err.w.close
       @producer = Thread.new do
@@ -76,8 +96,9 @@ class Test::Command
     @stderr = ex.message
     @enoent = true
     ##
-    # Capture a real non-zero status so predicates like
-    # #success? work even though the command never spawned.
+    # Close the read end of any input pipe so a pending
+    # writer thread does not block forever.
+    @in_r.close unless @in_r.equal?(IO::NULL)
     @status = Process.waitpid2(Process.spawn("false")).last
   end
 
@@ -209,6 +230,23 @@ class Test::Command
 
   private
 
+  ##
+  # Returns a pipe pair used for the command's
+  # standard input. When no input is set, the child
+  # reads from IO::NULL. When the input is another
+  # command, the source command is spawned first and
+  # its stdout feeds the pipe.
+  # @return [IO]
+  #  A read end (IO::NULL or a pipe read end)
+  def input_pipe
+    return IO::NULL if @stdin.nil?
+    data = self.class === @stdin ? @stdin.stdout : @stdin.to_s
+    r, w = IO.pipe
+    w.write(data)
+    w.close
+    r
+  end
+
   ##
   # Blocks until the spawned command has finished, its
   # output has been read, and its exit status captured.

data/test/cmd_test.rb

@@ -21,6 +21,35 @@ class Test::Command
     end
   end
 
+  ##
+  # Test::Command#env
+  class EnvTest < Test
+    def test_ruby_env
+      assert_equal "42\n",
+                   ::Test::Command.new("ruby", "-e", "puts ENV['FOO']")
+                     .env("FOO" => "42")
+                     .stdout
+    end
+  end
+
+  ##
+  # Test::Command#stdin
+  class StdinTest < Test
+    def test_ruby_stdin_string
+      assert_equal "hello world",
+                   ::Test::Command.new("cat")
+                     .stdin("hello world")
+                     .stdout
+    end
+
+    def test_ruby_stdin_command
+      assert_equal "42\n",
+                   ::Test::Command.new("cat")
+                     .stdin(ruby("puts 42"))
+                     .stdout
+    end
+  end
+
   ##
   # Test::Command#{exit_status, status, success?}
   class ExitStatusTest < Test

data/test-cmd.rb.gemspec

@@ -5,7 +5,7 @@ Gem::Specification.new do |gem|
   gem.authors = ["robert"]
   gem.email = ["robert@r.uby.dev"]
   gem.homepage = "https://github.com/0x1eef/test-cmd.rb#readme"
-  gem.version = "2.0.0"
+  gem.version = "2.2.0"
   gem.required_ruby_version = ">= 3.0"
   gem.licenses = ["0BSD"]
   gem.files = `git ls-files`.split($/)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: test-cmd.rb
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.2.0
 platform: ruby
 authors:
 - robert