expect-pty 0.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (56) hide show
  1. checksums.yaml +7 -0
  2. data/.rubocop.yml +29 -0
  3. data/CHANGELOG.md +25 -0
  4. data/Gemfile +10 -0
  5. data/LICENSE +21 -0
  6. data/README.md +264 -0
  7. data/Rakefile +38 -0
  8. data/docs/COMPATIBILITY.md +65 -0
  9. data/docs/RELEASING.md +55 -0
  10. data/docs/VERIFICATION.md +146 -0
  11. data/examples/dialogue.rb +30 -0
  12. data/examples/kibitz/README.md +73 -0
  13. data/examples/kibitz/kibitz.rb +139 -0
  14. data/examples/kibitz/test_kibitz.rb +37 -0
  15. data/examples/ssh_auto.rb +94 -0
  16. data/examples/ssh_interact.rb +159 -0
  17. data/examples/ssh_login.rb +64 -0
  18. data/expect-pty.gemspec +25 -0
  19. data/lib/expect/configuration.rb +113 -0
  20. data/lib/expect/engine.rb +141 -0
  21. data/lib/expect/interconnect.rb +170 -0
  22. data/lib/expect/pattern.rb +62 -0
  23. data/lib/expect/pattern_list.rb +90 -0
  24. data/lib/expect/pty.rb +4 -0
  25. data/lib/expect/resources.rb +63 -0
  26. data/lib/expect/result.rb +14 -0
  27. data/lib/expect/version.rb +6 -0
  28. data/lib/expect.rb +591 -0
  29. data/script/ci +44 -0
  30. data/script/release.rb +267 -0
  31. data/test/compare_upstream.rb +157 -0
  32. data/test/configuration_test.rb +90 -0
  33. data/test/edge_case_test.rb +183 -0
  34. data/test/fixtures/ssh_scripts/01_identity.sh +4 -0
  35. data/test/fixtures/ssh_scripts/02_output.sh +5 -0
  36. data/test/fixtures/ssh_scripts/03_delayed.sh +6 -0
  37. data/test/fixtures/ssh_scripts/04_failure.sh +2 -0
  38. data/test/fixtures/ssh_scripts/05_recovery.sh +3 -0
  39. data/test/integration/README.md +90 -0
  40. data/test/integration/ssh_scripts.rb +94 -0
  41. data/test/interact_test.rb +151 -0
  42. data/test/interconnect_test.rb +226 -0
  43. data/test/io_test.rb +184 -0
  44. data/test/kibitz_test.rb +45 -0
  45. data/test/matching_test.rb +178 -0
  46. data/test/multi_session_test.rb +66 -0
  47. data/test/process_test.rb +244 -0
  48. data/test/release_test.rb +153 -0
  49. data/test/ruby_api_test.rb +515 -0
  50. data/test/script_logging_test.rb +124 -0
  51. data/test/support/interact_probe.rb +125 -0
  52. data/test/support/kibitz_probe.rb +177 -0
  53. data/test/support/script_probe.rb +157 -0
  54. data/test/test_helper.rb +58 -0
  55. data/test/timeout_test.rb +170 -0
  56. metadata +97 -0
@@ -0,0 +1,4 @@
1
+ set -eu
2
+ printf 'USER=%s\n' "$(id -un)"
3
+ printf 'TTY=%s\n' "$(tty)"
4
+ printf 'IDENTITY_OK\n'
@@ -0,0 +1,5 @@
1
+ set -eu
2
+ printf 'STDOUT_FIRST\n'
3
+ printf 'STDERR_SECOND\n' >&2
4
+ printf '中文输出:日志验证\n'
5
+ printf 'STDOUT_LAST\n'
@@ -0,0 +1,6 @@
1
+ set -eu
2
+ printf 'DELAY_BEGIN\n'
3
+ sleep 0.1
4
+ printf 'DELAY_MIDDLE\n'
5
+ sleep 0.1
6
+ printf 'DELAY_END\n'
@@ -0,0 +1,2 @@
1
+ printf 'EXPECTED_FAILURE\n' >&2
2
+ exit 7
@@ -0,0 +1,3 @@
1
+ set -eu
2
+ printf 'RECOVERY_OK\n'
3
+ printf 'VALUE=%s\n' "$((20 + 22))"
@@ -0,0 +1,90 @@
1
+ # SSH 多脚本和日志验证
2
+
3
+ 在仓库根目录运行,要求 Ruby 3.2+、SSH 服务,以及能运行 POSIX `/bin/sh` 的目标账户:
4
+
5
+ ```sh
6
+ SSH_HOST=127.0.0.1 SSH_USER=crate ruby test/integration/ssh_scripts.rb
7
+ # 也可以通过 Rake:
8
+ SSH_HOST=127.0.0.1 SSH_USER=crate bundle exec rake test:ssh
9
+ ```
10
+
11
+ 脚本隐藏读取密码;也支持由运行环境提供 `EXPECT_PASSWORD`。密码不会作为 SSH 命令行参数传递,日志在认证完成后才开启。默认自动测试不连接 SSH、不读取密码。
12
+
13
+ 支持 `SSH_PORT`(默认 22)、`EXPECT_LOG_DIR`(日志根目录)、`SSH_KNOWN_HOSTS`。连接非本机主机时,必须提供已有的受信任 known_hosts,例如:
14
+
15
+ ```sh
16
+ SSH_HOST=192.0.2.10 SSH_USER=operator SSH_PORT=22 \
17
+ SSH_KNOWN_HOSTS="$HOME/.ssh/known_hosts" \
18
+ EXPECT_LOG_DIR=tmp/device-check ruby test/integration/ssh_scripts.rb
19
+ ```
20
+
21
+ 这是 POSIX shell 脚本测试;厂商专用 CLI(如交换机的 `show` 命令、分页提示符)需要对应设备的命令和预期输出,不能直接使用这些 shell fixtures。
22
+
23
+ ## 同一个登录会话执行的脚本
24
+
25
+ | 脚本 | 验证内容 | 预期退出码 |
26
+ | --- | --- | --- |
27
+ | `01_identity.sh` | 当前用户、远端 PTY、完成标记 | 0 |
28
+ | `02_output.sh` | stdout、stderr、中文和输出顺序 | 0 |
29
+ | `03_delayed.sh` | 分三次延迟输出,确保日志完整 | 0 |
30
+ | `04_failure.sh` | 明确输出错误并退出 | 7(预期失败) |
31
+ | `05_recovery.sh` | 上个脚本失败后继续执行,计算结果为 42 | 0 |
32
+
33
+ fixtures 位于 `test/fixtures/ssh_scripts/`,都不修改目标文件或设备配置。文件内容通过 SSH 的交互 shell 传给独立 `/bin/sh -c` 执行,不需要上传文件。每个脚本都有随机开始/结束标记,结束标记携带真实 `$?`;脚本输出和退出码都必须符合预期才算通过。
34
+
35
+ 测试关闭终端回显和 shell 行编辑,使用单引号传输完整脚本,保留中文 UTF-8 和引号,避免 C locale 的交互式 readline 把高位字节当快捷键执行。末尾仍等待 shell 提示符,确认可以继续执行下一项。
36
+
37
+ 另外执行两条日志控制命令:关闭日志后输出 `UNLOGGED_OUTPUT`,再以默认追加模式开启日志并输出 `APPEND_OK`。最后发送延迟输出及退出命令,只调用 `soft_close`,确认 `SESSION_FINAL_TAIL` 确实在关闭过程中写入日志。
38
+
39
+ ## 检查和输出文件
40
+
41
+ 每次执行在 `tmp/ssh-logs/` 下创建独立目录,目录权限 0700,文件权限 0600:
42
+
43
+ - `session.log`:收到的原始数据,以及手工添加的 `[SEND] 脚本名 sha256=...` 和 `[EXIT] 脚本名 status=...`。
44
+ - `report.json`:主机、用户、远端 TTY、每项脚本输出和退出码、校验结果、SSH 退出码、日志字节数及 SHA-256。
45
+
46
+ 只有认证后的输出进入日志。Expect 自动记录接收字节,发送的脚本名称和摘要由 `write_log` 明确写入,便于审核执行了哪个 fixture;fixture 文件中的原文可以用报告内的 SHA-256 核对。
47
+
48
+ 共 11 项日志/流程检查:完整输出、执行顺序、即时 flush、stdout/stderr、UTF-8、非零退出后恢复、覆盖模式、暂停记录、追加模式、关闭前尾部输出、密码不出现在日志中。另校验日志条目没有重复,日志句柄在停止记录和关闭会话后正确关闭。
49
+
50
+ 成功返回进程退出码 0。认证失败、超时、脚本输出错误、意外退出码或日志校验失败均返回非零,并在有报告目录时留下 `passed: false` 的报告。不用仅看到终端输出就判断成功;请查看最终 PASS 和 `report.json` 的 `passed`。
51
+
52
+ ## 无需 SSH 的回归测试
53
+
54
+ ```sh
55
+ bundle exec ruby -Itest test/script_logging_test.rb
56
+ bundle exec rake test
57
+ ```
58
+
59
+ `test/script_logging_test.rb` 使用真实本地 PTY 执行相同 fixtures,另外验证回调日志、借用 File 日志、错误退出/错误输出的反例、引号和 shell 元字符、日志错误上抛,以及超时后继续收集日志。它和 SSH 脚本共享测试 helper,不依赖远端账户。
60
+
61
+ ## SSH interact 人工和自动验证
62
+
63
+ ```sh
64
+ ruby examples/ssh_interact.rb
65
+ ruby examples/ssh_interact.rb --auto
66
+ # 自动方式也可通过 Rake 运行
67
+ bundle exec rake test:ssh_interact
68
+ ```
69
+
70
+ 使用上述同一套 SSH 环境变量和隐藏密码输入。人工模式显示 `EXPECT_SCRIPT_PROMPT>`;输入命令有回显,Ctrl-C 传给远端前台任务。在命令结束、回到 shell 提示符后按 Ctrl-],会关闭远端回显,执行 `MANUAL_AUTOMATION_RESUMED` 检查,再正常退出 SSH。也支持直接输入 `exit`:成功退出记为 `completion: remote_exit`,此路径不执行返回 expect 的检查。非零 SSH 退出仍判为失败。
71
+
72
+ `--auto` 创建真实本地 PTY,验证两次 `interact` 接管、当前用户和远端 TTY、stdout/stderr/中文、Ctrl-C、Ctrl-]、转义后的本地尾部不进入 SSH、恢复 `expect` 及终端与监听设置。4 项命令输出和 13 项交互/日志检查全部通过后才返回 0。
73
+
74
+ 日志在认证之后开启;每次在 `tmp/ssh-interact/` 新建 0700 目录,保存 0600 的 `session.log` 和 `report.json`。报告包含检查项、命令输出、SSH 退出码及日志摘要。自动模式也校验日志无重复、退出尾部不丢失、密码不出现在日志中。
75
+
76
+ 无需 SSH 的回归位于 `test/interact_test.rb`,覆盖可见输入、Ctrl-C、两次接管、返回自动命令、超时、两端 EOF、回调异常和输出 IO 故障时的终端恢复。`test/script_logging_test.rb` 另验证 CRLF 输出边界,包括空输出、末尾有/无换行和多个换行。
77
+
78
+ ## `ssh_auto.rb` 环境检查
79
+
80
+ ```sh
81
+ ruby examples/ssh_auto.rb
82
+ # 无人值守执行(密码可以由运行环境提供 EXPECT_PASSWORD)
83
+ ruby examples/ssh_auto.rb --no-interact
84
+ # 或执行 Rake 的自动退出入口
85
+ bundle exec rake test:ssh_auto
86
+ ```
87
+
88
+ 该示例自动登录 `SSH_HOST`(默认 `127.0.0.1`),用本库的 `write` / `expect` 顺序执行文件顶部的 `COMMANDS`,显示真实输出并检查退出码。默认命令为 `id`、`uname -srm`、`sw_vers`、`df -h /` 和 `uptime`,不修改系统设置;可直接修改数组来下发其他 macOS/POSIX shell 命令。它不依赖 `test/support`,`ScriptProbe.check` 只供测试脚本使用。
89
+
90
+ 执行成功后默认进入 `interact`,输入有回显,Ctrl-C 发给远端前台任务;`exit` 或 Ctrl-] 结束连接。使用 `--no-interact` 则执行完退出。`EXPECT_LOG_DIR` 可指定日志目录,默认 `tmp/ssh-auto/`;每次创建独立 0600 日志,记录命令和远端输出,认证前关闭日志。此使用示例不生成 JSON 测试报告,详细日志断言仍由 `ssh_scripts.rb` 和 `ssh_interact.rb --auto` 验证。
@@ -0,0 +1,94 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Opt-in: this script makes a real SSH connection. The default rake test does
4
+ # not load it, and no password belongs in fixture files or command arguments.
5
+ require "io/console"
6
+ require "json"
7
+ require "fileutils"
8
+ require "tmpdir"
9
+ require "time"
10
+ require_relative "../support/script_probe"
11
+
12
+ host = ENV.fetch("SSH_HOST", "127.0.0.1")
13
+ user = ENV.fetch("SSH_USER", ENV.fetch("USER", "crate"))
14
+ port = Integer(ENV.fetch("SSH_PORT", "22"), 10)
15
+ ScriptProbe.check((1..65_535).cover?(port), "SSH_PORT must be between 1 and 65535")
16
+ ScriptProbe.check([host, user].none? do |value|
17
+ value.empty? || value.start_with?("-") || value.match?(/[\s\x00]/)
18
+ end, "invalid SSH host or user")
19
+ known_hosts = ENV.fetch("SSH_KNOWN_HOSTS", nil)
20
+ ScriptProbe.check(known_hosts || %w[127.0.0.1 ::1 localhost].include?(host),
21
+ "SSH_KNOWN_HOSTS is required for remote hosts")
22
+
23
+ password = ENV.delete("EXPECT_PASSWORD")&.dup
24
+ unless password
25
+ $stderr.print("SSH password: ")
26
+ password = ($stdin.tty? ? $stdin.noecho(&:gets) : $stdin.gets)&.chomp
27
+ $stderr.puts
28
+ end
29
+ ScriptProbe.check(password && !password.empty? && !password.match?(/[\r\n\x00]/), "a single-line password is required")
30
+
31
+ base = File.expand_path(ENV.fetch("EXPECT_LOG_DIR", File.expand_path("../../tmp/ssh-logs", __dir__)))
32
+ FileUtils.mkdir_p(base)
33
+ directory = Dir.mktmpdir("#{Time.now.utc.strftime("%Y%m%dT%H%M%SZ")}-", base)
34
+ log_path = File.join(directory, "session.log")
35
+ report_path = File.join(directory, "report.json")
36
+ report = { host: host, port: port, user: user, started_at: Time.now.utc.iso8601, passed: false }
37
+ runner = nil
38
+ session = nil
39
+
40
+ begin
41
+ Dir.mktmpdir("expect-known-hosts-") do |temporary|
42
+ policy = known_hosts ? "yes" : "accept-new"
43
+ hosts_path = known_hosts || File.join(temporary, "known_hosts")
44
+ args = ["ssh", "-F", "/dev/null", "-tt", "-p", port.to_s,
45
+ "-o", "ConnectTimeout=5", "-o", "NumberOfPasswordPrompts=1",
46
+ "-o", "PreferredAuthentications=password", "-o", "PubkeyAuthentication=no",
47
+ "-o", "StrictHostKeyChecking=#{policy}", "-o", "UserKnownHostsFile=#{hosts_path}",
48
+ "-l", user, host, "env ENV= PS1=#{Shellwords.escape(ScriptProbe::PROMPT)} /bin/sh -i"]
49
+ # Authentication is completed before opening any log. Parent defaults
50
+ # cannot accidentally turn on debug or console logging for this check.
51
+ session = Expect.spawn(*args, raw_pty: true, log_stdout: false, log_listeners: false,
52
+ debug_level: 0, write_timeout: 5)
53
+ authentication = session.expect_result(/password:\s*\z/i, /Permission denied/i, timeout: 10)
54
+ ScriptProbe.check(authentication.number == 1,
55
+ "SSH password prompt not received (#{authentication.error || "authentication rejected"})")
56
+ session.write(password, "\n")
57
+ runner = ScriptProbe::Runner.new(session, timeout: 10).ready!
58
+ report.merge!(ScriptProbe.verify_file_session(runner, log_path, user: user))
59
+ report[:ssh_exit_code] = session.exit_code
60
+ ScriptProbe.check(!File.binread(log_path).include?(password.b), "password detected in session log")
61
+ report[:checks] << "password_absent"
62
+ report[:passed] = true
63
+ end
64
+ rescue StandardError => error
65
+ # Error messages identify the failed check; raw authentication output is
66
+ # deliberately excluded from both the report and the console.
67
+ report[:error] = "#{error.class}: #{error.message}".gsub(password, "[REDACTED]")
68
+ report[:cases] ||= runner&.results || []
69
+ ensure
70
+ session&.close
71
+ if File.file?(log_path)
72
+ bytes = File.binread(log_path)
73
+ if bytes.include?(password.b)
74
+ File.binwrite(log_path, bytes.gsub(password.b, "[REDACTED]"))
75
+ report[:passed] = false
76
+ report[:error] = "password detected and removed from log"
77
+ end
78
+ report[:log_sha256] = Digest::SHA256.file(log_path).hexdigest
79
+ report[:log_bytes] = File.size(log_path)
80
+ end
81
+ password.replace("\0" * password.bytesize)
82
+ report[:finished_at] = Time.now.utc.iso8601
83
+ report[:log_path] = log_path
84
+ File.open(report_path, File::WRONLY | File::CREAT | File::EXCL, 0o600) { |file| file.write(JSON.pretty_generate(report)) }
85
+ end
86
+
87
+ report.fetch(:cases, []).each do |result|
88
+ puts "#{result[:passed] ? "PASS" : "FAIL"} #{result[:name]} " \
89
+ "exit=#{result[:status]} expected=#{result[:expected_status]}"
90
+ end
91
+ puts "Log: #{log_path}"
92
+ puts "Report: #{report_path}"
93
+ abort(report[:error]) unless report[:passed]
94
+ puts "PASS SSH multi-script execution and #{report[:checks].length} logging checks; SSH exit=0"
@@ -0,0 +1,151 @@
1
+ # frozen_string_literal: true
2
+
3
+ require_relative "test_helper"
4
+ require_relative "support/interact_probe"
5
+ require "etc"
6
+
7
+ class InteractTest < ExpectTest
8
+ def shell_session
9
+ session = Expect.spawn("/bin/sh", "-i", env: { "PS1" => ScriptProbe::PROMPT, "ENV" => nil, "LC_ALL" => "C" },
10
+ raw_pty: true, log_stdout: false, write_timeout: 3)
11
+ @sessions << session
12
+ ScriptProbe::Runner.new(session).ready!
13
+ InteractProbe.prepare(session)
14
+ # Unlike SSH, the simulated remote shell shares the transport's PTY.
15
+ # Keep its canonical/ISIG settings while interact raws the local keyboard.
16
+ session.raw_terminal = false
17
+ session
18
+ end
19
+
20
+ def local_terminal
21
+ master, slave = PTY.open
22
+ @ios.push(master, slave)
23
+ source = Expect.open(slave)
24
+ @sessions << source
25
+ [master, slave, source]
26
+ end
27
+
28
+ def test_real_terminal_handoff_ctrl_c_escape_and_resume
29
+ session = shell_session
30
+ log = StringIO.new
31
+ session.log_to(log)
32
+ report = bounded(20) { InteractProbe.verify(session, user: Etc.getpwuid.name) }
33
+ assert_equal 4, report[:cases].length
34
+ assert(report[:cases].all? { |result| result[:passed] })
35
+ assert report[:local_terminal_restored]
36
+ assert report[:transport_terminal_restored]
37
+ text = ScriptProbe.normalize(log.string)
38
+ %w[AUTOMATION_RESUMED SECOND_HANDOFF_OK STDOUT_FIRST STDERR_SECOND].each do |line|
39
+ assert_equal 1, text.scan(/^#{line}$/).length
40
+ end
41
+ refute_includes text, InteractProbe::TAIL
42
+ end
43
+
44
+ def test_timeout_restores_local_tty_and_session_settings
45
+ session = shell_session
46
+ _, slave, source = local_terminal
47
+ saved = InteractProbe.configuration(source)
48
+ state = InteractProbe.settings(session)
49
+ source.on_sequence("original")
50
+ source_state = InteractProbe.settings(source)
51
+ assert_nil session.interact(input: source, escape: "\x1d", output: slave, timeout: 0.02)
52
+ assert_equal saved, InteractProbe.configuration(source)
53
+ assert_equal state, InteractProbe.settings(session)
54
+ assert_equal source_state, InteractProbe.settings(source)
55
+ assert session.alive?
56
+ end
57
+
58
+ def test_manual_typing_is_visible_before_enter_and_automation_resumes_without_echo
59
+ session = shell_session
60
+ InteractProbe.prepare(session, echo: true)
61
+ master, slave, source = local_terminal
62
+ screen = Expect.open(master, write_timeout: 3)
63
+ @sessions << screen
64
+ saved = InteractProbe.configuration(source)
65
+ session.write("printf '\\n%s\\n' 'MANUAL_READY'\n")
66
+ keyboard = Thread.new do
67
+ ScriptProbe.check(screen.expect(/\r?\nMANUAL_READY\r?\n/, timeout: 3), "manual handoff was not ready")
68
+ ScriptProbe.check(screen.expect(ScriptProbe::PROMPT, timeout: 3), "manual prompt missing")
69
+ command = "printf 'VISIBLE_COMMAND\\n'"
70
+ screen.write(command)
71
+ ScriptProbe.check(screen.expect(command, timeout: 3), "typed command was invisible before Enter")
72
+ screen.write("\n")
73
+ ScriptProbe.check(screen.expect(/\r?\nVISIBLE_COMMAND\r?\n/, timeout: 3), "manual command output missing")
74
+ ScriptProbe.check(screen.expect(ScriptProbe::PROMPT, timeout: 3), "manual command did not return to shell")
75
+ screen.write(InteractProbe::ESCAPE)
76
+ true
77
+ rescue Exception # rubocop:disable Lint/RescueException -- Clean up terminal drivers even on Interrupt or SystemExit.
78
+ begin
79
+ screen.write(InteractProbe::ESCAPE)
80
+ rescue StandardError
81
+ nil
82
+ end
83
+ raise
84
+ end
85
+ keyboard.report_on_exception = false
86
+ assert_same source, session.interact(input: source, escape: InteractProbe::ESCAPE, output: slave, timeout: 12)
87
+ assert keyboard.join(2), "manual keyboard driver did not finish"
88
+ assert keyboard.value
89
+ assert_equal saved, InteractProbe.configuration(source)
90
+ InteractProbe.prepare(session)
91
+ log = StringIO.new
92
+ session.log_to(log)
93
+ result = ScriptProbe::Runner.new(session).run("manual_resume", "printf 'RESUMED_WITHOUT_ECHO\\n'",
94
+ expected_status: 0, expected_output: "RESUMED_WITHOUT_ECHO\n")
95
+ assert result[:passed]
96
+ refute_includes log.string, "printf"
97
+ ensure
98
+ keyboard&.kill&.join if keyboard&.alive?
99
+ end
100
+
101
+ def test_remote_eof_restores_input_terminal_and_keeps_borrowed_io_open
102
+ session = child('STDIN.gets; print "FINAL_REMOTE_OUTPUT"', raw_pty: true)
103
+ _, slave, source = local_terminal
104
+ saved = InteractProbe.configuration(source)
105
+ output = StringIO.new
106
+ session.write("go\n")
107
+ assert_same session, session.interact(input: source, escape: "\x1d", output: output, timeout: 3)
108
+ assert_equal "FINAL_REMOTE_OUTPUT", output.string
109
+ assert_equal saved, InteractProbe.configuration(source)
110
+ refute slave.closed?
111
+ assert_equal 0, session.wait(timeout: 1).exitstatus
112
+ end
113
+
114
+ def test_local_eof_returns_without_closing_remote_session
115
+ session = shell_session
116
+ source, writer = pipe_session
117
+ writer.close
118
+ assert_same source, session.interact(input: source, escape: "\x1d", output: StringIO.new, timeout: 2)
119
+ assert session.alive?
120
+ session.write("printf 'AFTER_LOCAL_EOF\\n'\n")
121
+ assert_equal 1, session.expect(/AFTER_LOCAL_EOF\r?\n/, timeout: 2)
122
+ end
123
+
124
+ def test_remote_callback_exception_restores_both_terminals
125
+ session = shell_session
126
+ _, slave, source = local_terminal
127
+ local_mode = InteractProbe.configuration(source)
128
+ remote_mode = InteractProbe.configuration(session)
129
+ old_settings = InteractProbe.settings(session)
130
+ session.on_sequence("CALLBACK_FAILURE") { raise "test callback failed" }
131
+ session.write("printf 'CALLBACK_FAILURE\\n'\n")
132
+ error = assert_raises(RuntimeError) { session.interact(input: source, escape: "\x1d", output: slave, timeout: 2) }
133
+ assert_equal "test callback failed", error.message
134
+ assert_equal local_mode, InteractProbe.configuration(source)
135
+ assert_equal remote_mode, InteractProbe.configuration(session)
136
+ assert_equal old_settings[0..3], InteractProbe.settings(session)[0..3]
137
+ assert session.alive?
138
+ end
139
+
140
+ def test_output_io_failure_restores_input_terminal
141
+ session = shell_session
142
+ _, slave, source = local_terminal
143
+ saved = InteractProbe.configuration(source)
144
+ output = StringIO.new
145
+ output.close
146
+ session.write("printf 'OUTPUT_FAILURE\\n'\n")
147
+ assert_raises(IOError) { session.interact(input: source, escape: "\x1d", output: output, timeout: 2) }
148
+ assert_equal saved, InteractProbe.configuration(source)
149
+ refute slave.closed?
150
+ end
151
+ end
@@ -0,0 +1,226 @@
1
+ # frozen_string_literal: true
2
+
3
+ require_relative "test_helper"
4
+
5
+ class InterconnectTest < ExpectTest
6
+ def test_interconnect_forwards_and_strips_split_escape
7
+ session, writer = pipe_session
8
+ listener = StringIO.new
9
+ session.listeners = [listener]
10
+ session.on_sequence("STOP")
11
+ background do
12
+ writer.write("helloST")
13
+ sleep 0.03
14
+ writer.write("OPtail")
15
+ end
16
+ assert_same(session, bounded { Expect.interconnect(session) })
17
+ assert_equal "hello", listener.string
18
+ assert_equal "tail", session.buffer
19
+ end
20
+
21
+ def test_sequence_callback_parameters_and_resume
22
+ session, writer = pipe_session
23
+ listener = StringIO.new
24
+ values = []
25
+ session.listeners = [listener]
26
+ session.on_sequence("!") do
27
+ values << :event
28
+ true
29
+ end
30
+ session.on_sequence("?")
31
+ writer.write("one!two?three")
32
+ Expect.interconnect(session, timeout: 1)
33
+ assert_equal "onetwo", listener.string
34
+ assert_equal [:event], values
35
+ assert_equal "three", session.buffer
36
+ end
37
+
38
+ def test_zero_is_truthy_and_uppercase_eof_is_a_literal_sequence
39
+ session, writer = pipe_session
40
+ output = StringIO.new
41
+ session.listeners = [output]
42
+ session.on_sequence("!") { 0 }
43
+ session.on_sequence("EOF")
44
+ writer.write("one!twoEOFtail")
45
+ assert_same session, Expect.interconnect(session, timeout: 1)
46
+ assert_equal "onetwo", output.string
47
+ assert_equal "tail", session.buffer
48
+ end
49
+
50
+ def test_eof_flushes_partial_escape
51
+ session, writer = pipe_session
52
+ listener = StringIO.new
53
+ session.listeners = [listener]
54
+ session.on_sequence("STOP")
55
+ writer.write("helloST")
56
+ writer.close
57
+ assert_same session, Expect.interconnect(session, timeout: 1)
58
+ assert_equal "helloST", listener.string
59
+ end
60
+
61
+ def test_eof_handler_can_continue_other_sessions
62
+ first, first_writer = pipe_session
63
+ second, second_writer = pipe_session
64
+ listener = StringIO.new
65
+ second.listeners = [listener]
66
+ seen = []
67
+ first.on_sequence(:eof) do
68
+ seen << :first
69
+ true
70
+ end
71
+ second.on_sequence("!")
72
+ first_writer.close
73
+ second_writer.write("second!")
74
+ assert_same second, Expect.interconnect(first, second, timeout: 1)
75
+ assert_equal [:first], seen
76
+ assert_equal "second", listener.string
77
+ end
78
+
79
+ def test_interact_roundtrip_escape_and_restored_settings
80
+ session = child(<<~'RUBY', raw_pty: true)
81
+ while (value = STDIN.gets)
82
+ puts "reply:#{value.strip}"
83
+ end
84
+ RUBY
85
+ source, writer = pipe_session
86
+ sink = StringIO.new
87
+ listener = StringIO.new
88
+ session.listeners = [listener]
89
+ session.log_listeners = false
90
+ source.on_sequence("original")
91
+ background do
92
+ writer.write("hello\n")
93
+ # 收到真实响应后才发送退出键,避免将子进程启动速度当成交互完成条件。
94
+ bounded { sleep 0.001 until sink.string == "reply:hello\n" }
95
+ writer.write("\x1dtail")
96
+ end
97
+ assert_same(source, bounded { session.interact(input: source, escape: "\x1d", output: sink, timeout: 2) })
98
+ assert_equal "reply:hello\n", sink.string
99
+ assert_equal "tail", source.buffer
100
+ assert_equal [listener], session.listeners
101
+ refute session.log_listeners
102
+ assert_equal ["original"], source.instance_variable_get(:@sequences).keys
103
+ end
104
+
105
+ def test_terminal_modes_restore_after_callback_exception
106
+ session = child('print "!"; sleep 30')
107
+ mode = session.to_io.console_mode
108
+ original = terminal_configuration(session)
109
+ session.on_sequence("!") { raise "stop" }
110
+ assert_raises(RuntimeError) { Expect.interconnect(session, timeout: 1) }
111
+ assert_equal original, terminal_configuration(session)
112
+ refute_nil mode
113
+ end
114
+
115
+ def test_manual_stty_leaves_terminal_mode_to_caller
116
+ session = child('print "!"; sleep 30')
117
+ session.raw_terminal = false
118
+ original = session.stty
119
+ seen = nil
120
+ session.on_sequence("!") do
121
+ seen = session.stty
122
+ false
123
+ end
124
+ Expect.interconnect(session, timeout: 1)
125
+ assert_equal original, seen
126
+ end
127
+
128
+ def test_timeout_flushes_pending_escape_prefix
129
+ session, writer = pipe_session
130
+ listener = StringIO.new
131
+ session.listeners = [listener]
132
+ session.on_sequence("STOP")
133
+ writer.write("helloST")
134
+ assert_nil Expect.interconnect(session, timeout: 0.02)
135
+ assert_equal "helloST", listener.string
136
+ assert_empty session.buffer
137
+ end
138
+
139
+ def test_regexp_escape_matches_and_preserves_trailing_input
140
+ session, writer = pipe_session
141
+ output = StringIO.new
142
+ session.listeners = [output]
143
+ session.on_sequence(/STOP\d+;/)
144
+ writer.write("beforeSTOP42;after")
145
+ assert_same session, Expect.interconnect(session, timeout: 1)
146
+ assert_equal "before", output.string
147
+ assert_equal "after", session.buffer
148
+ end
149
+
150
+ def test_regexp_escape_tracks_prior_reads_without_delaying_forwarding
151
+ session, writer = pipe_session
152
+ seen = []
153
+ output = StringIO.new
154
+ session.listeners = [output]
155
+ session.on_sequence(/STOP\d+;/) do
156
+ seen << :stopped
157
+ false
158
+ end
159
+ # Await actual forwarding before writing the continuation, ensuring the
160
+ # test cannot accidentally pass with a single combined read.
161
+ background do
162
+ writer.write("beforeSTOP")
163
+ bounded { sleep 0.001 until output.string == "beforeSTOP" }
164
+ writer.write("42;after")
165
+ end
166
+ assert_same(session, bounded { Expect.interconnect(session, timeout: 1) })
167
+ assert_equal [:stopped], seen
168
+ assert_equal "beforeSTOP", output.string
169
+ assert_equal "after", session.buffer
170
+ end
171
+
172
+ def test_regexp_escape_continuation_does_not_rematch_history
173
+ session, writer = pipe_session
174
+ seen = []
175
+ output = StringIO.new
176
+ session.listeners = [output]
177
+ session.on_sequence(/\[[0-9]+\]/) do
178
+ seen << :hit
179
+ true
180
+ end
181
+ session.on_sequence("!")
182
+ writer.write("one[12]two[34]three!tail")
183
+ Expect.interconnect(session, timeout: 1)
184
+ assert_equal %i[hit hit], seen
185
+ assert_equal "onetwothree", output.string
186
+ assert_equal "tail", session.buffer
187
+ end
188
+
189
+ def test_zero_width_regexp_escape_is_rejected_without_spinning
190
+ session, writer = pipe_session
191
+ session.on_sequence(/(?=a)/) { true }
192
+ writer.write("abc")
193
+ assert_raises(ArgumentError) { bounded { Expect.interconnect(session, timeout: 1) } }
194
+ assert_equal "abc", session.buffer
195
+ end
196
+
197
+ def test_logs_received_bytes_once_across_expect_interconnect_and_expect
198
+ session, writer = pipe_session
199
+ log = StringIO.new
200
+ output = StringIO.new
201
+ session.log_to(log)
202
+ session.listeners = [output]
203
+ session.on_sequence("!")
204
+ writer.write("prompt>before!")
205
+ session.expect("prompt>", timeout: 1)
206
+ Expect.interconnect(session, timeout: 1)
207
+ writer.write("after")
208
+ session.expect("after", timeout: 1)
209
+ assert_equal "prompt>before!after", log.string
210
+ end
211
+
212
+ def test_log_includes_escape_and_tail_before_next_expect
213
+ session, writer = pipe_session
214
+ log = StringIO.new
215
+ output = StringIO.new
216
+ session.log_to(log)
217
+ session.listeners = [output]
218
+ session.on_sequence("!")
219
+ writer.write("before!tail")
220
+ Expect.interconnect(session, timeout: 1)
221
+ assert_equal "before", output.string
222
+ assert_equal "before!tail", log.string
223
+ assert_equal 1, session.expect("tail", timeout: 0)
224
+ assert_equal "before!tail", log.string
225
+ end
226
+ end