print module header when it doesn't match the passed module

We don't print the module header when only one module is tested, and
this module is passed explicitly as an argument to `retest`. But we
were wrongly not printing this header when one module not containing
tests was passed, which was containing a submodule with tests, and
`recursive=true`. In this case, we want to print the submodule header,
as this submodule was no passed explicitly to `retest`
(idem with `MyPackageTests` and `load=true`).

Author: rfourquet

src/ReTest.jl

@@ -658,11 +658,8 @@ function retest(@nospecialize(args::ArgType...);
     dry, stats, shuffle, group, verbose, recursive, id, strict, dup, static, marks, spin =
         update_keywords(args, dry, stats, shuffle, group, verbose, recursive, id, strict, dup, static, marks, spin)
 
-    implicitmodules, modules, verbose = process_args(args; verbose=verbose, shuffle=shuffle,
-                                                     recursive=recursive, load=load)
-    # overall: print header for each module, and probably "Overall" summary for all modules
-    overall = length(modules) > 1
-    module_header = overall | implicitmodules
+    module_header, modules, verbose = process_args(args; verbose=verbose, shuffle=shuffle,
+                                                   recursive=recursive, load=load)
     root = Testset.ReTestSet(Main, "Overall", overall=true)
 
     maxidw = Ref{Int}(0) # visual width for showing IDs (Ref for mutability in hack below)
@@ -1273,6 +1270,13 @@ function process_args(@nospecialize(args);
         end
     end
 
+    # module_header: whether to print module header before testsets belonging to that module
+    # we compute module_header before filtering out modules without tests, so that
+    # if a parent module with no tests is explicitly passed, which contains a submodule
+    # and recursive==true, then the submodule name is printed (and similarly for
+    # printing `MyPackageTests` when `MyPackage` is passed and `load==true`)
+    module_header = length(modules) > 1 | implicitmodules
+
     # remove modules which don't have tests, which can happen when a parent module without
     # tests is passed to retest in order to run tests in its submodules
     filter!(m -> isdefined(m, INLINE_TEST), modules)
@@ -1288,7 +1292,7 @@ function process_args(@nospecialize(args);
     end
     verbose = Int(verbose)
 
-    (implicitmodules=implicitmodules, modules=[mod => modpats[mod] for mod in modules],
+    (module_header=module_header, modules=[mod => modpats[mod] for mod in modules],
      verbose=verbose)
 end
 

test/runtests.jl

@@ -835,6 +835,23 @@ end
     # TODO: test in a distributed setting
 end
 
+module MiscSubmoduleHeader
+module Sub
+using ReTest
+@testset "a" begin end
+end
+end
+
+@chapter MiscSubmoduleHeader begin
+    check(MiscSubmoduleHeader, recursive=true, dry=true, [], output="""
+Main.MiscSubmoduleHeader.Sub
+1| a
+""")
+    check(MiscSubmoduleHeader.Sub, recursive=true, dry=true, [], output="""
+1| a
+""")
+end
+
 module Bugs
 using ReTest
 @testset "macros with nothing" begin

test/setup.jl

@@ -10,7 +10,7 @@ function trace(x)
     push!(RUN, x)
     @test true
 end
-end
+end # module Trace
 
 # NOTE: all keywords have the same defaults as `retest`, except `marks`
 # Also, not sure why ReTest.def has to be qualified, when we just import def from ReTest