fix: report fatal XML parsing errors only once as RSC-016

rdeltour · rdeltour · commit 62d67e71f4bb · 2022-11-14T22:57:58.000+01:00
diff --git a/src/main/java/com/adobe/epubcheck/xml/XMLParser.java b/src/main/java/com/adobe/epubcheck/xml/XMLParser.java
@@ -162,7 +162,10 @@ public void process()
       report.message(MessageId.PKG_008, EPUBLocation.of(context), context.path);
     } catch (SAXException e)
     {
-      report.message(MessageId.RSC_005, EPUBLocation.of(context), e.getMessage());
+      // All errors should have already been reported by the error handler
+      if (report.getFatalErrorCount() == 0) {
+        report.message(MessageId.RSC_016, EPUBLocation.of(context), e.getMessage());
+      }
     }
   }
 
diff --git a/src/test/java/com/adobe/epubcheck/ocf/OPFPeekerTest.java b/src/test/java/com/adobe/epubcheck/ocf/OPFPeekerTest.java
@@ -151,14 +151,16 @@ public void testRetrieveVersionNoVersionAttribute()
   @Test
   public void testRetrieveVersionNoEqualSign()
   {
-    Collections.addAll(expectedErrors, MessageId.RSC_005, MessageId.RSC_005);
+    Collections.addAll(expectedErrors, MessageId.RSC_005);
+    Collections.addAll(expectedFatals, MessageId.RSC_016);
     retrieveData("noEqual.opf");
   }
 
   @Test
   public void testRetrieveVersionValueWithoutQuotes()
   {
-    Collections.addAll(expectedErrors, MessageId.RSC_005, MessageId.RSC_005);
+    Collections.addAll(expectedErrors, MessageId.RSC_005);
+    Collections.addAll(expectedFatals, MessageId.RSC_016);
     retrieveData("valueWithoutQuotes.opf");
   }
 
diff --git a/src/test/resources/epub3/03-resources/resources.feature b/src/test/resources/epub3/03-resources/resources.feature
@@ -392,14 +392,12 @@
   Scenario: a not well-formed Package Document is reported 
     When checking file 'conformance-xml-malformed-error.opf'
     Then fatal error RSC-016 is reported (parsing error)
-    And error RSC-005 is reported (schema error)
     And no other errors or warnings are reported
     
   @spec @xref:sec-xml-constraint
   Scenario: using a not-declared namespace is not allowed 
     When checking file 'conformance-xml-undeclared-namespace-error.opf'
     Then fatal error RSC-016 is reported (parsing error)
-    And error RSC-005 is reported (schema error)
     And no other errors or warnings are reported
 
   Scenario: Verify an attribute value with leading/trailing whitespace is allowed (issue 332)
diff --git a/src/test/resources/epub3/06-content-document/content-document-xhtml.feature b/src/test/resources/epub3/06-content-document/content-document-xhtml.feature
@@ -91,14 +91,12 @@ Feature: EPUB 3 — Content Documents — XHTML
   Scenario: Report entity references not ending with a semicolon
     When checking document 'entities-no-semicolon-error.xhtml'
     Then fatal error RSC-016 is reported
-    And error RSC-005 is reported
     And the message contains 'must end with the \';\' delimiter'
     And no other errors or warnings are reported
   
   Scenario: Report unknown entity references
     When checking document 'entities-unknown-error.xhtml'
     Then fatal error RSC-016 is reported
-    And error RSC-005 is reported
     And the message contains 'was referenced, but not declared'
     And no other errors or warnings are reported
 

Original file line number	Diff line number	Diff line change
`@@ -162,7 +162,10 @@ public void process()`
`162`	`162`	`report.message(MessageId.PKG_008, EPUBLocation.of(context), context.path);`
`163`	`163`	`} catch (SAXException e)`
`164`	`164`	`{`
`165`		`- report.message(MessageId.RSC_005, EPUBLocation.of(context), e.getMessage());`
	`165`	`+ // All errors should have already been reported by the error handler`
	`166`	`+ if (report.getFatalErrorCount() == 0) {`
	`167`	`+ report.message(MessageId.RSC_016, EPUBLocation.of(context), e.getMessage());`
	`168`	`+ }`
`166`	`169`	`}`
`167`	`170`	`}`
`168`	`171`
Original file line number	Diff line number	Diff line change
`@@ -151,14 +151,16 @@ public void testRetrieveVersionNoVersionAttribute()`
`151`	`151`	`@Test`
`152`	`152`	`public void testRetrieveVersionNoEqualSign()`
`153`	`153`	`{`
`154`		`- Collections.addAll(expectedErrors, MessageId.RSC_005, MessageId.RSC_005);`
	`154`	`+ Collections.addAll(expectedErrors, MessageId.RSC_005);`
	`155`	`+ Collections.addAll(expectedFatals, MessageId.RSC_016);`
`155`	`156`	`retrieveData("noEqual.opf");`
`156`	`157`	`}`
`157`	`158`
`158`	`159`	`@Test`
`159`	`160`	`public void testRetrieveVersionValueWithoutQuotes()`
`160`	`161`	`{`
`161`		`- Collections.addAll(expectedErrors, MessageId.RSC_005, MessageId.RSC_005);`
	`162`	`+ Collections.addAll(expectedErrors, MessageId.RSC_005);`
	`163`	`+ Collections.addAll(expectedFatals, MessageId.RSC_016);`
`162`	`164`	`retrieveData("valueWithoutQuotes.opf");`
`163`	`165`	`}`
`164`	`166`