Tweak some more.

Author: maleadt

test/helpers/test.jl

@@ -42,8 +42,9 @@ module FileCheck
     import LLVM_jll
     import IOCapture
     using InteractiveUtils
+    using Test
 
-    export filecheck
+    export filecheck, @filecheck, @check_str
 
     global filecheck_path::String
     function __init__()
@@ -77,33 +78,76 @@ module FileCheck
 
     function filecheck(f, input)
         # FileCheck assumes that the input is available as a file
-        mktemp() do path, io
-            write(io, input)
-            close(io)
+        mktemp() do path, input_io
+            write(input_io, input)
+            close(input_io)
 
-            # Now execute `f` with IOCapture
-            # XXX: See if Suppressor is a better fit
-            value, output, error, backtrace = IOCapture.capture(()->f(input); rethrow=Union{})
-
-            io = IOBuffer()
-            write(io, output)
-            println(io)
+            # capture the output of `f` and write it into a temporary buffer
+            result = IOCapture.capture(rethrow=Union{}) do
+                f(input)
+            end
+            output_io = IOBuffer()
+            write(output_io, result.output)
+            println(output_io)
 
-            if error
-                showerror(io, value, backtrace)
+            # if the function errored, also render the exception and backtrace
+            if result.error
+                showerror(output_io, result.value, result.backtrace)
             end
 
-            # Determine some useful prefixes for FileCheck
+            # determine some useful prefixes for FileCheck
             prefixes = ["CHECK"]
             if julia_typed_pointers
                 push!(prefixes, "OPAQUE")
             else
                 push!(prefixes, "TYPED")
             end
 
-            seekstart(io)
-            cmd = `$(filecheck_exe()) --allow-unused-prefixes --check-prefixes $(join(prefixes, ',')) $path`
-            value, success(pipeline(cmd; stdin=io, stdout, stderr))
+            # now pass the collected output to FileCheck
+            seekstart(output_io)
+            filecheck_io = Pipe()
+            cmd = ```$(filecheck_exe())
+                     --color
+                     --dump-input never
+                     --allow-unused-prefixes
+                     --check-prefixes $(join(prefixes, ','))
+                     $path```
+            proc = run(pipeline(ignorestatus(cmd); stdin=output_io, stdout=filecheck_io, stderr=filecheck_io); wait=false)
+            close(filecheck_io.in)
+
+            # collect the output of FileCheck
+            reader = Threads.@spawn String(read(filecheck_io))
+            Base.wait(proc)
+            log = strip(fetch(reader))
+
+            # error out if FileCheck did not succeed.
+            # otherwise, return true so that `@test @filecheck` works as expected.
+            if !success(proc)
+                error(log)
+            end
+            return true
+        end
+    end
+
+    # collect checks used in the @filecheck block by piggybacking on macro expansion
+    const checks = String[]
+    macro check_str(str)
+        push!(checks, str)
+        nothing
+    end
+
+    macro filecheck(ex)
+        ex = Base.macroexpand(__module__, ex)
+        if isempty(checks)
+            error("No checks provided within the @filecheck macro block")
         end
+        check_str = join(checks, "\n")
+        empty!(checks)
+
+        esc(quote
+            filecheck($check_str) do _
+                $ex
+            end
+        end)
     end
 end

test/ptx.jl

@@ -20,10 +20,9 @@ end
         end
     end
 
-    filecheck(raw"""
-        ; TYPED: @{{(julia|j)_kernel_[0-9]+}}({{(\{ i64 \}|\[1 x i64\])}}*
-        ; OPAQUE: @{{(julia|j)_kernel_[0-9]+}}(ptr
-        """) do _
+    @test @filecheck begin
+        check"TYPED: @{{(julia|j)_kernel_[0-9]+}}({{(\{ i64 \}|\[1 x i64\])}}*"
+        check"OPAQUE: @{{(julia|j)_kernel_[0-9]+}}(ptr"
         PTX.code_llvm(mod.kernel, Tuple{mod.Aggregate})
     end
 

test/utils.jl

@@ -95,13 +95,23 @@ end
 
 # Test FileCheck
 @testset "FileCheck" begin
-    _, success = filecheck(_->println("works"), "# CHECK: works")
-    @test success
-
-    _, success = filecheck(_->@assert(false),
-    """
-    ; CHECK: AssertionError: false
-    ; CHECK-NEXT: Stacktrace:
-    """)
-    @test success
+    @test @filecheck begin
+        check"CHECK: works"
+        println("works")
+    end
+
+    @test_throws "expected string not found in input" @filecheck begin
+        check"CHECK: works"
+        println("doesn't work")
+    end
+
+    @test @filecheck begin
+        check"CHECK: errors"
+        error("errors")
+    end
+
+    @test_throws "expected string not found in input" @filecheck begin
+        check"CHECK: works"
+        error("errors")
+    end
 end