Add capturing checks publisher, make publishChecks withChecksName aware

docs/consumers-guide.md

@@ -62,3 +62,10 @@ 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
 
+## Integration Testing
+
+An implementation of `ChecksPublisher` that captures all published `ChecksDetails` is provided
+in the `test` classifier, as `io.jenkins.plugins.checks.api.test.CapturingChecksPublisher`.
+
+Adding the factory for this publisher as a `TestExtension` will allow inspection of published checks after running a job
+on a `JenkinsRule`.

pom.xml

@@ -126,6 +126,22 @@
           </analysisConfiguration>
         </configuration>
       </plugin>
+      <plugin>
+        <groupId>org.apache.maven.plugins</groupId>
+        <artifactId>maven-jar-plugin</artifactId>
+        <executions>
+          <execution>
+            <goals>
+              <goal>test-jar</goal>
+            </goals>
+            <configuration>
+              <includes combine.children="append">
+                <include>**/api/test/**</include>
+              </includes>
+            </configuration>
+          </execution>
+        </executions>
+      </plugin>
     </plugins>
   </build>
 

src/main/java/io/jenkins/plugins/checks/api/test/CapturingChecksPublisher.java → src/test/java/io/jenkins/plugins/checks/api/test/CapturingChecksPublisher.java

@@ -18,16 +18,29 @@
  * For example:
  *
  * <pre>
- * public class ChecksPublishingTest {
+ * public class ChecksPublishingTest extends IntegrationTestWithJenkinsPerTest {
+ *
  *     &#64;TestExtension
  *     public static final CapturingChecksPublisher.Factory PUBLISHER_FACTORY = new CapturingChecksPublisher.Factory();
  *
  *     &#64;After
  *     public void clearPublishedChecks() {
  *         PUBLISHER_FACTORY.getPublishedChecks().clear();
  *     }
+ *
+ *     &#64;Test
+ *     public void testChecksPublishing() {
+ *
+ *         // ...Run a test job...
+ *
+ *         List&lt;ChecksDetails&gt; publishedDetails = PUBLISHER_FACTORY.getPublishedChecks();
+ *
+ *         // ...Inspect published checks...
+ *     }
  * }
  * </pre>
+ *
+ * An example of this can be found in {@link io.jenkins.plugins.checks.steps.PublishChecksStepITest}
  */
 public class CapturingChecksPublisher extends ChecksPublisher {
 

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

@@ -13,7 +13,6 @@
 import java.io.IOException;
 
 import static org.assertj.core.api.Assertions.assertThat;
-import static org.mockito.ArgumentMatchers.eq;
 
 /**
  * Tests the pipeline step to publish checks.

src/test/resources/design.puml

@@ -7,14 +7,12 @@ skinparam component {
 }
 
 [API] <<..checks.api>>
-[Test] <<..checks.api.test>>
 [Steps] <<..checks.steps>>
 [Status] <<..checks.status>>
 [Checks] <<..checks>>
 
 [Steps] --> [API]
 [Status] --> [API]
 [Checks] --> [API]
-[Test] --> [API]
 
 @enduml