[Autobuild] Add log file prompt (#1154)

* [autobuild] Add log file prompt

* [AutoBuild] Tweak prompt copy

* Update src/AutoBuild.jl

Co-authored-by: Mosè Giordano <giordano@users.noreply.github.com>

* Update src/AutoBuild.jl

Co-authored-by: Mosè Giordano <giordano@users.noreply.github.com>

* Update src/AutoBuild.jl

Co-authored-by: Mosè Giordano <giordano@users.noreply.github.com>

* Update src/AutoBuild.jl

* Add test for debug prompt

* Add dashes before files

* Fix testset closure

* Two space tabs (make consistent with other examples)

* Typo

* Fix remaining four space tab

* Update test/basic.jl

* Fixes based on giordano's patch

* Fix path

* Update test/basic.jl

Co-authored-by: Mosè Giordano <giordano@users.noreply.github.com>

* Update test/basic.jl

Co-authored-by: Mosè Giordano <giordano@users.noreply.github.com>

* Extract testset

Co-authored-by: Mosè Giordano <giordano@users.noreply.github.com>

Author: jeremiahpslewis

src/AutoBuild.jl

@@ -605,6 +605,32 @@ function get_meta_json(
     return dict
 end
 
+function compose_debug_prompt(workspace)
+    log_files = String[]
+    for (root, dirs, files) in walkdir(joinpath(workspace, "srcdir"))
+        for file in files
+            if endswith(file, ".log")
+                push!(log_files, replace(joinpath(root, file), workspace => "\${WORKSPACE}"))
+            end
+        end
+    end
+    
+    if length(log_files) > 0
+        log_files_str = join(log_files, "\n  - ")
+
+        debug_shell_prompt = """
+        Build failed, the following log files were generated:
+          - $log_files_str
+
+        Launching debug shell:
+        """
+    else
+        debug_shell_prompt = "Build failed, launching debug shell:"
+    end
+
+    return debug_shell_prompt
+end
+
 """
     autobuild(dir::AbstractString, src_name::AbstractString,
               src_version::VersionNumber, sources::Vector,
@@ -793,7 +819,9 @@ function autobuild(dir::AbstractString,
         end
         if !did_succeed
             if debug
-                @warn("Build failed, launching debug shell")
+                # Print debug prompt and paths to any generated log files
+                debug_shell_prompt = compose_debug_prompt(prefix.path)
+                @warn(debug_shell_prompt)
                 run_interactive(ur, `/bin/bash -l -i`)
             end
             msg = "Build for $(src_name) on $(triplet(platform)) did not complete successfully\n"

test/basic.jl

@@ -111,6 +111,18 @@ end
     end
 end
 
+@testset "Debug Prompt (Flag Generated Logs)" begin
+    mktempdir() do build_path
+        log_dir = joinpath(build_path, "srcdir")
+        mkdir(log_dir)
+        @test "Build failed, launching debug shell:" == BinaryBuilder.compose_debug_prompt(build_path)
+
+        logfile_path = joinpath(log_dir, "errors.log")
+        write(logfile_path, "sample log message")
+        @test "Build failed, the following log files were generated:\n  - $(replace(logfile_path, "$build_path" => "\${WORKSPACE}"))\n\nLaunching debug shell:\n" == BinaryBuilder.compose_debug_prompt(build_path)
+    end
+end
+
 @testset "Wizard Utilities" begin
     # Make sure canonicalization does what we expect
     zmq_url = "https://github.com/zeromq/zeromq3-x/releases/download/v3.2.5/zeromq-3.2.5.tar.gz"