Try to filter test items without constructing the AST

Author: Drvi

Project.toml

@@ -4,21 +4,25 @@ version = "1.34.0"
 
 [deps]
 Dates = "ade2ca70-3891-5945-98fb-dc099432e06a"
+JuliaSyntax = "70703baa-626e-46a2-a12c-08ffd08c73b4"
 Logging = "56ddb016-857b-54e1-b83d-db4d58db5568"
 Pkg = "44cfe95a-1eb2-52ea-b672-e2afdf69b78f"
 Serialization = "9e88b42a-f829-5b0c-bbe9-9e923198166b"
 Sockets = "6462fe0b-24de-5631-8697-dd941f90decc"
+StringViews = "354b36f9-a18e-4713-926e-db85100087ba"
 Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"
 TestEnv = "1e6cf692-eddd-4d53-88a5-2d735e33781b"
 
 [compat]
 Dates = "1"
+JuliaSyntax = "1"
 Logging = "1"
 Pkg = "1"
 Profile = "1"
 Random = "1"
 Serialization = "1"
 Sockets = "1"
+StringViews = "1"
 Test = "1"
 TestEnv = "1.8"
 julia = "1.8"

src/ReTestItems.jl

@@ -102,6 +102,7 @@ include("junit_xml.jl")
 include("testcontext.jl")
 include("log_capture.jl")
 include("filtering.jl")
+include("include_test_file.jl")
 
 function __init__()
     if ccall(:jl_generating_output, Cint, ()) == 0 # not precompiling
@@ -869,7 +870,7 @@ function include_task(walkdir_channel, setup_channel, project_root, ti_filter)
                     for (file_path, file_node) in walkdir_channel
                         @debugv 1 "Including test items from file `$(file_path)`"
                         task_local_storage(:__RE_TEST_ITEMS__, (file_node, empty!(testitem_names))) do
-                            Base.include(ti_filter, Main, file_path)
+                            include_test_file(ti_filter, file_path)
                         end
                     end
                 end

src/include_test_file.jl

@@ -0,0 +1,74 @@
+using JuliaSyntax: ParseStream, @K_str, build_tree, bump_trivia, kind, parse!, peek_full_token, peek_token
+using StringViews
+
+function include_test_file(ti_filter, path::String)
+    bytes = read(path)
+    stream = ParseStream(bytes)
+    tls = task_local_storage()
+    tls[:SOURCE_PATH] = path # This is also done by Base.include
+    try
+        while true
+            bump_trivia(stream, skip_newlines=true)
+            t = peek_token(stream, 1)
+            k = kind(t)
+            k == K"EndMarker" && break
+            if k == K"@"
+                tf = peek_full_token(stream, 2)
+                v = @inbounds @view(bytes[tf.first_byte:tf.last_byte])
+                if     v == b"testitem" ; _eval_from_stream(stream, path, ti_filter, bytes)
+                elseif v == b"testsetup"; _eval_from_stream(stream, path)
+                elseif v == b"test_rel" ; _eval_from_stream(stream, path, ti_filter)
+                else
+                    error("Test files must only include `@testitem` and `@testsetup` calls, got an `@$(StringView(v))` at $(path)") # TODO
+                end
+            else
+                error("Test files must only include `@testitem` and `@testsetup` calls, got a $t at $(path)") # TODO
+            end
+            empty!(stream)
+        end
+    finally
+        delete!(tls, :SOURCE_PATH)
+    end
+end
+
+_contains(s::AbstractString, pattern::Regex) = occursin(pattern, s)
+_contains(s::AbstractString, pattern::AbstractString) = s == pattern
+
+# unconditionally eval
+function _eval_from_stream(stream, path)
+    parse!(stream; rule=:statement)
+    ast = build_tree(Expr, stream;  filename=path)
+    Core.eval(Main, ast)
+    return nothing
+end
+
+# test_rel -> apply ti_filter on the parsed ast
+function _eval_from_stream(stream, path, ti_filter)
+    parse!(stream; rule=:statement)
+    ast = build_tree(Expr, stream; filename=path)
+    filtered = ti_filter(ast)
+    filtered === nothing || Core.eval(Main, filtered)
+    return nothing
+end
+
+# like above, but tries to avoid parsing the ast if it sees from the name identifier token
+# it won't pass the filter
+function _eval_from_stream(stream, path, ti_filter, bytes)
+    if ti_filter.name isa Nothing
+        parse!(stream; rule=:statement)
+        ast = build_tree(Expr, stream; filename=path)
+        filtered = ti_filter(ast)
+        filtered === nothing || Core.eval(Main, filtered)
+        return nothing
+    end
+
+    name_t = peek_full_token(stream, 4) # 3 was '\"'
+    name = @inbounds StringView(@view(bytes[name_t.first_byte:name_t.last_byte]))
+    parse!(stream; rule=:statement)
+    if _contains(name, ti_filter.name)
+        ast = build_tree(Expr, stream; filename=path)
+        filtered = ti_filter(ast)
+        filtered === nothing || Core.eval(Main, filtered)
+    end
+    return nothing
+end