Improve reporting of parse errors in test files (#168)

* Improve reporting of parse errors in test files

* fixup! Improve reporting of parse errors in test files

* fixup! fixup! Improve reporting of parse errors in test files

* Bump version

Author: nickrobinson251

Project.toml

@@ -1,6 +1,6 @@
 name = "ReTestItems"
 uuid = "817f1d60-ba6b-4fd5-9520-3cf149f6a823"
-version = "1.24.0"
+version = "1.25.0"
 
 [deps]
 Dates = "ade2ca70-3891-5945-98fb-dc099432e06a"

src/ReTestItems.jl

@@ -653,6 +653,11 @@ end
 #   i.e. Only `@testitem` and `@testsetup` calls are officially supported.
 checked_include(mod, filepath) = Base.include(check_retestitem_macrocall, mod, filepath)
 function check_retestitem_macrocall(expr)
+    if Meta.isexpr(expr, :error)
+        # If the expression failed to parse, most user-friendly to throw the ParseError,
+        # rather than report an error about using only `@testitem` or `@testsetup`.
+        Core.eval(Main, expr)
+    end
     is_retestitem_macrocall(expr) || _throw_not_macrocall(expr)
     return expr
 end

test/integrationtests.jl

@@ -1141,4 +1141,15 @@ end
     @test contains(c1.output, r"SKIP  \(3/6\) test item \"skip true\"")
 end
 
+@testset "ParseError in test file" begin
+    file = joinpath(TEST_FILES_DIR, "_parse_error_test.jl")
+    # the actual error type will be a TaskFailedException, containing a LoadError,
+    # containing a ParseError, but what we care about is that ultimately the ParseError is
+    # displayed, so we just check for that.
+    # Only v1.10+ has the newer Parser with better error messages.
+    expected = VERSION < v"1.10" ? "syntax:" : ["ParseError:", "Expected `]`"]
+    @test_throws expected runtests(file; nworkers=0)
+    @test_throws expected runtests(file; nworkers=1)
+end
+
 end # integrationtests.jl testset

test/testfiles/_parse_error_test.jl

@@ -0,0 +1,5 @@
+# Test case for https://github.com/JuliaTesting/ReTestItems.jl/issues/166
+@testitem "file_doesnt_parse" begin
+    # Note the missing `]`
+    @test ["a", "b"] == ["a", "b"
+end