Issue-361: Add prudent information about a publishing of checks.

jenkinsci · Oct 4, 2023 · 3838fa3 · 3838fa3
1 parent 8d17133
commit 3838fa3
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 3 deletions.
diff --git a/src/main/java/io/jenkins/plugins/checks/github/GitHubChecksPublisher.java b/src/main/java/io/jenkins/plugins/checks/github/GitHubChecksPublisher.java
@@ -96,9 +96,12 @@ public void publish(final ChecksDetails details) {
 
             context.addActionIfMissing(run.getId(), gitHubDetails.getName());
 
-            buildLogger.log("GitHub check (name: %s, status: %s) has been published.", gitHubDetails.getName(),
-                    gitHubDetails.getStatus());
-            SYSTEM_LOGGER.fine(format("Published check for repo: %s, sha: %s, job name: %s, name: %s, status: %s",
+            buildLogger.log("GitHub check (name: %s, status: %s, url: %s) has been published.",
+                    gitHubDetails.getName(),
+                    gitHubDetails.getStatus(),
+                    gitHub.getApiUrl());
+            SYSTEM_LOGGER.fine(format("Published check for url: %s, repo: %s, sha: %s, job name: %s, name: %s, status: %s",
+                    gitHub.getApiUrl(),
                     context.getRepository(),
                     context.getHeadSha(),
                     context.getJob().getFullName(),

diff --git a/src/test/java/io/jenkins/plugins/checks/github/GitHubChecksPublisherITest.java b/src/test/java/io/jenkins/plugins/checks/github/GitHubChecksPublisherITest.java
@@ -161,6 +161,8 @@ public static Collection<Object[]> contextBuilders() {
      */
     @Test
     public void shouldPublishGitHubCheckRunCorrectly() {
+        loggerRule.record(GitHubChecksPublisher.class.getName(), Level.WARNING).capture(1);
+
         ChecksDetails details = new ChecksDetailsBuilder()
                 .withName("Jenkins")
                 .withStatus(ChecksStatus.COMPLETED)
@@ -206,6 +208,12 @@ public void shouldPublishGitHubCheckRunCorrectly() {
                 new PluginLogger(j.createTaskListener().getLogger(), "GitHub Checks"),
                 wireMockRule.baseUrl())
                 .publish(details);
+
+        assertThat(loggerRule.getRecords().size()).isEqualTo(1);
+        assertThat(loggerRule.getMessages().get(0))
+                .contains("Failed Publishing GitHub checks: ")
+                .contains("name='Jenkins'")
+                .contains("status=COMPLETED");
     }
 
     /**