Feature: Add CI for windows

.github/workflows/y.yml

@@ -42,3 +42,40 @@ jobs:
         run: |
           bundle install
           bundle exec rake test
+  windows-yamatanooroti:
+    needs: ruby-versions
+    name: >-
+      ${{ matrix.os }} ${{ matrix.ruby }} ${{ matrix.console }}
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ windows-2019, windows-2022 ]
+        ruby: ${{ fromJson(needs.ruby-versions.outputs.versions) }}
+        console: [ conhost, legacy-conhost, stable ]
+        exclude:
+          - ruby: 2.5
+          - console: stable
+            os: windows-2019
+          - console: legacy-conhost
+            os: windows-2022
+        include:
+          - os: windows-2022
+            ruby: 3.3
+            console: preview
+          - os: windows-2022
+            ruby: 3.3
+            console: canary
+    defaults:
+      run:
+        shell: bash
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+      - name: rake test
+        run: |
+          bundle install
+          bundle exec rake test TESTOPTS="-v --wt_dir=./tmp --windows=${{ matrix.console }}"

Gemfile

@@ -5,6 +5,17 @@ unless RbConfig::CONFIG['host_os'].match?(/mswin|msys|mingw|cygwin|bccwin|wince|
   gem "vterm", github: "ruby/vterm-gem"
 end
 
+if Gem.win_platform?
+  gem "fiddle", '>= 1.0.8' if
+    (RUBY_ENGINE == "ruby" && RUBY_VERSION >= '3.4') ||
+    Gem::Version.new("1.0.8") > begin
+      require 'fiddle'
+      Gem::Version.new(Fiddle::VERSION)
+    rescue
+      Gem::Version.new("0.0.0")
+    end
+end
+
 # Specify your gem's dependencies in reline.gemspec
 gemspec
 

README.md

@@ -46,6 +46,14 @@ Tasks: TOP => default => test
 (See full trace by running task with --trace)
 ```
 
+### Commandline Options
+
+Yamatanooroti provides some additional TESTOPTS options.
+
+This is more important when running on Windows because of the type of console to be tested is specified in TESTOPTS.
+
+Please see ```rake TESTOPTS="-h"```.
+
 ### Advanced Usage
 
 If you want to specify vterm environment that needs vterm gem, you can use `Yamatanooroti::VTermTestCase`:

bin/simple_repl

@@ -3,5 +3,10 @@
 loop {
   print 'prompt> '
   result = gets
+  result.force_encoding('locale').encode!(Encoding.default_external) unless result.valid_encoding?
   puts "=> #{eval(result).inspect}"
 }
+
+# On older windows ruby versions(< 3.1 ?), STDIN.gets returns locale code bytes with default external encoding. https://bugs.ruby-lang.org/issues/18353
+# Not same versions(< 3.2 ?), STDIN.gets returns invalid bytes if input with leading DBCS characters. https://bugs.ruby-lang.org/issues/18588
+# Because of this, input key stroke must start with SBCS character to support older ruby versions.

lib/yamatanooroti.rb

@@ -1,4 +1,5 @@
 require 'test/unit'
+require_relative 'yamatanooroti/options'
 
 class Yamatanooroti
   def self.load_vterm

lib/yamatanooroti/options.rb

@@ -0,0 +1,157 @@
+class Yamatanooroti
+  module Options
+    options = [
+      :default_wait,
+      :default_timeout,
+
+      # windows console selection
+      :windows,
+
+      # true if conhost(classic) or conhost(legacy)
+      :conhost,
+
+      # true if windows terminal
+      :terminal,
+
+      # windows terminal download/extract dir
+      :terminal_workdir,
+
+      # show console window on windows
+      :show_console,
+
+      # conditional close console window on windows
+      :close_console,
+    ]
+    self.singleton_class.instance_eval do
+      attr_reader(*options)
+    end
+
+    Accessor = Module.new do |mod|
+      options.each do |name|
+        mod.define_method name do
+          Yamatanooroti::Options.public_send(name)
+        end
+      end
+    end
+
+    module WindowsTerminal
+      ALIAS = {
+        stable: :"1.21",
+        preview: :"1.22preview"
+      }
+      RELEASES = {
+        "1.22preview": {
+          url: "https://github.com/microsoft/terminal/releases/download/v1.22.2702.0/Microsoft.WindowsTerminalPreview_1.22.2702.0_x64.zip",
+          sha256: "CE8EED54D120775F31E3572A76EF5AE461B9E2D8887AB5DFF2F1859E24F4CE0B"
+        },
+        "1.21": {
+          url: "https://github.com/microsoft/terminal/releases/download/v1.21.2701.0/Microsoft.WindowsTerminal_1.21.2701.0_x64.zip",
+          sha256: "2F712872ED7F552763F3776EA7A823C9E7413CFD5EC65B88E95162E93ACEF899"
+        },
+        "1.21preview": {
+          url: "https://github.com/microsoft/terminal/releases/download/v1.21.1772.0/Microsoft.WindowsTerminalPreview_1.21.1772.0_x64.zip",
+          sha256: "6AA37175E2B09170829A39DAF3357D4B88A3965C3C529A45B1B0781B8F3425F0"
+        },
+        "1.20": {
+          url: "https://github.com/microsoft/terminal/releases/download/v1.20.11781.0/Microsoft.WindowsTerminal_1.20.11781.0_x64.zip",
+          sha256: "B7A6046903CE33D75250DA7E40AD2929E51703AB66E9C3A0B02A839C2E868FEC"
+        },
+        "1.19": {
+          url: "https://github.com/microsoft/terminal/releases/download/v1.19.11213.0/Microsoft.WindowsTerminal_1.19.11213.0_x64.zip",
+          sha256: "E32D7E72F8490AD94174708BB0B420E1EF4467B92F442D40DFAFDF42202A16A7"
+        },
+        "1.18": {
+          url: "https://github.com/microsoft/terminal/releases/download/v1.18.10301.0/Microsoft.WindowsTerminal_1.18.10301.0_x64.zip",
+          sha256: "38B0E38B545D9C61F1B4214EA3EC6117C0EC348FEB18476D04ECEFB4D7DA723D"
+        },
+        # v1.17 : the first windows terminal supports portable mode
+        "1.17": {
+          url: "https://github.com/microsoft/terminal/releases/download/v1.17.11461.0/Microsoft.WindowsTerminal_1.17.11461.0_x64.zip",
+          sha256: "F2B1539649D17752888D7944F97D6372F8D48EB1CEB024501DF8D8E9D3352F25"
+        },
+      }
+
+      def self.interpret(name)
+        if ALIAS.has_key?(name)
+          name = ALIAS[name]
+        end
+        if RELEASES.has_key?(name)
+          return name.to_s
+        elsif name == :canary
+          return name
+        end
+        raise "bug! #{name} is unknows"
+      end
+    end
+
+    CONHOST_TYPES = [:conhost, :"legacy-conhost"]
+    TERMINAL_TYPES = [:stable, :preview, :canary]
+    TERMINAL_VERSIONS = WindowsTerminal::RELEASES.keys
+    CLOSE_WHEN = [:always, :pass, :never]
+
+    ::Test::Unit::AutoRunner.setup_option do |autorunner, o|
+      @default_wait = 0.01
+      @default_timeout = 2.0
+      @windows = Yamatanooroti.win? ? :conhost : nil
+      @conhost = true
+      @terminal = false
+      @terminal_workdir = nil
+      @show_console = nil
+      @close_console = :always
+
+      o.on_tail("yamatanooroti options")
+      o.on_tail("--wait=#{@default_wait}", Float,
+                "Specify yamatanooroti wait time in seconds.") do |seconds|
+        @default_wait = seconds
+      end
+
+      o.on_tail("--timeout=#{@default_timeout}", Float,
+                "Specify yamatanooroti timeout in seconds.") do |seconds|
+        @default_timeout = seconds
+      end
+
+      o.on_tail("windows specific yamatanooroti options")
+
+      o.on_tail("--windows=TYPE", CONHOST_TYPES + TERMINAL_TYPES + TERMINAL_VERSIONS,
+                "Specify console type",
+                "(#{autorunner.keyword_display(CONHOST_TYPES + TERMINAL_TYPES)})",
+                "(#{TERMINAL_VERSIONS.sort.join(", ")})") do |type|
+        @conhost = CONHOST_TYPES.include?(type)
+        @terminal = !@conhost
+        @windows =  @conhost ? type : WindowsTerminal.interpret(type)
+        if @terminal
+          if @show_console == false
+            puts "Windows Terminal is always visible. --no-show-console is ignored."
+          end
+          @show_console = true
+        end
+      end
+
+      o.on_tail("--wt-dir=DIR", String,
+                "Specify Windows Terminal working dir.",
+                "Automatically determined if not specified and treated temporary.",
+                "DIR is treaded permanent if specified and download files are remains.") do |dir|
+        @terminal_workdir = dir
+      end
+
+      o.on_tail("--[no-]show-console",
+                "Show test ongoing console.") do |show|
+        if show == false and @terminal
+          puts "Windows Terminal is always visible. --no-show-console is ignored."
+        else
+          @show_console = show
+        end
+      end
+
+      o.on_tail("--[no-]close-console[=COND]", CLOSE_WHEN,
+                "Close test target console when COND met",
+                "(#{autorunner.keyword_display(CLOSE_WHEN)})") do |cond|
+        @close_console = (cond.nil? ? :always : cond) || :never
+      end
+    end
+  end
+
+  def self.options
+    Options
+  end
+end

lib/yamatanooroti/vterm.rb

@@ -5,9 +5,9 @@
 require 'io/wait'
 
 module Yamatanooroti::VTermTestCaseModule
-  def start_terminal(height, width, command, wait: 0.01, timeout: 2, startup_message: nil)
-    @timeout = timeout
-    @wait = wait
+  def start_terminal(height, width, command, wait: nil, timeout: nil, startup_message: nil)
+    @timeout = timeout || Yamatanooroti.options.default_timeout
+    @wait = wait || Yamatanooroti.options.default_wait
     @result = nil
 
     @pty_output, @pty_input, @pid = PTY.spawn(*command)