Make Git::Base#ls_tree handle commit objects (ruby-git#643)

jcouball · web-flow · commit a79935e6459e · 2023-03-04T14:09:23.000-08:00
Signed-off-by: James Couball &lt;jcouball@yahoo.com&gt;
diff --git a/lib/git/lib.rb b/lib/git/lib.rb
@@ -338,7 +338,7 @@ def object_contents(sha, &block)
     end
 
     def ls_tree(sha)
-      data = {'blob' => {}, 'tree' => {}}
+      data = { 'blob' => {}, 'tree' => {}, 'commit' => {} }
 
       command_lines('ls-tree', sha).each do |line|
         (info, filenm) = line.split("\t")
diff --git a/tests/test_helper.rb b/tests/test_helper.rb
@@ -170,4 +170,9 @@ def assert_command_line(expected_command_line, git_cmd, git_cmd_args)
 
     assert_equal(expected_command_line, actual_command_line)
   end
+
+  def assert_child_process_success(&block)
+    yield
+    assert_equal 0, $CHILD_STATUS.exitstatus, "Child process failed with exitstatus #{$CHILD_STATUS.exitstatus}"
+  end
 end
diff --git a/tests/units/test_ls_tree.rb b/tests/units/test_ls_tree.rb
@@ -0,0 +1,31 @@
+require 'test_helper'
+
+class TestLsTree < Test::Unit::TestCase
+  def test_ls_tree_with_submodules
+    in_temp_dir do
+      submodule = Git.init('submodule', initial_branch: 'main')
+      File.write('submodule/README.md', '# Submodule')
+      submodule.add('README.md')
+      submodule.commit('Add README.md')
+
+      repo = Git.init('repo', initial_branch: 'main')
+      File.write('repo/README.md', '# Main Repository')
+      repo.add('README.md')
+      repo.commit('Add README.md')
+
+      Dir.chdir('repo') do
+        assert_child_process_success { `git -c protocol.file.allow=always submodule add ../submodule submodule 2>&1` }
+        assert_child_process_success { `git commit -am "Add submodule" 2>&1` }
+      end
+
+      expected_submodule_sha = submodule.object('HEAD').sha
+
+      # Make sure the ls_tree command can handle submodules (which show up as a commit object in the tree)
+      tree = assert_nothing_raised { repo.ls_tree('HEAD') }
+      actual_submodule_sha = tree.dig('commit', 'submodule', :sha)
+
+      # Make sure the submodule commit was parsed correctly
+      assert_equal(expected_submodule_sha, actual_submodule_sha, 'Submodule SHA was not returned')
+    end
+  end
+end
