Honor skipProgressUpdates for queued and checkout status publishes

The skipProgressUpdates property only guarded the stage updates
published by ChecksGraphListener. The "queued" status published when a
job is scheduled and the "in progress" statuses published after every
SCM checkout ignored the flag, so a job opting out of progress updates
still published several intermediate statuses per build. With the flag
set, the final completed status is now the only publish.

Author: jlanglois-jam

src/main/java/io/jenkins/plugins/checks/status/AbstractStatusChecksProperties.java

@@ -64,8 +64,9 @@ public boolean isSuppressLogs(final Job<?, ?> job) {
     }
 
     /**
-     * Returns whether to suppress progress updates from the {@link io.jenkins.plugins.checks.status.FlowExecutionAnalyzer}.
-     * Queued, Checkout and Completed will still run but not 'onNewHead'
+     * Returns whether to suppress intermediate progress updates: the "queued" status published when the job is
+     * scheduled, the "in progress" status published after each SCM checkout, and the stage updates from the
+     * {@link io.jenkins.plugins.checks.status.FlowExecutionAnalyzer}. The final completed status is always published.
      *
      * @param job
      *         A jenkins job.

src/main/java/io/jenkins/plugins/checks/status/BuildStatusChecksPublisher.java

@@ -137,7 +137,7 @@ public static class JobScheduledListener extends QueueListener {
          * {@inheritDoc}
          *
          * <p>
-         * When a job enters queue, creates the check on "queued".
+         * When a job enters queue, creates the check on "queued", unless progress updates are skipped.
          * </p>
          */
         @Override
@@ -147,6 +147,10 @@ public void onEnterWaiting(final Queue.WaitingItem wi) {
             }
 
             final Job<?, ?> job = (Job<?, ?>) wi.task;
+            if (findProperties(job).isSkipProgressUpdates(job)) {
+                return;
+            }
+
             getChecksName(job).ifPresent(checksName -> runAsync(() -> {
                 ChecksPublisher publisher = ChecksPublisherFactory.fromJob(job, TaskListener.NULL);
                 publish(publisher, ChecksStatus.QUEUED, ChecksConclusion.NONE, checksName, null);
@@ -169,13 +173,18 @@ public static class JobCheckoutListener extends SCMListener {
          * {@inheritDoc}
          *
          * <p>
-         * When checkout finished, update the check to "in progress".
+         * When checkout finished, update the check to "in progress", unless progress updates are skipped.
          * </p>
          */
         @Override
         public void onCheckout(final Run<?, ?> run, final SCM scm, final FilePath workspace,
                                final TaskListener listener, @CheckForNull final File changelogFile,
                                @CheckForNull final SCMRevisionState pollingBaseline) {
+            Job<?, ?> job = run.getParent();
+            if (findProperties(job).isSkipProgressUpdates(job)) {
+                return;
+            }
+
             getChecksName(run).ifPresent(checksName -> publish(ChecksPublisherFactory.fromRun(run, listener),
                     ChecksStatus.IN_PROGRESS, ChecksConclusion.NONE, checksName, null));
         }

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

@@ -149,6 +149,29 @@ public void shouldPublishStatusWithProperties() throws Exception {
         assertThat(details.getConclusion()).isEqualTo(ChecksConclusion.SUCCESS);
     }
 
+    /**
+     * Tests that when progress updates are skipped, the only published status is the final completed one:
+     * nothing is published when the job is scheduled or when checkout finishes.
+     */
+    @Test
+    public void shouldOnlyPublishCompletedStatusWhenProgressUpdatesAreSkipped() throws Exception {
+        getProperties().setApplicable(true);
+        getProperties().setSkipped(false);
+        getProperties().setSkipProgressUpdates(true);
+        getProperties().setName("Test Status");
+
+        buildSuccessfully(createFreeStyleProject());
+        // Wait for the job to finish to work around slow Windows builds sometimes
+        this.getJenkins().waitUntilNoActivity();
+        assertThat(getFactory().getPublishedChecks()).hasSize(1);
+
+        ChecksDetails details = getFactory().getPublishedChecks().get(0);
+
+        assertThat(details.getName()).contains("Test Status");
+        assertThat(details.getStatus()).isEqualTo(ChecksStatus.COMPLETED);
+        assertThat(details.getConclusion()).isEqualTo(ChecksConclusion.SUCCESS);
+    }
+
     /**
      * Test checks output includes pipeline details.
      */
@@ -556,6 +579,7 @@ static class ChecksProperties extends AbstractStatusChecksProperties {
         private boolean skipped;
         private String name;
         private boolean suppressLogs;
+        private boolean skipProgressUpdates;
 
         public void setApplicable(final boolean applicable) {
             this.applicable = applicable;
@@ -573,6 +597,10 @@ public void setSuppressLogs(final boolean suppressLogs) {
             this.suppressLogs = suppressLogs;
         }
 
+        public void setSkipProgressUpdates(final boolean skipProgressUpdates) {
+            this.skipProgressUpdates = skipProgressUpdates;
+        }
+
         @Override
         public boolean isApplicable(final Job<?, ?> job) {
             return applicable;
@@ -592,5 +620,10 @@ public boolean isSkipped(final Job<?, ?> job) {
         public boolean isSuppressLogs(final Job<?, ?> job) {
             return suppressLogs;
         }
+
+        @Override
+        public boolean isSkipProgressUpdates(final Job<?, ?> job) {
+            return skipProgressUpdates;
+        }
     }
 }