Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Publish only results included in current invocation to checks api - fixes #198 #199

Merged
merged 2 commits into from
Nov 10, 2020
Merged

Publish only results included in current invocation to checks api - fixes #198 #199

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5d837e7
Publish only results included in current invocation to checks api
mrginglymus Oct 29, 2020
ae34284
Refix test
mrginglymus Oct 29, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 1 addition & 3 deletions src/main/java/hudson/tasks/junit/JUnitResultArchiver.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -186,7 +186,6 @@ public static TestResultAction parseAndAttach(@Nonnull JUnitTask task, PipelineT
action.mergeResult(result, listener);
}
action.setHealthScaleFactor(task.getHealthScaleFactor()); // overwrites previous value if appending
action.setChecksName(task.getChecksName());
if (result.isEmpty()) {
if (build.getResult() == Result.FAILURE) {
// most likely a build failed before it gets to the test phase.
Expand Down Expand Up @@ -262,7 +261,6 @@ public static TestResultSummary parseAndSummarize(@Nonnull JUnitTask task, Pipel
summary = new TestResultSummary(result);
}
action.setHealthScaleFactor(task.getHealthScaleFactor()); // overwrites previous value if appending
action.setChecksName(task.getChecksName());
if (summary.getTotalCount() == 0 && /* maybe a secondary effect */ build.getResult() != Result.FAILURE) {
assert task.isAllowEmptyResults();
listener.getLogger().println(Messages.JUnitResultArchiver_ResultIsEmpty());
Expand All @@ -284,7 +282,7 @@ public static TestResultSummary parseAndSummarize(@Nonnull JUnitTask task, Pipel
}

if (!task.isSkipPublishingChecks()) {
new JUnitChecksPublisher(action, summary).publishChecks(listener);
new JUnitChecksPublisher(build, task.getChecksName(), result, summary).publishChecks(listener);
}

return summary;
Expand Down
13 changes: 0 additions & 13 deletions src/main/java/hudson/tasks/junit/TestResultAction.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,6 @@ public class TestResultAction extends AbstractTestResultAction<TestResultAction>
private @Nullable Integer totalCount;
private Double healthScaleFactor;
private List<Data> testData = new ArrayList<>();
private String checksName;

@Deprecated
public TestResultAction(AbstractBuild owner, TestResult result, BuildListener listener) {
Expand Down Expand Up @@ -287,18 +286,6 @@ public void addData(Data data) {
}
}

public String getChecksName() {
if (Util.fixEmpty(checksName) == null) {
return "Tests";
}

return checksName;
}

public void setChecksName(String checksName) {
this.checksName = checksName;
}

/**
* Merges an additional test result into this one.
*/
Expand Down
23 changes: 15 additions & 8 deletions src/main/java/io/jenkins/plugins/junit/checks/JUnitChecksPublisher.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,11 @@
package io.jenkins.plugins.junit.checks;

import edu.hm.hafner.util.VisibleForTesting;
import hudson.Util;
import hudson.model.Run;
import hudson.model.TaskListener;
import hudson.tasks.junit.CaseResult;
import hudson.tasks.junit.TestResult;
import hudson.tasks.junit.TestResultAction;
import hudson.tasks.junit.TestResultSummary;
import io.jenkins.plugins.checks.api.ChecksConclusion;
Expand All @@ -23,30 +26,34 @@ public class JUnitChecksPublisher {

// cap to avoid hitting check API message limit
private static final int MAX_MSG_SIZE_TO_CHECKS_API = 65535;
private final TestResultAction action;
private final Run run;
private final String checksName;
private final TestResult result;
private final TestResultSummary summary;

public JUnitChecksPublisher(final TestResultAction action, final TestResultSummary summary) {
this.action = action;
public JUnitChecksPublisher(final Run run, final String checksName, final TestResult result, final TestResultSummary summary) {
this.run = run;
this.checksName = Util.fixEmpty(checksName) == null ? "Tests" : checksName;
this.result = result;
this.summary = summary;
}

public void publishChecks(TaskListener listener) {
ChecksPublisher publisher = ChecksPublisherFactory.fromRun(action.run, listener);
ChecksPublisher publisher = ChecksPublisherFactory.fromRun(run, listener);
publisher.publish(extractChecksDetails());
}

@VisibleForTesting
ChecksDetails extractChecksDetails() {
String testsURL = DisplayURLProvider.get().getTestsURL(action.run);
String testsURL = DisplayURLProvider.get().getTestsURL(run);
ChecksOutput output = new ChecksOutput.ChecksOutputBuilder()
.withTitle(extractChecksTitle())
.withSummary("<sub>Send us [feedback](https://github.com/jenkinsci/junit-plugin/issues)")
.withText(extractChecksText(testsURL))
.build();

return new ChecksDetails.ChecksDetailsBuilder()
.withName(action.getChecksName())
.withName(checksName)
.withStatus(ChecksStatus.COMPLETED)
.withConclusion(summary.getFailCount() > 0 ? ChecksConclusion.FAILURE : ChecksConclusion.SUCCESS)
.withDetailsURL(testsURL)
Expand All @@ -57,7 +64,7 @@ ChecksDetails extractChecksDetails() {
private String extractChecksText(String testsURL) {
StringBuilder builder = new StringBuilder();
if (summary.getFailCount() > 0) {
List<CaseResult> failedTests = action.getResult().getFailedTests();
List<CaseResult> failedTests = result.getFailedTests();

for (CaseResult failedTest: failedTests) {
String testReport = mapFailedTestToTestReport(failedTest);
Expand Down Expand Up @@ -114,7 +121,7 @@ private String extractChecksTitle() {
StringBuilder builder = new StringBuilder();

if (summary.getFailCount() == 1) {
CaseResult failedTest = action.getResult().getFailedTests().get(0);
CaseResult failedTest = result.getFailedTests().get(0);
builder.append(failedTest.getTransformedFullDisplayName()).append(" failed");
return builder.toString();
}
Expand Down
10 changes: 6 additions & 4 deletions src/test/java/io/jenkins/plugins/junit/checks/JUnitChecksPublisherTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ public void extractChecksDetailsPassingTestResults() throws Exception {
assertNotNull(action);

TestResultSummary summary = new TestResultSummary(0, 0, 6, 6);
JUnitChecksPublisher publisher = new JUnitChecksPublisher(action, summary);
JUnitChecksPublisher publisher = new JUnitChecksPublisher(r, null, action.getResult(), summary);
ChecksDetails checksDetails = publisher.extractChecksDetails();

assertThat(checksDetails.getConclusion(), is(ChecksConclusion.SUCCESS));
Expand Down Expand Up @@ -75,10 +75,11 @@ public void extractChecksDetailsFailingSingleTestResult() throws Exception {
assertNotNull(action);

TestResultSummary summary = new TestResultSummary(1, 0, 1, 2);
JUnitChecksPublisher publisher = new JUnitChecksPublisher(action, summary);
JUnitChecksPublisher publisher = new JUnitChecksPublisher(r, "", action.getResult(), summary);
ChecksDetails checksDetails = publisher.extractChecksDetails();

assertThat(checksDetails.getConclusion(), is(ChecksConclusion.FAILURE));
assertThat(checksDetails.getName().get(), is("Tests"));

ChecksOutput output = checksDetails.getOutput().get();

Expand All @@ -104,10 +105,11 @@ public void extractChecksDetailsFailingMultipleTests() throws Exception {
assertNotNull(action);

TestResultSummary summary = new TestResultSummary(3, 0, 5, 8);
JUnitChecksPublisher publisher = new JUnitChecksPublisher(action, summary);
JUnitChecksPublisher publisher = new JUnitChecksPublisher(r, "Tests", action.getResult(), summary);
ChecksDetails checksDetails = publisher.extractChecksDetails();

assertThat(checksDetails.getConclusion(), is(ChecksConclusion.FAILURE));
assertThat(checksDetails.getName().get(), is("Tests"));

ChecksOutput output = checksDetails.getOutput().get();

Expand All @@ -133,7 +135,7 @@ public void setCustomCheckName() throws Exception {
assertNotNull(action);

TestResultSummary summary = new TestResultSummary(0, 0, 6, 6);
JUnitChecksPublisher publisher = new JUnitChecksPublisher(action, summary);
JUnitChecksPublisher publisher = new JUnitChecksPublisher(r, "Custom Checks Name", action.getResult(), summary);
ChecksDetails checksDetails = publisher.extractChecksDetails();

assertThat(checksDetails.getConclusion(), is(ChecksConclusion.SUCCESS));
Expand Down
2 changes: 1 addition & 1 deletion src/test/java/io/jenkins/plugins/junit/storage/TestResultStorageJunitTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -157,7 +157,7 @@ public class TestResultStorageJunitTest {
childNames.add(((Element) item).getTagName());
}
}
assertEquals(buildXml, ImmutableSet.of("checksName", "healthScaleFactor", "testData", "descriptions"), childNames);
assertEquals(buildXml, ImmutableSet.of("healthScaleFactor", "testData", "descriptions"), childNames);
}
Impl.queriesPermitted = true;
{
Expand Down