Fix doctest lines when compilation fails, closes #12607

Author: josevalim

lib/ex_unit/lib/ex_unit/doc_test.ex

@@ -376,13 +376,13 @@ defmodule ExUnit.DocTest do
     end) > 1
   end
 
-  defp test_case_content(expr, :test, location, stack, doctest) do
-    string_to_quoted(location, stack, expr, doctest) |> insert_assertions()
+  defp test_case_content(expr_lines, :test, location, stack, doctest) do
+    string_to_quoted(location, stack, expr_lines, doctest) |> insert_assertions()
   end
 
-  defp test_case_content(expr, {:test, expected}, location, stack, doctest) do
-    expr_ast = string_to_quoted(location, stack, expr, doctest) |> insert_assertions()
-    expected_ast = string_to_quoted(location, stack, expected, doctest)
+  defp test_case_content(expr_lines, {:test, expected}, location, stack, doctest) do
+    expr_ast = string_to_quoted(location, stack, expr_lines, doctest) |> insert_assertions()
+    expected_ast = string_to_quoted(update_line(location, expr_lines), stack, expected, doctest)
     last_expr = Macro.to_string(last_expr(expr_ast))
 
     quote do
@@ -397,8 +397,8 @@ defmodule ExUnit.DocTest do
     end
   end
 
-  defp test_case_content(expr, {:inspect, expected}, location, stack, doctest) do
-    expr_ast = string_to_quoted(location, stack, expr, doctest) |> insert_assertions()
+  defp test_case_content(expr_lines, {:inspect, expected}, location, stack, doctest) do
+    expr_ast = string_to_quoted(location, stack, expr_lines, doctest) |> insert_assertions()
     last_expr = Macro.to_string(last_expr(expr_ast))
 
     quote do
@@ -425,6 +425,10 @@ defmodule ExUnit.DocTest do
     end
   end
 
+  defp update_line(location, lines) do
+    Keyword.replace_lazy(location, :line, & &1 + length(lines))
+  end
+
   @doc false
   def __test__(value, expected, doctest, last_expr, expected_expr, stack) do
     case value do
@@ -510,7 +514,7 @@ defmodule ExUnit.DocTest do
 
   defp string_to_quoted(location, stack, expr, doctest) do
     try do
-      Code.string_to_quoted!(expr, location)
+      Code.string_to_quoted!(IO.iodata_to_binary(expr), location)
     rescue
       e ->
         ex_message = "(#{inspect(e.__struct__)}) #{Exception.message(e)}"
@@ -591,12 +595,6 @@ defmodule ExUnit.DocTest do
   defp extract_from_doc(_doc, _module),
     do: []
 
-  defp extract_tests(line_no, doc, module) do
-    all_lines = String.split(doc, ["\r\n", "\n"], trim: false)
-    lines = adjust_indent(all_lines, line_no + 1, module)
-    extract_tests(lines, "", "", [], true, module, "")
-  end
-
   @iex_prompt ["iex>", "iex("]
   @dot_prompt ["...>", "...("]
 
@@ -696,13 +694,19 @@ defmodule ExUnit.DocTest do
 
   @fences ["```", "~~~"]
 
+  defp extract_tests(line_no, doc, module) do
+    all_lines = String.split(doc, ["\r\n", "\n"], trim: false)
+    lines = adjust_indent(all_lines, line_no + 1, module)
+    extract_tests(lines, [], [], [], true, module, [])
+  end
+
   defp extract_tests(lines, expr_acc, expected_acc, acc, new_test, module, formatted)
 
-  defp extract_tests([], "", "", [], _, _, _) do
+  defp extract_tests([], [], [], [], _, _, _) do
     []
   end
 
-  defp extract_tests([], "", "", acc, _, _, _) do
+  defp extract_tests([], [], [], acc, _, _, _) do
     Enum.reverse(acc)
   end
 
@@ -722,36 +726,36 @@ defmodule ExUnit.DocTest do
          module,
          formatted
        )
-       when expr_acc != "" and expected_acc != "" do
+       when expr_acc != [] and expected_acc != [] do
     test = add_expr(test, expr_acc, expected_acc, formatted)
-    extract_tests(list, "", "", [test | rest], new_test, module, "")
+    extract_tests(list, [], [], [test | rest], new_test, module, [])
   end
 
   # Store expr_acc and start a new test case.
   defp extract_tests(
          [{"iex>" <> string = line, line_no} | lines],
-         "",
+         [],
          expected_acc,
          acc,
          true,
          module,
          _
        ) do
     test = %{line: line_no, fun_arity: nil, exprs: []}
-    extract_tests(lines, string, expected_acc, [test | acc], false, module, line)
+    extract_tests(lines, [string], expected_acc, [test | acc], false, module, line)
   end
 
   # Store expr_acc.
   defp extract_tests(
          [{"iex>" <> string = line, _} | lines],
-         "",
+         [],
          expected_acc,
          acc,
          false,
          module,
          _
        ) do
-    extract_tests(lines, string, expected_acc, acc, false, module, line)
+    extract_tests(lines, [string], expected_acc, acc, false, module, line)
   end
 
   # Still gathering expr_acc. Synonym for the next clause.
@@ -764,15 +768,9 @@ defmodule ExUnit.DocTest do
          module,
          formatted
        ) do
-    extract_tests(
-      lines,
-      expr_acc <> "\n" <> string,
-      expected_acc,
-      acc,
-      new_test,
-      module,
-      formatted <> "\n" <> line
-    )
+    expr_acc = add_line(expr_acc, string)
+    formatted = add_line(formatted, line)
+    extract_tests(lines, expr_acc, expected_acc, acc, new_test, module, formatted)
   end
 
   # Still gathering expr_acc. Synonym for the previous clause.
@@ -785,16 +783,10 @@ defmodule ExUnit.DocTest do
          module,
          formatted
        )
-       when expr_acc != "" do
-    extract_tests(
-      lines,
-      expr_acc <> "\n" <> string,
-      expected_acc,
-      acc,
-      new_test,
-      module,
-      formatted <> "\n" <> line
-    )
+       when expr_acc != [] do
+    expr_acc = add_line(expr_acc, string)
+    formatted = add_line(formatted, line)
+    extract_tests(lines, expr_acc, expected_acc, acc, new_test, module, formatted)
   end
 
   # Expression numbers are simply skipped.
@@ -826,8 +818,8 @@ defmodule ExUnit.DocTest do
   end
 
   # Skip empty or documentation line.
-  defp extract_tests([_ | lines], "", "", acc, _, module, _formatted) do
-    extract_tests(lines, "", "", acc, true, module, "")
+  defp extract_tests([_ | lines], [], [], acc, _, module, _formatted) do
+    extract_tests(lines, [], [], acc, true, module, [])
   end
 
   # Encountered end of fenced code block, store pending test
@@ -840,9 +832,9 @@ defmodule ExUnit.DocTest do
          module,
          formatted
        )
-       when fence in @fences and expr_acc != "" do
+       when fence in @fences and expr_acc != [] do
     test = add_expr(test, expr_acc, expected_acc, formatted)
-    extract_tests(lines, "", "", [test | rest], true, module, "")
+    extract_tests(lines, [], [], [test | rest], true, module, [])
   end
 
   # Encountered an empty line, store pending test
@@ -856,11 +848,11 @@ defmodule ExUnit.DocTest do
          formatted
        ) do
     test = add_expr(test, expr_acc, expected_acc, formatted)
-    extract_tests(lines, "", "", [test | rest], true, module, "")
+    extract_tests(lines, [], [], [test | rest], true, module, [])
   end
 
   # Finally, parse expected_acc.
-  defp extract_tests([{expected, _} | lines], expr_acc, "", acc, new_test, module, formatted) do
+  defp extract_tests([{expected, _} | lines], expr_acc, [], acc, new_test, module, formatted) do
     extract_tests(lines, expr_acc, expected, acc, new_test, module, formatted)
   end
 
@@ -873,15 +865,12 @@ defmodule ExUnit.DocTest do
          module,
          formatted
        ) do
-    extract_tests(
-      lines,
-      expr_acc,
-      expected_acc <> "\n" <> expected,
-      acc,
-      new_test,
-      module,
-      formatted
-    )
+    expected_acc = add_line(expected_acc, expected)
+    extract_tests(lines, expr_acc, expected_acc, acc, new_test, module, formatted)
+  end
+
+  defp add_line(acc, line) do
+    [acc, [?\n, line]]
   end
 
   defp skip_iex_number(")>" <> string, _module, _line_no, _line) do
@@ -903,13 +892,14 @@ defmodule ExUnit.DocTest do
     %{test | fun_arity: fa, exprs: Enum.reverse(exprs)}
   end
 
-  defp add_expr(%{exprs: exprs} = test, expr, expected, formatted) do
-    doctest = "\n" <> formatted <> "\n" <> expected
-    %{test | exprs: [{expr, tag_expected(expected), doctest} | exprs]}
+  defp add_expr(%{exprs: exprs} = test, expr_lines, expected_lines, formatted_lines) do
+    expected = IO.iodata_to_binary(expected_lines)
+    doctest = IO.iodata_to_binary([?\n, formatted_lines, ?\n, expected])
+    %{test | exprs: [{expr_lines, tag_expected(expected), doctest} | exprs]}
   end
 
-  defp tag_expected(string) do
-    case string do
+  defp tag_expected(expected) do
+    case expected do
       "" ->
         :test
 
@@ -918,10 +908,10 @@ defmodule ExUnit.DocTest do
         {:error, Module.concat([mod]), String.trim_leading(message)}
 
       _ ->
-        if inspectable?(string) do
-          {:inspect, string}
+        if inspectable?(expected) do
+          {:inspect, expected}
         else
-          {:test, string}
+          {:test, expected}
         end
     end
   end

lib/ex_unit/test/ex_unit/doc_test_test.exs

@@ -232,6 +232,13 @@ defmodule ExUnit.DocTestTest.Invalid do
       1
   """
   @type t :: any()
+
+  @doc """
+      iex> :foo
+      iex> :bar
+      1 + * 1
+  """
+  def result, do: :ok
 end
 |> ExUnit.BeamHelpers.write_beam()
 
@@ -630,6 +637,8 @@ defmodule ExUnit.DocTestTest do
 
     assert output =~
              "test/ex_unit/doc_test_test.exs:#{starting_line + 28}: ExUnit.DocTestTest.Failure (module)"
+
+    assert output =~ "8 doctests, 8 failures"
   end
 
   test "doctest invalid" do
@@ -678,10 +687,10 @@ defmodule ExUnit.DocTestTest do
     assert output =~ """
              3) doctest ExUnit.DocTestTest.Invalid.indented_not_enough/0 (3) (ExUnit.DocTestTest.InvalidCompiled)
                 test/ex_unit/doc_test_test.exs:#{doctest_line}
-                Doctest did not compile, got: (SyntaxError) test/ex_unit/doc_test_test.exs:#{starting_line + 14}:1: unexpected token: "`" (column 1, code point U+0060)
-                 #{line_placeholder(starting_line + 14)} |
-                 #{starting_line + 14} | `
-                 #{line_placeholder(starting_line + 14)} | ^
+                Doctest did not compile, got: (SyntaxError) test/ex_unit/doc_test_test.exs:#{starting_line + 15}:1: unexpected token: "`" (column 1, code point U+0060)
+                 #{line_placeholder(starting_line + 15)} |
+                 #{starting_line + 15} | `
+                 #{line_placeholder(starting_line + 15)} | ^
                 doctest:
                   iex> 1 + 2
                   3
@@ -693,10 +702,10 @@ defmodule ExUnit.DocTestTest do
     assert output =~ """
              4) doctest ExUnit.DocTestTest.Invalid.indented_too_much/0 (4) (ExUnit.DocTestTest.InvalidCompiled)
                 test/ex_unit/doc_test_test.exs:#{doctest_line}
-                Doctest did not compile, got: (SyntaxError) test/ex_unit/doc_test_test.exs:#{starting_line + 22}:3: unexpected token: "`" (column 3, code point U+0060)
-                 #{line_placeholder(starting_line + 22)} |
-                 #{starting_line + 22} |   ```
-                 #{line_placeholder(starting_line + 22)} |   ^
+                Doctest did not compile, got: (SyntaxError) test/ex_unit/doc_test_test.exs:#{starting_line + 23}:3: unexpected token: "`" (column 3, code point U+0060)
+                 #{line_placeholder(starting_line + 23)} |
+                 #{starting_line + 23} |   ```
+                 #{line_placeholder(starting_line + 23)} |   ^
                 doctest:
                   iex> 1 + 2
                   3
@@ -708,10 +717,10 @@ defmodule ExUnit.DocTestTest do
     assert output =~ """
              5) doctest ExUnit.DocTestTest.Invalid.dedented_past_fence/0 (5) (ExUnit.DocTestTest.InvalidCompiled)
                 test/ex_unit/doc_test_test.exs:#{doctest_line}
-                Doctest did not compile, got: (SyntaxError) test/ex_unit/doc_test_test.exs:#{starting_line + 30}:5: unexpected token: "`" (column 5, code point U+0060)
-                 #{line_placeholder(starting_line + 30)} |
-                 #{starting_line + 30} |     ```
-                 #{line_placeholder(starting_line + 30)} |     ^
+                Doctest did not compile, got: (SyntaxError) test/ex_unit/doc_test_test.exs:#{starting_line + 31}:5: unexpected token: "`" (column 5, code point U+0060)
+                 #{line_placeholder(starting_line + 31)} |
+                 #{starting_line + 31} |     ```
+                 #{line_placeholder(starting_line + 31)} |     ^
                 doctest:
                   iex> 1 + 2
                   3
@@ -731,10 +740,10 @@ defmodule ExUnit.DocTestTest do
     assert output =~ """
              7) doctest ExUnit.DocTestTest.Invalid.misplaced_opaque_type/0 (7) (ExUnit.DocTestTest.InvalidCompiled)
                 test/ex_unit/doc_test_test.exs:#{doctest_line}
-                Doctest did not compile, got: (TokenMissingError) test/ex_unit/doc_test_test.exs:#{starting_line + 42}:7: missing terminator: } (for "{" starting at line #{starting_line + 42})
-                 #{line_placeholder(starting_line + 42)} |
-                 #{starting_line + 42} | {:ok, #Inspect<[]>}
-                 #{line_placeholder(starting_line + 42)} |       ^
+                Doctest did not compile, got: (TokenMissingError) test/ex_unit/doc_test_test.exs:#{starting_line + 43}:7: missing terminator: } (for "{" starting at line #{starting_line + 43})
+                 #{line_placeholder(starting_line + 43)} |
+                 #{starting_line + 43} | {:ok, #Inspect<[]>}
+                 #{line_placeholder(starting_line + 43)} |       ^
                 If you are planning to assert on the result of an iex> expression which contains a value inspected as #Name<...>, please make sure the inspected value is placed at the beginning of the expression; otherwise Elixir will treat it as a comment due to the leading sign #.
                 doctest:
                   iex> {:ok, :oops}
@@ -756,6 +765,23 @@ defmodule ExUnit.DocTestTest do
                 stacktrace:
                   test/ex_unit/doc_test_test.exs:#{starting_line + 48}: ExUnit.DocTestTest.Invalid (module)
            """
+
+    assert output =~ """
+             9) doctest ExUnit.DocTestTest.Invalid.result/0 (9) (ExUnit.DocTestTest.InvalidCompiled)
+                test/ex_unit/doc_test_test.exs:#{doctest_line}
+                Doctest did not compile, got: (SyntaxError) test/ex_unit/doc_test_test.exs:#{starting_line + 56}:5: syntax error before: '*'
+                 #{line_placeholder(starting_line + 56)} |
+                 #{starting_line + 56} | 1 + * 1
+                 #{line_placeholder(starting_line + 56)} |     ^
+                doctest:
+                  iex> :foo
+                  iex> :bar
+                  1 + * 1
+                stacktrace:
+                  test/ex_unit/doc_test_test.exs:#{starting_line + 54}: ExUnit.DocTestTest.Invalid (module)
+           """
+
+    assert output =~ "9 doctests, 9 failures"
   end
 
   test "pattern matching assertions in doctests" do