yamatanooroti 0.0.1 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3f7c72bc6c902dd8b5cdf5d02183954cba1180960c702e5642c208b074e2ccd5
-  data.tar.gz: d5dfea77ef4a055e0e278fa7447d96e1c473ce7aa4108062c99e3fc1d3e3d499
+  metadata.gz: 7ec6554c150a5c256de88a3feda8e9a3b073bfdfc1af5925e82b78ec29563c83
+  data.tar.gz: 54df3900576ae774f4c86642c98ae22854e8917927cbb570666b38ac22b8ba16
 SHA512:
-  metadata.gz: d4242ac34c419417a1e8035968b26f4587d6d5c332852a73dad9d413b0b06447b1cd0969272b344bd3bc4a26fc4934e2a156cfc740d44fe53344f4d1f130048a
-  data.tar.gz: 1f2679e02d8183d15c5ded5baa273d6ca1b4b299335145a4141066c3f315a0277623ca64caa1e0f5bdffe205280ce2b9b27cfe7b1f728c71e03f8293d7211b1c
+  metadata.gz: e5765147b02b72bb30969075614e335d8019b6dd8c6ae5535d5170e5c18533dd6275fa065f413a9e1a2d5d126e6679010670d0a72d9c3e3216376386938e1886
+  data.tar.gz: 1b403888aa4428770f105a2e415997a6460e0cfb25335ba50a29e34add5cee35611ce138298e4e2e5276a4d16e8ea4fd7bc18f205aca15edc835d9e7f1773e02

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.1'
+  VERSION = '0.0.6'
 end

data/lib/yamatanooroti/vterm.rb

@@ -1,12 +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)
@@ -14,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
 
@@ -27,35 +38,56 @@ module Yamatanooroti::VTermTestCaseModule
     sync
     @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
 
-  def assert_screen(expected_lines)
-    actual_lines = []
+  def result
+    return @result if @result
+    @result = []
     rows, cols = @vterm.size
     rows.times do |r|
-      actual_lines << ''
+      @result << ''
       cols.times do |c|
         cell = @screen.cell_at(r, c)
-        actual_lines.last << cell.char if cell.char
+        @result.last << cell.char if cell.char
       end
-      actual_lines.last.gsub!(/ *$/, '')
+      @result.last.gsub!(/ *$/, '')
     end
+    @result
+  end
+
+  def assert_screen(expected_lines)
+    actual_lines = result
     case expected_lines
     when Array
       assert_equal(expected_lines, actual_lines)

data/lib/yamatanooroti/vterm.rb.orig

@@ -0,0 +1,70 @@
+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

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,7 @@ module Yamatanooroti::WindowsDefinition
   C3_IDEOGRAPH = 0x0100
   TH32CS_SNAPPROCESS = 0x00000002
   PROCESS_ALL_ACCESS = 0x001FFFFF
+  SW_HIDE = 0
 
   # HANDLE GetStdHandle(DWORD nStdHandle);
   extern 'HANDLE GetStdHandle(DWORD);', :stdcall
@@ -158,6 +159,10 @@ 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);
@@ -212,10 +217,10 @@ module Yamatanooroti::WindowsTestCaseModule
 
   private def setup_console(height, width)
 
-    result = DL.FreeConsole
-    error_message(result, 'FreeConsole')
-    result = DL.AllocConsole
-    error_message(result, 'AllocConsole')
+    r = DL.FreeConsole
+    error_message(r, 'FreeConsole')
+    r = DL.AllocConsole
+    error_message(r, 'AllocConsole')
     @output_handle = DL.GetStdHandle(DL::STD_OUTPUT_HANDLE)
 
 =begin
@@ -228,8 +233,8 @@ module Yamatanooroti::WindowsTestCaseModule
     font.FontFamily = 0
     font.FontWeight = 0
     font.FaceName[0] = "\x00".ord
-    result = DL.SetCurrentConsoleFontEx(@output_handle, 0, font)
-    error_message(result, 'SetCurrentConsoleFontEx')
+    r = DL.SetCurrentConsoleFontEx(@output_handle, 0, font)
+    error_message(r, 'SetCurrentConsoleFontEx')
 =end
 
     rect = DL::SMALL_RECT.malloc
@@ -237,16 +242,18 @@ module Yamatanooroti::WindowsTestCaseModule
     rect.Top = 0
     rect.Right = width - 1
     rect.Bottom = height - 1
-    result = DL.SetConsoleWindowInfo(@output_handle, 1, rect)
-    error_message(result, 'SetConsoleWindowInfo')
+    r = DL.SetConsoleWindowInfo(@output_handle, 1, rect)
+    error_message(r, 'SetConsoleWindowInfo')
 
     size = DL.GetSystemMetrics(DL::SM_CYMIN) * 65536 + DL.GetSystemMetrics(DL::SM_CXMIN)
-    result = DL.SetConsoleScreenBufferSize(@output_handle, size)
-    error_message(result, 'SetConsoleScreenBufferSize')
+    r = DL.SetConsoleScreenBufferSize(@output_handle, size)
+    error_message(r, 'SetConsoleScreenBufferSize')
 
     size = height * 65536 + width
-    result = DL.SetConsoleScreenBufferSize(@output_handle, size)
-    error_message(result, 'SetConsoleScreenBufferSize')
+    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,26 +289,55 @@ 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
     @startup_info_ex = DL::STARTUPINFOW.malloc
     (@startup_info_ex.to_ptr + 0)[0, DL::STARTUPINFOW.size] = "\x00" * DL::STARTUPINFOW.size
-    result = DL.CreateProcessW(
+    r = DL.CreateProcessW(
       Fiddle::NULL, converted_command,
       Fiddle::NULL, Fiddle::NULL, 0, 0, Fiddle::NULL, Fiddle::NULL,
       @startup_info_ex, @pi
     )
-    error_message(result, 'CreateProcessW')
+    error_message(r, 'CreateProcessW')
     sleep @wait
   rescue => e
     pp e
   end
 
-  private def error_message(result, method_name)
-    return if not result.zero?
+  private def error_message(r, method_name)
+    return if not r.zero?
     err = DL.GetLastError
     string = Fiddle::Pointer.malloc(Fiddle::SIZEOF_VOIDP)
     DL.FormatMessage(
@@ -349,8 +385,8 @@ module Yamatanooroti::WindowsTestCaseModule
       r.dwControlKeyState = 0
     end
     written_size = Fiddle::Pointer.malloc(Fiddle::SIZEOF_DWORD, DL::FREE)
-    result = DL.WriteConsoleInputW(DL.GetStdHandle(DL::STD_INPUT_HANDLE), records, str.size * 2, written_size)
-    error_message(result, 'WriteConsoleInput')
+    r = DL.WriteConsoleInputW(DL.GetStdHandle(DL::STD_INPUT_HANDLE), records, str.size * 2, written_size)
+    error_message(r, 'WriteConsoleInput')
   end
 
   private def free_resources
@@ -358,41 +394,58 @@ module Yamatanooroti::WindowsTestCaseModule
     pe = DL::PROCESSENTRY32W.malloc
     (pe.to_ptr + 0)[0, DL::PROCESSENTRY32W.size] = "\x00" * DL::PROCESSENTRY32W.size
     pe.dwSize = DL::PROCESSENTRY32W.size
-    result = DL.Process32FirstW(h_snap, pe)
-    error_message(result, "Process32First")
-    result = DL.FreeConsole()
-    #error_message(result, "FreeConsole")
-    result = DL.AttachConsole(DL::ATTACH_PARENT_PROCESS)
-    error_message(result, 'AttachConsole')
+    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)
-          result = DL.TerminateProcess(h_child_proc, 0)
-          error_message(result, "TerminateProcess")
-          result = DL.CloseHandle(h_child_proc)
-          error_message(result, "CloseHandle")
-        end
-      end
+      process_table[pe.th32ParentProcessID] ||= []
+      process_table[pe.th32ParentProcessID] << pe.th32ProcessID
       break if DL.Process32NextW(h_snap, pe).zero?
     end
-    result = DL.TerminateThread(@pi.hThread, 0)
-    error_message(result, "TerminateThread")
+    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
     region.Top = 0
     region.Right = @width
     region.Bottom = @height
-    result = DL.ReadConsoleOutputW(@output_handle, char_info_matrix, @height * 65536 + @width, 0, region)
-    error_message(result, "ReadConsoleOutputW")
-    @result = []
+    r = DL.ReadConsoleOutputW(@output_handle, char_info_matrix, @height * 65536 + @width, 0, region)
+    error_message(r, "ReadConsoleOutputW")
+    screen = []
     prev_c = nil
     @height.times do |y|
       line = ''
@@ -407,10 +460,13 @@ module Yamatanooroti::WindowsTestCaseModule
           prev_c = mb
         end
       end
-      @result << line.gsub(/ *$/, '')
+      screen << line.gsub(/ *$/, '')
     end
+    screen
+  end
 
-    free_resources
+  def result
+    @result
   end
 
   def assert_screen(expected_lines)
@@ -422,12 +478,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.1
+  version: 0.0.6
 platform: ruby
 authors:
 - aycabta
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-03-21 00:00:00.000000000 Z
+date: 2020-10-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: test-unit
@@ -38,6 +38,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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
@@ -50,12 +64,13 @@ 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
@@ -70,8 +85,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.0.3
+signing_key:
 specification_version: 4
 summary: Multi-platform real(?) terminal test framework
 test_files: []