Add the InteractiveUtils.diagnostics() function

Author: DilumAluthge

stdlib/InteractiveUtils/src/InteractiveUtils.jl

@@ -19,6 +19,7 @@ include("editless.jl")
 include("codeview.jl")
 include("macros.jl")
 include("clipboard.jl")
+include("diagnostics.jl")
 
 """
     varinfo(m::Module=Main, pattern::Regex=r""; all::Bool = false, imported::Bool = false, sortby::Symbol = :name, minsize::Int = 0)
@@ -163,7 +164,6 @@ function versioninfo(io::IO=stdout; verbose::Bool=false)
     end
 end
 
-
 function type_close_enough(@nospecialize(x), @nospecialize(t))
     x == t && return true
     # TODO: handle UnionAll properly

stdlib/InteractiveUtils/src/diagnostics.jl

@@ -0,0 +1,83 @@
+"""
+    InteractiveUtils.diagnostics(io::IO=stderr)
+
+Print a variety of useful debugging info.
+
+!!! warning "Warning"
+    The output of this function may contain sensitive information. Before sharing the output,
+    please review the output and remove any data that should not be shared publicly.
+
+See also: [`versioninfo`](@ref).
+"""
+function diagnostics(io::IO=stderr)
+    loaded_modules = copy(Base.loaded_modules_array())
+    sort!(loaded_modules; by = nameof)
+    loaded_names = nameof.(loaded_modules)
+    for m in loaded_modules
+        _module_diagnostics(io, m)
+    end
+    return nothing
+end
+
+function _module_diagnostics(io::IO, m::Module)
+    module_name = nameof(m)
+    if isdefined(m, :__diagnostics__) && applicable(m.__diagnostics__, io)
+        header = "# $(module_name)"
+        println(io, header)
+        try
+            m.__diagnostics__(io)
+        catch ex
+            bt = catch_backtrace()
+            msg = "Warning: encountered an error while running $(module_name).__diagnostics__()"
+            println(io, msg)
+            Base.showerror(io, ex)
+            Base.show_backtrace(io, bt)
+        end
+    end
+    return nothing
+end
+
+# InteractiveUtils.__diagnostics__()
+function __diagnostics__(io::IO)
+    indent = "  "
+    versioninfo(io; verbose = true) # InteractiveUtils.versioninfo()
+    println(io, "Miscellaneous Info:")
+    if !_is_tagged_commit()
+        println(io, "It looks like you are probably not using the official binaries from julialang.org")
+    end
+    startup_files = [
+        "Global" => _global_julia_startup_file(),
+        "Local"  => _local_julia_startup_file(),
+    ]
+    for pair in startup_files
+        filename = pair[2]
+        if filename === nothing
+            description = "does not exist"
+        else
+            str = strip(read(filename, String))
+            expr = Base.Meta.parse(str; raise = false)
+            if expr === nothing
+                description = "is empty"
+            else
+                description = "exists and contains code ($(filename))"
+            end
+        end
+        println(io, indent, pair[1], " startup file: ", description)
+    end
+    println(io, indent, "Base.julia_cmd(): ", Base.julia_cmd())
+    return nothing
+end
+
+# We can't say with 100% certainty whether or not this is the official binary
+# from julialang.org, but we can make an educated guess.
+function _is_tagged_commit()
+    tagged_commit = Base.GIT_VERSION_INFO.tagged_commit
+    if !tagged_commit
+        return false
+    end
+    banner = Base.TAGGED_RELEASE_BANNER
+    if banner == "Official https://julialang.org/ release"
+        return true
+    end
+    return false
+end

stdlib/InteractiveUtils/test/runtests.jl

@@ -222,7 +222,7 @@ module A
 end
 
 # PR #23075
-@testset "versioninfo" begin
+@testset "versioninfo()" begin
     # check that versioninfo(io; verbose=true) doesn't error, produces some output
     mktempdir() do dir
         buf = PipeBuffer()
@@ -239,6 +239,17 @@ end
     end
 end
 
+@testset "diagnostics()" begin
+    # check that diagnostics(io) doesn't error, produces some output
+    buf = PipeBuffer()
+    InteractiveUtils.diagnostics(buf)
+    output = read(buf, String)
+    @test occursin("Julia Version $VERSION", output)
+    @test occursin("Environment:", ver)
+
+    InteractiveUtils.diagnostics(stdout) # TODO: delete this line before merging the PR
+end
+
 const curmod = @__MODULE__
 const curmod_name = fullname(curmod)
 const curmod_str = curmod === Main ? "Main" : join(curmod_name, ".")

stdlib/LinearAlgebra/src/diagnostics.jl

@@ -0,0 +1,5 @@
+# LinearAlgebra.__diagnostics__()
+function __diagnostics__(io::IO)
+    versioninfo(io) # LinearAlgebra.versioninfo()
+    return nothing
+end

stdlib/LinearAlgebra/test/diagnostics.jl

@@ -0,0 +1,9 @@
+@testset "__diagnostics__()" begin
+    # check that `LinearAlgebra.__diagnostics__(io)` doesn't error, produces some output
+    buf = PipeBuffer()
+    LinearAlgebra.__diagnostics__(buf)
+    output = read(buf, String)
+    @test !isempty(strip(output))
+
+    NetworkOptions.__diagnostics__(stdout) # TODO: delete this line before merging the PR
+end

stdlib/LinearAlgebra/test/testgroups

@@ -26,3 +26,4 @@ structuredbroadcast
 addmul
 ldlt
 factorization
+diagnostics