rosh 0.9.5 → 0.9.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9a9b04489aa21bdb87dd7a21a2696d33c0f1b29c45767593bca5bdc0b383b2a4
-  data.tar.gz: a43d640d729094bb85640cfece07ebe2f1b82bb007723d528b628fb5a495a23a
+  metadata.gz: e3c244fe02aac976b4bc470e13f529e71bd0a0ec43cc2a389222b7dd7b9b2fc2
+  data.tar.gz: e4283b6e8c61adb188861184350959de02ba1c75ecc751bf1c8101c4f6934f31
 SHA512:
-  metadata.gz: 35972089d8384a358f3e79795fbf774be00e38b811872f690491057ccb17134488d3a19d21cdd2bc5854acab669033273689f2d99bc1fedbdb324d1eff31982c
-  data.tar.gz: 8a422f7936c8482d12b168ed6a5aab6dddda8691e98b327c206a676976f770ad3a02d4a0d19888eeb86188b0dea4431b370ed2e6989559758d99adaf2c696932
+  metadata.gz: 12de5a2533f7943d5adc5f29d5f675f97da16e692c615eb40e0357adbce3c649619d44536fd92f5278cb7157a798c32658207869875865b7bdf42ebf14536fcd
+  data.tar.gz: cb3c1055ad0e11fd5ad55c81268508ed795d165157606e0c16925fc3dd18e3ba0fb74c39b5104926766accf9b6d619e5e62f73561a83bc5336377fdbe1423ed7

data/.gitignore

@@ -15,3 +15,4 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+vendor/bundle

data/README.md

@@ -30,6 +30,11 @@ Or install it yourself as:
 
 If ~/.ssh/config contains LocalForward or RemoteForward for the host, the same
 forwarding options are passed to `ssh` automatically.
+
+If a `LocalForward` is skipped because the local port is actually in use,
+rosh retries that forwarding on later reconnect attempts instead of dropping it
+for the rest of the process lifetime.
+
 To detach the outer screen session,
 
     ^t d

data/lib/rosh/version.rb

@@ -1,3 +1,3 @@
 class Rosh
-  VERSION = '0.9.5'
+  VERSION = '0.9.7'
 end

data/lib/rosh.rb

@@ -9,6 +9,9 @@ class Rosh
   def initialize(*args)
     @interval = 3
     @ssh_opts = []
+    @base_ssh_opts = []
+    @local_forward_specs = []
+    @remote_forward_specs = []
     alive_interval = 5
     @escape = '^t'
     @tmux_socket_name = nil
@@ -23,8 +26,8 @@ class Rosh
     end.parse! args
     @host, @name = *args, :default
     abort 'hostname is required' if @host == :default
-    @ssh_opts << "-o ServerAliveInterval=#{alive_interval}"
-    @ssh_opts << "-o ServerAliveCountMax=1"
+    @base_ssh_opts << "-o ServerAliveInterval=#{alive_interval}"
+    @base_ssh_opts << "-o ServerAliveCountMax=1"
 
     # check ~/.ssh/config to resolve alias name
     alias_name = @host
@@ -32,23 +35,18 @@ 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|
-      add_forward_option(:local, f)
-    end
-    remote_forwards(alias_name).each do |f|
-      add_forward_option(:remote, f)
-    end
+    @local_forward_specs = local_forwards(alias_name)
+    @remote_forward_specs = remote_forwards(alias_name)
     @host = config[:host_name] if config[:host_name]
-    @ssh_opts << "-l #{config[:user]}" if config[:user]
-    @ssh_opts << "-p #{config[:port]}" if config[:port]
-    @ssh_opts << "-J #{config[:proxy].jump_proxies}" if config[:proxy]
+    @base_ssh_opts << "-l #{config[:user]}" if config[:user]
+    @base_ssh_opts << "-p #{config[:port]}" if config[:port]
+    @base_ssh_opts << "-J #{config[:proxy].jump_proxies}" if config[:proxy]
     if keys = config[:keys]
-      keys.each{|k| @ssh_opts << "-i #{k}"}
+      keys.each{|k| @base_ssh_opts << "-i #{k}"}
     end
+    refresh_ssh_opts!
     if @verbose
       puts "host: #{@host}"
       puts "name: #{@name}"
@@ -60,25 +58,20 @@ class Rosh
   end
 
   def connect
-    cmd = if @screen
-      ["ssh", *@ssh_opts, resolv,
-        '-t', "'screen -rx #{@name}'", '2>/dev/null']*' '
-    else
-      remote_cmd = single_quote(tmux_attach_command)
-      ["ssh", *@ssh_opts, resolv,
-        '-t', remote_cmd, '2>/dev/null']*' '
-    end
     if @verbose
       puts "connecting to #{@host}..."
-      puts cmd
     end
+    cmd = nil
     begin
       reconnect
+      cmd = attach_command
+      puts cmd if @verbose
     end until execute_attach(cmd)
     report_session_end(cmd)
   end
 
   def reconnect
+    refresh_ssh_opts!
     if @first_try
       session_exists = if @screen
         sh('-p 0 -X echo ok', '2>&1 >/dev/null')
@@ -109,6 +102,16 @@ class Rosh
   end
 
 private
+  def refresh_ssh_opts!
+    @ssh_opts = @base_ssh_opts.dup
+    @local_forward_specs.each do |spec|
+      add_forward_option(:local, spec)
+    end
+    @remote_forward_specs.each do |spec|
+      add_forward_option(:remote, spec)
+    end
+  end
+
   def execute_attach(cmd)
     result = system cmd
     @last_exit_status = $?
@@ -120,26 +123,12 @@ private
   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)
@@ -254,6 +243,17 @@ private
     system cmd
   end
 
+  def attach_command
+    if @screen
+      ["ssh", *@ssh_opts, resolv,
+        '-t', "'screen -rx #{@name}'", '2>/dev/null']*' '
+    else
+      remote_cmd = single_quote(tmux_attach_command)
+      ["ssh", *@ssh_opts, resolv,
+        '-t', remote_cmd, '2>/dev/null']*' '
+    end
+  end
+
   def local_forwards(host)
     file = File.expand_path("~/.ssh/config")
     return [] unless File.readable?(file)

data/test/rosh_forwarding_test.rb

@@ -5,6 +5,22 @@ require 'fileutils'
 require_relative '../lib/rosh'
 
 class RoshForwardingTest < Minitest::Test
+  def with_stub(obj, method_name, callable)
+    singleton = class << obj; self; end
+    original_defined = obj.respond_to?(method_name, true)
+    original_name = :"__orig_#{method_name}_for_test"
+
+    singleton.alias_method(original_name, method_name) if original_defined
+    singleton.define_method(method_name, &callable)
+    yield
+  ensure
+    singleton.remove_method(method_name) rescue nil
+    if original_defined
+      singleton.alias_method(method_name, original_name)
+      singleton.remove_method(original_name) rescue nil
+    end
+  end
+
   def setup
     @original_home = ENV['HOME']
     @tmp_home = Dir.mktmpdir('rosh-test-home-')
@@ -57,7 +73,56 @@ class RoshForwardingTest < Minitest::Test
     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'
+    assert_includes ssh_opts, '-R 8082:localhost:8082'
+  end
+
+  def test_reconnect_retries_local_forwarding_when_port_becomes_available
+    klass = Class.new(Rosh) do
+      def initialize(*args)
+        @availability_checks = [false, true]
+        super
+      end
+
+      def local_forward_available?(_spec)
+        @availability_checks.empty? ? true : @availability_checks.shift
+      end
+    end
+
+    rosh = klass.new('grav')
+    refute_includes rosh.instance_variable_get(:@ssh_opts), '-L 127.0.0.1:3131:localhost:3131'
+
+    rosh.instance_variable_set(:@first_try, false)
+    capture_io { rosh.reconnect }
+
+    assert_includes rosh.instance_variable_get(:@ssh_opts), '-L 127.0.0.1:3131:localhost:3131'
+  end
+
+  def test_connect_rebuilds_attach_command_after_reconnect_refreshes_forwarding
+    klass = Class.new(Rosh) do
+      def initialize(*args)
+        @availability_checks = [false, false, true]
+        super
+      end
+
+      def local_forward_available?(_spec)
+        @availability_checks.empty? ? true : @availability_checks.shift
+      end
+    end
+
+    rosh = klass.new('grav')
+    rosh.instance_variable_set(:@first_try, false)
+
+    commands = []
+    results = [false, true]
+
+    with_stub(rosh, :execute_attach, ->(cmd) { commands << cmd; results.shift }) do
+      with_stub(rosh, :report_session_end, ->(_cmd) { nil }) do
+        capture_io { rosh.connect }
+      end
+    end
+
+    refute_includes commands.first, '-L 127.0.0.1:3131:localhost:3131'
+    assert_includes commands.last, '-L 127.0.0.1:3131:localhost:3131'
   end
 
   def test_verbose_logs_when_session_is_missing
@@ -69,7 +134,7 @@ class RoshForwardingTest < Minitest::Test
     rosh.instance_variable_set(:@last_exit_status, status)
 
     out, _ = capture_io do
-      rosh.stub(:sh_has_session?, false) do
+      with_stub(rosh, :sh_has_session?, -> { false }) do
         rosh.send(:log_session_end, 'ssh grav')
       end
     end
@@ -98,7 +163,7 @@ class RoshForwardingTest < Minitest::Test
   def test_tmux_new_session_disables_destroy_unattached
     rosh = Rosh.new('grav', 'grav')
     commands = []
-    rosh.stub(:system, ->(cmd) { commands << cmd; true }) do
+    with_stub(rosh, :system, ->(cmd) { commands << cmd; true }) do
       assert rosh.send(:sh_new_session?)
     end
 
@@ -111,7 +176,7 @@ class RoshForwardingTest < Minitest::Test
     commands = []
     results = [false, true].each
 
-    rosh.stub(:system, ->(cmd) { commands << cmd; results.next rescue true }) do
+    with_stub(rosh, :system, ->(cmd) { commands << cmd; results.next rescue true }) do
       assert rosh.send(:sh_new_session?)
     end
 
@@ -127,7 +192,7 @@ class RoshForwardingTest < Minitest::Test
     assert_includes rosh.send(:tmux_attach_command), "-L #{socket_name}"
 
     commands = []
-    rosh.stub(:system, ->(cmd) { commands << cmd; true }) do
+    with_stub(rosh, :system, ->(cmd) { commands << cmd; true }) do
       rosh.send(:sh_has_session?)
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rosh
 version: !ruby/object:Gem::Version
-  version: 0.9.5
+  version: 0.9.7
 platform: ruby
 authors:
 - Genki Takiuchi
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-10-14 00:00:00.000000000 Z
+date: 2026-04-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: net-ssh
@@ -107,7 +107,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.15
+rubygems_version: 3.4.20
 signing_key:
 specification_version: 4
 summary: Rosh is roaming shell