yamatanooroti 0.0.2 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 92dcb67921820e4dedad1aed9de7d18c062f623c9b73c4a05427049111217f4a
-  data.tar.gz: 5683fb3c7544c67dc4c1f024df1b8fd9953c6378be0826a6f834191cf5c694e8
+  metadata.gz: b0fd9df2f9f10fe273c68653443f62f80a66b2c18e2f7fad4ad3a39bf2b41ff5
+  data.tar.gz: e349135272b3c4321e8e7a54d03fe8e22c5a3e237d1b6c134743f44d94ccb628
 SHA512:
-  metadata.gz: 6c614da80dcaf5b4ff0799be9be726fa0ea61fcc8ae1f53a4219e61cb17a86d3dee3e9e3fce5663b7224493b53ee0f379359859f448b10963306959647169c16
-  data.tar.gz: 0e2d1c4d031666509d85c5abc5a8d0f847d3c50392aec52df6f920269ebdff7fb99ac0442c1e582e8edd06f74f124dc9de559a5db8bc271510b331afbdc0f53b
+  metadata.gz: 6d5612862c2a2286463a81af6b1cce97c95fc6fe8f231c8e1cd78a03c5ea4d5a582f51d5bb80f13f80c7fa3717db242c35e13f4d23fb4e846d7a38484336d860
+  data.tar.gz: e891f544e3433528a6ca47a49538fd4a571cbe8f9eca874091df1cec177ff9ba2199718ffa0cd6fc291d82d6ae0c8f2195ed99adbb24cf4206e3ea9b61e86ee8

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.rb

@@ -78,9 +78,8 @@ class Yamatanooroti::TestCase < Test::Unit::TestCase
       def klass.method_added(name)
         super
         if ancestors[1] == Yamatanooroti::TestCase
-          @@runners.each do |test_klass|
-            test_klass.define_method(name, instance_method(name))
-          end
+          test_klass = @@runners.find { |test_klass| test_klass.ancestors.include?(self) }
+          test_klass.define_method(name, instance_method(name))
           remove_method name
         end
       end

data/lib/yamatanooroti/version.rb

@@ -1,3 +1,3 @@
 class Yamatanooroti
-  VERSION = '0.0.2'
+  VERSION = '0.0.7'
 end

data/lib/yamatanooroti/vterm.rb

@@ -1,13 +1,14 @@
 require 'test-unit'
 require 'vterm'
 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
 
-    @pty_output, @pty_input, @pid = PTY.spawn(*command)
+    @pty_output, @pty_input, @pid = PTY.spawn('bash', '-c', %[stty rows #{height.to_s} cols #{width.to_s}; "$@"], '--', *command)
 
     @vterm = VTerm.new(height, width)
     @vterm.set_utf8(true)
@@ -15,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
 
@@ -29,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

data/lib/yamatanooroti/windows.rb

@@ -11,7 +11,7 @@ module Yamatanooroti::WindowsDefinition
 
   typealias 'SHORT', 'short'
   typealias 'HPCON', 'HANDLE'
-  typealias 'HPCON', 'HANDLE'
+  typealias 'HWND', 'HANDLE'
   typealias 'HRESULT', 'HANDLE'
   typealias 'LPVOID', 'void*'
   typealias 'SIZE_T', 'size_t'
@@ -146,6 +146,8 @@ module Yamatanooroti::WindowsDefinition
   C3_IDEOGRAPH = 0x0100
   TH32CS_SNAPPROCESS = 0x00000002
   PROCESS_ALL_ACCESS = 0x001FFFFF
+  SW_HIDE = 0
+  LEFT_ALT_PRESSED = 0x0002
 
   # HANDLE GetStdHandle(DWORD nStdHandle);
   extern 'HANDLE GetStdHandle(DWORD);', :stdcall
@@ -158,12 +160,20 @@ module Yamatanooroti::WindowsDefinition
   extern 'BOOL AllocConsole(void);', :stdcall
   # BOOL AttachConsole(DWORD dwProcessId);
   extern 'BOOL AttachConsole(DWORD);', :stdcall
+  # BOOL ShowWindow(HWND hWnd, int nCmdShow);
+  extern 'BOOL ShowWindow(HWND hWnd,int nCmdShow);', :stdcall
+  # HWND WINAPI GetConsoleWindow(void);
+  extern 'HWND GetConsoleWindow(void);', :stdcall
   # BOOL WINAPI SetConsoleScreenBufferSize(HANDLE hConsoleOutput, COORD dwSize);
   extern 'BOOL SetConsoleScreenBufferSize(HANDLE, COORD);', :stdcall
   # BOOL WINAPI SetConsoleWindowInfo(HANDLE hConsoleOutput, BOOL bAbsolute, const SMALL_RECT *lpConsoleWindow);
   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);
@@ -247,6 +257,8 @@ module Yamatanooroti::WindowsTestCaseModule
     size = height * 65536 + width
     r = DL.SetConsoleScreenBufferSize(@output_handle, size)
     error_message(r, 'SetConsoleScreenBufferSize')
+    r = DL.ShowWindow(DL.GetConsoleWindow(), DL::SW_HIDE)
+    error_message(r, 'ShowWindow')
   end
 
   private def mb2wc(str)
@@ -282,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
@@ -326,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
@@ -360,31 +411,47 @@ module Yamatanooroti::WindowsTestCaseModule
     pe.dwSize = DL::PROCESSENTRY32W.size
     r = DL.Process32FirstW(h_snap, pe)
     error_message(r, "Process32First")
+    process_table = {}
     loop do
       #log "a #{pe.th32ParentProcessID.inspect} -> #{pe.th32ProcessID.inspect} #{wc2mb(pe.szExeFile.pack('S260')).unpack('Z*').pack('Z*')}"
-      if pe.th32ParentProcessID == DL.GetCurrentProcessId
-        h_child_proc = DL.OpenProcess(DL::PROCESS_ALL_ACCESS, 0, pe.th32ProcessID)
-        if (h_child_proc)
-          r = DL.TerminateProcess(h_child_proc, 0)
-          error_message(r, "TerminateProcess")
-          r = DL.CloseHandle(h_child_proc)
-          error_message(r, "CloseHandle")
-        end
-      end
+      process_table[pe.th32ParentProcessID] ||= []
+      process_table[pe.th32ParentProcessID] << pe.th32ProcessID
       break if DL.Process32NextW(h_snap, pe).zero?
     end
-    r = DL.TerminateThread(@pi.hThread, 0)
-    error_message(r, "TerminateThread")
-    sleep @wait
+    process_table[DL.GetCurrentProcessId].each do |child_pid|
+      kill_process_tree(process_table, child_pid)
+    end
+    #r = DL.TerminateThread(@pi.hThread, 0)
+    #error_message(r, "TerminateThread")
+    #sleep @wait
     r = DL.FreeConsole()
     #error_message(r, "FreeConsole")
     r = DL.AttachConsole(DL::ATTACH_PARENT_PROCESS)
     error_message(r, 'AttachConsole')
   end
 
+  private def kill_process_tree(process_table, pid)
+    process_table[pid]&.each do |child_pid|
+      kill_process_tree(process_table, child_pid)
+    end
+    h_proc = DL.OpenProcess(DL::PROCESS_ALL_ACCESS, 0, pid)
+    if (h_proc)
+      r = DL.TerminateProcess(h_proc, 0)
+      error_message(r, "TerminateProcess")
+      r = DL.CloseHandle(h_proc)
+      error_message(r, "CloseHandle")
+    end
+  end
+
   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
@@ -393,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 = ''
@@ -408,10 +475,9 @@ module Yamatanooroti::WindowsTestCaseModule
           prev_c = mb
         end
       end
-      @result << line.gsub(/ *$/, '')
+      screen << line.gsub(/ *$/, '')
     end
-
-    free_resources
+    screen
   end
 
   def result
@@ -427,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.2
+  version: 0.0.7
 platform: ruby
 authors:
 - aycabta
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-07-03 00:00:00.000000000 Z
+date: 2021-04-19 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,13 +78,12 @@ 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:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -85,8 +98,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.2.3
+signing_key:
 specification_version: 4
 summary: Multi-platform real(?) terminal test framework
 test_files: []

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