yamatanooroti 0.0.4 → 0.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c009e6dc5f113b62e9e62a6c1ce27130b2f2100f9ab0aa2a959afb893eace993
-  data.tar.gz: dd24b52416f695388dda859d1f538662d15bead1e16b6b0b5702baf40702a54e
+  metadata.gz: 405b57a78b93d5990c59232f331cfabec9c9c0e6bd6f0421ed4f62d7df0f93ed
+  data.tar.gz: e3cb1a67a2ab62d8afa3c12ff9e76b6630c4ea7bd9adc3f79074f438bcefd2eb
 SHA512:
-  metadata.gz: 5a412b98347bd3e0b251905fa8f2de3dd54763899dcd80f50635d5d13f9166a2d0dbe80daa06faabd03a5ef000862db7d42951b935c15ecb75fd278b7e79c834
-  data.tar.gz: 137f7d47e13c565daf6ffaf3cf56b47f00937ac6c61255bab821013fc408e14318b5b9110edf80e3c8796d7866e498665a190ff444fc28bea3704f9efb67afe6
+  metadata.gz: a3831e1e85b7c03ff786ec24085ba85846ef9b1aa9ce049043cf6d96e3ff39fa7981c67123f91355a7c3f8f7f721a3c827d2d93fc18d43e74875f5a940600952
+  data.tar.gz: e3626f863db8cdb3b4287485b068883e117f4b2946f2f1d55cd6d4eca991b9753ccf6c967d7461936c8cb5311867404ae2431f525c725380d56632196f90371c

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.8'
 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,12 +16,32 @@ 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
 
   def write(str)
     sync
-    @pty_input.write(str)
+    str_to_write = String.new(encoding: Encoding::ASCII_8BIT)
+    str.chars.each do |c|
+      byte = c.force_encoding(Encoding::ASCII_8BIT).ord
+      if c.bytesize == 1 and byte.allbits?(0x80) # with Meta key
+        c = (byte ^ 0x80).chr
+        str_to_write << "\e"
+        str_to_write << c
+      else
+        str_to_write << c
+      end
+    end
+    @pty_input.write(str_to_write)
     sync
   end
 
@@ -30,20 +50,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
@@ -56,7 +90,13 @@ module Yamatanooroti::VTermTestCaseModule
       @result << ''
       cols.times do |c|
         cell = @screen.cell_at(r, c)
-        @result.last << cell.char if cell.char
+        if cell.char.nil? or cell.char.empty?
+          # There will be no char to the left of the rendered area if moves
+          # the cursor.
+          @result.last << ' '
+        else
+          @result.last << cell.char
+        end
       end
       @result.last.gsub!(/ *$/, '')
     end

data/lib/yamatanooroti/windows.rb

@@ -147,6 +147,7 @@ module Yamatanooroti::WindowsDefinition
   TH32CS_SNAPPROCESS = 0x00000002
   PROCESS_ALL_ACCESS = 0x001FFFFF
   SW_HIDE = 0
+  LEFT_ALT_PRESSED = 0x0002
 
   # HANDLE GetStdHandle(DWORD nStdHandle);
   extern 'HANDLE GetStdHandle(DWORD);', :stdcall
@@ -169,6 +170,10 @@ module Yamatanooroti::WindowsDefinition
   extern 'BOOL SetConsoleWindowInfo(HANDLE, BOOL, PSMALL_RECT);', :stdcall
   # BOOL WriteConsoleInputW(HANDLE hConsoleInput, const INPUT_RECORD *lpBuffer, DWORD nLength, LPDWORD lpNumberOfEventsWritten);
   extern 'BOOL WriteConsoleInputW(HANDLE, const INPUT_RECORD*, DWORD, LPDWORD);', :stdcall
+  # SHORT VkKeyScanW(WCHAR ch);
+  extern 'SHORT VkKeyScanW(WCHAR);', :stdcall
+  # UINT MapVirtualKeyW(UINT uCode, UINT uMapType);
+  extern 'UINT MapVirtualKeyW(UINT, UINT);', :stdcall
   # BOOL ReadConsoleOutputW(HANDLE hConsoleOutput, PCHAR_INFO lpBuffer, COORD dwBufferSize, COORD dwBufferCoord, PSMALL_RECT lpReadRegion);
   extern 'BOOL ReadConsoleOutputW(HANDLE, PCHAR_INFO, COORD, COORD, PSMALL_RECT);', :stdcall
   # BOOL WINAPI SetCurrentConsoleFontEx(HANDLE hConsoleOutput, BOOL bMaximumWindow, PCONSOLE_FONT_INFOEX lpConsoleCurrentFontEx);
@@ -289,8 +294,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
@@ -333,33 +367,43 @@ module Yamatanooroti::WindowsTestCaseModule
 
   def write(str)
     sleep @wait
-    str.tr!("\n", "\r")
+    str.force_encoding(Encoding::ASCII_8BIT).tr!("\n", "\r")
     records = Fiddle::Pointer.malloc(DL::INPUT_RECORD_WITH_KEY_EVENT.size * str.size * 2, DL::FREE)
     str.chars.each_with_index do |c, i|
+      byte = c.ord
+      if c.bytesize == 1 and byte.allbits?(0x80) # with Meta key
+        c = (byte ^ 0x80).chr
+        control_key_state = DL::LEFT_ALT_PRESSED
+      else
+        control_key_state = 0
+      end
       record_index = i * 2
       r = DL::INPUT_RECORD_WITH_KEY_EVENT.new(records + DL::INPUT_RECORD_WITH_KEY_EVENT.size * record_index)
-      r.EventType = DL::KEY_EVENT
-      r.bKeyDown = 1
-      r.wRepeatCount = 0
-      r.wVirtualKeyCode = 0
-      r.wVirtualScanCode = 0
-      r.UnicodeChar = c.unpack('U').first
-      r.dwControlKeyState = 0
+      set_input_record(r, c, true, control_key_state)
       record_index = i * 2 + 1
       r = DL::INPUT_RECORD_WITH_KEY_EVENT.new(records + DL::INPUT_RECORD_WITH_KEY_EVENT.size * record_index)
-      r.EventType = DL::KEY_EVENT
-      r.bKeyDown = 0
-      r.wRepeatCount = 0
-      r.wVirtualKeyCode = 0
-      r.wVirtualScanCode = 0
-      r.UnicodeChar = c.unpack('U').first
-      r.dwControlKeyState = 0
+      set_input_record(r, c, false, control_key_state)
     end
     written_size = Fiddle::Pointer.malloc(Fiddle::SIZEOF_DWORD, DL::FREE)
     r = DL.WriteConsoleInputW(DL.GetStdHandle(DL::STD_INPUT_HANDLE), records, str.size * 2, written_size)
     error_message(r, 'WriteConsoleInput')
   end
 
+  private def set_input_record(r, c, key_down, control_key_state)
+    begin
+      code = c.unpack('U').first
+    rescue ArgumentError
+      code = c.bytes.first
+    end
+    r.EventType = DL::KEY_EVENT
+    r.bKeyDown = key_down ? 1 : 0
+    r.wRepeatCount = 1
+    r.wVirtualKeyCode = DL.VkKeyScanW(code)
+    r.wVirtualScanCode = DL.MapVirtualKeyW(code, 0)
+    r.UnicodeChar = code
+    r.dwControlKeyState = control_key_state
+  end
+
   private def free_resources
     h_snap = DL.CreateToolhelp32Snapshot(DL::TH32CS_SNAPPROCESS, 0)
     pe = DL::PROCESSENTRY32W.malloc
@@ -402,6 +446,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 +460,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 +475,9 @@ module Yamatanooroti::WindowsTestCaseModule
           prev_c = mb
         end
       end
-      @result << line.gsub(/ *$/, '')
+      screen << line.gsub(/ *$/, '')
     end
-
-    free_resources
+    screen
   end
 
   def result
@@ -444,13 +493,26 @@ module Yamatanooroti::WindowsTestCaseModule
     end
   end
 
-  def start_terminal(height, width, command, wait: 1)
+  def start_terminal(height, width, command, wait: 1, startup_message: nil)
     @height = height
     @width = width
     @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.8
 platform: ruby
 authors:
 - aycabta
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-09-08 00:00:00.000000000 Z
+date: 2021-09-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: test-unit
@@ -52,6 +52,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: reline
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: "    Yamatanooroti is a multi-platform real(?) terminal test framework.\n"
 email:
 - aycabta@gmail.com
@@ -64,7 +78,6 @@ files:
 - lib/yamatanooroti.rb
 - lib/yamatanooroti/version.rb
 - lib/yamatanooroti/vterm.rb
-- lib/yamatanooroti/vterm.rb.orig
 - lib/yamatanooroti/windows.rb
 homepage: https://github.com/aycabta/yamatanooroti
 licenses:
@@ -85,7 +98,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.2.22
 signing_key:
 specification_version: 4
 summary: Multi-platform real(?) terminal test framework

data/lib/yamatanooroti/vterm.rb.orig

@@ -1,70 +0,0 @@
-require 'test-unit'
-require 'vterm'
-require 'pty'
-
-module Yamatanooroti::VTermTestCaseModule
-  def start_terminal(height, width, command, wait: 0.1)
-    @wait = wait
-
-    @pty_output, @pty_input, @pid = PTY.spawn(*command)
-
-    @vterm = VTerm.new(height, width)
-    @vterm.set_utf8(true)
-
-    @screen = @vterm.screen
-    @screen.reset(true)
-
-    sync
-  end
-
-  def write(str)
-    sync
-    @pty_input.write(str)
-    sync
-  end
-
-  def close
-    sync
-    @pty_input.close
-    sync
-  end
-
-  private def sync
-    loop do
-      sleep @wait
-      chunk = @pty_output.read_nonblock(1024)
-      @vterm.write(chunk)
-      chunk = @vterm.read
-      @pty_input.write(chunk)
-    rescue Errno::EAGAIN, Errno::EWOULDBLOCK
-      break
-    rescue Errno::EIO # EOF
-      break
-    rescue IO::EAGAINWaitReadable # emtpy buffer
-      break
-    end
-  end
-
-  def assert_screen(expected_lines)
-    actual_lines = []
-    rows, cols = @vterm.size
-    rows.times do |r|
-      actual_lines << ''
-      cols.times do |c|
-        cell = @screen.cell_at(r, c)
-        actual_lines.last << cell.char if cell.char
-      end
-      actual_lines.last.gsub!(/ *$/, '')
-    end
-    case expected_lines
-    when Array
-      assert_equal(expected_lines, actual_lines)
-    when String
-      assert_equal(expected_lines, actual_lines.join("\n").sub(/\n*\z/, "\n"))
-    end
-  end
-end
-
-class Yamatanooroti::VTermTestCase < Test::Unit::TestCase
-  include Yamatanooroti::VTermTestCaseModule
-end