Fix issues found by JET.jl (#57)

* put accumulated_data in second if block

* use Hendriks suggestion

* define dummy accumulated_data in disabled case

* fix comments

* use default TimeData

Author: JoshuaLampert

src/trixi_timeit.jl

@@ -57,6 +57,9 @@ macro trixi_timeit(timer_output, label, expr)
             local enabled = to.enabled
             if enabled
                 local accumulated_data = $(TimerOutputs.push!)(to, $(esc(label)))
+            else
+                # dummy to avoid issues with JET.jl complaining about potentially undefined variables
+                local accumulated_data = TimerOutputs.TimeData()
             end
             local b0 = $(TimerOutputs.gc_bytes)()
             local t0 = $(TimerOutputs.time_ns)()

test/test_timers.jl

@@ -57,7 +57,7 @@
         @test actual == expected
     end
 
-    @testset verbose=true "disable and enable timings" begin
+    @testset verbose=true "disable and enable timings using disable_debug_timings and enable_debug_timings" begin
         # Start with empty timer output
         TrixiBase.TimerOutputs.reset_timer!(timer())
 
@@ -68,13 +68,52 @@
         @trixi_timeit timer() "test timer" sin(0.0)
         @trixi_timeit timer() "test timer" sin(0.0)
 
-        # Disable timings
+        # Enable timings
         enable_debug_timings()
 
         # This timing should be counted
         @trixi_timeit timer() "test timer 2" sin(0.0)
 
-        println(timer())
+        timer_output = """
+        ─────────────────────────────────────────────────────────────────────────
+                                        Time                    Allocations
+                               ───────────────────────   ────────────────────────
+           Tot / % measured:       23.7ms /   0.0%           1.00MiB /   0.0%
+
+        Section        ncalls     time    %tot     avg     alloc    %tot      avg
+        ─────────────────────────────────────────────────────────────────────────
+        test timer 2        1    875ns  100.0%   875ns     48.0B  100.0%    48.0B
+        ─────────────────────────────────────────────────────────────────────────
+        """
+        # Remove "Tot / % measured" line and trailing white spaces and replace
+        # the "test timer" line (but don't remove it, we want to check that it's there).
+        expected = replace(timer_output, r"Tot / % measured: .*" => "",
+                           r"\s+\n" => "\n",
+                           r"test timer 2        1 .*B\n" => "test timer 2        1")
+        actual = replace(repr(timer()) * "\n", r"Tot / % measured: .*" => "",
+                         r"\s+\n" => "\n",
+                         r"test timer 2        1 .*B\n" => "test timer 2        1")
+
+        # Compare against empty timer output
+        @test actual == expected
+    end
+
+    @testset verbose=true "disable and enable timings using disable_timer! and enable_timer!" begin
+        # Start with empty timer output
+        TrixiBase.TimerOutputs.reset_timer!(timer())
+
+        # Disable timer
+        TrixiBase.TimerOutputs.disable_timer!(timer())
+
+        # These two timings should be disabled
+        @trixi_timeit timer() "test timer" sin(0.0)
+        @trixi_timeit timer() "test timer" sin(0.0)
+
+        # Enable timer
+        TrixiBase.TimerOutputs.enable_timer!(timer())
+
+        # This timing should be counted
+        @trixi_timeit timer() "test timer 2" sin(0.0)
 
         timer_output = """
         ─────────────────────────────────────────────────────────────────────────