yamatanooroti 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c009e6dc5f113b62e9e62a6c1ce27130b2f2100f9ab0aa2a959afb893eace993
-  data.tar.gz: dd24b52416f695388dda859d1f538662d15bead1e16b6b0b5702baf40702a54e
+  metadata.gz: 642a33b1504b4ecfdf9698597be8c5cff356950cfe71379cfb8c05ae6af45ec6
+  data.tar.gz: 8f4c37ab46ff74d2f14f4f2069c0b7c1847ea59c5d6b43990eaeff462c99474e
 SHA512:
-  metadata.gz: 5a412b98347bd3e0b251905fa8f2de3dd54763899dcd80f50635d5d13f9166a2d0dbe80daa06faabd03a5ef000862db7d42951b935c15ecb75fd278b7e79c834
-  data.tar.gz: 137f7d47e13c565daf6ffaf3cf56b47f00937ac6c61255bab821013fc408e14318b5b9110edf80e3c8796d7866e498665a190ff444fc28bea3704f9efb67afe6
+  metadata.gz: d017372f678c86f9e7f3dc0f6a6d96b4f26a0de534d96e508fe92b63e2ff129f2ae664dff1dcb4170aea0208420d014d5587ba66b6081c13d98713157f3a9c17
+  data.tar.gz: 77e04395752636618fd8202ccd8942440e7d5dfaa920d5650f60dd8b5ad4e83581d07297fcae62af46147ef063e25ee3ea0a2ab9531d840a2818d24a79c9fbeb

data/README.md

@@ -75,10 +75,24 @@ Likewise, you can specify Windows command prompt test by `Yamatanooroti::Windows
 
 ## Method Reference
 
-### `start_terminal(height, width, command)`
+### `start_terminal(height, width, command, startup_message: nil)`
 
 Starts terminal internally that is sized `height` and `width` with `command` to test the result. The `command` should be an array of strings with a path of command and zero or more options. This should be called in `setup` method.
 
+If `startup_message` is given, `start_terminal` waits for the string to be printed and then returns.
+
+```ruby
+code = 'sleep 1; puts "aaa"; sleep 10; puts "bbb"'
+start_terminal(5, 30, ['ruby', '-e', code], startup_message: 'aaa')
+close
+assert_screen(<<~EOC)
+  aaa
+EOC
+# The start_terminal method waits for the output of the "aaa" as specified by
+# the startup_message option, the "bbb" after 10 seconds won't come because
+# the I/O is closed immediately after it.
+```
+
 ### `write(str)`
 
 Writes `str` like inputting by a keyboard to the started terminal.

data/lib/yamatanooroti/version.rb

@@ -1,3 +1,3 @@
 class Yamatanooroti
-  VERSION = '0.0.4'
+  VERSION = '0.0.5'
 end

data/lib/yamatanooroti/vterm.rb

@@ -4,7 +4,7 @@ require 'pty'
 require 'io/console'
 
 module Yamatanooroti::VTermTestCaseModule
-  def start_terminal(height, width, command, wait: 0.1)
+  def start_terminal(height, width, command, wait: 0.1, startup_message: nil)
     @wait = wait
     @result = nil
 
@@ -16,6 +16,15 @@ module Yamatanooroti::VTermTestCaseModule
     @screen = @vterm.screen
     @screen.reset(true)
 
+    case startup_message
+    when String
+      @startup_message = ->(message) { message.start_with?(startup_message) }
+    when Regexp
+      @startup_message = ->(message) { startup_message.match?(message) }
+    else
+      @startup_message = nil
+    end
+
     sync
   end
 
@@ -30,20 +39,34 @@ module Yamatanooroti::VTermTestCaseModule
     @pty_input.close
     sync
     Process.kill('KILL', @pid)
+    Process.waitpid(@pid)
   end
 
   private def sync
+    startup_message = '' if @startup_message
     loop do
       sleep @wait
       chunk = @pty_output.read_nonblock(1024)
+      if @startup_message
+        startup_message << chunk
+        if @startup_message.(startup_message)
+          @startup_message = nil
+          chunk = startup_message
+        else
+          redo
+        end
+      end
       @vterm.write(chunk)
       chunk = @vterm.read
       @pty_input.write(chunk)
     rescue Errno::EAGAIN, Errno::EWOULDBLOCK
+      retry if @startup_message
       break
     rescue Errno::EIO # EOF
+      retry if @startup_message
       break
     rescue IO::EAGAINWaitReadable # emtpy buffer
+      retry if @startup_message
       break
     end
   end

data/lib/yamatanooroti/windows.rb

@@ -289,8 +289,37 @@ module Yamatanooroti::WindowsTestCaseModule
     end
   end
 
+  private def quote_command_arg(arg)
+    if not arg.match?(/[ \t"]/)
+      # No quotation needed.
+      return arg
+    end
+
+    if not arg.match?(/["\\]/)
+      # No embedded double quotes or backlashes, so I can just wrap quote
+      # marks around the whole thing.
+      return %{"#{arg}"}
+    end
+
+    quote_hit = true
+    result = '"'
+    arg.chars.reverse.each do |c|
+      result << c
+      if quote_hit and c == '\\'
+        result << '\\'
+      elsif c == '"'
+        quote_hit = true
+        result << '\\'
+      else
+        quote_hit = false
+      end
+    end
+    result << '"'
+    result.reverse
+  end
+
   private def launch(command)
-    command = %Q{cmd.exe /q /c "#{command.gsub('"', '\\"')}"}
+    command = %Q{cmd.exe /q /c "#{command}"}
     converted_command = mb2wc(command)
     @pi = DL::PROCESS_INFORMATION.malloc
     (@pi.to_ptr + 0)[0, DL::PROCESS_INFORMATION.size] = "\x00" * DL::PROCESS_INFORMATION.size
@@ -402,6 +431,12 @@ module Yamatanooroti::WindowsTestCaseModule
   def close
     sleep @wait
     # read first before kill the console process including output
+    @result = retrieve_screen
+
+    free_resources
+  end
+
+  private def retrieve_screen
     char_info_matrix = Fiddle::Pointer.to_ptr("\x00" * (DL::CHAR_INFO.size * (@height * @width)))
     region = DL::SMALL_RECT.malloc
     region.Left = 0
@@ -410,7 +445,7 @@ module Yamatanooroti::WindowsTestCaseModule
     region.Bottom = @height
     r = DL.ReadConsoleOutputW(@output_handle, char_info_matrix, @height * 65536 + @width, 0, region)
     error_message(r, "ReadConsoleOutputW")
-    @result = []
+    screen = []
     prev_c = nil
     @height.times do |y|
       line = ''
@@ -425,10 +460,9 @@ module Yamatanooroti::WindowsTestCaseModule
           prev_c = mb
         end
       end
-      @result << line.gsub(/ *$/, '')
+      screen << line.gsub(/ *$/, '')
     end
-
-    free_resources
+    screen
   end
 
   def result
@@ -450,7 +484,20 @@ module Yamatanooroti::WindowsTestCaseModule
     @wait = wait
     @result = nil
     setup_console(height, width)
-    launch(command.join(' '))
+    launch(command.map{ |c| quote_command_arg(c) }.join(' '))
+    case startup_message
+    when String
+      check_startup_message = ->(message) { message.start_with?(startup_message) }
+    when Regexp
+      check_startup_message = ->(message) { startup_message.match?(message) }
+    end
+    if check_startup_message
+      loop do
+        screen = retrieve_screen.join("\n").sub(/\n*\z/, "\n")
+        break if check_startup_message.(screen)
+        sleep @wait
+      end
+    end
   end
 end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yamatanooroti
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - aycabta
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-09-08 00:00:00.000000000 Z
+date: 2020-09-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: test-unit
@@ -85,7 +85,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.0.3
 signing_key:
 specification_version: 4
 summary: Multi-platform real(?) terminal test framework