review

Author: joshjennings98

changes/20250801151058.bugfix

@@ -1 +1 @@
-:bug: `filsystem` IsFile should return true for special unix files not just regular files
+:bug: `filesystem` IsFile should return true for special unix files not just regular files

utils/filesystem/files.go

@@ -778,7 +778,7 @@ func (fs *VFS) IsFile(path string) (result bool, err error) {
 	if err != nil {
 		return
 	}
-	result = IsRegularFile(fi) || IsSpecialFile(fi)
+	result = IsRegularFile(fi) || IsSpecialFile(fi) // We want to treat special files as files (otherwise the only distinction is a directory which special files are not)
 	return
 }
 
@@ -789,6 +789,7 @@ func IsRegularFile(fi os.FileInfo) bool {
 	return fi.Mode().IsRegular()
 }
 
+// IsSpecialFile returns true for files that are not regular files. This includes: unix socket files, device files, and named pipes
 func IsSpecialFile(fi os.FileInfo) bool {
 	if fi == nil {
 		return false

utils/filesystem/files_test.go

@@ -556,38 +556,49 @@ func TestIsFile(t *testing.T) {
 		t.Run(fmt.Sprint(fsType), func(t *testing.T) {
 			fs := NewFs(fsType)
 
-			if fsType == InMemoryFS {
-				t.Skip("In-memory file system won't have hardware devices or special files")
-			}
+			tmpDir := t.TempDir()
 
-			b, err := fs.IsFile("/dev/null")
-			require.NoError(t, err)
-			assert.True(t, b)
+			t.Run("normal file", func(t *testing.T) {
+				filePath := filepath.Join(tmpDir, faker.Word())
+				err := fs.Touch(filePath)
+				require.NoError(t, err)
+				b, err := fs.IsFile(filePath)
+				require.NoError(t, err)
+				assert.True(t, b)
+			})
 
-			tmpDir := t.TempDir()
+			t.Run("special file", func(t *testing.T) {
+				if fsType == InMemoryFS {
+					t.Skip("In-memory file system won't have hardware devices or special files")
+				}
 
-			fifoPath := filepath.Join(tmpDir, faker.Word())
-			require.NoError(t, err)
-			defer func() { _ = fs.Rm(fifoPath) }()
-			err = unix.Mkfifo(fifoPath, 0666)
-			require.NoError(t, err)
-			b, err = fs.IsFile(fifoPath)
-			require.NoError(t, err)
-			assert.True(t, b)
-			err = fs.Rm(fifoPath)
-			require.NoError(t, err)
+				b, err := fs.IsFile("/dev/null")
+				require.NoError(t, err)
+				assert.True(t, b)
 
-			socketPath := filepath.Join(tmpDir, faker.Word())
-			require.NoError(t, err)
-			defer func() { _ = fs.Rm(socketPath) }()
-			l, err := net.Listen("unix", socketPath)
-			require.NoError(t, err)
-			defer func() { _ = l.Close() }()
-			b, err = fs.IsFile(socketPath)
-			require.NoError(t, err)
-			assert.True(t, b)
-			err = fs.Rm(socketPath)
-			require.NoError(t, err)
+				fifoPath := filepath.Join(tmpDir, faker.Word())
+				require.NoError(t, err)
+				defer func() { _ = fs.Rm(fifoPath) }()
+				err = unix.Mkfifo(fifoPath, 0666)
+				require.NoError(t, err)
+				b, err = fs.IsFile(fifoPath)
+				require.NoError(t, err)
+				assert.True(t, b)
+				err = fs.Rm(fifoPath)
+				require.NoError(t, err)
+
+				socketPath := filepath.Join(tmpDir, faker.Word())
+				require.NoError(t, err)
+				defer func() { _ = fs.Rm(socketPath) }()
+				l, err := net.Listen("unix", socketPath)
+				require.NoError(t, err)
+				defer func() { _ = l.Close() }()
+				b, err = fs.IsFile(socketPath)
+				require.NoError(t, err)
+				assert.True(t, b)
+				err = fs.Rm(socketPath)
+				require.NoError(t, err)
+			})
 		})
 	}
 }