Record errors before logs in XML reports (#88)

* Record errors before logs in XML reports

* Bump version

* Update docstring

Project.toml

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

src/junit_xml.jl

@@ -55,7 +55,7 @@ function JUnitTestCase(ti::TestItem, run_number::Int)
         message = nothing
     else
         io = IOBuffer()
-        print_errors_and_captured_logs(io, ti, run_number)
+        print_errors_and_captured_logs(io, ti, run_number; errors_first=true)
         logs = take!(io)
         message = _error_message(ts, ti)
     end

src/log_capture.jl

@@ -147,7 +147,7 @@ _mem_watermark() = string(
 )
 
 """
-    print_errors_and_captured_logs(ti::TestItem, run_number::Int; logs=:batched)
+    print_errors_and_captured_logs(ti::TestItem, run_number::Int; logs=:batched, errors_first=false)
 
 When a testitem doesn't succeed, we print the corresponding error/failure reports
 from the testset and any logs that we captured while the testitem was eval()'d.
@@ -156,20 +156,30 @@ For `:eager` mode of `logs` we don't print any logs as they bypass log capture.
 means we print logs even for passing test items, whereas `:issues` means we are only printing
 captured logs if there were any errors or failures.
 
+If `errors_first=true`, then the test errors are printed first and the logs second.
+The default `errors_first=false`, prints the logs firsts.
+
 Nothing is printed when no logs were captures and no failures or errors occured.
 """
-print_errors_and_captured_logs(ti::TestItem, run_number::Int; logs=:batched) =
-    print_errors_and_captured_logs(DEFAULT_STDOUT[], ti, run_number; logs)
-function print_errors_and_captured_logs(io, ti::TestItem, run_number::Int; logs=:batched)
+print_errors_and_captured_logs(ti::TestItem, run_number::Int; kwargs...) =
+    print_errors_and_captured_logs(DEFAULT_STDOUT[], ti, run_number; kwargs...)
+function print_errors_and_captured_logs(
+    io, ti::TestItem, run_number::Int; logs=:batched, errors_first::Bool=false,
+)
     ts = ti.testsets[run_number]
     has_errors = ts.anynonpass
     has_logs = _has_logs(ti, run_number) || any(_has_logs, ti.testsetups)
     if has_errors || logs == :batched
         report_iob = IOContext(IOBuffer(), :color=>Base.get_have_color())
         println(report_iob)
         # in :eager mode, the logs were already printed
-        logs != :eager && _print_captured_logs(report_iob, ti, run_number)
-        has_errors && _print_test_errors(report_iob, ts, _on_worker(ti))
+        if errors_first
+            has_errors && _print_test_errors(report_iob, ts, _on_worker(ti))
+            logs != :eager && _print_captured_logs(report_iob, ti, run_number)
+        else
+            logs != :eager && _print_captured_logs(report_iob, ti, run_number)
+            has_errors && _print_test_errors(report_iob, ts, _on_worker(ti))
+        end
         if has_errors || has_logs
             # a newline to visually separate the report for the current test item
             println(report_iob)