rosh 0.9.1 → 0.9.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c281394b7c56d31763a538fe527e83e811fbd96c9cb777e203f1e6805309e8f0
-  data.tar.gz: 79b3f328162456af2d3b5d582ef3773244c05764a1b25b56921361d92033deee
+  metadata.gz: 3934908cd1559287bd808f7774a044e7e598850d814bfcfe15604df715653114
+  data.tar.gz: 71f530ac4d74d582a4c4145f07f941e7ca63323a0bc054e33ac7cffd72b475ef
 SHA512:
-  metadata.gz: 2fdf8acb2e2973c428320999966fc7c071e67cb35afea53570fb1781ca718facbefecf7ee0e15d8c90aca387a8a828a6ce3ed97648c8bdeb3f4c34505d724ecf
-  data.tar.gz: 75389ed8edf6e5a84512d52071ceeba6f618725d94841887afd3fb08a4fe285d593cdebf32ded16359f9460cd3731de15991af9eb0129d19ef121a45f6a5bbfb
+  metadata.gz: 922807c829ec873dbcb5a617cbcfd5b50a3d3da0cdfac24c6914223c27da717c9c29d109893402ca6f2666e3287035d34827b9efced35eaf4bc8cb7cdb6459e9
+  data.tar.gz: 0da6edde2a9f4825d029d2e8a37b5edf728e518d31997ede1522562e8d24d8ebd0f4a74f93211529ebb412824508a4105d0c50046775b042f3ee59469cb8851c

data/lib/rosh/version.rb

@@ -1,3 +1,3 @@
 class Rosh
-  VERSION = '0.9.1'
+  VERSION = '0.9.4'
 end

data/lib/rosh.rb

@@ -2,6 +2,7 @@ require 'uri'
 require 'resolv'
 require 'net/ssh/config'
 require 'optparse'
+require 'socket'
 require File.join(File.dirname(__FILE__), %w[rosh version])
 
 class Rosh
@@ -29,11 +30,15 @@ class Rosh
     if @verbose
       puts "ssh-config: #{config}"
     end
+    @forward_opts = []
+    @forwarding_disabled = false
+    @oom_reported = false
+    @last_exit_status = nil
     local_forwards(alias_name).each do |f|
-      @ssh_opts << "-L #{f}"
+      add_forward_option(:local, f)
     end
     remote_forwards(alias_name).each do |f|
-      @ssh_opts << "-R #{f}"
+      add_forward_option(:remote, f)
     end
     @host = config[:host_name] if config[:host_name]
     @ssh_opts << "-l #{config[:user]}" if config[:user]
@@ -64,7 +69,10 @@ class Rosh
       puts "connecting to #{@host}..."
       puts cmd
     end
-    reconnect until system cmd
+    begin
+      reconnect
+    end until execute_attach(cmd)
+    report_session_end(cmd)
   end
 
   def reconnect
@@ -98,6 +106,117 @@ class Rosh
   end
 
 private
+  def execute_attach(cmd)
+    result = system cmd
+    @last_exit_status = $?
+    report_oom_if_needed(cmd)
+    if @verbose && !result
+      log_failed_command(cmd)
+    end
+    result
+  end
+
+  def add_forward_option(kind, spec)
+    return if forwarding_disabled?
+    if kind == :local && !local_forward_available?(spec)
+      puts "skip forwarding: #{spec} is already in use"
+      disable_forwarding!
+      return
+    end
+    opt = kind == :local ? "-L #{spec}" : "-R #{spec}"
+    @ssh_opts << opt
+    @forward_opts << opt
+  end
+
+  def disable_forwarding!
+    return if @forwarding_disabled
+    @forwarding_disabled = true
+    @forward_opts.each { |opt| @ssh_opts.delete(opt) }
+    @forward_opts.clear
+  end
+
+  def forwarding_disabled?
+    @forwarding_disabled
+  end
+
+  def local_forward_available?(spec)
+    host, port = parse_local_forward(spec)
+    return true unless host && port
+    server = TCPServer.new(host, port)
+    server.close
+    true
+  rescue Errno::EADDRINUSE, Errno::EACCES, Errno::EADDRNOTAVAIL
+    false
+  rescue Errno::EPERM
+    true
+  rescue SocketError, ArgumentError
+    true
+  end
+
+  def parse_local_forward(spec)
+    parts = spec.split(':')
+    host = parts.length >= 4 ? parts.first : '127.0.0.1'
+    port = parts.length >= 4 ? parts[1] : parts.first
+    port_num = Integer(port)
+    [host.empty? ? '127.0.0.1' : host, port_num]
+  rescue ArgumentError
+    [nil, nil]
+  end
+
+  def report_session_end(cmd)
+    report_oom_if_needed(cmd)
+    log_session_end(cmd) if @verbose
+  end
+
+  def report_oom_if_needed(cmd)
+    return if @oom_reported
+    return unless oom_killed?(@last_exit_status)
+    @oom_reported = true
+    puts "tmux session #{@name} が SIGKILL (OOM の可能性) で終了しました。" +
+      " (command: #{cmd})"
+  end
+
+  def oom_killed?(status)
+    return false unless status
+    sig9 = status.respond_to?(:termsig) && status.termsig == 9
+    exit_137 = status.respond_to?(:exitstatus) && status.exitstatus == 137
+    sig9 || exit_137
+  end
+
+  def log_failed_command(cmd)
+    status = @last_exit_status
+    detail = format_status(status)
+    if detail
+      puts "ssh command failed (#{detail}) while executing: #{cmd}"
+    else
+      puts "ssh command failed while executing: #{cmd}"
+    end
+  end
+
+  def log_session_end(cmd)
+    status = @last_exit_status
+    detail = format_status(status)
+    puts "ssh command finished (#{detail}) for: #{cmd}"
+    return unless status && status.success?
+    prev_status = @last_exit_status
+    session_alive = sh_has_session?
+    @last_exit_status = prev_status
+    if session_alive
+      puts "tmux session #{@name} は継続中です。ユーザーデタッチまたはSSH切断で終了しました。"
+    else
+      puts "tmux session #{@name} が見つかりません。リモートシェルが即終了した可能性があります。"
+    end
+  end
+
+  def format_status(status)
+    return nil unless status
+    parts = []
+    parts << "exit #{status.exitstatus}" if status.exitstatus
+    parts << "signal #{status.termsig}" if status.signaled?
+    parts << "stopped #{status.stopsig}" if status.stopped?
+    parts.empty? ? nil : parts.join(', ')
+  end
+
   def sh(a, r=nil)
     cmd = "ssh #{resolv} #{@ssh_opts*' '} 'screen -S #{@name} #{a}' #{r}"
     if @verbose
@@ -108,23 +227,24 @@ private
 
   def sh_has_session?
     # tmux has-session -t <session_name>
-    cmd = [
-      "ssh",
-      *@ssh_opts,
-      resolv,
-      "'tmux has-session -t #{@name} 2>/dev/null'"
-    ]*' '
-    puts cmd if @verbose
-    system cmd
+    ssh_tmux("tmux has-session -t #{@name} 2>/dev/null")
   end
 
   def sh_new_session?
     # tmux new-session -s <session_name> -d
+    create_with_override = "tmux new-session -s #{@name} -d \\; set-option -t #{@name} destroy-unattached off"
+    return true if ssh_tmux(create_with_override)
+
+    puts "retrying tmux new-session without destroy-unattached override" if @verbose
+    ssh_tmux("tmux new-session -s #{@name} -d")
+  end
+
+  def ssh_tmux(command)
     cmd = [
       "ssh",
       *@ssh_opts,
       resolv,
-      "'tmux new-session -s #{@name} -d'"
+      "'#{command}'"
     ]*' '
     puts cmd if @verbose
     system cmd

data/memo/20250926_rosh_session_crash.md

@@ -0,0 +1,59 @@
+# roshセッションがクラッシュする件 調査メモ (2025-09-26)
+
+## 事象
+- roshで `vagrant grav` に接続中、セッションが突然落ち、以下の標準出力を確認。
+  - `can't find session: grav`
+  - `bind [127.0.0.1]:3131: Address already in use`
+  - `Warning: remote port forwarding failed for listen port 8082`
+- rosh は再接続を試みるが、最終的に `[exited]` してしまい復旧しない。
+
+## 原因の整理
+- rosh は初期化時に `~/.ssh/config` から対象ホストの `LocalForward` と `RemoteForward` をそのまま `ssh` オプションとして引き継ぐ。（`lib/rosh.rb:32-37`）
+- 対象ホスト設定に `LocalForward 3131 ...` および `RemoteForward 8082 ...` が含まれているため、接続のたびにローカル127.0.0.1:3131とリモート8082/tcpの占有を試みる。
+- セッションが異常終了した直後や、別ターミナルで同じホストに接続したままの場合、既存の `ssh` プロセスがこれらのポートを掴んでおり、新しい `ssh` が `bind ... Address already in use` を返して失敗する。
+- `ssh` が失敗すると rosh の `system cmd` 呼び出しが偽を返し、再接続ループ中に `tmux` セッション作成も失敗扱いとなって rosh 本体が終了する。（`lib/rosh.rb:55-90`）
+- 冒頭の `can't find session: grav` は、リモート tmux セッションが異常終了したか、まだ存在しないことを示しており、ポート前提の再接続をより不安定にしている。
+
+## 確認ポイント
+- `lsof -iTCP:3131 -sTCP:LISTEN` でローカルの占有プロセスを特定。
+- `ps aux | grep ssh.*3131` で rosh/vagrant 由来の既存 SSH プロセスが残っていないか確認。
+- リモートホスト側で `ss -tnlp | grep 8082` などを実行し、8082/tcp を掴んでいるプロセスの有無を確認。
+- `.ssh/config` の該当 Host 節を確認し、前述の Local/RemoteForward が設定されていることを記録。
+
+## 対策案
+### 応急対応
+- 残留している SSH プロセスを終了し、ローカル3131/tcpを解放する（例: `pkill -f 'ssh.*3131'`）。その後 rosh を再実行。
+- 必要に応じてリモートで `tmux new-session -s grav -d` を手動実行し、セッションを復旧。
+
+### 恒久対応候補
+1. rosh 専用の Host エイリアスを `.ssh/config` に用意し、Local/RemoteForward を外す。通常の `ssh`/`vagrant` 用と分離してポート競合を防ぐ。
+2. Forward のポート番号を見直し、常に空いている番号に変更するか、ローカル側だけでも `LocalForward 0 ...` で OS 任せの空きポートを採用し、アプリ側には `SSH_CONNECTION` などから割当ポートを伝える。
+3. rosh を改修し、`bind ... Address already in use` を検知した場合は次のリトライまで `sleep` する、または Forward をスキップできるオプションを追加する（要検討）。
+4. `.ssh/config` に `ExitOnForwardFailure yes` を追加しておくと、Forward が確立できない接続を早期に失敗させられるため、原因の切り分けが容易になる。
+
+## 改修方針（Forward衝突時はスキップ）
+- 目的: 同一ホストに対して複数の rosh セッションを開いた際に Forward が衝突する場合、Forward を諦めて tmux 再接続のみ継続させる。
+- 想定フロー
+  1. `local_forwards` / `remote_forwards` の戻り値をもとに `@ssh_opts` を組み立てる処理にフックし、ポートの事前占有チェックを追加。
+  2. ローカル Forward については `Socket.tcp_server_sockets`、`Addrinfo#getnameinfo` 等を利用して事前に bind 可否を確認し、失敗した場合は該当ポートの `-L` オプションを除外する。
+  3. リモート Forward の衝突は事前検知が難しいため、`ssh` 実行時の標準エラー出力をパイプで受け取り、`bind ... Address already in use`／`remote port forwarding failed` を検知した時点で `-R` オプションを除外して再試行する（Forward なしバージョンで再接続）。
+  4. Forward を全て除外した再接続が成功した場合は警告ログを出力し、恒常的に Forward を使わないモードへ遷移（セッション終了まで）。
+  5. ユーザが Forward を強制したいケース向けに、`--require-forward` のようなフラグを導入し、オプトインで従来動作を維持できるようにする案も検討。
+- 実装時に考慮する点
+  - `OptionParser` や既存引数との後方互換性を確保する。
+  - `system cmd` を直接使っているため、エラーメッセージ捕捉のために `Open3.capture3` への置き換えや、`IO.popen` を導入する必要がある。
+  - Forward をスキップした場合でも再接続ループが破綻しないよう、`@first_try` フラグや `@ssh_opts` の再構築タイミングを整理する。
+
+## 実装済みの改善点 (2025-09-26)
+- Forward の衝突を検知して `-L/-R` を除去し、警告だけを出して tmux 再接続を継続する挙動を実装。
+- `rosh -V` 実行時は、`ssh` コマンドの終了ステータスと tmux セッション存否をログ出力し、突然 `[exited]` した際の原因切り分けを支援する。
+- `tmux attach` が `SIGKILL`/exit137 で終了した場合は OOM Kill の可能性を常時警告するようにし、`-V` 指定の有無に関わらず検知できるようにした。
+- バージョンを `0.9.2` に更新。
+
+## 追加したテスト
+- `test/rosh_forwarding_test.rb`: `.ssh/config` に記載した `LocalForward`/`RemoteForward` が `@ssh_opts` に反映されること、ポート衝突を検知した場合は Forward オプションが取り除かれることを検証する Minitest。現状の Forward 振る舞いを固定化し、今後の改修時に明示的に意図を更新できるようにする。
+
+## メモ
+- 調査日: 2025-09-26
+- 関連ソース: `lib/rosh.rb:32-37`, `lib/rosh.rb:55-90`, `lib/rosh.rb:133-166`
+- Forward 設定が必要なワークロードの場合は、他クライアントとポート割当が被らないよう利用時間帯や利用者単位で整理すること。

data/rosh.gemspec

@@ -21,5 +21,6 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency "net-ssh"
   spec.add_development_dependency "bundler"
+  spec.add_development_dependency "minitest"
   spec.add_development_dependency "rake"
 end

data/test/rosh_forwarding_test.rb

@@ -0,0 +1,121 @@
+require 'minitest/autorun'
+require 'tmpdir'
+require 'fileutils'
+
+require_relative '../lib/rosh'
+
+class RoshForwardingTest < Minitest::Test
+  def setup
+    @original_home = ENV['HOME']
+    @tmp_home = Dir.mktmpdir('rosh-test-home-')
+    ssh_dir = File.join(@tmp_home, '.ssh')
+    FileUtils.mkdir_p(ssh_dir)
+    File.write(File.join(ssh_dir, 'config'), <<~CONFIG)
+      Host grav
+        LocalForward 127.0.0.1 3131 localhost 3131
+        RemoteForward 8082 localhost 8082
+    CONFIG
+    ENV['HOME'] = @tmp_home
+  end
+
+  def teardown
+    ENV['HOME'] = @original_home
+    FileUtils.remove_entry(@tmp_home) if @tmp_home && File.exist?(@tmp_home)
+  end
+
+  def test_ssh_opts_include_local_forwarding_from_ssh_config
+    klass = Class.new(Rosh) do
+      def local_forward_available?(_spec)
+        true
+      end
+    end
+    rosh = klass.new('grav')
+    ssh_opts = rosh.instance_variable_get(:@ssh_opts)
+
+    assert_includes ssh_opts, '-L 127.0.0.1:3131:localhost:3131'
+  end
+
+  def test_ssh_opts_include_remote_forwarding_from_ssh_config
+    klass = Class.new(Rosh) do
+      def local_forward_available?(_spec)
+        true
+      end
+    end
+    rosh = klass.new('grav')
+    ssh_opts = rosh.instance_variable_get(:@ssh_opts)
+
+    assert_includes ssh_opts, '-R 8082:localhost:8082'
+  end
+
+  def test_forwarding_is_skipped_when_local_port_is_in_use
+    klass = Class.new(Rosh) do
+      def local_forward_available?(_spec)
+        false
+      end
+    end
+    rosh = klass.new('grav')
+    ssh_opts = rosh.instance_variable_get(:@ssh_opts)
+
+    refute_includes ssh_opts, '-L 127.0.0.1:3131:localhost:3131'
+    refute_includes ssh_opts, '-R 8082:localhost:8082'
+  end
+
+  def test_verbose_logs_when_session_is_missing
+    rosh = Rosh.new('grav')
+    rosh.instance_variable_set(:@verbose, true)
+    rosh.instance_variable_set(:@name, 'grav')
+    system('true')
+    status = $?
+    rosh.instance_variable_set(:@last_exit_status, status)
+
+    out, _ = capture_io do
+      rosh.stub(:sh_has_session?, false) do
+        rosh.send(:log_session_end, 'ssh grav')
+      end
+    end
+
+    assert_includes out, 'ssh command finished (exit 0)'
+    assert_includes out, 'tmux session grav が見つかりません'
+  end
+
+  def test_oom_kill_warning_is_printed_once
+    rosh = Rosh.new('grav')
+    status = Struct.new(:termsig, :exitstatus) do
+      def success?; false; end
+      def signaled?; true; end
+      def stopped?; false; end
+      def stopsig; nil; end
+    end.new(9, nil)
+    rosh.instance_variable_set(:@last_exit_status, status)
+
+    out, _ = capture_io { rosh.send(:report_oom_if_needed, 'ssh grav') }
+    assert_includes out, 'SIGKILL (OOM の可能性)'
+
+    out_again, _ = capture_io { rosh.send(:report_oom_if_needed, 'ssh grav') }
+    assert_equal '', out_again
+  end
+
+  def test_tmux_new_session_disables_destroy_unattached
+    rosh = Rosh.new('grav', 'grav')
+    commands = []
+    rosh.stub(:system, ->(cmd) { commands << cmd; true }) do
+      assert rosh.send(:sh_new_session?)
+    end
+
+    assert_equal 1, commands.size
+    assert_includes commands.first, 'set-option -t grav destroy-unattached off'
+  end
+
+  def test_tmux_new_session_fallback_without_override
+    rosh = Rosh.new('grav', 'grav')
+    commands = []
+    results = [false, true].each
+
+    rosh.stub(:system, ->(cmd) { commands << cmd; results.next rescue true }) do
+      assert rosh.send(:sh_new_session?)
+    end
+
+    assert_includes commands.first, 'set-option -t grav destroy-unattached off'
+    refute_includes commands.last, 'set-option -t grav destroy-unattached off'
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rosh
 version: !ruby/object:Gem::Version
-  version: 0.9.1
+  version: 0.9.4
 platform: ruby
 authors:
 - Genki Takiuchi
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-07-03 00:00:00.000000000 Z
+date: 2025-10-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: net-ssh
@@ -38,6 +38,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  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'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -70,7 +84,9 @@ files:
 - bin/rosh
 - lib/rosh.rb
 - lib/rosh/version.rb
+- memo/20250926_rosh_session_crash.md
 - rosh.gemspec
+- test/rosh_forwarding_test.rb
 homepage: https://github.com/genki/rosh
 licenses:
 - MIT
@@ -94,4 +110,5 @@ rubygems_version: 3.4.15
 signing_key:
 specification_version: 4
 summary: Rosh is roaming shell
-test_files: []
+test_files:
+- test/rosh_forwarding_test.rb