cram: add location for conflict markers (#12720)

Signed-off-by: Ali Caglayan <[email protected]>

Author: Alizter

src/dune_rules/cram/cram_exec.ml

@@ -40,20 +40,29 @@ let quote_for_sh fn =
     Buffer.contents buf
 ;;
 
+let map_loc_to_source_path loc =
+  Loc.map_pos loc ~f:(fun (pos : Lexing.position) ->
+    { pos with
+      pos_fname =
+        Path.of_string pos.pos_fname
+        |> Path.drop_optional_build_context_maybe_sandboxed
+        |> Path.to_string
+    })
+;;
+
 let cram_stanzas =
   let is_conflict_marker line =
     [ "======="; "%%%%%%%"; "+++++++"; "-------"; "|||||||" ]
     |> List.exists ~f:(fun prefix -> String.is_prefix line ~prefix)
   in
-  let find_conflict state line =
+  let find_conflict ~loc state line =
     match state with
-    | `No_conflict when String.is_prefix ~prefix:"<<<<<<<" line -> `Started
-    | `Started when is_conflict_marker line -> `Has_markers
-    | `Has_markers when is_conflict_marker line -> `Has_markers
-    | `Has_markers when String.is_prefix ~prefix:">>>>>>>" line ->
-      (* CR-someday rgrinberg for alizter: insert a location spanning the
-         entire once we start extracting it *)
+    | `No_conflict when String.is_prefix ~prefix:"<<<<<<<" line -> `Started loc
+    | `Started loc when is_conflict_marker line -> `Has_markers loc
+    | `Has_markers loc when is_conflict_marker line -> `Has_markers loc
+    | `Has_markers start_loc when String.is_prefix ~prefix:">>>>>>>" line ->
       User_error.raise
+        ~loc:(Loc.span start_loc loc)
         [ Pp.text
             "Conflict marker found. Please remove it or set (conflict_markers allow)"
         ]
@@ -64,13 +73,14 @@ let cram_stanzas =
       match Cram_lexer.block lexbuf with
       | None -> List.rev acc
       | Some (loc, block) ->
+        let loc = map_loc_to_source_path loc in
         let conflict_state =
           match block with
           | Command _ -> conflict_state
           | Comment lines ->
             (match conflict_markers with
              | Ignore -> conflict_state
-             | Error -> List.fold_left lines ~init:conflict_state ~f:find_conflict)
+             | Error -> List.fold_left lines ~init:conflict_state ~f:(find_conflict ~loc))
         in
         loop ((loc, block) :: acc) conflict_state
     in

test/blackbox-tests/test-cases/cram/conflict-markers-diff3.t

@@ -22,11 +22,17 @@ Full diff3 conflict without command and output interleaving:
   > EOF
 
   $ dune runtest test.t
+  File "test.t", lines 1-8, characters 0-73:
+  1 | <<<<<<<
+  2 | Left side
+  3 | |||||||
+  4 | Original
+  5 | =======
+  6 | Right side
+  7 | >>>>>>>
+  8 | $ echo tada
   Error: Conflict marker found. Please remove it or set (conflict_markers
   allow)
-  -> required by _build/default/.cram.test.t/cram.sh
-  -> required by _build/default/.cram.test.t/cram.out
-  -> required by alias test
   [1]
 
 Full diff3 conflict with command and output interleaving:
@@ -43,11 +49,17 @@ Full diff3 conflict with command and output interleaving:
   > EOF
 
   $ dune runtest test.t
+  File "test.t", lines 1-8, characters 0-87:
+  1 | <<<<<<<
+  2 |   $ foo left
+  3 | |||||||
+  4 |   $ foo original
+  5 | =======
+  6 |   > bar right
+  7 | >>>>>>>
+  8 | $ echo tada
   Error: Conflict marker found. Please remove it or set (conflict_markers
   allow)
-  -> required by _build/default/.cram.test.t/cram.sh
-  -> required by _build/default/.cram.test.t/cram.out
-  -> required by alias test
   [1]
 
 Partial diff3 conflicts are ignored:

test/blackbox-tests/test-cases/cram/conflict-markers-jj.t

@@ -20,11 +20,15 @@ Full jujutsu conflict without command and output interleaving:
   > EOF
 
   $ dune runtest test.t
+  File "test.t", lines 1-6, characters 0-89:
+  1 | <<<<<<< Conflict 1 of 2
+  2 | A Small
+  3 | %%%%%%%
+  4 | Conflict
+  5 | >>>>>>> Conflict 1 of 2 ends
+  6 | $ echo tada
   Error: Conflict marker found. Please remove it or set (conflict_markers
   allow)
-  -> required by _build/default/.cram.test.t/cram.sh
-  -> required by _build/default/.cram.test.t/cram.out
-  -> required by alias test
   [1]
 
 Full jujutsu conflict with command and output interleaving:
@@ -39,11 +43,15 @@ Full jujutsu conflict with command and output interleaving:
   > EOF
 
   $ dune runtest test.t
+  File "test.t", lines 1-6, characters 0-88:
+  1 | <<<<<<< Conflict 2 of 2
+  2 |   $ foo
+  3 | %%%%%%%
+  4 |   > bar
+  5 | >>>>>>> Conflict 2 of 2 ends
+  6 | $ echo tada
   Error: Conflict marker found. Please remove it or set (conflict_markers
   allow)
-  -> required by _build/default/.cram.test.t/cram.sh
-  -> required by _build/default/.cram.test.t/cram.out
-  -> required by alias test
   [1]
 
 Jujutsu default style conflict (diff + snapshot):
@@ -61,11 +69,18 @@ Jujutsu default style conflict (diff + snapshot):
   > EOF
 
   $ dune runtest test.t
+  File "test.t", lines 1-9, characters 0-160:
+  1 | <<<<<<< Conflict 1 of 1
+  2 | %%%%%%% Changes from base to side #1
+  3 | -apple
+  4 | +grapefruit
+  5 | +++++++ Contents of side #2
+  6 | APPLE
+  7 | GRAPE
+  8 | >>>>>>> Conflict 1 of 1 ends
+  9 | $ echo tada
   Error: Conflict marker found. Please remove it or set (conflict_markers
   allow)
-  -> required by _build/default/.cram.test.t/cram.sh
-  -> required by _build/default/.cram.test.t/cram.out
-  -> required by alias test
   [1]
 
 Jujutsu snapshot style conflict:
@@ -83,11 +98,18 @@ Jujutsu snapshot style conflict:
   > EOF
 
   $ dune runtest test.t
+  File "test.t", lines 1-9, characters 0-175:
+  1 | <<<<<<< Conflict 1 of 1
+  2 | +++++++ Contents of side #1
+  3 | Left side
+  4 | ------- Contents of base
+  5 | Original
+  6 | +++++++ Contents of side #2
+  7 | Right side
+  8 | >>>>>>> Conflict 1 of 1 ends
+  9 | $ echo tada
   Error: Conflict marker found. Please remove it or set (conflict_markers
   allow)
-  -> required by _build/default/.cram.test.t/cram.sh
-  -> required by _build/default/.cram.test.t/cram.out
-  -> required by alias test
   [1]
 
 Partial jujutsu conflicts are ignored:

test/blackbox-tests/test-cases/cram/conflict-markers.t

@@ -20,11 +20,15 @@ Full conflict without command and output interleaving:
   > EOF
 
   $ dune runtest test.t
+  File "test.t", lines 1-6, characters 0-52:
+  1 | <<<<<<<
+  2 | A Small
+  3 | =======
+  4 | Conflict
+  5 | >>>>>>>
+  6 | $ echo tada
   Error: Conflict marker found. Please remove it or set (conflict_markers
   allow)
-  -> required by _build/default/.cram.test.t/cram.sh
-  -> required by _build/default/.cram.test.t/cram.out
-  -> required by alias test
   [1]
 
 Full conflict with command and output interleaving:
@@ -39,11 +43,15 @@ Full conflict with command and output interleaving:
   > EOF
 
   $ dune runtest test.t
+  File "test.t", lines 1-6, characters 0-51:
+  1 | <<<<<<<
+  2 |   $ foo
+  3 | =======
+  4 |   > bar
+  5 | >>>>>>>
+  6 | $ echo tada
   Error: Conflict marker found. Please remove it or set (conflict_markers
   allow)
-  -> required by _build/default/.cram.test.t/cram.sh
-  -> required by _build/default/.cram.test.t/cram.out
-  -> required by alias test
   [1]
 
 Partial conflicts are ignored: