test: verify that command line envionment variables are set as expected

jcouball · jcouball · commit b060e479b7eb · 2025-02-27T17:25:19.000-08:00
diff --git a/lib/git/lib.rb b/lib/git/lib.rb
@@ -1547,7 +1547,7 @@ def env_overrides
         'GIT_DIR' => @git_dir,
         'GIT_WORK_TREE' => @git_work_dir,
         'GIT_INDEX_FILE' => @git_index_file,
-        'GIT_SSH' => Git::Base.config.git_ssh
+        'GIT_SSH' => Git::Base.config.git_ssh,
       }
     end
 
diff --git a/tests/test_helper.rb b/tests/test_helper.rb
@@ -131,7 +131,7 @@ def append_file(name, contents)
   #
   # @return [void]
   #
-  def assert_command_line_eq(expected_command_line, method: :command, mocked_output: nil)
+  def assert_command_line_eq(expected_command_line, method: :command, mocked_output: nil, include_env: false)
     actual_command_line = nil
 
     command_output = ''
@@ -140,7 +140,11 @@ def assert_command_line_eq(expected_command_line, method: :command, mocked_outpu
       git = Git.init('test_project')
 
       git.lib.define_singleton_method(method) do |*cmd, **opts, &block|
-        actual_command_line = [*cmd, opts]
+        if include_env
+          actual_command_line = [env_overrides, *cmd, opts]
+        else
+          actual_command_line = [*cmd, opts]
+        end
         mocked_output
       end
 
@@ -149,6 +153,8 @@ def assert_command_line_eq(expected_command_line, method: :command, mocked_outpu
       end
     end
 
+    expected_command_line = expected_command_line.call if expected_command_line.is_a?(Proc)
+
     assert_equal(expected_command_line, actual_command_line)
 
     command_output
diff --git a/tests/units/test_command_line_env_overrides.rb b/tests/units/test_command_line_env_overrides.rb
@@ -0,0 +1,48 @@
+
+# frozen_string_literal: true
+
+require 'test_helper'
+
+class TestCommandLineEnvOverrides < Test::Unit::TestCase
+  test 'it should set the expected environment variables' do
+    expected_command_line = nil
+    expected_command_line_proc = ->{ expected_command_line }
+    assert_command_line_eq(expected_command_line_proc, include_env: true) do |git|
+      expected_env = {
+        'GIT_DIR' => git.lib.git_dir,
+        'GIT_INDEX_FILE' => git.lib.git_index_file,
+        'GIT_SSH' => nil,
+        'GIT_WORK_TREE' => git.lib.git_work_dir
+      }
+      expected_command_line = [expected_env, 'checkout', {}]
+
+      git.checkout
+    end
+  end
+
+  test 'it should set the GIT_SSH environment variable from Git::Base.config.git_ssh' do
+    expected_command_line = nil
+    expected_command_line_proc = ->{ expected_command_line }
+
+    saved_git_ssh = Git::Base.config.git_ssh
+    begin
+      Git::Base.config.git_ssh = 'ssh -i /path/to/key'
+
+      assert_command_line_eq(expected_command_line_proc, include_env: true) do |git|
+        # Set the expected command line
+
+        expected_env = {
+          'GIT_DIR' => git.lib.git_dir,
+          'GIT_INDEX_FILE' => git.lib.git_index_file,
+          'GIT_SSH' => 'ssh -i /path/to/key',
+          'GIT_WORK_TREE' => git.lib.git_work_dir
+        }
+
+        expected_command_line = [expected_env, 'checkout', {}]
+        git.checkout
+      end
+    ensure
+      Git::Base.config.git_ssh = saved_git_ssh
+    end
+  end
+end

Original file line number	Diff line number	Diff line change
`@@ -1547,7 +1547,7 @@ def env_overrides`
`1547`	`1547`	`'GIT_DIR' => @git_dir,`
`1548`	`1548`	`'GIT_WORK_TREE' => @git_work_dir,`
`1549`	`1549`	`'GIT_INDEX_FILE' => @git_index_file,`
`1550`		`- 'GIT_SSH' => Git::Base.config.git_ssh`
	`1550`	`+ 'GIT_SSH' => Git::Base.config.git_ssh,`
`1551`	`1551`	`}`
`1552`	`1552`	`end`
`1553`	`1553`