rosh 0.9.6 → 0.9.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1399835146cfcd6615a17868694c426b4c06b25649fab1c02192bf8f4534fe1d
-  data.tar.gz: 835a84fe3a697e322fb28aa6c67e16f0ad1cbf832616b23991c65f0333fde8f9
+  metadata.gz: 5e3423833dad99eaf3db27ca753520ab865385a1dff3326f3dffd612297cccb7
+  data.tar.gz: cb28364217707106482da121b7842f5f4d6894c501330e10861e6c89a3062e35
 SHA512:
-  metadata.gz: ecaffa32659f87db955a586bced2a742f15735cc75c5d76b00cc7113a9378673cfb54294b7d33ffa29eefdda0213cee56ea09f07de4caae68b3239875f4d9d7c
-  data.tar.gz: 66a075c156779a0d33907187ada1195f8d7ebce66fb59de8136e585f7e3b4ce1d0e9f641961d3be12c6b956ae8215f0071e60e16a2a46ea153f0b5c8f377fbd0
+  metadata.gz: 201f582429c6e1b15bf5516db2abc236e6977d117b579faae4fdb2f243b965979a3cf6be69e19c0df19a72b705c541c45e87bc11430f04633a3725769040951f
+  data.tar.gz: e2fdf6bfb3d9861e72a47bbda8fa5a5b94e3747fa0e77a30f5678c6ad484f06257ff5aaaa839b8c2fccc5772326f3f5b1469acd3cfb0f14779cdbdeff021345e

data/.gitignore

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

data/README.md

@@ -30,6 +30,14 @@ 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 the host uses `ProxyJump` or `ProxyCommand`, rosh also carries that proxy
+setting over to the spawned `ssh` command.
+
+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.6'
+  VERSION = '0.9.8'
 end

data/lib/rosh.rb

@@ -2,6 +2,7 @@ require 'uri'
 require 'resolv'
 require 'net/ssh/config'
 require 'optparse'
+require 'shellwords'
 require 'socket'
 require File.join(File.dirname(__FILE__), %w[rosh version])
 
@@ -9,6 +10,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 +27,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
@@ -34,19 +38,18 @@ class Rosh
     end
     @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]
+    if proxy_option = ssh_proxy_option(config[:proxy])
+      @base_ssh_opts << proxy_option
+    end
     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}"
@@ -58,25 +61,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')
@@ -107,6 +105,26 @@ class Rosh
   end
 
 private
+  def ssh_proxy_option(proxy)
+    return nil unless proxy
+
+    if proxy.respond_to?(:jump_proxies)
+      "-J #{proxy.jump_proxies}"
+    elsif proxy.respond_to?(:command_line_template)
+      "-o ProxyCommand=#{Shellwords.escape(proxy.command_line_template)}"
+    end
+  end
+
+  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 = $?
@@ -238,6 +256,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

@@ -1,10 +1,27 @@
 require 'minitest/autorun'
 require 'tmpdir'
 require 'fileutils'
+require 'shellwords'
 
 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-')
@@ -14,6 +31,14 @@ class RoshForwardingTest < Minitest::Test
       Host grav
         LocalForward 127.0.0.1 3131 localhost 3131
         RemoteForward 8082 localhost 8082
+
+      Host grav-jump
+        HostName grav.example.com
+        ProxyJump bastion.example.com
+
+      Host grav-command
+        HostName grav.example.com
+        ProxyCommand ssh bastion.example.com -W %h:%p
     CONFIG
     ENV['HOME'] = @tmp_home
   end
@@ -47,6 +72,21 @@ class RoshForwardingTest < Minitest::Test
     assert_includes ssh_opts, '-R 8082:localhost:8082'
   end
 
+  def test_ssh_opts_include_proxy_jump_from_ssh_config
+    rosh = Rosh.new('grav-jump')
+    ssh_opts = rosh.instance_variable_get(:@ssh_opts)
+
+    assert_includes ssh_opts, '-J bastion.example.com'
+  end
+
+  def test_ssh_opts_include_proxy_command_from_ssh_config
+    rosh = Rosh.new('grav-command')
+    ssh_opts = rosh.instance_variable_get(:@ssh_opts)
+
+    expected = "-o ProxyCommand=#{Shellwords.escape('ssh bastion.example.com -W %h:%p')}"
+    assert_includes ssh_opts, expected
+  end
+
   def test_forwarding_is_skipped_when_local_port_is_in_use
     klass = Class.new(Rosh) do
       def local_forward_available?(_spec)
@@ -60,6 +100,55 @@ class RoshForwardingTest < Minitest::Test
     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
     rosh = Rosh.new('grav')
     rosh.instance_variable_set(:@verbose, true)
@@ -69,7 +158,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 +187,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 +200,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 +216,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.6
+  version: 0.9.8
 platform: ruby
 authors:
 - Genki Takiuchi
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-12-28 00:00:00.000000000 Z
+date: 2026-04-06 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