fix: worktree when .git is symlink (#2052)

Author: arumugamramaswamy

gix/src/open/repository.rs

@@ -301,7 +301,20 @@ impl ThreadSafeRepository {
                     | gix_config::Source::EnvOverride => wt_path,
                     _ => git_dir.join(wt_path).into(),
                 };
-                worktree_dir = gix_path::normalize(wt_path, current_dir).map(Cow::into_owned);
+
+                // the reason we use realpath instead of gix_path::normalize here is because there
+                // could be any intermediate symlinks (for example due to a symlinked .git
+                // directory)
+                worktree_dir = gix_path::realpath(&wt_path).ok();
+                // restore the relative path if possible after resolving the absolute path
+                if wt_path.is_relative() {
+                    if let Ok(cwd) = std::env::current_dir() {
+                        if let Some(rel_path) = worktree_dir.as_deref().and_then(|p| p.strip_prefix(&cwd).ok()) {
+                            worktree_dir = Some(rel_path.to_path_buf());
+                        }
+                    }
+                }
+
                 #[allow(unused_variables)]
                 if let Some(worktree_path) = worktree_dir.as_deref().filter(|wtd| !wtd.is_dir()) {
                     gix_trace::warn!("The configured worktree path '{}' is not a directory or doesn't exist - `core.worktree` may be misleading", worktree_path.display());

gix/tests/fixtures/make_submodules.sh

@@ -151,4 +151,18 @@ git clone with-submodules not-a-submodule
   git add m1 && git commit -m "no submodule in index and commit, but in configuration"
 )
 
-git init unborn
+git init unborn
+
+mkdir symlinked-git-dir
+(cd symlinked-git-dir
+  git init -q r1
+  (cd r1
+    git commit -q --allow-empty -m "init"
+  )
+
+  git config -f r1/.git/config core.worktree `pwd`
+  ln -s r1/.git .git
+
+  git -c protocol.file.allow=always submodule add ../module1 m1
+  git commit -m "add module 1"
+)

gix/tests/gix/status.rs

@@ -310,6 +310,22 @@ mod index_worktree {
             );
         }
 
+        #[test]
+        fn submodule_in_symlinked_dir() -> crate::Result {
+            let repo = submodule_repo("symlinked-git-dir")?;
+            let status = repo
+                .status(gix::progress::Discard)?
+                .index_worktree_options_mut(|opts| {
+                    opts.sorting =
+                        Some(gix::status::plumbing::index_as_worktree_with_renames::Sorting::ByPathCaseSensitive);
+                })
+                .into_index_worktree_iter(None)?;
+            for change in status {
+                change?;
+            }
+            Ok(())
+        }
+
         #[test]
         fn submodule_modification() -> crate::Result {
             let repo = submodule_repo("modified-untracked-and-submodule-head-changed-and-modified")?;