fix(subst): ignore broken symlinks

Fixes ocaml#9593 Signed-off-by: Etienne Millon <[email protected]>
emillon · Jan 23, 2024 · d04f6bf · d04f6bf
1 parent 7f770e0
commit d04f6bf
Show file tree

Hide file tree

Showing 3 changed files with 28 additions and 19 deletions.
diff --git a/bin/subst.ml b/bin/subst.ml
@@ -1,24 +1,33 @@
 open Import
 
-let is_a_source_file path =
-  (match Path.extension path with
-   | ".flv"
-   | ".gif"
-   | ".ico"
-   | ".jpeg"
-   | ".jpg"
-   | ".mov"
-   | ".mp3"
-   | ".mp4"
-   | ".otf"
-   | ".pdf"
-   | ".png"
-   | ".ttf"
-   | ".woff" -> false
-   | _ -> true)
-  && (Path.stat_exn path).st_kind = Unix.S_REG
+let is_path_a_source_file path =
+  match Path.extension path with
+  | ".flv"
+  | ".gif"
+  | ".ico"
+  | ".jpeg"
+  | ".jpg"
+  | ".mov"
+  | ".mp3"
+  | ".mp4"
+  | ".otf"
+  | ".pdf"
+  | ".png"
+  | ".ttf"
+  | ".woff" -> false
+  | _ -> true
 ;;
 
+let is_kind_a_source_file path =
+  match Path.stat_exn path with
+  | st -> st.st_kind = Unix.S_REG
+  | exception Unix.Unix_error (ENOENT, "stat", _) ->
+    (* broken symlink *)
+    false
+;;
+
+let is_a_source_file path = is_path_a_source_file path && is_kind_a_source_file path
+
 let subst_string s path ~map =
   let len = String.length s in
   let longest_var = String.longest (String.Map.keys map) in

diff --git a/doc/changes/9810.md b/doc/changes/9810.md
@@ -0,0 +1,2 @@
+- subst: ignore broken symlinks when looking at source files
+(#9810, fixes #9593, @emillon)
diff --git a/test/blackbox-tests/test-cases/subst/broken-symlink.t b/test/blackbox-tests/test-cases/subst/broken-symlink.t
@@ -19,5 +19,3 @@ This test requires a git repository, otherwise `dune subst` does nothing.
    create mode 100644 dune-project
 
   $ dune subst
-  Error: stat(broken): No such file or directory
-  [1]
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		- subst: ignore broken symlinks when looking at source files
		(#9810, fixes #9593, @emillon)