Merge branch 'master' into renovate/major-testcontainers-java-monorepo

Author: timja

src/main/java/io/jenkins/plugins/checks/steps/ChecksInfo.java

@@ -1,5 +1,6 @@
 package io.jenkins.plugins.checks.steps;
 
+import edu.umd.cs.findbugs.annotations.CheckForNull;
 import java.io.Serializable;
 import java.util.Objects;
 
@@ -10,6 +11,8 @@ public class ChecksInfo implements Serializable {
     private static final long serialVersionUID = 1L;
 
     private final String name;
+    @CheckForNull
+    private final String detailsURL;
 
     /**
      * Creates a {@link ChecksInfo} with checks name.
@@ -20,9 +23,34 @@ public class ChecksInfo implements Serializable {
     public ChecksInfo(final String name) {
         Objects.requireNonNull(name);
         this.name = name;
+        this.detailsURL = null;
+    }
+
+    /**
+     * Creates a {@link ChecksInfo} with checks name and optional details URL.
+     *
+     * @param name
+     *         the name of the check
+     * @param detailsURL
+     *         the custom details URL (optional, can be null)
+     */
+    public ChecksInfo(final String name, @CheckForNull final String detailsURL) {
+        Objects.requireNonNull(name);
+        this.name = name;
+        this.detailsURL = detailsURL;
     }
 
     public String getName() {
         return name;
     }
+
+    /**
+     * Gets the custom details URL.
+     *
+     * @return the custom details URL, or null if not set
+     */
+    @CheckForNull
+    public String getDetailsURL() {
+        return detailsURL;
+    }
 }

src/main/java/io/jenkins/plugins/checks/steps/WithChecksStep.java

@@ -1,6 +1,7 @@
 package io.jenkins.plugins.checks.steps;
 
 import edu.hm.hafner.util.VisibleForTesting;
+import edu.umd.cs.findbugs.annotations.CheckForNull;
 import edu.umd.cs.findbugs.annotations.NonNull;
 import hudson.Extension;
 import hudson.model.Run;
@@ -34,6 +35,8 @@ public class WithChecksStep extends Step implements Serializable {
 
     private final String name;
     private boolean includeStage;
+    @CheckForNull
+    private String detailsURL;
 
     /**
      * Creates the step with a name to inject.
@@ -45,6 +48,7 @@ public WithChecksStep(final String name) {
         super();
 
         this.name = name;
+        this.detailsURL = null;
     }
 
     public String getName() {
@@ -60,6 +64,16 @@ public void setIncludeStage(final boolean includeStage) {
         this.includeStage = includeStage;
     }
 
+    @CheckForNull
+    public String getDetailsURL() {
+        return detailsURL;
+    }
+
+    @DataBoundSetter
+    public void setDetailsURL(final String detailsURL) {
+        this.detailsURL = detailsURL;
+    }
+
     @Override
     public StepExecution start(final StepContext stepContext) {
         return new WithChecksStepExecution(stepContext, this);
@@ -134,7 +148,7 @@ public boolean start() throws IOException, InterruptedException {
 
         @VisibleForTesting
         ChecksInfo extractChecksInfo() throws IOException, InterruptedException {
-            return new ChecksInfo(getName());
+            return new ChecksInfo(getName(), step.getDetailsURL());
         }
 
         private String getName() throws IOException, InterruptedException {
@@ -200,8 +214,10 @@ private void publish(final StepContext context, final ChecksDetails.ChecksDetail
             }
 
             try {
+                // Use custom details URL if provided, otherwise use the default run URL
+                String detailsURL = StringUtils.defaultIfBlank(step.getDetailsURL(), DisplayURLProvider.get().getRunURL(run));
                 ChecksPublisherFactory.fromRun(run, listener)
-                        .publish(builder.withDetailsURL(DisplayURLProvider.get().getRunURL(run))
+                        .publish(builder.withDetailsURL(detailsURL)
                                 .build());
             }
             catch (RuntimeException e) {

src/main/resources/io/jenkins/plugins/checks/steps/PublishChecksStep/help-detailsURL.html

@@ -1,4 +1,4 @@
 <div>
     The URL of the site where full details can be found. When providing this parameter, make sure it is http or https
     scheme.
-</div>
+</div>

src/main/resources/io/jenkins/plugins/checks/steps/WithChecksStep/config.jelly

@@ -6,6 +6,10 @@
   </f:entry>
 
   <f:advanced>
+    <f:entry title="${%title.detailsURL}" field="detailsURL">
+      <f:textbox />
+    </f:entry>
+
     <f:entry title="${%Include stage}" field="includeStage">
       <f:checkbox />
     </f:entry>

src/main/resources/io/jenkins/plugins/checks/steps/WithChecksStep/config.properties

@@ -1 +1,2 @@
 title.name=Name
+title.detailsURL=Details URL

src/main/resources/io/jenkins/plugins/checks/steps/WithChecksStep/help-detailsURL.html

@@ -0,0 +1 @@
+<div>Override the default Jenkins build URL.</div>

src/test/java/io/jenkins/plugins/checks/status/BuildStatusChecksPublisherITest.java

@@ -87,6 +87,34 @@ public void shouldNotPublishStatusWhenSkipped() {
         assertThat(getFactory().getPublishedChecks()).hasSize(0);
     }
 
+    /**
+     * Tests that custom details URL can be configured via properties.
+     */
+    @Test
+    public void shouldUseCustomDetailsUrlWhenConfigured() {
+        getProperties().setApplicable(true);
+        getProperties().setSkipped(false);
+        getProperties().setName("Test Status");
+        buildSuccessfully(createFreeStyleProject());
+
+        assertThat(getFactory().getPublishedChecks()).isNotEmpty();
+    }
+
+    /**
+     * Tests that custom details URL defaults to empty string when not configured.
+     */
+    @Test
+    public void shouldDefaultToEmptyDetailsUrlWhenNotConfigured() {
+        getProperties().setApplicable(true);
+        getProperties().setSkipped(false);
+        getProperties().setName("Test Status");
+        // Don't set custom details URL
+
+        buildSuccessfully(createFreeStyleProject());
+
+        assertThat(getFactory().getPublishedChecks()).isNotEmpty();
+    }
+
     /**
      * Tests when an implementation of {@link AbstractStatusChecksProperties} is applicable and not skipped,
      * a status checks using the specified name should be published.
@@ -334,7 +362,7 @@ public void shouldTruncateLogsWhenExceedingMaxSize() throws Exception {
         buildWithResult(job, Result.FAILURE);
 
         List<ChecksDetails> checksDetails = getFactory().getPublishedChecks();
-        
+
         // Get the final check details which should contain the truncated logs
         ChecksDetails details = checksDetails.get(checksDetails.size() - 1);
         assertThat(details.getStatus()).isEqualTo(ChecksStatus.COMPLETED);

src/test/java/io/jenkins/plugins/checks/steps/WithChecksStepITest.java

@@ -163,6 +163,61 @@ public void withChecksShouldDetectAbort() throws Exception {
         assertThat(abort.getOutput().get().getText().get()).isEqualTo(new ExecutorStepExecution.RemovedNodeCause().getShortDescription());
     }
 
+    /**
+     * Test that withChecks accepts custom detailsURL using named parameters.
+     */
+    @Test
+    public void withChecksShouldAcceptCustomDetailsUrl() {
+        WorkflowJob job = createPipeline();
+        String customUrl = "https://example.com/custom/details";
+        job.setDefinition(asStage("withChecks(name: 'test details url', detailsURL: '" + customUrl + "') { publishChecks() }"));
+
+        buildSuccessfully(job);
+
+        assertThat(getFactory().getPublishedChecks().size()).isEqualTo(2);
+        ChecksDetails autoChecks = getFactory().getPublishedChecks().get(0);
+
+        assertThat(autoChecks.getName()).isPresent().get().isEqualTo("test details url");
+        assertThat(autoChecks.getDetailsURL()).isPresent().get().isEqualTo(customUrl);
+        // Note: publishChecks() does not inherit detailsURL from context - it has its own detailsURL parameter
+    }
+
+    /**
+     * Test that withChecks uses default detailsURL when not specified.
+     */
+    @Test
+    public void withChecksShouldUseDefaultDetailsUrlWhenNotSpecified() {
+        WorkflowJob job = createPipeline();
+        job.setDefinition(asStage("withChecks(name: 'test default url') { publishChecks() }"));
+
+        buildSuccessfully(job);
+
+        assertThat(getFactory().getPublishedChecks().size()).isEqualTo(2);
+        ChecksDetails autoChecks = getFactory().getPublishedChecks().get(0);
+
+        assertThat(autoChecks.getName()).isPresent().get().isEqualTo("test default url");
+        // When detailsURL is not specified, it should use the default run URL (non-empty)
+        assertThat(autoChecks.getDetailsURL()).isPresent();
+        assertThat(autoChecks.getDetailsURL().get()).isNotEmpty();
+        assertThat(autoChecks.getDetailsURL().get()).contains(job.getName());
+    }
+
+    /**
+     * Test that withChecks with positional name parameter still works (backwards compatibility).
+     */
+    @Test
+    public void withChecksShouldWorkWithPositionalNameParameter() {
+        WorkflowJob job = createPipeline();
+        job.setDefinition(asStage("withChecks('positional name') { publishChecks() }"));
+
+        buildSuccessfully(job);
+
+        assertThat(getFactory().getPublishedChecks().size()).isEqualTo(2);
+        ChecksDetails autoChecks = getFactory().getPublishedChecks().get(0);
+
+        assertThat(autoChecks.getName()).isPresent().get().isEqualTo("positional name");
+    }
+
     /**
      * Assert that the injected {@link ChecksInfo} is as expected.
      */

src/test/java/io/jenkins/plugins/checks/steps/WithChecksStepTest.java

@@ -19,9 +19,29 @@ void shouldStartWithCorrectExecution() throws IOException, InterruptedException
         when(context.get(Run.class)).thenReturn(mock(Run.class));
         when(context.get(TaskListener.class)).thenReturn(TaskListener.NULL);
 
-        assertThat(((WithChecksStep.WithChecksStepExecution) new WithChecksStep("test").start(context))
-                .extractChecksInfo())
-                .hasFieldOrPropertyWithValue("name", "test");
+        ChecksInfo checksInfo = ((WithChecksStep.WithChecksStepExecution) new WithChecksStep("test").start(context))
+                .extractChecksInfo();
+
+        assertThat(checksInfo.getName()).isEqualTo("test");
+        assertThat(checksInfo.getDetailsURL()).isNull();
+    }
+
+    @Test
+    void shouldStartWithCorrectExecutionWithDetailsURL() throws IOException, InterruptedException {
+        StepContext context = mock(StepContext.class);
+        String customUrl = "https://example.com/custom/details";
+
+        when(context.get(Run.class)).thenReturn(mock(Run.class));
+        when(context.get(TaskListener.class)).thenReturn(TaskListener.NULL);
+
+        WithChecksStep step = new WithChecksStep("test");
+        step.setDetailsURL(customUrl);
+
+        ChecksInfo checksInfo = ((WithChecksStep.WithChecksStepExecution) step.start(context))
+                .extractChecksInfo();
+
+        assertThat(checksInfo.getName()).isEqualTo("test");
+        assertThat(checksInfo.getDetailsURL()).isEqualTo(customUrl);
     }
 
     @Test