fix: status retrieval now deals with non-file entries by ignoring them when possible.

Author: Byron

gix-status/src/index_as_worktree/types.rs

@@ -103,7 +103,12 @@ impl Outcome {
 pub enum Change<T = (), U = ()> {
     /// This corresponding file does not exist in the worktree anymore.
     Removed,
-    /// The type of file changed compared to the worktree, i.e. a symlink s now a file.
+    /// The type of file changed compared to the worktree, i.e. a symlink is now a file, or a file was replaced with a named pipe.
+    ///
+    /// ### Deviation
+    ///
+    /// A change to a non-file is marked as `modification` in Git, but that's related to the content which we can't evaluate.
+    /// Hence, a type-change is considered more appropriate.
     Type,
     /// This worktree file was modified in some form, like a permission change or content change or both,
     /// as compared to this entry.

gix-status/src/index_as_worktree_with_renames/mod.rs

@@ -387,8 +387,11 @@ pub(super) mod function {
 
         impl<T, U> gix_dir::walk::Delegate for Delegate<'_, '_, T, U> {
             fn emit(&mut self, entry: EntryRef<'_>, collapsed_directory_status: Option<Status>) -> Action {
-                let entry = entry.to_owned();
-                self.tx.send(Event::DirEntry(entry, collapsed_directory_status)).ok();
+                // Status never shows untracked non-files
+                if entry.disk_kind != Some(gix_dir::entry::Kind::NonFile) {
+                    let entry = entry.to_owned();
+                    self.tx.send(Event::DirEntry(entry, collapsed_directory_status)).ok();
+                }
 
                 if self.should_interrupt.load(Ordering::Relaxed) {
                     Action::Cancel

gix-status/tests/Cargo.toml

@@ -12,8 +12,8 @@ publish = false
 rust-version = "1.65"
 
 [[test]]
-name = "worktree"
-path = "worktree.rs"
+name = "status"
+path = "status/mod.rs"
 
 [features]
 gix-features-parallel = ["gix-features/parallel"]

gix-status/tests/fixtures/generated-archives/.gitignore

@@ -1,3 +1,4 @@
 status_unchanged.tar
 status_changed.tar
 symlink_stack.tar
+status_nonfile.tar

gix-status/tests/fixtures/status_nonfile.sh

@@ -0,0 +1,19 @@
+#!/usr/bin/env bash
+set -eu -o pipefail
+
+git init -q untracked
+(cd untracked
+  touch file && git add file && git commit -m "just to get an index for the test-suite"
+
+  mkfifo pipe
+  git status
+)
+
+git init -q tracked-swapped
+(cd tracked-swapped
+  touch file && git add file && git commit -m "it starts out as trackable file"
+
+  rm file && mkfifo file
+  git status
+)
+

gix-status/tests/status/index_as_worktree.rs

@@ -37,6 +37,10 @@ fn fixture(name: &str, expected_status: &[Expectation<'_>]) -> Outcome {
     fixture_filtered(name, &[], expected_status)
 }
 
+fn nonfile_fixture(name: &str, expected_status: &[Expectation<'_>]) -> Outcome {
+    fixture_filtered_detailed("status_nonfile", name, &[], expected_status, |_| {}, false)
+}
+
 fn fixture_with_index(
     name: &str,
     prepare_index: impl FnMut(&mut gix_index::State),
@@ -185,6 +189,19 @@ fn status_removed() -> EntryStatus {
     Change::Removed.into()
 }
 
+#[test]
+#[cfg(unix)]
+fn nonfile_untracked_are_not_visible() {
+    // And generally, untracked aren't visible here.
+    nonfile_fixture("untracked", &[]);
+}
+
+#[test]
+#[cfg(unix)]
+fn tracked_changed_to_non_file() {
+    nonfile_fixture("tracked-swapped", &[(BStr::new(b"file"), 0, Change::Type.into())]);
+}
+
 #[test]
 fn removed() {
     let out = fixture(

gix-status/tests/status/index_as_worktree_with_renames.rs

@@ -1,4 +1,4 @@
-use crate::status::fixture_path;
+use crate::fixture_path;
 use bstr::ByteSlice;
 use gix_diff::blob::pipeline::WorktreeRoots;
 use gix_diff::rewrites::CopySource;
@@ -83,6 +83,7 @@ fn changed_and_untracked_and_renamed() {
         track_empty: true,
     };
     let out = fixture_filtered_detailed(
+        "status_many.sh",
         "changed-and-untracked-and-renamed",
         &[],
         &expectations_with_dirwalk,
@@ -100,9 +101,38 @@ fn changed_and_untracked_and_renamed() {
     );
 }
 
+#[test]
+#[cfg(unix)]
+fn nonfile_untracked_are_not_visible() {
+    fixture_filtered_detailed(
+        "status_nonfile.sh",
+        "untracked",
+        &[],
+        &[],
+        None,
+        Some(Default::default()),
+    );
+}
+
+#[test]
+#[cfg(unix)]
+fn tracked_changed_to_non_file() {
+    fixture_filtered_detailed(
+        "status_nonfile.sh",
+        "tracked-swapped",
+        &[],
+        &[Expectation::Modification {
+            rela_path: "file",
+            status: Change::Type.into(),
+        }],
+        None,
+        Some(Default::default()),
+    );
+}
 #[test]
 fn changed_and_untracked() {
     let out = fixture_filtered_detailed(
+        "status_many.sh",
         "changed-and-untracked",
         &[],
         &[Expectation::Modification {
@@ -144,6 +174,7 @@ fn changed_and_untracked() {
         },
     ];
     let out = fixture_filtered_detailed(
+        "status_many.sh",
         "changed-and-untracked",
         &[],
         &expectations_with_dirwalk,
@@ -163,6 +194,7 @@ fn changed_and_untracked() {
     assert_eq!(out.rewrites, None, "rewrites are still not configured");
 
     let out = fixture_filtered_detailed(
+        "status_many.sh",
         "changed-and-untracked",
         &[],
         &expectations_with_dirwalk,
@@ -179,6 +211,7 @@ fn changed_and_untracked() {
 }
 
 fn fixture_filtered_detailed(
+    script: &str,
     subdir: &str,
     pathspecs: &[&str],
     expected: &[Expectation<'_>],
@@ -193,11 +226,11 @@ fn fixture_filtered_detailed(
         out
     }
 
-    let worktree = fixture_path("status_many.sh").join(subdir);
+    let worktree = fixture_path(script).join(subdir);
     let git_dir = worktree.join(".git");
     let index = gix_index::File::at(git_dir.join("index"), gix_hash::Kind::Sha1, false, Default::default()).unwrap();
     let search = gix_pathspec::Search::from_specs(
-        crate::status::index_as_worktree::to_pathspecs(pathspecs),
+        crate::index_as_worktree::to_pathspecs(pathspecs),
         None,
         std::path::Path::new(""),
     )
@@ -247,7 +280,7 @@ fn fixture_filtered_detailed(
         object_hash: gix_hash::Kind::Sha1,
         tracked_file_modifications: gix_status::index_as_worktree::Options {
             fs: capabilities,
-            stat: crate::status::index_as_worktree::TEST_OPTIONS,
+            stat: crate::index_as_worktree::TEST_OPTIONS,
             ..Default::default()
         },
         dirwalk,
@@ -262,7 +295,7 @@ fn fixture_filtered_detailed(
         &worktree,
         &mut recorder,
         FastEq,
-        crate::status::index_as_worktree::SubmoduleStatusMock { dirty: false },
+        crate::index_as_worktree::SubmoduleStatusMock { dirty: false },
         objects,
         &mut gix_features::progress::Discard,
         context,

gix-status/tests/status/mod.rs

@@ -1,6 +1,10 @@
+pub use gix_testtools::Result;
+
 mod index_as_worktree;
 mod index_as_worktree_with_renames;
 
+mod stack;
+
 pub fn fixture_path(name: &str) -> std::path::PathBuf {
     let dir = gix_testtools::scripted_fixture_read_only_standalone(std::path::Path::new(name).with_extension("sh"))
         .expect("script works");