Fix flaky test

Author: tz-lom

src/deployconfig.jl

@@ -520,8 +520,8 @@ function post_status(cfg::GitHubActions; type, repo::String, subfolder = nothing
         end
         sha === nothing && return
         return post_github_status(cfg, type, repo, sha, subfolder)
-    catch
-        @debug "Failed to post status"
+    catch e
+        @debug "Failed to post status" e
     end
 end
 

test/deployconfig.jl

@@ -1521,7 +1521,7 @@ end
     if Sys.which("curl") === nothing
         @warn "'curl' binary not found, skipping related tests."
     else
-        @testset "Default GitHubActions" begin
+        @testset "Default GitHubActions push" begin
             buffer = IOBuffer()
             logger = SimpleLogger(buffer, Logging.Debug)
             with_logger(logger) do
@@ -1539,7 +1539,40 @@ end
                 end
             end
             logged = read(seek(buffer, 0), String)
-            @test occursin("""`curl -sX POST -H 'Authorization: token SGVsbG8sIHdvcmxkLg==' -H 'User-Agent: Documenter.jl' -H 'Content-Type: application/json' -d '{"target_url":"https://JuliaDocs.github.io/Documenter.jl/","context":"documenter/deploy","description":"Documentation build succeeded","state":"success"}' badurl://api.github.com/repos/JuliaDocs/Documenter.jl/statuses/407d4b94`""", logged)
+            @test occursin(r"""`curl -sX POST -H 'Authorization: token SGVsbG8sIHdvcmxkLg==' -H 'User-Agent: Documenter.jl' -H 'Content-Type: application/json' -d '{.+?}' badurl://api.github.com/repos/JuliaDocs/Documenter.jl/statuses/407d4b94`""", logged)
+            @test occursin(r"""`.+?{.*?\"target_url":"https://JuliaDocs.github.io/Documenter.jl/".*?}'.+?`""", logged)
+            @test occursin(r"""`.+?{.*?\"context\":\"documenter/deploy\".*?}'.+?`""", logged)
+            @test occursin(r"""`.+?{.*?\"description\":\"Documentation build succeeded\".*?}'.+?`""", logged)
+            @test occursin(r"""`.+?{.*?\"state\":\"success\".*?}'.+?`""", logged)
+        end
+
+        @testset "Default GitHubActions pull_request" begin
+            buffer = IOBuffer()
+            logger = SimpleLogger(buffer, Logging.Debug)
+            with_logger(logger) do
+                mktemp() do path, io
+                    write(io, """{"pull_request":{"head":{"sha":"407d4b94"}}}""")
+                    close(io)
+                    withenv(
+                        "GITHUB_EVENT_NAME" => "pull_request",
+                        "GITHUB_EVENT_PATH" => path,
+                        "GITHUB_REPOSITORY" => "JuliaDocs/Documenter.jl",
+                        "GITHUB_REF" => "refs/tags/v1.2.3",
+                        "GITHUB_ACTOR" => "github-actions",
+                        "GITHUB_TOKEN" => "SGVsbG8sIHdvcmxkLg==",
+                        "GITHUB_API_URL" => "badurl://api.github.com" # use bad url protocol to trigger CURL failure
+                    ) do
+                        cfg = Documenter.GitHubActions()
+                        Documenter.post_status(cfg; type = "success", repo = "github.com/JuliaDocs/Documenter.jl")
+                    end
+                end
+            end
+            logged = read(seek(buffer, 0), String)
+            @test occursin(r"""`curl -sX POST -H 'Authorization: token SGVsbG8sIHdvcmxkLg==' -H 'User-Agent: Documenter.jl' -H 'Content-Type: application/json' -d '{.+?}' badurl://api.github.com/repos/JuliaDocs/Documenter.jl/statuses/407d4b94`""", logged)
+            @test occursin(r"""`.+?{.*?\"target_url":"https://JuliaDocs.github.io/Documenter.jl/".*?}'.+?`""", logged)
+            @test occursin(r"""`.+?{.*?\"context\":\"documenter/deploy\".*?}'.+?`""", logged)
+            @test occursin(r"""`.+?{.*?\"description\":\"Documentation build succeeded\".*?}'.+?`""", logged)
+            @test occursin(r"""`.+?{.*?\"state\":\"success\".*?}'.+?`""", logged)
         end
 
         @testset "Self-hosted GitHubActions" begin
@@ -1555,12 +1588,17 @@ end
                     "GITHUB_TOKEN" => "SGVsbG8sIHdvcmxkLg==",
                     "GITHUB_API_URL" => "badurl://api.github.selfhosted" # use bad url protocol to trigger CURL failure
                 ) do
-                    cfg = Documenter.GitHubActions("github.selfhosted", "pages.selfhosted")
+                    cfg = Documenter.GitHubActions("github.selfhosted", "pages.selfhosted/pages/JuliaDocs/Documenter.jl")
                     Documenter.post_status(cfg; type = "success", repo = "github.selfhosted/JuliaDocs/Documenter.jl")
                 end
             end
             logged = read(seek(buffer, 0), String)
-            @test occursin("""`curl -sX POST -H 'Authorization: token SGVsbG8sIHdvcmxkLg==' -H 'User-Agent: Documenter.jl' -H 'Content-Type: application/json' -d '{\"target_url\":\"pages.selfhosted\",\"context\":\"documenter/deploy\",\"description\":\"Documentation build succeeded\",\"state\":\"success\"}' badurl://api.github.selfhosted/repos/JuliaDocs/Documenter.jl/statuses/407d4b94`""", logged)
+            @test occursin(r"""`curl -sX POST -H 'Authorization: token SGVsbG8sIHdvcmxkLg==' -H 'User-Agent: Documenter.jl' -H 'Content-Type: application/json' -d '{.+?}' badurl://api.github.selfhosted/repos/JuliaDocs/Documenter.jl/statuses/407d4b94`""", logged)
+            @test occursin(r"""`.+?{.*?\"target_url\":\"pages.selfhosted/pages/JuliaDocs/Documenter.jl\".*?}'.+?`""", logged)
+            @test occursin(r"""`.+?{.*?\"context\":\"documenter/deploy\".*?}'.+?`""", logged)
+            @test occursin(r"""`.+?{.*?\"description\":\"Documentation build succeeded\".*?}'.+?`""", logged)
+            @test occursin(r"""`.+?{.*?\"state\":\"success\".*?}'.+?`""", logged)
+
         end
 
     end