Add withChecks step (#49)

* Add withChecks step

* Add test for WithChecksStep.

* Add document and snippet generator support.

* Bump version to 1.2.0 for adding ChecksInfo and WithChecksStep.

* remove unused setter

* Remove unused import

* Add callback for withChecks.

* Add consumer doc.

* Remove unnessary denpendency version in pom

* Improve consumer doc

README.md

@@ -35,12 +35,20 @@ If enabled, the statuses will be published in different stages of a Jenkins buil
 
 ### Pipeline Usage
 
-Instead of depending on consumers plugins, the users can publish their checks directly in the pipeline script:
+- publishChecks: you can publish checks directly in the pipeline script instead of depending on consumer plugins:
 
 ```
 publishChecks name: 'example', title: 'Pipeline Check', summary: 'check through pipeline', text: 'you can publish checks in pipeline script', detailsURL: 'https://github.com/jenkinsci/checks-api-plugin#pipeline-usage'
 ```
 
+- withChecks: you can inject the check's name into the closure for other steps to use:
+
+```
+withChecks(name: 'injected name') {
+    // some other steps that will extract the name
+}
+```
+
 ## Guides
 
 - [Consumers Guide](docs/consumers-guide.md)

docs/consumers-guide.md

@@ -42,3 +42,23 @@ Consumers can set these parameters through the checks models:
 
 The publishers are created through the static factory method (`fromRun` or `fromJob`) of `ChecksPublisherFactory`.
 The factory will iterate all available implementations of the `ChecksPublisher` in order to find the suitable publisher for the Jenkins `Run` or `Job`.
+
+## Pipeline Step: withChecks
+
+The `withChecks` step injects a `ChecksInfo` object into its closure by users:
+
+```groovy
+withChecks('MyCheck') {
+  junit '*.xml'
+}
+```
+
+The injected object can be resolved by other plugin developers in their [Step](https://javadoc.jenkins.io/plugin/workflow-step-api/org/jenkinsci/plugins/workflow/steps/Step.html) implementation:
+
+```
+getContext().get(ChecksInfo.class)
+```
+
+Currently, the `ChecksInfo` object only includes a `name` specified by users,
+it is recommended that you look for this name and set it over your default checks name
+

pom.xml

@@ -55,6 +55,11 @@
       <type>test-jar</type>
     </dependency>
 
+    <dependency>
+      <groupId>org.jenkins-ci.plugins</groupId>
+      <artifactId>display-url-api</artifactId>
+    </dependency>
+
     <dependency>
       <groupId>org.jenkins-ci.plugins.workflow</groupId>
       <artifactId>workflow-step-api</artifactId>

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

@@ -0,0 +1,28 @@
+package io.jenkins.plugins.checks.steps;
+
+import java.io.Serializable;
+import java.util.Objects;
+
+/**
+ * A collection of checks properties that will be injected into {@link WithChecksStep} closure.
+ */
+public class ChecksInfo implements Serializable {
+    private static final long serialVersionUID = 1L;
+
+    private final String name;
+
+    /**
+     * Creates a {@link ChecksInfo} with checks name.
+     *
+     * @param name
+     *         the name of the check
+     */
+    public ChecksInfo(final String name) {
+        Objects.requireNonNull(name);
+        this.name = name;
+    }
+
+    public String getName() {
+        return name;
+    }
+}

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

@@ -0,0 +1,188 @@
+package io.jenkins.plugins.checks.steps;
+
+import edu.hm.hafner.util.VisibleForTesting;
+import edu.umd.cs.findbugs.annotations.NonNull;
+import hudson.Extension;
+import hudson.model.Run;
+import hudson.model.TaskListener;
+import io.jenkins.plugins.checks.api.*;
+import io.jenkins.plugins.util.PluginLogger;
+import org.jenkinsci.plugins.displayurlapi.DisplayURLProvider;
+import org.jenkinsci.plugins.workflow.steps.*;
+import org.kohsuke.stapler.DataBoundConstructor;
+
+import java.io.IOException;
+import java.io.Serializable;
+import java.util.*;
+import java.util.logging.Level;
+import java.util.logging.Logger;
+
+import static hudson.Util.fixNull;
+
+/**
+ * Pipeline step that injects a {@link ChecksInfo} into the closure.
+ */
+public class WithChecksStep extends Step implements Serializable {
+    private static final long serialVersionUID = 1L;
+
+    private final String name;
+
+    /**
+     * Creates the step with a name to inject.
+     *
+     * @param name name to inject
+     */
+    @DataBoundConstructor
+    public WithChecksStep(final String name) {
+        super();
+
+        this.name = name;
+    }
+
+    public String getName() {
+        return name;
+    }
+
+    @Override
+    public StepExecution start(final StepContext stepContext) {
+        return new WithChecksStepExecution(stepContext, this);
+    }
+
+    /**
+     * This step's descriptor which defines the function name ("withChecks") and required context.
+     */
+    @Extension
+    public static class WithChecksStepDescriptor extends StepDescriptor {
+        @Override
+        public String getFunctionName() {
+            return "withChecks";
+        }
+
+        @Override
+        public Set<? extends Class<?>> getRequiredContext() {
+            return Collections.unmodifiableSet(new HashSet<>(Arrays.asList(Run.class, TaskListener.class)));
+        }
+
+        @Override
+        public boolean takesImplicitBlockArgument() {
+            return true;
+        }
+
+        @NonNull
+        @Override
+        public String getDisplayName() {
+            return "Inject checks properties into its closure";
+        }
+    }
+
+    /**
+     * The step's execution to actually inject the {@link ChecksInfo} into the closure.
+     */
+    static class WithChecksStepExecution extends AbstractStepExecutionImpl {
+        private static final long serialVersionUID = 1L;
+        private static final Logger SYSTEM_LOGGER = Logger.getLogger(WithChecksStepExecution.class.getName());
+
+        private final WithChecksStep step;
+
+        WithChecksStepExecution(final StepContext context, final WithChecksStep step) {
+            super(context);
+            this.step = step;
+        }
+
+        @Override
+        public boolean start() {
+            ChecksInfo info = extractChecksInfo();
+            getContext().newBodyInvoker()
+                    .withContext(info)
+                    .withCallback(new WithChecksCallBack(info))
+                    .start();
+            return false;
+        }
+
+        @VisibleForTesting
+        ChecksInfo extractChecksInfo() {
+            return new ChecksInfo(step.name);
+        }
+
+        @Override
+        public void stop(final Throwable cause) {
+            publish(getContext(), new ChecksDetails.ChecksDetailsBuilder()
+                    .withName(step.getName())
+                    .withStatus(ChecksStatus.COMPLETED)
+                    .withConclusion(ChecksConclusion.CANCELED));
+        }
+
+        private void publish(final StepContext context, final ChecksDetails.ChecksDetailsBuilder builder) {
+            TaskListener listener = TaskListener.NULL;
+            try {
+                listener = fixNull(context.get(TaskListener.class), TaskListener.NULL);
+            }
+            catch (IOException | InterruptedException e) {
+                SYSTEM_LOGGER.log(Level.WARNING, "Failed getting TaskListener from the context: " + e);
+            }
+
+            PluginLogger pluginLogger = new PluginLogger(listener.getLogger(), "Checks API");
+
+            Run<?, ?> run;
+            try {
+                run = context.get(Run.class);
+            }
+            catch (IOException | InterruptedException e) {
+                String msg = "Failed getting Run from the context on the start of withChecks step: " + e;
+                pluginLogger.log(msg);
+                SYSTEM_LOGGER.log(Level.WARNING, msg);
+                context.onFailure(new IllegalStateException(msg));
+                return;
+            }
+
+            if (run == null) {
+                String msg = "No Run found in the context.";
+                pluginLogger.log(msg);
+                SYSTEM_LOGGER.log(Level.WARNING, msg);
+                context.onFailure(new IllegalStateException(msg));
+                return;
+            }
+
+            ChecksPublisherFactory.fromRun(run, listener)
+                    .publish(builder.withDetailsURL(DisplayURLProvider.get().getRunURL(run))
+                            .build());
+        }
+
+        class WithChecksCallBack extends BodyExecutionCallback {
+            private static final long serialVersionUID = 1L;
+
+            private final ChecksInfo info;
+
+            WithChecksCallBack(final ChecksInfo info) {
+                super();
+
+                this.info = info;
+            }
+
+            @Override
+            public void onStart(final StepContext context) {
+                publish(context, new ChecksDetails.ChecksDetailsBuilder()
+                        .withName(info.getName())
+                        .withStatus(ChecksStatus.IN_PROGRESS)
+                        .withConclusion(ChecksConclusion.NONE));
+            }
+
+            @Override
+            public void onSuccess(final StepContext context, final Object result) {
+                context.onSuccess(result);
+            }
+
+            @Override
+            public void onFailure(final StepContext context, final Throwable t) {
+                publish(context, new ChecksDetails.ChecksDetailsBuilder()
+                        .withName(info.getName())
+                        .withStatus(ChecksStatus.COMPLETED)
+                        .withConclusion(ChecksConclusion.FAILURE)
+                        .withOutput(new ChecksOutput.ChecksOutputBuilder()
+                                .withSummary("occurred while executing withChecks step.")
+                                .withText(t.toString()).build()));
+                context.onFailure(t);
+            }
+        }
+    }
+}

src/main/java/io/jenkins/plugins/checks/steps/package-info.java

@@ -0,0 +1,8 @@
+/**
+ * Provides default Findbugs annotations.
+ */
+@DefaultAnnotation(NonNull.class)
+package io.jenkins.plugins.checks.steps;
+
+import edu.umd.cs.findbugs.annotations.DefaultAnnotation;
+import edu.umd.cs.findbugs.annotations.NonNull;

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

@@ -0,0 +1,8 @@
+<?jelly escape-by-default='true'?>
+<j:jelly xmlns:j="jelly:core" xmlns:st="jelly:stapler" xmlns:f="/lib/form">
+
+  <f:entry title="${%title.name}" field="name">
+    <f:textbox />
+  </f:entry>
+
+</j:jelly>

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

@@ -0,0 +1 @@
+title.name=Name