Skip to content

The Unified and Autonomous Development Platform

feat: Able to render GoogleTest report (OD-2093)

Robin Shenf8f17dbec346
diff --git a/server-plugin/pom.xml b/server-plugin/pom.xml
index 46011f3535..51c96f6192 100644
--- a/server-plugin/pom.xml
+++ b/server-plugin/pom.xml
@@ -41,6 +41,7 @@
<module>server-plugin-executor-remoteshell</module>
<module>server-plugin-report-unittest</module>
<module>server-plugin-report-junit</module>
+ <module>server-plugin-report-gtest</module>
<module>server-plugin-report-trx</module>
<module>server-plugin-report-coverage</module>
<module>server-plugin-report-jacoco</module>
diff --git a/server-plugin/server-plugin-report-gtest/pom.xml b/server-plugin/server-plugin-report-gtest/pom.xml
new file mode 100644
index 0000000000..8912696e1a
--- /dev/null
+++ b/server-plugin/server-plugin-report-gtest/pom.xml
@@ -0,0 +1,26 @@
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
+ <modelVersion>4.0.0</modelVersion>
+ <artifactId>server-plugin-report-gtest</artifactId>
+ <parent>
+ <groupId>io.onedev</groupId>
+ <artifactId>server-plugin</artifactId>
+ <version>11.1.3</version>
+ </parent>
+ <dependencies>
+ <dependency>
+ <groupId>io.onedev</groupId>
+ <artifactId>server-plugin-report-unittest</artifactId>
+ <version>${project.version}</version>
+ </dependency>
+ <dependency>
+ <groupId>io.onedev</groupId>
+ <artifactId>commons-loader</artifactId>
+ <type>test-jar</type>
+ <scope>test</scope>
+ </dependency>
+ </dependencies>
+ <properties>
+ <moduleClass>io.onedev.server.plugin.report.gtest.GTestModule</moduleClass>
+ </properties>
+</project>
diff --git a/server-plugin/server-plugin-report-gtest/src/main/java/io/onedev/server/plugin/report/gtest/GTestModule.java b/server-plugin/server-plugin-report-gtest/src/main/java/io/onedev/server/plugin/report/gtest/GTestModule.java
new file mode 100644
index 0000000000..efacf3c027
--- /dev/null
+++ b/server-plugin/server-plugin-report-gtest/src/main/java/io/onedev/server/plugin/report/gtest/GTestModule.java
@@ -0,0 +1,36 @@
+package io.onedev.server.plugin.report.gtest;
+
+import java.util.Collection;
+
+import com.google.common.collect.Sets;
+
+import io.onedev.commons.loader.AbstractPluginModule;
+import io.onedev.commons.loader.ImplementationProvider;
+import io.onedev.server.buildspec.step.PublishReportStep;
+
+/**
+ * NOTE: Do not forget to rename moduleClass property defined in the pom if you've renamed this class.
+ *
+ */
+public class GTestModule extends AbstractPluginModule {
+
+ @Override
+ protected void configure() {
+ super.configure();
+
+ contribute(ImplementationProvider.class, new ImplementationProvider() {
+
+ @Override
+ public Class<?> getAbstractClass() {
+ return PublishReportStep.class;
+ }
+
+ @Override
+ public Collection<Class<?>> getImplementations() {
+ return Sets.newHashSet(PublishGTestReportStep.class);
+ }
+
+ });
+ }
+
+}
diff --git a/server-plugin/server-plugin-report-gtest/src/main/java/io/onedev/server/plugin/report/gtest/GTestReportParser.java b/server-plugin/server-plugin-report-gtest/src/main/java/io/onedev/server/plugin/report/gtest/GTestReportParser.java
new file mode 100644
index 0000000000..a4ddb27e6c
--- /dev/null
+++ b/server-plugin/server-plugin-report-gtest/src/main/java/io/onedev/server/plugin/report/gtest/GTestReportParser.java
@@ -0,0 +1,160 @@
+package io.onedev.server.plugin.report.gtest;
+
+import io.onedev.commons.utils.PlanarRange;
+import io.onedev.commons.utils.StringUtils;
+import io.onedev.server.git.BlobIdent;
+import io.onedev.server.model.Build;
+import io.onedev.server.plugin.report.unittest.UnitTestReport.Status;
+import io.onedev.server.plugin.report.unittest.UnitTestReport.TestCase;
+import io.onedev.server.plugin.report.unittest.UnitTestReport.TestSuite;
+import io.onedev.server.web.page.project.blob.ProjectBlobPage;
+import io.onedev.server.web.page.project.blob.render.BlobRenderer;
+import org.apache.commons.lang3.math.NumberUtils;
+import org.apache.commons.lang3.tuple.ImmutablePair;
+import org.apache.commons.lang3.tuple.Pair;
+import org.apache.wicket.Component;
+import org.apache.wicket.markup.html.basic.Label;
+import org.apache.wicket.request.cycle.RequestCycle;
+import org.apache.wicket.request.mapper.parameter.PageParameters;
+import org.dom4j.Document;
+import org.dom4j.Element;
+import org.jetbrains.annotations.Nullable;
+
+import java.util.ArrayList;
+import java.util.List;
+
+import static org.unbescape.html.HtmlEscape.escapeHtml5;
+
+public class GTestReportParser {
+
+ public static List<TestCase> parse(Build build, Document doc) {
+ List<TestCase> testCases = new ArrayList<>();
+ for (Element testSuiteElement : doc.getRootElement().elements()) {
+ String name = testSuiteElement.attributeValue("name");
+ long duration = (long)(getDouble(testSuiteElement.attributeValue("time"))*1000);
+ int tests = getInt(testSuiteElement.attributeValue("tests"));
+ int failures =getInt(testSuiteElement.attributeValue("failures"));
+ int errors = getInt(testSuiteElement.attributeValue("errors"));
+
+ int skipped = 0;
+ String skippedString = testSuiteElement.attributeValue("skipped");
+ if (StringUtils.isNotBlank(skippedString))
+ skipped = getInt(skippedString);
+
+ int disabled = 0;
+ String disabledString = testSuiteElement.attributeValue("disabled");
+ if (StringUtils.isNotBlank(disabledString))
+ disabled = getInt(disabledString);
+
+ Status status;
+ if (failures != 0 || errors != 0)
+ status = Status.NOT_PASSED;
+ else if (skipped + disabled == tests)
+ status = Status.NOT_RUN;
+ else
+ status = Status.PASSED;
+
+ TestSuite testSuite = new TestSuite(name, status, duration, null, null) {
+
+ @Nullable
+ @Override
+ protected Component renderDetail(String componentId, Build build) {
+ return null;
+ }
+ };
+
+ for (Element testCaseElement: testSuiteElement.elements("testcase")) {
+ name = testCaseElement.attributeValue("name");
+ var result = testCaseElement.attributeValue("result");
+ if (result.equals("skipped") || result.equals("suppressed")) {
+ var skippedElement = testCaseElement.element("skipped");
+ String message = skippedElement != null? skippedElement.getText(): null;
+ var blobLocation = parseBlobLocation(build, message);
+ testCases.add(new TestCase(testSuite, name, Status.NOT_RUN, result, 0) {
+
+ @Nullable
+ @Override
+ protected Component renderDetail(String componentId, Build build) {
+ return renderMessage(componentId, build, blobLocation, message);
+ }
+ });
+ } else {
+ duration = (long)(getDouble(testCaseElement.attributeValue("time"))*1000);
+ status = Status.PASSED;
+ String message;
+ Element failureElement = testCaseElement.element("failure");
+ Element errorElement = testCaseElement.element("error");
+ if (failureElement != null) {
+ status = Status.NOT_PASSED;
+ message = failureElement.getText();
+ } else if (errorElement != null) {
+ status = Status.NOT_PASSED;
+ message = errorElement.getText();
+ } else {
+ message = null;
+ }
+
+ var blobLocation = parseBlobLocation(build, message);
+ testCases.add(new TestCase(testSuite, name, status, null, duration) {
+
+ @Nullable
+ @Override
+ protected Component renderDetail(String componentId, Build build) {
+ return renderMessage(componentId, build, blobLocation, message);
+ }
+ });
+ }
+ }
+ }
+ return testCases;
+ }
+
+ @Nullable
+ private static Component renderMessage(String componentId, Build build,
+ @Nullable Pair<String, Integer> blobLocation,
+ @Nullable String message) {
+ if (blobLocation != null) {
+ ProjectBlobPage.State state = new ProjectBlobPage.State();
+ state.blobIdent = new BlobIdent(build.getCommitHash(), blobLocation.getLeft());
+ PlanarRange range = new PlanarRange(blobLocation.getRight()-1, -1, blobLocation.getRight()-1, -1);
+ state.position = BlobRenderer.getSourcePosition(range);
+ PageParameters params = ProjectBlobPage.paramsOf(build.getProject(), state);
+ String url = RequestCycle.get().urlFor(ProjectBlobPage.class, params).toString();
+ var html = String.format("<a href='%s'>%s</a><br>%s",
+ url,
+ StringUtils.substringBefore(message, "\n").trim(),
+ StringUtils.substringAfter(message, "\n"));
+ return new Label(componentId, html).setEscapeModelStrings(false);
+ } else if (message != null) {
+ return new Label(componentId, message);
+ } else {
+ return null;
+ }
+ }
+
+ @Nullable
+ private static Pair<String, Integer> parseBlobLocation(Build build, @Nullable String message) {
+ if (message != null) {
+ var firstLine = StringUtils.substringBefore(message, "\n").trim();
+ var possibleFilePath = StringUtils.substringBeforeLast(firstLine, ":");
+ var possibleLineNumber = StringUtils.substringAfterLast(firstLine, ":");
+ var blobPath = build.getBlobPath(possibleFilePath);
+ if (blobPath != null && NumberUtils.isDigits(possibleLineNumber))
+ return new ImmutablePair<>(blobPath, Integer.parseInt(possibleLineNumber));
+ }
+ return null;
+ }
+
+ private static int getInt(String input) {
+ if (input == null)
+ return 0;
+ return Integer.parseInt(input);
+ }
+
+ private static double getDouble(String input) {
+ if (input == null)
+ return 0;
+ return Double.parseDouble(input);
+ }
+
+}
diff --git a/server-plugin/server-plugin-report-gtest/src/main/java/io/onedev/server/plugin/report/gtest/PublishGTestReportStep.java b/server-plugin/server-plugin-report-gtest/src/main/java/io/onedev/server/plugin/report/gtest/PublishGTestReportStep.java
new file mode 100644
index 0000000000..e1333bc080
--- /dev/null
+++ b/server-plugin/server-plugin-report-gtest/src/main/java/io/onedev/server/plugin/report/gtest/PublishGTestReportStep.java
@@ -0,0 +1,88 @@
+package io.onedev.server.plugin.report.gtest;
+
+import java.io.File;
+import java.io.IOException;
+import java.io.StringReader;
+import java.nio.charset.StandardCharsets;
+import java.util.ArrayList;
+import java.util.List;
+
+import org.dom4j.DocumentException;
+import org.dom4j.io.SAXReader;
+import javax.validation.constraints.NotEmpty;
+
+import com.google.common.collect.Lists;
+
+import io.onedev.commons.codeassist.InputSuggestion;
+import io.onedev.commons.utils.FileUtils;
+import io.onedev.commons.utils.TaskLogger;
+import io.onedev.server.buildspec.BuildSpec;
+import io.onedev.server.buildspec.step.StepGroup;
+import io.onedev.server.model.Build;
+import io.onedev.server.plugin.report.unittest.PublishUnitTestReportStep;
+import io.onedev.server.plugin.report.unittest.UnitTestReport;
+import io.onedev.server.plugin.report.unittest.UnitTestReport.TestCase;
+import io.onedev.server.util.XmlUtils;
+import io.onedev.server.annotation.Editable;
+import io.onedev.server.annotation.Interpolative;
+import io.onedev.server.annotation.Patterns;
+
+@Editable(order=10000, group=StepGroup.PUBLISH, name="Google Test Report")
+public class PublishGTestReportStep extends PublishUnitTestReportStep {
+
+ private static final long serialVersionUID = 1L;
+
+ @Editable(order=100, description="Specify GoogleTest XML result file relative to <a href='https://docs.onedev.io/concepts#job-workspace'>job workspace</a>. " +
+ "This report can be generated with environment variable <tt>GTEST_OUTPUT</tt> when running tests, " +
+ "For instance, <code>export GTEST_OUTPUT=&quot;xml:gtest-result.xml&quot;</code>. " +
+ "Use * or ? for pattern match")
+ @Interpolative(variableSuggester="suggestVariables")
+ @Patterns(path=true)
+ @NotEmpty
+ @Override
+ public String getFilePatterns() {
+ return super.getFilePatterns();
+ }
+
+ @Override
+ public void setFilePatterns(String filePatterns) {
+ super.setFilePatterns(filePatterns);
+ }
+
+ @SuppressWarnings("unused")
+ private static List<InputSuggestion> suggestVariables(String matchWith) {
+ return BuildSpec.suggestVariables(matchWith, true, true, false);
+ }
+
+ @Override
+ public boolean requireCommitIndex() {
+ return true;
+ }
+
+ @Override
+ protected UnitTestReport createReport(Build build, File inputDir, TaskLogger logger) {
+ SAXReader reader = new SAXReader();
+ XmlUtils.disallowDocTypeDecl(reader);
+
+ List<TestCase> testCases = new ArrayList<>();
+ int baseLen = inputDir.getAbsolutePath().length()+1;
+ for (File file: FileUtils.listFiles(inputDir, Lists.newArrayList("**"), Lists.newArrayList())) {
+ String relativePath = file.getAbsolutePath().substring(baseLen);
+ logger.log("Processing GoogleTest report '" + relativePath + "'...");
+ try {
+ String xml = FileUtils.readFileToString(file, StandardCharsets.UTF_8);
+ xml = XmlUtils.stripDoctype(xml);
+ testCases.addAll(GTestReportParser.parse(build, reader.read(new StringReader(xml))));
+ } catch (DocumentException e) {
+ logger.warning("Ignored test report '" + relativePath + "' as it is not a valid XML");
+ } catch (IOException e) {
+ throw new RuntimeException(e);
+ }
+ }
+ if (!testCases.isEmpty())
+ return new UnitTestReport(testCases, true);
+ else
+ return null;
+ }
+
+}
diff --git a/server-plugin/server-plugin-report-gtest/src/test/java/io/onedev/server/plugin/report/gtest/GTestReportParserTest.java b/server-plugin/server-plugin-report-gtest/src/test/java/io/onedev/server/plugin/report/gtest/GTestReportParserTest.java
new file mode 100644
index 0000000000..71accb00cf
--- /dev/null
+++ b/server-plugin/server-plugin-report-gtest/src/test/java/io/onedev/server/plugin/report/gtest/GTestReportParserTest.java
@@ -0,0 +1,91 @@
+package io.onedev.server.plugin.report.gtest;
+
+import com.google.common.io.Resources;
+import io.onedev.commons.jsymbol.Symbol;
+import io.onedev.commons.loader.AppLoader;
+import io.onedev.commons.loader.AppLoaderMocker;
+import io.onedev.server.model.Build;
+import io.onedev.server.model.Project;
+import io.onedev.server.plugin.report.unittest.UnitTestReport;
+import io.onedev.server.plugin.report.unittest.UnitTestReport.Status;
+import io.onedev.server.search.code.CodeSearchManager;
+import io.onedev.server.search.code.hit.QueryHit;
+import io.onedev.server.search.code.hit.SymbolHit;
+import io.onedev.server.search.code.query.BlobQuery;
+import io.onedev.server.search.code.query.TooGeneralQueryException;
+import org.apache.lucene.search.IndexSearcher;
+import org.dom4j.DocumentException;
+import org.dom4j.io.SAXReader;
+import org.eclipse.jgit.lib.ObjectId;
+import org.jetbrains.annotations.Nullable;
+import org.junit.Test;
+import org.mockito.Mockito;
+import org.mockito.internal.util.collections.Sets;
+
+import java.io.IOException;
+import java.io.InputStream;
+import java.util.List;
+
+import static org.junit.Assert.assertEquals;
+
+public class GTestReportParserTest extends AppLoaderMocker {
+
+ @Test
+ public void testParse() {
+ try (InputStream is = Resources.getResource(GTestReportParserTest.class, "test-result.xml").openStream()) {
+ Mockito.when(AppLoader.getInstance(CodeSearchManager.class)).thenReturn(new CodeSearchManager() {
+
+ @Override
+ public List<QueryHit> search(Project project, ObjectId commit, BlobQuery query)
+ throws TooGeneralQueryException {
+ return null;
+ }
+
+ @Override
+ public List<Symbol> getSymbols(Project project, ObjectId blobId, String blobPath) {
+ return null;
+ }
+
+ @Override
+ public List<Symbol> getSymbols(IndexSearcher searcher, ObjectId blobId, String blobPath) {
+ return null;
+ }
+
+ @Override
+ public String findBlobPathBySuffix(Project project, ObjectId commit, String blobPathSuffix) {
+ return "Test.java";
+ }
+
+ @Nullable
+ @Override
+ public SymbolHit findPrimarySymbol(Project project, ObjectId commitId, String symbolFQN, String fqnSeparator) {
+ return null;
+ }
+
+ });
+
+ Build build = new Build();
+ build.setCommitHash(ObjectId.zeroId().name());
+
+ SAXReader reader = new SAXReader();
+ UnitTestReport report = new UnitTestReport(GTestReportParser.parse(build, reader.read(is)), true);
+
+ assertEquals(3, report.getTestSuites().size());
+ assertEquals(1, report.getTestCases(null, null, Sets.newSet(Status.PASSED)).size());
+ assertEquals(1, report.getTestCases(null, null, Sets.newSet(Status.NOT_PASSED)).size());
+ assertEquals(5, report.getTestCases(null, null, Sets.newSet(Status.NOT_RUN)).size());
+ assertEquals(1503, report.getTestCases(null, null, Sets.newSet(Status.NOT_PASSED)).iterator().next().getDuration());
+ } catch (IOException|DocumentException e) {
+ throw new RuntimeException(e);
+ }
+ }
+
+ @Override
+ protected void setup() {
+ }
+
+ @Override
+ protected void teardown() {
+ }
+
+}
diff --git a/server-plugin/server-plugin-report-gtest/src/test/java/io/onedev/server/plugin/report/gtest/test-result.xml b/server-plugin/server-plugin-report-gtest/src/test/java/io/onedev/server/plugin/report/gtest/test-result.xml
new file mode 100644
index 0000000000..cd07624586
--- /dev/null
+++ b/server-plugin/server-plugin-report-gtest/src/test/java/io/onedev/server/plugin/report/gtest/test-result.xml
@@ -0,0 +1,29 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<testsuites tests="7" failures="1" disabled="3" errors="0" time="1.504" timestamp="2024-09-18T20:34:05.972" name="AllTests">
+ <testsuite name="MultiplyTests" tests="3" failures="1" disabled="1" skipped="1" errors="0" time="1.503" timestamp="2024-09-18T20:34:05.972">
+ <testcase name="TestIntegerOne_One" status="run" result="completed" time="1.503" timestamp="2024-09-18T20:34:05.972" classname="MultiplyTests">
+ <failure message="/Users/robin/temp/gtest/tests/calc_test.cpp:11&#x0A;Expected equality of these values:&#x0A; expected&#x0A; Which is: 2&#x0A; actual&#x0A; Which is: 1" type=""><![CDATA[/Users/robin/temp/gtest/tests/calc_test.cpp:11
+Expected equality of these values:
+ expected
+ Which is: 2
+ actual
+ Which is: 1]]></failure>
+ </testcase>
+ <testcase name="TestIntegerZero_Zero" status="run" result="skipped" time="0" timestamp="2024-09-18T20:34:07.476" classname="MultiplyTests">
+ <skipped message="/Users/robin/temp/gtest/tests/calc_test.cpp:16&#x0A;"><![CDATA[/Users/robin/temp/gtest/tests/calc_test.cpp:16
+]]></skipped>
+ </testcase>
+ <testcase name="DISABLED_TestIntegerZero_One" status="notrun" result="suppressed" time="0" timestamp="1970-01-01T08:00:00.000" classname="MultiplyTests" />
+ </testsuite>
+ <testsuite name="DivideTests" tests="2" failures="0" disabled="0" skipped="1" errors="0" time="0" timestamp="2024-09-18T20:34:07.476">
+ <testcase name="TestIntegerOne_One" status="run" result="completed" time="0" timestamp="2024-09-18T20:34:07.476" classname="DivideTests" />
+ <testcase name="TestIntegerTwo_One" status="run" result="skipped" time="0" timestamp="2024-09-18T20:34:07.476" classname="DivideTests">
+ <skipped message="/Users/robin/temp/gtest/tests/calc_test.cpp:38&#x0A;Skipping single test"><![CDATA[/Users/robin/temp/gtest/tests/calc_test.cpp:38
+Skipping single test]]></skipped>
+ </testcase>
+ </testsuite>
+ <testsuite name="DISABLED_DivideTests" tests="2" failures="0" disabled="2" skipped="0" errors="0" time="0" timestamp="1970-01-01T08:00:00.000">
+ <testcase name="TestIntegerZero_One" status="notrun" result="suppressed" time="0" timestamp="1970-01-01T08:00:00.000" classname="DISABLED_DivideTests" />
+ <testcase name="TestIntegerZero_Two" status="notrun" result="suppressed" time="0" timestamp="1970-01-01T08:00:00.000" classname="DISABLED_DivideTests" />
+ </testsuite>
+</testsuites>
\ No newline at end of file
diff --git a/server-plugin/server-plugin-report-unittest/src/main/java/io/onedev/server/plugin/report/unittest/UnitTestCasesPage.java b/server-plugin/server-plugin-report-unittest/src/main/java/io/onedev/server/plugin/report/unittest/UnitTestCasesPage.java
index d6a098f6e1..ec0c921258 100644
--- a/server-plugin/server-plugin-report-unittest/src/main/java/io/onedev/server/plugin/report/unittest/UnitTestCasesPage.java
+++ b/server-plugin/server-plugin-report-unittest/src/main/java/io/onedev/server/plugin/report/unittest/UnitTestCasesPage.java
@@ -437,7 +437,7 @@ public class UnitTestCasesPage extends UnitTestReportPage {
name += " (" + escapeHtml5(testCase.getTestSuite().getName()) + ")";
}
if (testCase.getStatusText() != null && !testCase.getStatusText().equalsIgnoreCase(testCase.getStatus().name().replace("_", " "))) {
- name = escapeHtml5("[" + testCase.getStatusText() + "] ") + name;
+ name = name + escapeHtml5(" [" + testCase.getStatusText() + "]");
}
item.add(new Label("name", name).setEscapeModelStrings(false));
if (getReport().hasTestCaseDuration())
diff --git a/server-product/pom.xml b/server-product/pom.xml
index d9a921c1d8..95f0f20f9f 100644
--- a/server-product/pom.xml
+++ b/server-product/pom.xml
@@ -30,6 +30,11 @@
<artifactId>server-plugin-report-junit</artifactId>
<version>${project.version}</version>
</dependency>
+ <dependency>
+ <groupId>io.onedev</groupId>
+ <artifactId>server-plugin-report-gtest</artifactId>
+ <version>${project.version}</version>
+ </dependency>
<dependency>
<groupId>io.onedev</groupId>
<artifactId>server-plugin-report-trx</artifactId>