v0.17~preview.129.07+242

Author: public-release

LICENSE.md

@@ -1,6 +1,6 @@
 The MIT License
 
-Copyright (c) 2015--2023 Jane Street Group, LLC <[email protected]>
+Copyright (c) 2015--2024 Jane Street Group, LLC <[email protected]>
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

config/dune

@@ -1,3 +1,6 @@
-(library (name expect_test_config) (public_name ppx_expect.config)
+(library
+ (name expect_test_config)
+ (public_name ppx_expect.config)
  (synopsis "Default runtime configuration for ppx_expect")
- (libraries expect_test_config_types) (preprocess no_preprocessing))
+ (libraries expect_test_config_types)
+ (preprocess no_preprocessing))

config/types/dune

@@ -1,4 +1,6 @@
-(library (name expect_test_config_types)
+(library
+ (name expect_test_config_types)
  (public_name ppx_expect.config_types)
- (synopsis "Runtime configuration options for ppx_expect") (libraries)
- (preprocess no_preprocessing))
+ (synopsis "Runtime configuration options for ppx_expect")
+ (libraries)
+ (preprocess no_preprocessing))

dune-project

@@ -1 +1,3 @@
-(lang dune 1.11)
+(lang dune 2.0)
+
+(formatting disabled)

evaluator/dune

@@ -1,2 +1,6 @@
-(library (name ppx_expect_evaluator) (public_name ppx_expect.evaluator)
- (libraries) (preprocess no_preprocessing) (library_flags -linkall))
+(library
+ (name ppx_expect_evaluator)
+ (public_name ppx_expect.evaluator)
+ (libraries)
+ (preprocess no_preprocessing)
+ (library_flags -linkall))

make-corrected-file/dune

@@ -1,3 +1,5 @@
-(library (name make_corrected_file)
+(library
+ (name make_corrected_file)
  (public_name ppx_expect.make_corrected_file)
- (libraries base ppxlib.print_diff stdio) (preprocess no_preprocessing))
+ (libraries base ppxlib.print_diff stdio)
+ (preprocess no_preprocessing))

runtime/dune

@@ -1,5 +1,11 @@
-(library (name ppx_expect_runtime) (public_name ppx_expect.runtime)
+(library
+ (foreign_stubs
+  (language c)
+  (names ppx_expect_runtime_stubs))
+ (name ppx_expect_runtime)
+ (public_name ppx_expect.runtime)
  (libraries base stdio ppx_inline_test.runtime-lib make_corrected_file
-  expect_test_config)
- (c_names ppx_expect_runtime_stubs)
- (js_of_ocaml (javascript_files runtime.js)) (preprocess no_preprocessing))
+   expect_test_config)
+ (js_of_ocaml
+  (javascript_files runtime.js))
+ (preprocess no_preprocessing))

runtime/expectation.ml

@@ -36,25 +36,31 @@ let formatter
    } :
     (output, behavior) t)
   =
+  let count_leading_spaces line =
+    line |> String.to_list |> List.take_while ~f:(Char.( = ) ' ') |> List.length
+  in
   Output.Formatter.create
   @@ fun str ->
   let lines =
-    (* Whitespace splitting/stripping specifically targets ['\n'] and [' '] so that
-       unusual characters like ['\r'] and ['\t'] get displayed explicitly in
-       expectations. *)
+    (* In pretty payloads, we normalize all newlines to ['\n']. [[%expect_exact ""]]
+       can be used in cases where a user wants to inspect the whitespace produced by
+       their output more closely. *)
     let stripped =
       str
-      |> String.split ~on:'\n'
-      |> List.map ~f:(String.rstrip ~drop:(Char.equal ' '))
+      |> String.split_lines
+      |> List.map ~f:(String.rstrip ~drop:Char.is_whitespace)
       |> List.drop_while ~f:String.is_empty
       |> List.rev
       |> List.drop_while ~f:String.is_empty
       |> List.rev
     in
     let indent_and_contents =
       List.map stripped ~f:(fun line ->
-        let unindented = String.lstrip ~drop:(Char.equal ' ') line in
-        String.length line - String.length unindented, unindented)
+        (* The legacy behavior is to only count the longest prefix of actual spaces
+           ([' ']) for indentation, but to strip all whitespace (including, e.g., ['\t']).
+           Note that this means [" \t contents"] is counted as having contents
+           ["contents"] and indentation [1]. *)
+        count_leading_spaces line, String.strip line)
     in
     match
       indent_and_contents
@@ -216,23 +222,23 @@ let expect_no_uncaught_exn virtual_loc =
 module For_apply_style = struct
   let format_payload mk_node =
     Staged.stage
-    @@ fun ~expect_node_formatting ~loc tag contents ->
+    @@ fun ~expect_node_formatting ~payload_loc ~loc tag contents ->
+    let node =
+      mk_node ~payload_loc:(Some payload_loc) ({ tag; contents } : _ Payload.t) loc
+    in
     let formatted_contents =
-      Output.Formatter.apply
-        (formatter
-           ~expect_node_formatting
-           (mk_node ~payload_loc:None ({ tag; contents } : _ Payload.t) loc))
-        contents
+      Output.Formatter.apply (formatter ~expect_node_formatting node) contents
+    in
+    let node_shape =
+      match node.on_incorrect_output with
+      | T { hand = Longhand; name = _; kind = _ } -> None
+      | node_shape -> Some node_shape
     in
     match Output.reconcile ~expected_output:contents ~test_output:formatted_contents with
     | Pass -> None
     | Fail contents ->
       Some
-        (Output.to_source_code_string
-           ~expect_node_formatting
-           ~node_shape:None
-           ~tag
-           contents)
+        (Output.to_source_code_string ~expect_node_formatting ~node_shape ~tag contents)
   ;;
 
   let format_expect_payload = format_payload expect |> Staged.unstage

runtime/expectation_intf.ml

@@ -169,6 +169,7 @@ module type Expectation = sig
   module For_apply_style : sig
     type format_payload :=
       expect_node_formatting:Expect_node_formatting.t
+      -> payload_loc:Compact_loc.t
       -> loc:Compact_loc.t
       -> String_node_format.Delimiter.t
       -> string

runtime/test_block.ml

@@ -175,6 +175,7 @@ module Current_test : sig
   val current_test : unit -> Shared.t option
   val current_test_exn : unit -> Shared.t
   val iter : f:(t -> unit) -> unit
+  val assert_no_test_running : basename:string -> line_number:int -> unit
 end = struct
   type t =
     { line_number : int
@@ -194,6 +195,33 @@ end = struct
 
   let current_test_exn () = Option.value_exn (current_test ())
   let iter ~f = Option.iter !test_is_running ~f
+
+  let assert_no_test_running ~basename ~line_number =
+    iter
+      ~f:
+        (fun
+          { line_number = outer_line_number
+          ; basename = outer_basename
+          ; location = _
+          ; test_block = _
+          }
+          ->
+      let sexp_here ~basename ~line_number : Sexp.t =
+        List
+          [ List [ Atom "file"; sexp_of_string basename ]
+          ; List [ Atom "line"; sexp_of_int line_number ]
+          ]
+      in
+      raise_s
+        (Sexp.message
+           "Expect_test_runtime: reached one [let%expect_test] from another. Nesting \
+            expect\n\
+            tests is prohibited."
+           [ ( "outer_test"
+             , sexp_here ~basename:outer_basename ~line_number:outer_line_number )
+           ; "inner_test", sexp_here ~basename ~line_number
+           ]))
+  ;;
 end
 
 (* The main testing functions of a test block, which depend on configurations. *)
@@ -244,6 +272,9 @@ module Make (C : Expect_test_config_types.S) = struct
     =
     let ({ start_bol; start_pos; end_pos } : Compact_loc.t) = location in
     let basename = Stdlib.Filename.basename filename_rel_to_project_root in
+    (* Even if the current tag set indicates this test should be dropped, check that it
+       wasn't reached from another expect test *)
+    Current_test.assert_no_test_running ~basename ~line_number;
     Ppx_inline_test_lib.test
       ~config:inline_test_config
       ~descr:(lazy (Option.value description ~default:""))
@@ -290,9 +321,8 @@ module Make (C : Expect_test_config_types.S) = struct
                    ~expect_node_formatting:Expect_node_formatting.default
                    ~original_file_contents))
         in
-        (* To avoid capturing not-yet flushed data of the stdout/stderr buffers. Lifting
-            into the provided [IO] monad is required to preserve legacy behavior. *)
-        C.run (fun () -> C.IO.return (Shared.flush ()));
+        (* To avoid capturing not-yet flushed data of the stdout/stderr buffers. *)
+        Shared.flush ();
         (* Redirect stdout/stderr *)
         let test_block = Shared.set_up_block absolute_filename in
         (* Run the test *)