expect-pty 0.5.3 → 0.6.1

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 (89) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +28 -0
  3. data/README.md +28 -19
  4. data/docs/API.md +88 -0
  5. data/docs/MIGRATION.md +15 -0
  6. data/lib/expect/cleanup.rb +33 -0
  7. data/lib/expect/configuration.rb +87 -66
  8. data/lib/expect/interaction.rb +226 -209
  9. data/lib/expect/logging.rb +157 -156
  10. data/lib/expect/matcher.rb +30 -29
  11. data/lib/expect/pattern.rb +8 -2
  12. data/lib/expect/pattern_list.rb +35 -5
  13. data/lib/expect/redactor.rb +11 -4
  14. data/lib/expect/relay.rb +97 -73
  15. data/lib/expect/relay_writer.rb +2 -1
  16. data/lib/expect/result.rb +32 -8
  17. data/lib/expect/session.rb +508 -0
  18. data/lib/expect/session_resources.rb +10 -2
  19. data/lib/expect/terminal.rb +78 -78
  20. data/lib/expect/version.rb +1 -1
  21. data/lib/expect.rb +333 -520
  22. data/sig/expect.rbs +355 -0
  23. metadata +13 -106
  24. data/.rubocop.yml +0 -66
  25. data/CONTRIBUTING.md +0 -29
  26. data/Gemfile +0 -28
  27. data/Rakefile +0 -38
  28. data/benchmark/matching.rb +0 -98
  29. data/benchmark/redactor.rb +0 -64
  30. data/benchmark/relay.rb +0 -48
  31. data/benchmark/scaling.rb +0 -70
  32. data/benchmark/send_slow.rb +0 -41
  33. data/benchmark/support.rb +0 -114
  34. data/docs/COMPATIBILITY.md +0 -98
  35. data/docs/INTERNAL_CONTRACTS.md +0 -154
  36. data/docs/PERFORMANCE.md +0 -165
  37. data/docs/RELEASING.md +0 -84
  38. data/docs/VERIFICATION.md +0 -456
  39. data/examples/dialogue.rb +0 -30
  40. data/examples/kibitz/README.md +0 -81
  41. data/examples/kibitz/kibitz.rb +0 -142
  42. data/examples/kibitz/test_kibitz.rb +0 -37
  43. data/examples/ssh_auto.rb +0 -94
  44. data/examples/ssh_interact.rb +0 -159
  45. data/examples/ssh_login.rb +0 -64
  46. data/expect-pty.gemspec +0 -33
  47. data/script/ci +0 -121
  48. data/script/release.rb +0 -319
  49. data/test/buffer_accounting_test.rb +0 -83
  50. data/test/cleanup_test.rb +0 -251
  51. data/test/compare_upstream.rb +0 -157
  52. data/test/configuration_test.rb +0 -133
  53. data/test/deadline_test.rb +0 -237
  54. data/test/diagnostics_test.rb +0 -353
  55. data/test/edge_case_test.rb +0 -262
  56. data/test/fixtures/ssh_scripts/01_identity.sh +0 -4
  57. data/test/fixtures/ssh_scripts/02_output.sh +0 -5
  58. data/test/fixtures/ssh_scripts/03_delayed.sh +0 -6
  59. data/test/fixtures/ssh_scripts/04_failure.sh +0 -2
  60. data/test/fixtures/ssh_scripts/05_recovery.sh +0 -3
  61. data/test/initialization_failure_test.rb +0 -92
  62. data/test/integration/README.md +0 -109
  63. data/test/integration/ssh_scripts.rb +0 -94
  64. data/test/interact_test.rb +0 -253
  65. data/test/interconnect_test.rb +0 -425
  66. data/test/io_test.rb +0 -321
  67. data/test/kibitz_test.rb +0 -45
  68. data/test/lifecycle_contract_test.rb +0 -71
  69. data/test/literal_scan_test.rb +0 -97
  70. data/test/matching_test.rb +0 -211
  71. data/test/multi_session_test.rb +0 -66
  72. data/test/ownership_sequence_test.rb +0 -208
  73. data/test/pattern_offset_test.rb +0 -43
  74. data/test/process_interruption_test.rb +0 -296
  75. data/test/process_test.rb +0 -291
  76. data/test/redactor_test.rb +0 -183
  77. data/test/relay_recovery_test.rb +0 -451
  78. data/test/relay_reentrancy_test.rb +0 -159
  79. data/test/release_test.rb +0 -375
  80. data/test/ruby_api_test.rb +0 -515
  81. data/test/scan_reuse_test.rb +0 -109
  82. data/test/script_logging_test.rb +0 -124
  83. data/test/support/interact_probe.rb +0 -125
  84. data/test/support/kibitz_probe.rb +0 -177
  85. data/test/support/script_probe.rb +0 -158
  86. data/test/terminal_cleanup_test.rb +0 -349
  87. data/test/test_helper.rb +0 -58
  88. data/test/timeout_test.rb +0 -289
  89. data/test/write_contract_test.rb +0 -105
@@ -1,92 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- require_relative "test_helper"
4
- require "minitest/mock"
5
-
6
- class InitializationFailureTest < ExpectTest
7
- def test_new_closes_both_pty_ends_before_propagating_the_original_exception
8
- initialization_errors.each do |failure|
9
- master, slave = PTY.open
10
- @ios.push(master, slave)
11
- PTY.stub(:open, [master, slave]) do
12
- without_ledger(failure) do
13
- assert_same failure, assert_raises(failure.class) { Expect.new }
14
- assert master.closed?, "master leaked before test cleanup"
15
- assert slave.closed?, "slave leaked before test cleanup"
16
- end
17
- end
18
- end
19
- end
20
-
21
- def test_open_cleans_owned_handles_and_preserves_borrowed_handles
22
- [true, false].product(initialization_errors).each do |own, failure|
23
- reader, writer = IO.pipe
24
- @ios.push(reader, writer)
25
- without_ledger(failure) do
26
- assert_same failure, assert_raises(failure.class) { Expect.open(reader, writer: writer, own: own) }
27
- assert_equal own, reader.closed?
28
- assert_equal own, writer.closed?
29
- end
30
- end
31
- end
32
-
33
- def test_duplicate_owned_handle_is_attempted_once_even_when_close_fails
34
- reader, writer = IO.pipe
35
- @ios.push(reader, writer)
36
- calls = 0
37
- reader.stub(:close, lambda {
38
- calls += 1
39
- raise IOError, "injected close failure"
40
- }) do
41
- without_ledger(failure = Interrupt.new) do
42
- assert_same failure, assert_raises(Interrupt) { Expect.open(reader, own: true) }
43
- assert_equal 1, calls
44
- end
45
- end
46
- end
47
-
48
- def test_cleanup_failure_still_attempts_other_handles_and_keeps_primary_exception
49
- initialization_errors.each do |failure|
50
- reader, writer = IO.pipe
51
- @ios.push(reader, writer)
52
- reader.stub(:close, -> { raise Errno::EIO }) do
53
- without_ledger(failure) do
54
- assert_same failure, assert_raises(failure.class) { Expect.open(reader, writer: writer, own: true) }
55
- assert writer.closed?
56
- end
57
- end
58
- end
59
- end
60
-
61
- def test_new_cleanup_failure_still_closes_slave
62
- master, slave = PTY.open
63
- @ios.push(master, slave)
64
- PTY.stub(:open, [master, slave]) do
65
- master.stub(:close, -> { raise IOError, "injected close failure" }) do
66
- without_ledger(failure = SystemExit.new(17)) do
67
- assert_same failure, assert_raises(SystemExit) { Expect.new }
68
- assert slave.closed?
69
- end
70
- end
71
- end
72
- end
73
-
74
- def test_invalid_non_io_argument_is_not_closed_by_the_fallback
75
- reader, writer = IO.pipe
76
- @ios.push(reader, writer)
77
- invalid = Object.new
78
- invalid.define_singleton_method(:close) { raise "must not close non-IO objects" }
79
- without_ledger(failure = Interrupt.new) do
80
- assert_same failure, assert_raises(Interrupt) { Expect.open(invalid, writer: writer, own: true) }
81
- assert writer.closed?
82
- end
83
- end
84
-
85
- private
86
-
87
- def initialization_errors = [Interrupt.new("injected initialization interruption"), SystemExit.new(17)]
88
-
89
- def without_ledger(failure, &)
90
- Expect::SessionResources.stub(:new, ->(*, **) { raise failure }, &)
91
- end
92
- end
@@ -1,109 +0,0 @@
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 命令行参数传递,日志在认证完成后才开启。默认自动测试不连接
12
- SSH、不读取密码。
13
-
14
- 支持 `SSH_PORT`(默认 22)、`EXPECT_LOG_DIR`(日志根目录)、`SSH_KNOWN_HOSTS`。连接非本机主机时,必须提供已有的受信任
15
- known_hosts,例如:
16
-
17
- ```sh
18
- SSH_HOST=192.0.2.10 SSH_USER=operator SSH_PORT=22 \
19
- SSH_KNOWN_HOSTS="$HOME/.ssh/known_hosts" \
20
- EXPECT_LOG_DIR=tmp/device-check ruby test/integration/ssh_scripts.rb
21
- ```
22
-
23
- 这是 POSIX shell 脚本测试;厂商专用 CLI(如交换机的 `show` 命令、分页提示符)需要对应设备的命令和预期输出,不能直接使用这些
24
- shell fixtures。
25
-
26
- ## 同一个登录会话执行的脚本
27
-
28
- | 脚本 | 验证内容 | 预期退出码 |
29
- |------------------|---------------------------------------|---------------|
30
- | `01_identity.sh` | 当前用户、远端 PTY、完成标记 | 0 |
31
- | `02_output.sh` | stdout、stderr、中文和输出顺序 | 0 |
32
- | `03_delayed.sh` | 分三次延迟输出,确保日志完整 | 0 |
33
- | `04_failure.sh` | 明确输出错误并退出 | 7(预期失败) |
34
- | `05_recovery.sh` | 上个脚本失败后继续执行,计算结果为 42 | 0 |
35
-
36
- fixtures 位于 `test/fixtures/ssh_scripts/`,都不修改目标文件或设备配置。文件内容通过 SSH 的交互 shell 传给独立
37
- `/bin/sh -c` 执行,不需要上传文件。每个脚本都有随机开始/结束标记,结束标记携带真实 `$?`;脚本输出和退出码都必须符合预期才算通过。
38
-
39
- 测试关闭终端回显和 shell 行编辑,使用单引号传输完整脚本,保留中文 UTF-8 和引号,避免 C locale 的交互式 readline
40
- 把高位字节当快捷键执行。末尾仍等待 shell 提示符,确认可以继续执行下一项。
41
-
42
- 另外执行两条日志控制命令:关闭日志后输出 `UNLOGGED_OUTPUT`,再以默认追加模式开启日志并输出 `APPEND_OK`。最后发送延迟输出及退出命令,只调用
43
- `soft_close`,确认 `SESSION_FINAL_TAIL` 确实在关闭过程中写入日志。
44
-
45
- ## 检查和输出文件
46
-
47
- 每次执行在 `tmp/ssh-logs/` 下创建独立目录,目录权限 0700,文件权限 0600:
48
-
49
- - `session.log`:收到的原始数据,以及手工添加的 `[SEND] 脚本名 sha256=...` 和 `[EXIT] 脚本名 status=...`。
50
- - `report.json`:主机、用户、远端 TTY、每项脚本输出和退出码、校验结果、SSH 退出码、日志字节数及 SHA-256。
51
-
52
- 只有认证后的输出进入日志。Expect 自动记录接收字节,发送的脚本名称和摘要由 `write_log` 明确写入,便于审核执行了哪个
53
- fixture;fixture 文件中的原文可以用报告内的 SHA-256 核对。
54
-
55
- 共 11 项日志/流程检查:完整输出、执行顺序、即时
56
- flush、stdout/stderr、UTF-8、非零退出后恢复、覆盖模式、暂停记录、追加模式、关闭前尾部输出、密码不出现在日志中。另校验日志条目没有重复,日志句柄在停止记录和关闭会话后正确关闭。
57
-
58
- 成功返回进程退出码 0。认证失败、超时、脚本输出错误、意外退出码或日志校验失败均返回非零,并在有报告目录时留下 `passed: false`
59
- 的报告。不用仅看到终端输出就判断成功;请查看最终 PASS 和 `report.json` 的 `passed`。
60
-
61
- ## 无需 SSH 的回归测试
62
-
63
- ```sh
64
- bundle exec ruby -Itest test/script_logging_test.rb
65
- bundle exec rake test
66
- ```
67
-
68
- `test/script_logging_test.rb` 使用真实本地 PTY 执行相同 fixtures,另外验证回调日志、借用 File 日志、错误退出/错误输出的反例、引号和
69
- shell 元字符、日志错误上抛,以及超时后继续收集日志。它和 SSH 脚本共享测试 helper,不依赖远端账户。
70
-
71
- ## SSH interact 人工和自动验证
72
-
73
- ```sh
74
- ruby examples/ssh_interact.rb
75
- ruby examples/ssh_interact.rb --auto
76
- # 自动方式也可通过 Rake 运行
77
- bundle exec rake test:ssh_interact
78
- ```
79
-
80
- 使用上述同一套 SSH 环境变量和隐藏密码输入。人工模式显示 `EXPECT_SCRIPT_PROMPT>`;输入命令有回显,Ctrl-C 传给远端前台任务。在命令结束、回到
81
- shell 提示符后按 Ctrl-],会关闭远端回显,执行 `MANUAL_AUTOMATION_RESUMED` 检查,再正常退出 SSH。也支持直接输入 `exit`:成功退出记为
82
- `completion: remote_exit`,此路径不执行返回 expect 的检查。非零 SSH 退出仍判为失败。
83
-
84
- `--auto` 创建真实本地 PTY,验证两次 `interact` 接管、当前用户和远端 TTY、stdout/stderr/中文、Ctrl-C、Ctrl-]、转义后的本地尾部不进入
85
- SSH、恢复 `expect` 及终端与监听设置。4 项命令输出和 13 项交互/日志检查全部通过后才返回 0。
86
-
87
- 日志在认证之后开启;每次在 `tmp/ssh-interact/` 新建 0700 目录,保存 0600 的 `session.log` 和 `report.json`
88
- 。报告包含检查项、命令输出、SSH 退出码及日志摘要。自动模式也校验日志无重复、退出尾部不丢失、密码不出现在日志中。
89
-
90
- 无需 SSH 的回归位于 `test/interact_test.rb`,覆盖可见输入、Ctrl-C、两次接管、返回自动命令、超时、两端 EOF、回调异常和输出 IO
91
- 故障时的终端恢复。`test/script_logging_test.rb` 另验证 CRLF 输出边界,包括空输出、末尾有/无换行和多个换行。
92
-
93
- ## `ssh_auto.rb` 环境检查
94
-
95
- ```sh
96
- ruby examples/ssh_auto.rb
97
- # 无人值守执行(密码可以由运行环境提供 EXPECT_PASSWORD)
98
- ruby examples/ssh_auto.rb --no-interact
99
- # 或执行 Rake 的自动退出入口
100
- bundle exec rake test:ssh_auto
101
- ```
102
-
103
- 该示例自动登录 `SSH_HOST`(默认 `127.0.0.1`),用本库的 `write` / `expect` 顺序执行文件顶部的 `COMMANDS`,显示真实输出并检查退出码。默认命令为
104
- `id`、`uname -srm`、`sw_vers`、`df -h /` 和 `uptime`,不修改系统设置;可直接修改数组来下发其他 macOS/POSIX shell 命令。它不依赖
105
- `test/support`,`ScriptProbe.check` 只供测试脚本使用。
106
-
107
- 执行成功后默认进入 `interact`,输入有回显,Ctrl-C 发给远端前台任务;`exit` 或 Ctrl-] 结束连接。使用 `--no-interact` 则执行完退出。
108
- `EXPECT_LOG_DIR` 可指定日志目录,默认 `tmp/ssh-auto/`;每次创建独立 0600 日志,记录命令和远端输出,认证前关闭日志。此使用示例不生成
109
- JSON 测试报告,详细日志断言仍由 `ssh_scripts.rb` 和 `ssh_interact.rb --auto` 验证。
@@ -1,94 +0,0 @@
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"
@@ -1,253 +0,0 @@
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 socket_session
29
- local, peer = Socket.pair(:UNIX, :STREAM, 0)
30
- @ios.push(local, peer)
31
- session = Expect.open(local)
32
- @sessions << session
33
- [session, peer]
34
- end
35
-
36
- def test_changed_interact_regexp_does_not_match_previously_forwarded_input
37
- session, peer = socket_session
38
- input, keyboard = pipe_session
39
- keyboard.write("old")
40
- assert_nil session.interact(input: input.to_io, output: StringIO.new, escape: /STOP/, timeout: 0)
41
- assert_equal "old", peer.read_nonblock(100)
42
-
43
- assert_nil session.interact(input: input.to_io, output: StringIO.new, escape: /old/, timeout: 0)
44
- keyboard.write("oldtail")
45
- stopped = session.interact(input: input.to_io, output: StringIO.new, escape: /old/, timeout: 0.1)
46
- assert_same input.to_io, stopped.to_io
47
- assert_equal "tail", stopped.buffer
48
- end
49
-
50
- def test_same_interact_regexp_keeps_cross_call_history_and_unread_tail
51
- session, peer = socket_session
52
- input, keyboard = pipe_session
53
- keyboard.write("ST")
54
- assert_nil session.interact(input: input.to_io, output: StringIO.new, escape: /STOP/, timeout: 0)
55
- assert_equal "ST", peer.read_nonblock(100)
56
-
57
- keyboard.write("OPtail")
58
- stopped = session.interact(input: input.to_io, output: StringIO.new, escape: /STOP/, timeout: 0.1)
59
- assert_same input.to_io, stopped.to_io
60
- assert_equal "tail", stopped.buffer
61
- assert_nil session.interact(input: input.to_io, output: StringIO.new, escape: /STOP/, timeout: 0)
62
- assert_equal "tail", peer.read_nonblock(100)
63
- end
64
-
65
- def test_repeated_interact_keeps_split_crlf_on_the_same_terminal
66
- session, = socket_session
67
- master, slave, source = local_terminal
68
- session.buffer = "first\r"
69
- assert_nil session.interact(input: source, output: slave, timeout: 0)
70
- assert_equal "first\r", master.read_nonblock(100)
71
-
72
- session.buffer = "\nsecond"
73
- assert_nil session.interact(input: source, output: slave, timeout: 0)
74
- assert_equal "\nsecond", master.read_nonblock(100)
75
- end
76
-
77
- def test_changed_interact_regexp_preserves_pending_output_and_tail
78
- session, peer = socket_session
79
- input, keyboard = pipe_session
80
- loop { break if session.writer.write_nonblock("x" * 4096, exception: false) == :wait_writable }
81
- keyboard.write("old")
82
- assert_nil session.interact(input: input, output: StringIO.new, escape: /STOP/, timeout: 0)
83
- assert input.pending_output?
84
- input.buffer = "tail"
85
- loop { break if peer.read_nonblock(65_536, exception: false) == :wait_readable }
86
-
87
- assert_nil session.interact(input: input, output: StringIO.new, escape: /old/, timeout: 0.01)
88
- refute input.pending_output?
89
- assert_empty input.buffer
90
- assert_equal "oldtail", peer.read_nonblock(100)
91
- end
92
-
93
- def test_real_terminal_handoff_ctrl_c_escape_and_resume
94
- session = shell_session
95
- log = StringIO.new
96
- session.log_to(log)
97
- report = bounded(20) { InteractProbe.verify(session, user: Etc.getpwuid.name) }
98
- assert_equal 4, report[:cases].length
99
- assert(report[:cases].all? { |result| result[:passed] })
100
- assert report[:local_terminal_restored]
101
- assert report[:transport_terminal_restored]
102
- text = ScriptProbe.normalize(log.string)
103
- %w[AUTOMATION_RESUMED SECOND_HANDOFF_OK STDOUT_FIRST STDERR_SECOND].each do |line|
104
- assert_equal 1, text.scan(/^#{line}$/).length
105
- end
106
- refute_includes text, InteractProbe::TAIL
107
- end
108
-
109
- def test_timeout_restores_local_tty_and_session_settings
110
- session = shell_session
111
- _, slave, source = local_terminal
112
- saved = InteractProbe.configuration(source)
113
- state = InteractProbe.settings(session)
114
- source.on_sequence("original")
115
- source_state = InteractProbe.settings(source)
116
- assert_nil session.interact(input: source, escape: "\x1d", output: slave, timeout: 0.02)
117
- assert_equal saved, InteractProbe.configuration(source)
118
- assert_equal state, InteractProbe.settings(session)
119
- assert_equal source_state, InteractProbe.settings(source)
120
- assert session.alive?
121
- end
122
-
123
- def test_manual_typing_is_visible_before_enter_and_automation_resumes_without_echo
124
- session = shell_session
125
- InteractProbe.prepare(session, echo: true)
126
- master, slave, source = local_terminal
127
- screen = Expect.open(master, write_timeout: 3)
128
- @sessions << screen
129
- saved = InteractProbe.configuration(source)
130
- session.write("printf '\\n%s\\n' 'MANUAL_READY'\n")
131
- keyboard = Thread.new do
132
- ScriptProbe.check(screen.expect(/\r?\nMANUAL_READY\r?\n/, timeout: 3), "manual handoff was not ready")
133
- ScriptProbe.check(screen.expect(ScriptProbe::PROMPT, timeout: 3), "manual prompt missing")
134
- command = "printf 'VISIBLE_COMMAND\\n'"
135
- screen.write(command)
136
- ScriptProbe.check(screen.expect(command, timeout: 3), "typed command was invisible before Enter")
137
- screen.write("\n")
138
- ScriptProbe.check(screen.expect(/\r?\nVISIBLE_COMMAND\r?\n/, timeout: 3), "manual command output missing")
139
- ScriptProbe.check(screen.expect(ScriptProbe::PROMPT, timeout: 3), "manual command did not return to shell")
140
- screen.write(InteractProbe::ESCAPE)
141
- true
142
- rescue Exception # rubocop:disable Lint/RescueException -- Clean up terminal drivers even on Interrupt or SystemExit.
143
- begin
144
- screen.write(InteractProbe::ESCAPE)
145
- rescue StandardError
146
- nil
147
- end
148
- raise
149
- end
150
- keyboard.report_on_exception = false
151
- assert_same source, session.interact(input: source, escape: InteractProbe::ESCAPE, output: slave, timeout: 12)
152
- assert keyboard.join(2), "manual keyboard driver did not finish"
153
- assert keyboard.value
154
- assert_equal saved, InteractProbe.configuration(source)
155
- InteractProbe.prepare(session)
156
- log = StringIO.new
157
- session.log_to(log)
158
- result = ScriptProbe::Runner.new(session).run("manual_resume", "printf 'RESUMED_WITHOUT_ECHO\\n'",
159
- expected_status: 0, expected_output: "RESUMED_WITHOUT_ECHO\n")
160
- assert result[:passed]
161
- refute_includes log.string, "printf"
162
- ensure
163
- keyboard&.kill&.join if keyboard&.alive?
164
- end
165
-
166
- def test_interact_preserves_newline_processing_on_the_shared_local_terminal
167
- session = child(<<~'RUBY', raw_pty: true)
168
- STDOUT.sync = true
169
- while STDIN.gets
170
- STDOUT.write("first\nsecond\r")
171
- STDIN.gets
172
- STDOUT.write("\nFW# ")
173
- end
174
- RUBY
175
- master, _, source = local_terminal
176
- screen = Expect.open(master, write_timeout: 3)
177
- @sessions << screen
178
- driver = Thread.new do
179
- screen.write("show\n")
180
- ScriptProbe.check(screen.expect("first\r\nsecond\r", timeout: 3),
181
- "interact disabled output newline processing")
182
- screen.write("continue\n")
183
- ScriptProbe.check(screen.expect("\nFW# ", timeout: 3), "interact duplicated a split CRLF sequence")
184
- screen.write(InteractProbe::ESCAPE)
185
- true
186
- rescue Exception # rubocop:disable Lint/RescueException -- Release interact when the assertion fails.
187
- begin
188
- screen.write(InteractProbe::ESCAPE)
189
- rescue StandardError
190
- nil
191
- end
192
- raise
193
- end
194
- driver.report_on_exception = false
195
-
196
- assert_same source, session.interact(input: source, escape: InteractProbe::ESCAPE, output: source.to_io, timeout: 5)
197
- assert driver.join(2), "terminal driver did not finish"
198
- assert driver.value
199
- ensure
200
- driver&.kill&.join if driver&.alive?
201
- end
202
-
203
- def test_remote_eof_restores_input_terminal_and_keeps_borrowed_io_open
204
- session = child('STDIN.gets; print "FINAL_REMOTE_OUTPUT"', raw_pty: true)
205
- _, slave, source = local_terminal
206
- saved = InteractProbe.configuration(source)
207
- output = StringIO.new
208
- session.write("go\n")
209
- assert_same session, session.interact(input: source, escape: "\x1d", output: output, timeout: 3)
210
- assert_equal "FINAL_REMOTE_OUTPUT", output.string
211
- assert_equal saved, InteractProbe.configuration(source)
212
- refute slave.closed?
213
- assert_equal 0, session.wait(timeout: 1).exitstatus
214
- end
215
-
216
- def test_local_eof_returns_without_closing_remote_session
217
- session = shell_session
218
- source, writer = pipe_session
219
- writer.close
220
- assert_same source, session.interact(input: source, escape: "\x1d", output: StringIO.new, timeout: 2)
221
- assert session.alive?
222
- session.write("printf 'AFTER_LOCAL_EOF\\n'\n")
223
- assert_equal 1, session.expect(/AFTER_LOCAL_EOF\r?\n/, timeout: 2)
224
- end
225
-
226
- def test_remote_callback_exception_restores_both_terminals
227
- session = shell_session
228
- _, slave, source = local_terminal
229
- local_mode = InteractProbe.configuration(source)
230
- remote_mode = InteractProbe.configuration(session)
231
- old_settings = InteractProbe.settings(session)
232
- session.on_sequence("CALLBACK_FAILURE") { raise "test callback failed" }
233
- session.write("printf 'CALLBACK_FAILURE\\n'\n")
234
- error = assert_raises(RuntimeError) { session.interact(input: source, escape: "\x1d", output: slave, timeout: 2) }
235
- assert_equal "test callback failed", error.message
236
- assert_equal local_mode, InteractProbe.configuration(source)
237
- assert_equal remote_mode, InteractProbe.configuration(session)
238
- assert_equal old_settings[0..3], InteractProbe.settings(session)[0..3]
239
- assert session.alive?
240
- end
241
-
242
- def test_output_io_failure_restores_input_terminal
243
- session = shell_session
244
- _, slave, source = local_terminal
245
- saved = InteractProbe.configuration(source)
246
- output = StringIO.new
247
- output.close
248
- session.write("printf 'OUTPUT_FAILURE\\n'\n")
249
- assert_raises(IOError) { session.interact(input: source, escape: "\x1d", output: output, timeout: 2) }
250
- assert_equal saved, InteractProbe.configuration(source)
251
- refute slave.closed?
252
- end
253
- end