Extract a common base class for test parsers

src/main/java/edu/hm/hafner/coverage/CoverageParser.java

@@ -7,6 +7,7 @@
 import javax.xml.namespace.QName;
 import javax.xml.stream.events.Attribute;
 import javax.xml.stream.events.StartElement;
+import javax.xml.stream.events.XMLEvent;
 
 import edu.hm.hafner.util.FilteredLog;
 import edu.hm.hafner.util.SecureXmlParserFactory.ParsingException;
@@ -18,6 +19,8 @@
  * @author Ullrich Hafner
  */
 public abstract class CoverageParser implements Serializable {
+    private static final long serialVersionUID = 3941742254762282096L;
+
     /** Error message when there are no results. */
     public static final String EMPTY_MESSAGE = "No data found in the specified file.";
     /** Toplevel module name. */
@@ -33,9 +36,7 @@ public enum ProcessingMode {
         FAIL_FAST
     }
 
-    private static final long serialVersionUID = 3941742254762282096L;
     private transient TreeStringBuilder treeStringBuilder = new TreeStringBuilder();
-
     private final ProcessingMode processingMode; // since 0.26.0
 
     /**
@@ -82,6 +83,23 @@ public ModuleNode parse(final Reader reader, final FilteredLog log) {
         return moduleNode;
     }
 
+    /**
+     * Returns the name of the specified element.
+     *
+     * @param event the event
+     * @return the name
+     */
+    protected QName getElementName(final XMLEvent event) {
+        QName name;
+        if (event.isStartElement()) {
+            name = event.asStartElement().getName();
+        }
+        else {
+            name = event.asEndElement().getName();
+        }
+        return name;
+    }
+
     /**
      * Handles processing of empty results.
      *

src/main/java/edu/hm/hafner/coverage/parser/AbstractTestParser.java

@@ -0,0 +1,87 @@
+package edu.hm.hafner.coverage.parser;
+
+import java.io.Reader;
+import java.util.ArrayList;
+import java.util.List;
+import java.util.UUID;
+import javax.xml.namespace.QName;
+import javax.xml.stream.XMLEventReader;
+import javax.xml.stream.XMLStreamException;
+import javax.xml.stream.events.StartElement;
+import javax.xml.stream.events.XMLEvent;
+
+import edu.hm.hafner.coverage.CoverageParser;
+import edu.hm.hafner.coverage.ModuleNode;
+import edu.hm.hafner.coverage.TestCase;
+import edu.hm.hafner.util.FilteredLog;
+import edu.hm.hafner.util.SecureXmlParserFactory;
+import edu.hm.hafner.util.SecureXmlParserFactory.ParsingException;
+
+/**
+ * Baseclass for test result parsers.
+ *
+ * @author Ullrich Hafner
+ */
+abstract class AbstractTestParser extends CoverageParser {
+    private static final long serialVersionUID = 3771784159977766871L;
+
+    static final QName NAME = new QName("name");
+    static final QName FAILURE = new QName("failure");
+    static final QName MESSAGE = new QName("message");
+    static final QName CLASS_NAME = new QName("classname");
+
+    private final QName testSuite;
+    private final QName testCase;
+
+    AbstractTestParser(final ProcessingMode processingMode, final QName testSuite, final QName testCase) {
+        super(processingMode);
+        this.testSuite = testSuite;
+        this.testCase = testCase;
+    }
+
+    QName getTestCase() {
+        return testCase;
+    }
+
+    QName getTestSuite() {
+        return testSuite;
+    }
+
+    @Override
+    protected ModuleNode parseReport(final Reader reader, final FilteredLog log) {
+        try {
+            var eventReader = new SecureXmlParserFactory().createXmlEventReader(reader);
+            var root = new ModuleNode(EMPTY);
+            var tests = readTestCases(eventReader, root);
+            handleEmptyResults(log, tests.isEmpty());
+            return root;
+        }
+        catch (XMLStreamException exception) {
+            throw new ParsingException(exception);
+        }
+    }
+
+    private List<TestCase> readTestCases(final XMLEventReader eventReader,
+            final ModuleNode root) throws XMLStreamException {
+        String suiteName = EMPTY;
+        var tests = new ArrayList<TestCase>();
+        while (eventReader.hasNext()) {
+            XMLEvent event = eventReader.nextEvent();
+
+            if (event.isStartElement() && getTestSuite().equals(event.asStartElement().getName())) {
+                suiteName = getOptionalValueOf(event.asStartElement(), NAME).orElse(EMPTY);
+            }
+            else if (event.isStartElement() && getTestCase().equals(event.asStartElement().getName())) {
+                tests.add(readTestCase(eventReader, event.asStartElement(), suiteName, root));
+            }
+        }
+        return tests;
+    }
+
+    abstract TestCase readTestCase(XMLEventReader reader, StartElement testCaseElement,
+            String suiteName, ModuleNode root) throws XMLStreamException;
+
+    protected String createId() {
+        return UUID.randomUUID().toString();
+    }
+}

src/main/java/edu/hm/hafner/coverage/parser/JunitParser.java

@@ -1,39 +1,27 @@
 package edu.hm.hafner.coverage.parser;
 
-import java.io.Reader;
-import java.util.ArrayList;
-import java.util.List;
-import java.util.UUID;
 import javax.xml.namespace.QName;
 import javax.xml.stream.XMLEventReader;
 import javax.xml.stream.XMLStreamException;
 import javax.xml.stream.events.StartElement;
 import javax.xml.stream.events.XMLEvent;
 
-import edu.hm.hafner.coverage.CoverageParser;
 import edu.hm.hafner.coverage.ModuleNode;
 import edu.hm.hafner.coverage.TestCase;
 import edu.hm.hafner.coverage.TestCase.TestCaseBuilder;
-import edu.hm.hafner.util.FilteredLog;
-import edu.hm.hafner.util.SecureXmlParserFactory;
-import edu.hm.hafner.util.SecureXmlParserFactory.ParsingException;
 
 /**
  * Parses reports in the JUnit format into a Java object model.
  *
  * @author Ullrich Hafner
  */
 @SuppressWarnings("checkstyle:ClassDataAbstractionCoupling")
-public class JunitParser extends CoverageParser {
+public class JunitParser extends AbstractTestParser {
     private static final long serialVersionUID = -5468593789018138107L;
 
     private static final QName TEST_SUITE = new QName("testsuite");
     private static final QName TEST_CASE = new QName("testcase");
-    private static final QName NAME = new QName("name");
-    private static final QName CLASS_NAME = new QName("classname");
-    private static final QName FAILURE = new QName("failure");
     private static final QName FAILURE_TYPE = new QName("type");
-    private static final QName MESSAGE = new QName("message");
     private static final QName ERROR = new QName("error");
     private static final QName SKIPPED = new QName("skipped");
 
@@ -50,49 +38,16 @@
      * @param processingMode
      *         determines whether to ignore errors
      */
     public JunitParser(final ProcessingMode processingMode) {
-        super(processingMode);
+        super(processingMode, TEST_SUITE, TEST_CASE);
     }
 
     @Override
-    protected ModuleNode parseReport(final Reader reader, final FilteredLog log) {
-        try {
-            var factory = new SecureXmlParserFactory();
-            var eventReader = factory.createXmlEventReader(reader);
-
-            var root = new ModuleNode(EMPTY);
-            var tests = readTestCases(eventReader, root);
-            handleEmptyResults(log, tests.isEmpty());
-            return root;
-        }
-        catch (XMLStreamException exception) {
-            throw new ParsingException(exception);
-        }
-    }
-
-    private List<Object> readTestCases(final XMLEventReader eventReader,
-            final ModuleNode root) throws XMLStreamException {
-        String suiteName = EMPTY;
-        var tests = new ArrayList<>();
-        while (eventReader.hasNext()) {
-            XMLEvent event = eventReader.nextEvent();
-
-            if (event.isStartElement() && TEST_SUITE.equals(event.asStartElement().getName())) {
-                suiteName = getOptionalValueOf(event.asStartElement(), NAME).orElse(EMPTY);
-            }
-            else if (event.isStartElement() && TEST_CASE.equals(event.asStartElement().getName())) {
-                tests.add(readTestCase(eventReader, event.asStartElement(), suiteName, root));
-            }
-        }
-        return tests;
-    }
-
-    private TestCase readTestCase(final XMLEventReader reader, final StartElement testCaseElement,
-            final String suiteName, final ModuleNode root)
-            throws XMLStreamException {
+    TestCase readTestCase(final XMLEventReader reader, final StartElement testCaseElement,
+            final String suiteName, final ModuleNode root) throws XMLStreamException {
         var builder = new TestCaseBuilder();
 
         builder.withTestName(getOptionalValueOf(testCaseElement, NAME).orElse(createId()));
 
         while (reader.hasNext()) {
             XMLEvent event = reader.nextEvent();
@@ -117,13 +72,7 @@
     }
 
     private boolean isFailure(final XMLEvent event) {
-        QName name;
-        if (event.isStartElement()) {
-            name = event.asStartElement().getName();
-        }
-        else {
-            name = event.asEndElement().getName();
-        }
+        var name = getElementName(event);
 
         return FAILURE.equals(name) || ERROR.equals(name);
     }
@@ -157,8 +106,4 @@
             }
         }
     }
-
-    private String createId() {
-        return UUID.randomUUID().toString();
-    }
 }