Merge pull request #117 from JuliaDebug/sp/infiltry-tests

chore: infiltry tests, docs, improvements
JuliaDebug · Apr 8, 2024 · 9b0d328 · 9b0d328
2 parents d411f15 + 542666c
commit 9b0d328
Show file tree

Hide file tree

Showing 23 changed files with 896 additions and 12 deletions.
diff --git a/.github/workflows/CI.yml b/.github/workflows/CI.yml
@@ -46,3 +46,4 @@ jobs:
       - uses: codecov/codecov-action@v4
         with:
           file: lcov.info
+          token: ${{ secrets.CODECOV_TOKEN }}
diff --git a/README.md b/README.md
@@ -148,6 +148,8 @@ infil> ?
 
     •  @locals: Print local variables. @locals x y only prints x and y.
 
+    •  @exception: Print the exception that triggered the current @infiltry session, if any.
+
     •  @exfiltrate: Save all local variables into the store. @exfiltrate x y saves x and y; this variant can also exfiltrate variables defined in the infil> REPL.
 
     •  @toggle: Toggle infiltrating at this @infiltrate spot (clear all with Infiltrator.clear_disabled!()).

diff --git a/docs/src/API/index.md b/docs/src/API/index.md
@@ -12,6 +12,7 @@ This means that you'll need to use [Revise.jl](https://github.com/timholy/Revise
 in VS Code, or just plain old `@eval` to apply `@infiltrate` statements in your package code.
 ```@docs
 @infiltrate
+@infiltry
 infiltrate
 @exfiltrate
 ```

diff --git a/src/Infiltrator.jl b/src/Infiltrator.jl
@@ -10,7 +10,7 @@ using REPL.LineEdit: getproperty
 using REPL.LineEdit
 using Markdown
 
-export @infiltrate, @exfiltrate, @withstore, safehouse, exfiltrated, infiltrate
+export @infiltrate, @infiltry, @exfiltrate, @withstore, safehouse, exfiltrated, infiltrate
 
 const REPL_HOOKED = Ref{Bool}(false)
 const INFILTRATION_LOCK = Ref{ReentrantLock}()
@@ -117,12 +117,12 @@ Equivalent to:
         @infiltrate
     end
 """
-macro infiltry(ex)
+macro infiltry(expr)
     return quote
         try
-            $(esc(ex))
-        catch
-            $(Infiltrator.start_prompt)($(__module__), Base.@locals, $(String(__source__.file)), $(__source__.line))
+            $(esc(expr))
+        catch ex
+            $(Infiltrator.start_prompt)($(__module__), Base.@locals, $(String(__source__.file)), $(__source__.line), ex, catch_backtrace())
         end
     end
 end
@@ -265,7 +265,7 @@ function set_store!(s::Session, m::Module)
   nothing
 end
 
-function start_prompt(mod, locals, file, fileline;
+function start_prompt(mod, locals, file, fileline, ex = nothing, bt = nothing;
                         terminal = TEST_TERMINAL_REF[],
                         repl = TEST_REPL_REF[],
                         nostack = TEST_NOSTACK[]
@@ -299,6 +299,7 @@ function start_prompt(mod, locals, file, fileline;
     last = something(findfirst(x -> x.func === StackTraces.top_level_scope_sym, trace),
                     length(trace))
     trace = trace[start:last]
+    bt = bt === nothing ? nothing : crop_backtrace(bt)
 
     if CHECK_TASK[] && !active_repl_backend.in_eval
       b = IOBuffer()
@@ -343,21 +344,28 @@ function start_prompt(mod, locals, file, fileline;
       return
     end
 
-    print(io, "Infiltrating ")
+    if ex !== nothing
+      printstyled(io, "EXCEPTION"; color=:red, bold=true)
+      print(io, " while infiltrating ")
+    else
+      print(io, "Infiltrating ")
+    end
+
     if Threads.nthreads() > 1
       print(io, "(on thread $(Threads.threadid())) ")
     end
     if length(trace) > 0
       if nostack
-        println(io, "<unknown>")
+        print(io, "<unknown>")
       else
         print_verbose_stackframe(io, trace[1])
       end
     else
-      println(io, "top-level frame")
+      print(io, "top-level frame")
     end
     println(io)
-    debugprompt(mod, locals, trace, terminal, repl, nostack, file=file, fileline=fileline)
+    println(io)
+    debugprompt(mod, locals, trace, terminal, repl, ex, bt; nostack=nostack, file=file, fileline=fileline)
     println(io)
   finally
     unlock(INFILTRATION_LOCK[])
@@ -374,6 +382,7 @@ The following commands are special cased:
   - `?`: Print this help text.
   - `@trace`: Print the current stack trace.
   - `@locals`: Print local variables. `@locals x y` only prints `x` and `y`.
+  - `@exception`: Print the exception that triggered the current `@infiltry` session, if any.
   - `@exfiltrate`: Save all local variables into the store. `@exfiltrate x y` saves `x` and `y`;
     this variant can also exfiltrate variables defined in the `infil>` REPL.
   - `@toggle`: Toggle infiltrating at this `@infiltrate` spot (clear all with `Infiltrator.clear_disabled!()`).
@@ -488,7 +497,7 @@ end
 
 const PROMPT = Ref{Any}()
 
-function debugprompt(mod, locals, trace, terminal, repl, nostack = false; file, fileline)
+function debugprompt(mod, locals, trace, terminal, repl, ex, bt; nostack = false, file, fileline)
   io = Base.pipe_writer(terminal)
 
   evalmod = init_transient_eval_module(mod, locals)
@@ -541,6 +550,15 @@ function debugprompt(mod, locals, trace, terminal, repl, nostack = false; file,
         exfiltrate_locals(io, evalmod, locals, sline)
         LineEdit.reset_state(s)
         return true
+      elseif sline == "@exception"
+        if ex !== nothing && bt !== nothing
+          Base.display_error(io, ex, nostack ? bt[1:1] : bt)
+        else
+          println(io, "No exception available")
+        end
+        println(io)
+        LineEdit.reset_state(s)
+        return true
       elseif sline == "@toggle"
         spot = (file, fileline)
         ds = getfield(store, :disabled)
@@ -883,7 +901,7 @@ function completions(c::InfiltratorCompletionProvider, full, partial)
   prepend!(ret, map(REPL.REPLCompletions.completion_text, comps))
 
   # Infiltrator commands completions
-  commands = ["?", "@trace", "@locals", "@toggle", "@exit", "@continue", "@exfiltrate"]
+  commands = ["?", "@trace", "@locals", "@toggle", "@exit", "@continue", "@exfiltrate", "@exception"]
   prepend!(ret, filter!(c -> startswith(c, partial), commands))
 
   unique!(ret), range, should_complete

diff --git a/test/outputs/Julia_f_1.1.multiout b/test/outputs/Julia_f_1.1.multiout
@@ -24,6 +24,9 @@
 |
 |    •    @locals: Print local variables. @locals x y only prints x and y.
 |
+|    •    @exception: Print the exception that triggered the current
+|        @infiltry session, if any.
+|
 |    •    @exfiltrate: Save all local variables into the store. @exfiltrate
 |        x y saves x and y; this variant can also exfiltrate variables
 |        defined in the infil> REPL.
@@ -65,6 +68,9 @@
 |
 |CCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCC
 |
+|CCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCC
+|CCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCC
+|
 |CCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCC
 |CCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCC
 |CCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCC
@@ -106,6 +112,9 @@
 |
 |    •    @locals: Print local variables. @locals x y only prints x and y.
 |
+|    •    @exception: Print the exception that triggered the current
+|        @infiltry session, if any.
+|
 |    •    @exfiltrate: Save all local variables into the store. @exfiltrate
 |        x y saves x and y; this variant can also exfiltrate variables
 |        defined in the infil> REPL.
@@ -149,6 +158,9 @@
 |
 |CCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCC
 |
+|CCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCC
+|CCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCC
+|
 |CCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCC
 |CCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCC
 |CCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCC
@@ -192,6 +204,9 @@
 |
 |    •    @locals: Print local variables. @locals x y only prints x and y.
 |
+|    •    @exception: Print the exception that triggered the current
+|        @infiltry session, if any.
+|
 |    •    @exfiltrate: Save all local variables into the store. @exfiltrate
 |        x y saves x and y; this variant can also exfiltrate variables
 |        defined in the infil> REPL.
@@ -239,6 +254,9 @@
 |
 |CCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCC
 |
+|CCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCC
+|CCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCC
+|
 |CCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCC
 |CCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCC
 |CCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCC
@@ -286,6 +304,9 @@
 |
 |    •    @locals: Print local variables. @locals x y only prints x and y.
 |
+|    •    @exception: Print the exception that triggered the current
+|        @infiltry session, if any.
+|
 |    •    @exfiltrate: Save all local variables into the store. @exfiltrate
 |        x y saves x and y; this variant can also exfiltrate variables
 |        defined in the infil> REPL.
@@ -339,6 +360,9 @@
 |
 |CCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCC
 |
+|CCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCC
+|CCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCC
+|
 |CCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCC
 |CCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCC
 |CCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCC
@@ -392,6 +416,9 @@
 |
 |    •    @locals: Print local variables. @locals x y only prints x and y.
 |
+|    •    @exception: Print the exception that triggered the current
+|        @infiltry session, if any.
+|
 |    •    @exfiltrate: Save all local variables into the store. @exfiltrate
 |        x y saves x and y; this variant can also exfiltrate variables
 |        defined in the infil> REPL.
@@ -450,6 +477,9 @@
 |
 |CCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCC
 |
+|CCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCC
+|CCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCC
+|
 |CCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCC
 |CCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCC
 |CCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCC
@@ -508,6 +538,9 @@
 |
 |    •    @locals: Print local variables. @locals x y only prints x and y.
 |
+|    •    @exception: Print the exception that triggered the current
+|        @infiltry session, if any.
+|
 |    •    @exfiltrate: Save all local variables into the store. @exfiltrate
 |        x y saves x and y; this variant can also exfiltrate variables
 |        defined in the infil> REPL.
@@ -569,6 +602,9 @@
 |
 |CCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCC
 |
+|CCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCC
+|CCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCC
+|
 |CCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCC
 |CCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCC
 |CCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCC
@@ -630,6 +666,9 @@
 |
 |    •    @locals: Print local variables. @locals x y only prints x and y.
 |
+|    •    @exception: Print the exception that triggered the current
+|        @infiltry session, if any.
+|
 |    •    @exfiltrate: Save all local variables into the store. @exfiltrate
 |        x y saves x and y; this variant can also exfiltrate variables
 |        defined in the infil> REPL.
@@ -694,6 +733,9 @@
 |
 |CCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCC
 |
+|CCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCC
+|CCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCC
+|
 |CCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCC
 |CCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCC
 |CCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCC
@@ -758,6 +800,9 @@
 |
 |    •    @locals: Print local variables. @locals x y only prints x and y.
 |
+|    •    @exception: Print the exception that triggered the current
+|        @infiltry session, if any.
+|
 |    •    @exfiltrate: Save all local variables into the store. @exfiltrate
 |        x y saves x and y; this variant can also exfiltrate variables
 |        defined in the infil> REPL.
@@ -825,6 +870,9 @@
 |
 |CCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCC
 |
+|CCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCC
+|CCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCC
+|
 |CCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCC
 |CCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCC
 |CCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCC
@@ -892,6 +940,9 @@
 |
 |    •    @locals: Print local variables. @locals x y only prints x and y.
 |
+|    •    @exception: Print the exception that triggered the current
+|        @infiltry session, if any.
+|
 |    •    @exfiltrate: Save all local variables into the store. @exfiltrate
 |        x y saves x and y; this variant can also exfiltrate variables
 |        defined in the infil> REPL.
@@ -962,6 +1013,9 @@
 |
 |CCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCC
 |
+|CCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCC
+|CCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCC
+|
 |CCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCC
 |CCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCC
 |CCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCC
@@ -1032,6 +1086,9 @@
 |
 |    •    @locals: Print local variables. @locals x y only prints x and y.
 |
+|    •    @exception: Print the exception that triggered the current
+|        @infiltry session, if any.
+|
 |    •    @exfiltrate: Save all local variables into the store. @exfiltrate
 |        x y saves x and y; this variant can also exfiltrate variables
 |        defined in the infil> REPL.
@@ -1105,6 +1162,9 @@
 |
 |CCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCC
 |
+|CCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCC
+|CCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCC
+|
 |CCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCC
 |CCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCC
 |CCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCC
@@ -1178,6 +1238,9 @@
 |
 |    •    @locals: Print local variables. @locals x y only prints x and y.
 |
+|    •    @exception: Print the exception that triggered the current
+|        @infiltry session, if any.
+|
 |    •    @exfiltrate: Save all local variables into the store. @exfiltrate
 |        x y saves x and y; this variant can also exfiltrate variables
 |        defined in the infil> REPL.
@@ -1254,6 +1317,9 @@
 |
 |CCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCC
 |
+|CCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCC
+|CCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCC
+|
 |CCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCC
 |CCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCC
 |CCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCC