Skip to content

Commit

Permalink
Output pipeline summary (#66)
Browse files Browse the repository at this point in the history 
Co-authored-by: Tim Jacomb <[email protected]>
Co-authored-by: Kezhi Xiong <[email protected]>
Co-authored-by: Tim Jacomb <[email protected]>
  • Loading branch information
@mrginglymus @timja @XiongKezhi
4 people authored Feb 5, 2021
1 parent a2f223c commit 22f6a7c
Show file tree
Hide file tree
Showing 4 changed files with 501 additions and 94 deletions.
22 changes: 19 additions & 3 deletions pom.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -63,13 +63,14 @@

<dependency>
<groupId>org.jenkins-ci.plugins.workflow</groupId>
<artifactId>workflow-step-api</artifactId>
<artifactId>workflow-job</artifactId>
</dependency>

<dependency>
<groupId>org.jenkins-ci.plugins.workflow</groupId>
<artifactId>workflow-job</artifactId>
<scope>test</scope>
<artifactId>workflow-step-api</artifactId>
</dependency>

<dependency>
<groupId>org.jenkins-ci.plugins.workflow</groupId>
<artifactId>workflow-cps</artifactId>
Expand Down Expand Up @@ -128,6 +129,21 @@
<old>class io.jenkins.plugins.checks.BuildStatusChecksPublisher</old>
<justification>BuildStatusChecksPublisher has no consumers, should be safe to move.</justification>
</item>
<item>
<code>java.class.added</code>
<new>class io.jenkins.plugins.checks.status.BuildStatusChecksPublisher.ChecksGraphListener</new>
<justification>ChecksGraphListener is an extension, should be safe to add.</justification>
</item>
<item>
<code>java.method.visibilityReduced</code>
<old>method void io.jenkins.plugins.checks.status.BuildStatusChecksPublisher::&lt;init&gt;()</old>
<justification>BuildStatusChecksPublisher is a utility class</justification>
</item>
<item>
<code>java.class.externalClassExposedInAPI</code>
<newArchive>org.jenkins-ci.plugins.workflow:workflow-api:jar:2.40</newArchive>
<justification>Used only as extension in BuildStatusChecksPublisher, has no consumers.</justification>
</item>
</revapi.ignore>
</analysisConfiguration>
</configuration>
Expand Down
164 changes: 101 additions & 63 deletions src/main/java/io/jenkins/plugins/checks/status/BuildStatusChecksPublisher.java
View file
Original file line number Diff line number Diff line change
@@ -1,45 +1,56 @@
package io.jenkins.plugins.checks.status;

import java.io.File;
import java.util.Optional;

import edu.umd.cs.findbugs.annotations.CheckForNull;

import hudson.Extension;
import hudson.FilePath;
import hudson.model.Job;
import hudson.model.Queue;
import hudson.model.Result;
import hudson.model.Run;
import hudson.model.TaskListener;
import hudson.model.*;
import hudson.model.listeners.RunListener;
import hudson.model.listeners.SCMListener;
import hudson.model.queue.QueueListener;
import hudson.scm.SCM;
import hudson.scm.SCMRevisionState;

import io.jenkins.plugins.checks.api.ChecksConclusion;
import io.jenkins.plugins.checks.api.*;
import io.jenkins.plugins.checks.api.ChecksDetails.ChecksDetailsBuilder;
import io.jenkins.plugins.checks.api.ChecksPublisher;
import io.jenkins.plugins.checks.api.ChecksPublisherFactory;
import io.jenkins.plugins.checks.api.ChecksStatus;
import io.jenkins.plugins.util.JenkinsFacade;
import org.jenkinsci.plugins.workflow.actions.LabelAction;
import org.jenkinsci.plugins.workflow.flow.FlowExecution;
import org.jenkinsci.plugins.workflow.flow.GraphListener;
import org.jenkinsci.plugins.workflow.graph.FlowNode;
import org.jenkinsci.plugins.workflow.job.WorkflowRun;

import java.io.File;
import java.io.IOException;
import java.util.Optional;
import java.util.logging.Level;
import java.util.logging.Logger;
import java.util.stream.Stream;

/**
* A publisher which publishes different statuses through the checks API based on the stage of the {@link Queue.Item}
* or {@link Run}.
*/
public final class BuildStatusChecksPublisher {

private static final Logger LOGGER = Logger.getLogger(BuildStatusChecksPublisher.class.getName());

private BuildStatusChecksPublisher() {
}

private static final JenkinsFacade JENKINS = new JenkinsFacade();
private static final AbstractStatusChecksProperties DEFAULT_PROPERTIES = new DefaultStatusCheckProperties();

private static void publish(final ChecksPublisher publisher, final ChecksStatus status,
final ChecksConclusion conclusion, final String name) {
publisher.publish(new ChecksDetailsBuilder()
final ChecksConclusion conclusion, final String name, @CheckForNull final ChecksOutput output) {
ChecksDetailsBuilder builder = new ChecksDetailsBuilder()
.withName(name)
.withStatus(status)
.withConclusion(conclusion)
.build());
.withConclusion(conclusion);

if (output != null) {
builder.withOutput(output);
}

publisher.publish(builder.build());
}

@Deprecated
Expand All @@ -58,6 +69,39 @@ private static AbstractStatusChecksProperties findProperties(final Job<?, ?> job
.orElse(DEFAULT_PROPERTIES);
}

static Optional<String> getChecksName(final Run<?, ?> run) {
return getChecksName(run.getParent());
}

static Optional<String> getChecksName(final Job<?, ?> job) {
return Stream.of(
findDeprecatedProperties(job)
.filter(p -> !p.isSkip(job))
.map(p -> p.getName(job)),
Optional.of(findProperties(job))
.filter(p -> !p.isSkipped(job))
.map(p -> p.getName(job))
)
.filter(Optional::isPresent)
.map(Optional::get)
.findFirst();
}

@CheckForNull
static ChecksOutput getOutput(final Run run) {
if (run instanceof WorkflowRun) {
FlowExecution execution = ((WorkflowRun) run).getExecution();
if (execution != null) {
return getOutput(run, execution);
}
}
return null;
}

static ChecksOutput getOutput(final Run run, final FlowExecution execution) {
return new FlowExecutionAnalyzer(run, execution).extractOutput();
}

/**
* {@inheritDoc}
*
Expand All @@ -80,21 +124,9 @@ public void onEnterWaiting(final Queue.WaitingItem wi) {
return;
}

final Job job = (Job)wi.task;
Optional<StatusChecksProperties> deprecatedProperties = findDeprecatedProperties(job);
if (deprecatedProperties.isPresent()) {
if (!deprecatedProperties.get().isSkip(job)) {
publish(ChecksPublisherFactory.fromJob(job, TaskListener.NULL), ChecksStatus.QUEUED,
ChecksConclusion.NONE, deprecatedProperties.get().getName(job));
}
}
else {
final AbstractStatusChecksProperties properties = findProperties(job);
if (!properties.isSkipped(job)) {
publish(ChecksPublisherFactory.fromJob(job, TaskListener.NULL), ChecksStatus.QUEUED,
ChecksConclusion.NONE, properties.getName(job));
}
}
final Job job = (Job) wi.task;
getChecksName(job).ifPresent(checksName -> publish(ChecksPublisherFactory.fromJob(job, TaskListener.NULL),
ChecksStatus.QUEUED, ChecksConclusion.NONE, checksName, null));
}
}

Expand All @@ -117,24 +149,12 @@ public static class JobCheckoutListener extends SCMListener {
public void onCheckout(final Run<?, ?> run, final SCM scm, final FilePath workspace,
final TaskListener listener, @CheckForNull final File changelogFile,
@CheckForNull final SCMRevisionState pollingBaseline) {
final Job job = run.getParent();
final Optional<StatusChecksProperties> deprecatedProperties = findDeprecatedProperties(job);
if (deprecatedProperties.isPresent()) {
if (!deprecatedProperties.get().isSkip(job)) {
publish(ChecksPublisherFactory.fromRun(run, listener), ChecksStatus.IN_PROGRESS,
ChecksConclusion.NONE, deprecatedProperties.get().getName(job));
}
}
else {
final AbstractStatusChecksProperties properties = findProperties(job);
if (!properties.isSkipped(job)) {
publish(ChecksPublisherFactory.fromRun(run, listener), ChecksStatus.IN_PROGRESS,
ChecksConclusion.NONE, properties.getName(job));
}
}
getChecksName(run).ifPresent(checksName -> publish(ChecksPublisherFactory.fromRun(run, listener),
ChecksStatus.IN_PROGRESS, ChecksConclusion.NONE, checksName, getOutput(run)));
}
}


/**
* {@inheritDoc}
*
Expand All @@ -153,21 +173,8 @@ public static class JobCompletedListener extends RunListener<Run<?, ?>> {
*/
@Override
public void onCompleted(final Run run, @CheckForNull final TaskListener listener) {
final Job job = run.getParent();
final Optional<StatusChecksProperties> deprecatedProperties = findDeprecatedProperties(job);
if (deprecatedProperties.isPresent()) {
if (!deprecatedProperties.get().isSkip(job)) {
publish(ChecksPublisherFactory.fromRun(run, listener), ChecksStatus.COMPLETED,
extractConclusion(run), deprecatedProperties.get().getName(job));
}
}
else {
final AbstractStatusChecksProperties properties = findProperties(job);
if (!properties.isSkipped(job)) {
publish(ChecksPublisherFactory.fromRun(run, listener), ChecksStatus.COMPLETED,
extractConclusion(run), properties.getName(job));
}
}
getChecksName(run).ifPresent(checksName -> publish(ChecksPublisherFactory.fromRun(run, listener),
ChecksStatus.COMPLETED, extractConclusion(run), checksName, getOutput(run)));
}

private ChecksConclusion extractConclusion(final Run<?, ?> run) {
Expand All @@ -193,4 +200,35 @@ else if (result.isBetterOrEqualTo(Result.ABORTED)) {
}
}
}

/**
* {@inheritDoc}
*
* <p>
* As a job progresses, record a representation of the flow graph.
* </p>
*/
@Extension
public static class ChecksGraphListener implements GraphListener {
@Override
public void onNewHead(final FlowNode node) {
if (node.getAction(LabelAction.class) == null) {
// It's not a branch or stage node, so let's not worry about updating.
return;
}

Run<?, ?> run;
try {
run = (Run) node.getExecution().getOwner().getExecutable();
}
catch (IOException e) {
LOGGER.log(Level.WARNING, "Unable to find Run from flow node.", e);
return;
}

getChecksName(run).ifPresent(checksName -> publish(ChecksPublisherFactory.fromRun(run, TaskListener.NULL),
ChecksStatus.IN_PROGRESS, ChecksConclusion.NONE, checksName, getOutput(run, node.getExecution())));

}
}
}
Loading

0 comments on commit 22f6a7c

Please sign in to comment.