[SUREFIRE-2298] fix xml output with junit 5 nested classes (#828)

* [SUREFIRE-2298] fix xml output with junit 5 nested classes Signed-off-by: Olivier Lamy <olamy@apache.org>

Author: olamy

Jenkinsfile

@@ -24,8 +24,8 @@ properties(
  buildDiscarder(logRotator(artifactNumToKeepStr: env.BRANCH_NAME == 'master' ? '15' : '5',
  daysToKeepStr: env.BRANCH_NAME == 'master' ? '30' : '14',
  numToKeepStr: env.BRANCH_NAME == 'master' ? '20' : '10')
- )//,
- //disableConcurrentBuilds()
+ ),
+ disableConcurrentBuilds(abortPrevious: true)
  ]
 )
 // final def oses = ['linux':'ubuntu && maven', 'windows':'windows-he']

maven-surefire-common/src/main/java/org/apache/maven/plugin/surefire/report/StatelessXmlReporter.java

@@ -120,6 +120,7 @@ public class StatelessXmlReporter implements StatelessReportEventListener<Wrappe
 
  private final boolean enablePropertiesElement;
 
+ @Deprecated
  public StatelessXmlReporter(
  File reportsDirectory,
  String reportNameSuffix,
@@ -205,17 +206,10 @@ private Map<String, Map<String, List<WrappedReportEntry>>> arrangeMethodStatisti
  Map<String, Map<String, List<WrappedReportEntry>>> classMethodStatistics = new LinkedHashMap<>();
  for (WrappedReportEntry methodEntry : aggregateCacheFromMultipleReruns(testSetReportEntry, testSetStats)) {
  String testClassName = methodEntry.getSourceName();
- Map<String, List<WrappedReportEntry>> stats = classMethodStatistics.get(testClassName);
- if (stats == null) {
- stats = new LinkedHashMap<>();
- classMethodStatistics.put(testClassName, stats);
- }
+ Map<String, List<WrappedReportEntry>> stats =
+ classMethodStatistics.computeIfAbsent(testClassName, k -> new LinkedHashMap<>());
  String methodName = methodEntry.getName();
- List<WrappedReportEntry> methodRuns = stats.get(methodName);
- if (methodRuns == null) {
- methodRuns = new ArrayList<>();
- stats.put(methodName, methodRuns);
- }
+ List<WrappedReportEntry> methodRuns = stats.computeIfAbsent(methodName, k -> new ArrayList<>());
  methodRuns.add(methodEntry);
  }
  return classMethodStatistics;
@@ -416,7 +410,7 @@ private void startTestElement(XMLWriter ppw, WrappedReportEntry report) throws I
 
  String className = phrasedClassName
  ? report.getReportSourceName(reportNameSuffix)
- : report.getSourceName(reportNameSuffix);
+ : report.getSourceText() != null ? report.getSourceText() : report.getSourceName(reportNameSuffix);
  if (className != null) {
  ppw.addAttribute("classname", extraEscapeAttribute(className));
  }

maven-surefire-common/src/main/java/org/apache/maven/plugin/surefire/report/TestSetStats.java

@@ -252,7 +252,7 @@ static String concatenateWithTestGroup(MessageBuilder builder, ReportEntry repor
  if (phrasedClassName && report.getReportNameWithGroup() != null) {
  return builder.strong(report.getReportNameWithGroup()).toString();
  } else {
- String testClass = report.getNameWithGroup();
+ String testClass = report.getSourceText() != null ? report.getSourceText() : report.getNameWithGroup();
  int indexOfGroup = testClass.indexOf(GROUP_PREFIX);
  int delimiter = testClass.lastIndexOf('.', indexOfGroup == -1 ? testClass.length() : indexOfGroup);
  String pkg = testClass.substring(0, 1 + delimiter);

maven-surefire-common/src/test/java/org/apache/maven/plugin/surefire/report/TestSetStatsTest.java

@@ -44,8 +44,10 @@ public class TestSetStatsTest {
 
  @Test
  public void shouldConcatenateWithTestGroup() {
+ when(reportEntry.getSourceText()).thenReturn(null);
  when(reportEntry.getNameWithGroup()).thenReturn("pkg.MyTest (my group)");
  String actual = TestSetStats.concatenateWithTestGroup(buffer(), reportEntry, false);
+ verify(reportEntry, times(1)).getSourceText();
  verify(reportEntry, times(1)).getNameWithGroup();
  verifyNoMoreInteractions(reportEntry);
  String expected = buffer().a("pkg.").strong("MyTest (my group)").toString();
@@ -54,6 +56,7 @@ public void shouldConcatenateWithTestGroup() {
 
  @Test
  public void shouldConcatenateWithJUnit5TestGroup() {
+ when(reportEntry.getSourceText()).thenReturn(null);
  when(reportEntry.getReportNameWithGroup()).thenReturn("pkg.MyTest (my group)");
  String actual = TestSetStats.concatenateWithTestGroup(buffer(), reportEntry, true);
  verify(reportEntry, atLeastOnce()).getReportNameWithGroup();
@@ -64,11 +67,13 @@ public void shouldConcatenateWithJUnit5TestGroup() {
 
  @Test
  public void shouldFallBackToTestGroupIfJUnit5TestGroupIsNull() {
+ when(reportEntry.getSourceText()).thenReturn(null);
  when(reportEntry.getReportNameWithGroup()).thenReturn(null);
  when(reportEntry.getNameWithGroup()).thenReturn("pkg.MyTest (my group)");
  String actual = TestSetStats.concatenateWithTestGroup(buffer(), reportEntry, true);
  verify(reportEntry, atLeastOnce()).getReportNameWithGroup();
  verify(reportEntry, atLeastOnce()).getNameWithGroup();
+ verify(reportEntry, atLeastOnce()).getSourceText();
  verifyNoMoreInteractions(reportEntry);
  String expected = buffer().a("pkg.").strong("MyTest (my group)").toString();
  assertThat(actual).isEqualTo(expected);

surefire-its/pom.xml

@@ -33,8 +33,12 @@
 
  <properties>
  <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
- <its.forkCount>1C</its.forkCount>
+ <surefire.rerunFailingTestsCount>0</surefire.rerunFailingTestsCount>
+ <its.forkCount>0.5C</its.forkCount>
  <its.threadCount>1</its.threadCount>
+ <maven.deploy.skip>true</maven.deploy.skip>
+ <maven.install.skip>true</maven.install.skip>
+ <maven.javadoc.skip>true</maven.javadoc.skip>
  </properties>
 
  <dependencies>
@@ -110,6 +114,11 @@
  <artifactId>assertj-core</artifactId>
  <scope>test</scope>
  </dependency>
+ <dependency>
+ <groupId>org.xmlunit</groupId>
+ <artifactId>xmlunit-core</artifactId>
+ <scope>test</scope>
+ </dependency>
  </dependencies>
 
  <build>
@@ -189,18 +198,6 @@
  </execution>
  </executions>
  </plugin>
- <plugin>
- <artifactId>maven-install-plugin</artifactId>
- <configuration>
- <skip>true</skip>
- </configuration>
- </plugin>
- <plugin>
- <artifactId>maven-deploy-plugin</artifactId>
- <configuration>
- <skip>true</skip>
- </configuration>
- </plugin>
  </plugins>
  </build>
  <profiles>
@@ -217,7 +214,6 @@
  <runOrder>alphabetical</runOrder>
  <forkCount>${its.forkCount}</forkCount>
  <threadCount>${its.threadCount}</threadCount>
- <rerunFailingTestsCount>1</rerunFailingTestsCount>
  <perCoreThreadCount>false</perCoreThreadCount>
  <argLine>-server -Xmx64m -XX:+UseG1GC -XX:+TieredCompilation -XX:TieredStopAtLevel=1 -Djava.awt.headless=true -Djdk.net.URLClassPath.disableClassPathURLCheck=true</argLine>
  <!-- Pass current surefire version to the main suite so that it -->
@@ -251,6 +247,7 @@
  <properties>
  <its.forkCount>0.4C</its.forkCount>
  <its.threadCount>1</its.threadCount>
+ <surefire.rerunFailingTestsCount>1</surefire.rerunFailingTestsCount>
  </properties>
  </profile>
  <profile>

surefire-its/src/test/java/org/apache/maven/surefire/its/ArchUnitIT.java

@@ -0,0 +1,70 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+package org.apache.maven.surefire.its;
+
+import javax.xml.transform.Source;
+
+import org.apache.maven.surefire.its.fixture.OutputValidator;
+import org.apache.maven.surefire.its.fixture.SurefireJUnit4IntegrationTestCase;
+import org.apache.maven.surefire.its.fixture.TestFile;
+import org.hamcrest.collection.IsIterableWithSize;
+import org.junit.Before;
+import org.junit.Test;
+import org.w3c.dom.Node;
+import org.xmlunit.builder.Input;
+import org.xmlunit.xpath.JAXPXPathEngine;
+
+import static org.apache.maven.surefire.its.fixture.HelperAssertions.assumeJavaVersion;
+import static org.hamcrest.MatcherAssert.assertThat;
+
+/**
+ *
+ */
+@SuppressWarnings("checkstyle:magicnumber")
+public class ArchUnitIT extends SurefireJUnit4IntegrationTestCase {
+
+ @Before
+ public void setUp() {
+ assumeJavaVersion(17);
+ }
+
+ @Test
+ public void simpleCucumberUsage() throws Exception {
+ OutputValidator outputValidator = unpack("archunit")
+ .maven()
+ .withFailure()
+ .executeTest()
+ .verifyTextInLog("BUILD FAILURE")
+ .verifyTextInLog("classes that have simple name ending with 'DTO'")
+ .assertTestSuiteResults(1, 0, 1, 0);
+
+ TestFile xmlReportFile = outputValidator.getSurefireReportsXmlFile("TEST-custom.ArchUnitTest.xml");
+ xmlReportFile.assertFileExists();
+
+ Source source = Input.fromFile(xmlReportFile.getFile()).build();
+
+ Iterable<Node> ite = new JAXPXPathEngine().selectNodes("//testcase", source);
+ assertThat(ite, IsIterableWithSize.iterableWithSize(1));
+ ite = new JAXPXPathEngine().selectNodes("//testcase[@classname='ArchUnitTest']", source);
+ assertThat(ite, IsIterableWithSize.iterableWithSize(1));
+
+ ite = new JAXPXPathEngine().selectNodes("//testcase[@name='DTO_IN_PACKAGE_DTO']", source);
+ assertThat(ite, IsIterableWithSize.iterableWithSize(1));
+ }
+}

surefire-its/src/test/java/org/apache/maven/surefire/its/CucumberIT.java

@@ -0,0 +1,84 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+package org.apache.maven.surefire.its;
+
+import javax.xml.transform.Source;
+
+import org.apache.maven.surefire.its.fixture.OutputValidator;
+import org.apache.maven.surefire.its.fixture.SurefireJUnit4IntegrationTestCase;
+import org.apache.maven.surefire.its.fixture.TestFile;
+import org.hamcrest.collection.IsIterableWithSize;
+import org.junit.Before;
+import org.junit.Test;
+import org.w3c.dom.Node;
+import org.xmlunit.builder.Input;
+import org.xmlunit.xpath.JAXPXPathEngine;
+
+import static org.apache.maven.surefire.its.fixture.HelperAssertions.assumeJavaVersion;
+import static org.hamcrest.MatcherAssert.assertThat;
+
+/**
+ *
+ */
+@SuppressWarnings("checkstyle:magicnumber")
+public class CucumberIT extends SurefireJUnit4IntegrationTestCase {
+
+ @Before
+ public void setUp() {
+ assumeJavaVersion(17);
+ }
+
+ @Test
+ public void simpleCucumberUsage() throws Exception {
+ OutputValidator outputValidator = unpack("cucumber-tests")
+ .maven()
+ .withFailure()
+ .executeTest()
+ .verifyTextInLog("BUILD FAILURE")
+ .verifyTextInLog("expected: <11> but was: <15>")
+ .assertTestSuiteResults(3, 0, 1, 0);
+
+ TestFile xmlReportFile = outputValidator.getSurefireReportsXmlFile("TEST-cz.fafejta.SimpleTest.xml");
+ xmlReportFile.assertFileExists();
+
+ Source source = Input.fromFile(xmlReportFile.getFile()).build();
+
+ Iterable<Node> ite = new JAXPXPathEngine().selectNodes("//testcase", source);
+ assertThat(ite, IsIterableWithSize.iterableWithSize(1));
+ ite = new JAXPXPathEngine().selectNodes("//testcase[@classname='cz.fafejta.SimpleTest']", source);
+ assertThat(ite, IsIterableWithSize.iterableWithSize(1));
+
+ xmlReportFile = outputValidator.getSurefireReportsXmlFile("TEST-cz.fafejta.RunCucumberTest.xml");
+ xmlReportFile.assertFileExists();
+
+ source = Input.fromFile(xmlReportFile.getFile()).build();
+
+ ite = new JAXPXPathEngine().selectNodes("//testcase", source);
+ assertThat(ite, IsIterableWithSize.iterableWithSize(2));
+
+ ite = new JAXPXPathEngine().selectNodes("//testcase[@classname='RunCucumberTest']", source);
+ assertThat(ite, IsIterableWithSize.iterableWithSize(2));
+
+ ite = new JAXPXPathEngine().selectNodes("//testcase[@name='Sum test - Valid test']", source);
+ assertThat(ite, IsIterableWithSize.iterableWithSize(1));
+
+ ite = new JAXPXPathEngine().selectNodes("//testcase[@name='Sum test - Invalid test']", source);
+ assertThat(ite, IsIterableWithSize.iterableWithSize(1));
+ }
+}

surefire-its/src/test/java/org/apache/maven/surefire/its/JUnitPlatformEnginesIT.java

@@ -73,15 +73,10 @@ public class JUnitPlatformEnginesIT extends SurefireJUnit4IntegrationTestCase {
  @Parameters(name = "{0}")
  public static Iterable<Object[]> artifactVersions() {
  List<Object[]> args = new ArrayList<>();
- args.add(new Object[] {"1.2.0", "5.2.0", "1.1.0", "1.0.0"});
- args.add(new Object[] {"1.3.2", "5.3.2", "1.1.1", "1.0.0"});
- args.add(new Object[] {"1.4.2", "5.4.2", "1.1.1", "1.0.0"});
- args.add(new Object[] {"1.5.2", "5.5.2", "1.2.0", "1.1.0"});
- args.add(new Object[] {"1.6.3", "5.6.3", "1.2.0", "1.1.0"});
- args.add(new Object[] {"1.7.2", "5.7.2", "1.2.0", "1.1.0"});
  args.add(new Object[] {"1.8.2", "5.8.2", "1.2.0", "1.1.2"});
  args.add(new Object[] {"1.9.1", "5.9.1", "1.2.0", "1.1.2"});
  args.add(new Object[] {"1.10.2", "5.10.2", "1.3.0", "1.1.2"});
+ args.add(new Object[] {"1.13.4", "5.13.4", "1.3.0", "1.1.2"});
  return args;
  }
 

surefire-its/src/test/java/org/apache/maven/surefire/its/JUnitPlatformIT.java

@@ -48,16 +48,11 @@ public class JUnitPlatformIT extends SurefireJUnit4IntegrationTestCase {
  @Parameters(name = "{0}")
  public static Iterable<Object[]> artifactVersions() {
  List<Object[]> args = new ArrayList<>();
- args.add(new Object[] {"5.2.0", "0.8.0"});
- args.add(new Object[] {"5.3.2", "0.9.0"});
- args.add(new Object[] {"5.4.2", "1.0.0"});
- args.add(new Object[] {"5.5.2", "0.8.15"});
- args.add(new Object[] {"5.6.2", "1.3.5"});
- args.add(new Object[] {"5.7.2", "1.5.5"});
  args.add(new Object[] {"5.8.2", "1.6.5"});
  args.add(new Object[] {"5.9.1", "1.7.1"});
  args.add(new Object[] {"5.10.2", "1.8.5"});
- args.add(new Object[] {"5.11.0-M2", "1.8.5"});
+ args.add(new Object[] {"5.11.4", "1.8.5"});
+ args.add(new Object[] {"5.13.4", "1.8.5"});
  return args;
  }
 

surefire-its/src/test/java/org/apache/maven/surefire/its/fixture/SurefireLauncher.java

@@ -86,7 +86,7 @@ private List<String> getInitialGoals() {
  jacocoAgent = jacocoAgent.replace("\"", "");
  goals.add("-Djacoco.agent=" + jacocoAgent);
  goals.add("-nsu");
-
+ goals.add("-Dmaven.build.cache.enabled=false");
  return goals;
  }