feat: report as usage container resources not listed in manifest

EPUBCheck used to report any resource found in the the container but not listed in the manifest as a warning (since #58 was fixed, in v1.1). But the EPUB specification does not require that. This commit downgrades the severity of `OPF-003` to a usage report. See also #1452 See also w3c/epub-specs#563
w3c · Dec 21, 2022 · f81b423 · f81b423
1 parent 5bac4f8
commit f81b423
Show file tree

Hide file tree

Showing 18 changed files with 62 additions and 8 deletions.
diff --git a/src/main/java/com/adobe/epubcheck/messages/DefaultSeverities.java b/src/main/java/com/adobe/epubcheck/messages/DefaultSeverities.java
@@ -190,7 +190,7 @@ private void initialize()
     // OPF
     severities.put(MessageId.OPF_001, Severity.ERROR);
     severities.put(MessageId.OPF_002, Severity.FATAL);
-    severities.put(MessageId.OPF_003, Severity.WARNING);
+    severities.put(MessageId.OPF_003, Severity.USAGE);
     severities.put(MessageId.OPF_004, Severity.WARNING);
     severities.put(MessageId.OPF_004a, Severity.ERROR);
     severities.put(MessageId.OPF_004b, Severity.ERROR);

diff --git a/src/test/resources/epub-multiple-renditions/multiple-rendition-publication.feature b/src/test/resources/epub-multiple-renditions/multiple-rendition-publication.feature
@@ -81,7 +81,6 @@ Feature: EPUB Multiple-Rendition ▸ Full Publication Checks
     Then warning RSC-019 is reported (for the missing metatada.xml file)
     And warning RSC-017 is reported (for the missing selection attributes)
     And the message contains 'At least one rendition selection attribute should be specified for each non-first rootfile element'
-    And warning OPF-003 is reported (for a mapping document without a link in the container.xml file)
     And no other errors or warnings are reported
 
 

diff --git a/...undeclared-warning/META-INF/container.xml → ...e-undeclared-usage/META-INF/container.xml b/...undeclared-warning/META-INF/container.xml → ...e-undeclared-usage/META-INF/container.xml
diff --git a/...-undeclared-warning/OPS/content_001.xhtml → ...ce-undeclared-usage/OPS/content_001.xhtml b/...-undeclared-warning/OPS/content_001.xhtml → ...ce-undeclared-usage/OPS/content_001.xhtml
diff --git a/...ndeclared-warning/OPS/not-in-manifest.txt → ...-undeclared-usage/OPS/not-in-manifest.txt b/...ndeclared-warning/OPS/not-in-manifest.txt → ...-undeclared-usage/OPS/not-in-manifest.txt
diff --git a/...source-undeclared-warning/OPS/package.opf → ...resource-undeclared-usage/OPS/package.opf b/...source-undeclared-warning/OPS/package.opf → ...resource-undeclared-usage/OPS/package.opf
diff --git a/...t-resource-undeclared-warning/OPS/toc.ncx → ...est-resource-undeclared-usage/OPS/toc.ncx b/...t-resource-undeclared-warning/OPS/toc.ncx → ...est-resource-undeclared-usage/OPS/toc.ncx
diff --git a/...fest-resource-undeclared-warning/mimetype → ...nifest-resource-undeclared-usage/mimetype b/...fest-resource-undeclared-warning/mimetype → ...nifest-resource-undeclared-usage/mimetype
diff --git a/src/test/resources/epub2/opf-publication.feature b/src/test/resources/epub2/opf-publication.feature
@@ -72,10 +72,12 @@ Feature: EPUB 2 ▸ Open Packaging Format ▸ Full Publication Checks
     Then warning OPF-035 is reported
     And no other errors or warnings are reported
 
-  Scenario: Report a reference to a resource that is not listed in the manifest
-    When checking EPUB 'opf-manifest-resource-undeclared-warning'
-    Then warning OPF-003 is reported
-    And no other errors or warnings are reported
+  Scenario: Report (usage) a resource that is not listed in the manifest
+    Given the reporting level is set to usage  
+    When checking EPUB 'opf-manifest-resource-undeclared-usage'
+    Then usage OPF-003 is reported
+    But no other usages are reported
+    And no errors or warnings are reported
 
   Scenario: Verify that operating system files (`.DS_STORE`, `thumbs.db`) are ignored (issue 256)
     When checking EPUB 'opf-manifest-os-files-ignore-valid'

diff --git a/...ckage-document/files/manifest-not-listing-container-resource-usage/EPUB/content_001.xhtml b/...ckage-document/files/manifest-not-listing-container-resource-usage/EPUB/content_001.xhtml
@@ -0,0 +1,11 @@
+<!DOCTYPE html>
+<html xmlns:epub="http://www.idpf.org/2007/ops" xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+	<head>
+		<meta charset="utf-8"/>
+		<title>Minimal EPUB</title>
+	</head>
+	<body>
+		<h1>Loomings</h1>
+		<p>Call me Ishmael.</p>
+	</body>
+</html>
diff --git a/...b3/05-package-document/files/manifest-not-listing-container-resource-usage/EPUB/nav.xhtml b/...b3/05-package-document/files/manifest-not-listing-container-resource-usage/EPUB/nav.xhtml
@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html xmlns="http://www.w3.org/1999/xhtml" xmlns:epub="http://www.idpf.org/2007/ops" xml:lang="en" lang="en">
+	<head>
+		<meta charset="utf-8"/>
+		<title>Minimal Nav</title>
+	</head>
+	<body>
+		<nav epub:type="toc">
+			<ol>
+				<li><a href="content_001.xhtml">content 001</a></li>
+			</ol>
+		</nav>
+	</body>
+</html>
diff --git a/...age-document/files/manifest-not-listing-container-resource-usage/EPUB/not-in-manifest.txt b/...age-document/files/manifest-not-listing-container-resource-usage/EPUB/not-in-manifest.txt
diff --git a/.../05-package-document/files/manifest-not-listing-container-resource-usage/EPUB/package.opf b/.../05-package-document/files/manifest-not-listing-container-resource-usage/EPUB/package.opf
@@ -0,0 +1,16 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<package xmlns="http://www.idpf.org/2007/opf" version="3.0" xml:lang="en" unique-identifier="q">
+<metadata xmlns:dc="http://purl.org/dc/elements/1.1/">
+  <dc:title id="title">Minimal EPUB 3.0</dc:title>
+  <dc:language>en</dc:language>
+  <dc:identifier id="q">NOID</dc:identifier>
+  <meta property="dcterms:modified">2017-06-14T00:00:01Z</meta>
+</metadata>
+<manifest>
+  <item id="content_001"  href="content_001.xhtml" media-type="application/xhtml+xml"/>
+  <item id="nav"  href="nav.xhtml" media-type="application/xhtml+xml" properties="nav"/>
+</manifest>
+<spine>
+  <itemref idref="content_001" />
+</spine>
+</package>
diff --git a/...ckage-document/files/manifest-not-listing-container-resource-usage/META-INF/container.xml b/...ckage-document/files/manifest-not-listing-container-resource-usage/META-INF/container.xml
@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<container version="1.0" xmlns="urn:oasis:names:tc:opendocument:xmlns:container">
+	<rootfiles>
+		<rootfile full-path="EPUB/package.opf" media-type="application/oebps-package+xml"/>
+	</rootfiles>
+</container>
diff --git a/...es/epub3/05-package-document/files/manifest-not-listing-container-resource-usage/mimetype b/...es/epub3/05-package-document/files/manifest-not-listing-container-resource-usage/mimetype
@@ -0,0 +1 @@
+application/epub+zip
diff --git a/src/test/resources/epub3/05-package-document/package-document.feature b/src/test/resources/epub3/05-package-document/package-document.feature
@@ -412,6 +412,13 @@ Feature: EPUB 3 — Package document
     When checking EPUB 'package-remote-font-undeclared-error'
     Then error RSC-008 is reported
     And no other errors or warnings are reported
+
+  Scenario: Report (usage) a container resource that is not listed in the manifest
+    Given the reporting level is set to usage  
+    When checking EPUB 'manifest-not-listing-container-resource-usage'
+    Then usage OPF-003 is reported
+    But no other usages are reported
+    And no errors or warnings are reported
 
 
   ### 5.6.2 The item element

diff --git a/src/test/resources/epub3/06-content-document/content-document-css.feature b/src/test/resources/epub3/06-content-document/content-document-css.feature
@@ -76,7 +76,6 @@ Feature: EPUB 3 — Content Documents — CSS
   Scenario: Report an attempt to `@import` a CSS file that is not declared in the manifest but is present in the container
     When checking EPUB 'content-css-import-not-declared-error'
     Then error RSC-008 is reported
-    And warning OPF-003 is reported
     And no other errors or warnings are reported
 
   @spec @xref:sec-container-iri @xref:sec-manifest-elem

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
@@ -335,7 +335,6 @@ Feature: EPUB 3 — Content Documents — XHTML
   Scenario: Report references to undeclared resources in `img srcset`
     When checking EPUB 'content-xhtml-img-srcset-undeclared-error'
     Then error RSC-008 is reported (undeclared resource in srcset)
-    And warning OPF-003 is reported (undeclared resource in container)
     And no other errors or warnings are reported
 
   Scenario: Allow an `img` element with a video resource