Publish result of auto grading to GitHub checks

plugin/pom.xml

@@ -23,7 +23,7 @@
     <changelist>-SNAPSHOT</changelist>
     <module.name>${project.groupId}.autograding</module.name>
 
-    <autograding-model.version>0.3.0</autograding-model.version>
+    <autograding-model.version>0.5.0</autograding-model.version>
 
     <commons.lang.version>3.11</commons.lang.version>
 
@@ -44,6 +44,8 @@
     <pipeline-stage-step.version>2.5</pipeline-stage-step.version>
     <workflow-support.version>3.3</workflow-support.version>
     <jackson2-api.version>2.11.1</jackson2-api.version>
+
+    <useBeta>true</useBeta>
   </properties>
 
   <licenses>

plugin/src/main/java/io/jenkins/plugins/grading/AutoGrader.java

@@ -53,7 +53,8 @@ public void perform(@NonNull final Run<?, ?> run, @NonNull final FilePath worksp
         FilteredLog log = new FilteredLog(LOG_TITLE);
 
         AggregatedScore score = new AggregatedScore(configuration, log);
-        score.addAnalysisScores(new JenkinsAnalysisSupplier(run));
+        JenkinsAnalysisSupplier analysisScores = new JenkinsAnalysisSupplier(run);
+        score.addAnalysisScores(analysisScores);
         score.addTestScores(new JenkinsTestSupplier(run));
         score.addCoverageScores(new JenkinsCoverageSupplier(run));
         score.addPitScores(new JenkinsPitSupplier(run));
@@ -62,6 +63,9 @@ public void perform(@NonNull final Run<?, ?> run, @NonNull final FilePath worksp
         logHandler.log(log);
 
         run.addAction(new AutoGradingBuildAction(run, score));
+
+        AutoGradingChecksPublisher checksPublisher = new AutoGradingChecksPublisher();
+        checksPublisher.publishChecks(run, listener, score, analysisScores.getReports());
     }
 
     @Override

plugin/src/main/java/io/jenkins/plugins/grading/AutoGradingChecksPublisher.java

@@ -0,0 +1,102 @@
+package io.jenkins.plugins.grading;
+
+import java.util.Collections;
+import java.util.HashSet;
+import java.util.List;
+import java.util.Set;
+import java.util.stream.Collectors;
+
+import org.jsoup.Jsoup;
+import org.jsoup.nodes.Element;
+import org.jsoup.nodes.TextNode;
+
+import edu.hm.hafner.analysis.Issue;
+import edu.hm.hafner.analysis.Report;
+import edu.hm.hafner.grading.AggregatedScore;
+import edu.hm.hafner.grading.GradingReport;
+
+import hudson.model.Run;
+import hudson.model.TaskListener;
+
+import io.jenkins.plugins.checks.api.ChecksAnnotation;
+import io.jenkins.plugins.checks.api.ChecksAnnotation.ChecksAnnotationBuilder;
+import io.jenkins.plugins.checks.api.ChecksAnnotation.ChecksAnnotationLevel;
+import io.jenkins.plugins.checks.api.ChecksConclusion;
+import io.jenkins.plugins.checks.api.ChecksDetails;
+import io.jenkins.plugins.checks.api.ChecksDetails.ChecksDetailsBuilder;
+import io.jenkins.plugins.checks.api.ChecksOutput.ChecksOutputBuilder;
+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;
+
+/**
+ * Publishes the autograding results to SCM providers.
+ *
+ * @author Ullrich Hafner
+ */
+class AutoGradingChecksPublisher {
+    void publishChecks(final Run<?, ?> run, final TaskListener listener,
+            final AggregatedScore score, final List<Report> warnings) {
+        ChecksPublisher publisher = ChecksPublisherFactory.fromRun(run, listener);
+
+        GradingReport report = new GradingReport();
+
+        ChecksDetails details = new ChecksDetailsBuilder()
+                .withName("Autograding")
+                .withStatus(ChecksStatus.COMPLETED)
+                .withConclusion(ChecksConclusion.SUCCESS)
+                .withOutput(new ChecksOutputBuilder()
+                        .withTitle(report.getHeader())
+                        .withSummary(report.getSummary(score))
+                        .withText(report.getDetails(score, Collections.emptyList(), warnings))
+                        .withAnnotations(createAnnotations(warnings))
+                        .build())
+                .withDetailsURL(new JenkinsFacade().getAbsoluteUrl(AutoGradingJobAction.ID))
+                .build();
+
+        publisher.publish(details);
+    }
+
+    private List<ChecksAnnotation> createAnnotations(final List<Report> reports) {
+        return reports.stream().flatMap(Report::stream).map(this::createAnnotation).collect(Collectors.toList());
+    }
+
+    private ChecksAnnotation createAnnotation(final Issue warning) {
+        ChecksAnnotationBuilder builder = new ChecksAnnotationBuilder()
+                .withPath(warning.getFileName())
+                .withTitle(warning.getType())
+                .withAnnotationLevel(ChecksAnnotationLevel.WARNING)
+                .withMessage(warning.getSeverity() + ":\n" + parseHtml(warning.getMessage()))
+                .withStartLine(warning.getLineStart())
+                .withEndLine(warning.getLineEnd())
+                .withRawDetails(warning.getDescription());
+
+        if (warning.getLineStart() == warning.getLineEnd()) {
+            builder.withStartColumn(warning.getColumnStart())
+                    .withEndColumn(warning.getColumnEnd());
+        }
+        return builder.build();
+    }
+
+    private String parseHtml(final String html) {
+        Set<String> contents = new HashSet<>();
+        parseHtml(Jsoup.parse(html), contents);
+        return String.join("\n", contents);
+    }
+
+    private void parseHtml(final Element html, final Set<String> contents) {
+        for (TextNode node : html.textNodes()) {
+            contents.add(node.text().trim());
+        }
+
+        for (Element child : html.children()) {
+            if (child.hasAttr("href")) {
+                contents.add(child.text().trim() + ":" + child.attr("href").trim());
+            }
+            else {
+                parseHtml(child, contents);
+            }
+        }
+    }
+}

plugin/src/main/java/io/jenkins/plugins/grading/JenkinsAnalysisSupplier.java

@@ -3,18 +3,20 @@
 import java.util.List;
 import java.util.stream.Collectors;
 
+import edu.hm.hafner.analysis.Report;
 import edu.hm.hafner.grading.AnalysisConfiguration;
 import edu.hm.hafner.grading.AnalysisScore;
 import edu.hm.hafner.grading.AnalysisScore.AnalysisScoreBuilder;
 import edu.hm.hafner.grading.AnalysisSupplier;
 
 import hudson.model.Run;
 
+import io.jenkins.plugins.analysis.core.model.AnalysisResult;
 import io.jenkins.plugins.analysis.core.model.ResultAction;
 
 /**
- * Supplies {@link AnalysisScore static analysis scores} based on the results of the registered
- * {@link ResultAction} instances.
+ * Supplies {@link AnalysisScore static analysis scores} based on the results of the registered {@link ResultAction}
+ * instances.
  *
  * @author Ullrich Hafner
  */
@@ -36,4 +38,12 @@ protected List<AnalysisScore> createScores(final AnalysisConfiguration configura
                         .withTotalLowSeveritySize(action.getResult().getTotalLowPrioritySize())
                         .build()).collect(Collectors.toList());
     }
+
+    List<Report> getReports() {
+        return run.getActions(ResultAction.class)
+                .stream()
+                .map(ResultAction::getResult)
+                .map(AnalysisResult::getIssues)
+                .collect(Collectors.toList());
+    }
 }