FOP-3165 Fix table structure creation when using PDFUA

Author: Joao Goncalves

fop-core/src/main/java/org/apache/fop/render/pdf/PDFStructureTreeBuilder.java

@@ -465,8 +465,7 @@ public void endNode(String name) {
     }
 
     private boolean isPDFA1Safe(String name) {
-        return !((pdfFactory.getDocument().getProfile().getPDFAMode().isPart1()
-                || pdfFactory.getDocument().getProfile().getPDFUAMode().isEnabled())
+        return !((pdfFactory.getDocument().getProfile().getPDFAMode().isPart1())
                 && (name.equals("table-body")
                 || name.equals("table-header")
                 || name.equals("table-footer")));

fop-core/src/test/java/org/apache/fop/accessibility/fo/FO2StructureTreeConverterTestCase.java

@@ -20,11 +20,8 @@
 package org.apache.fop.accessibility.fo;
 
 import java.io.ByteArrayInputStream;
-import java.io.ByteArrayOutputStream;
-import java.io.File;
 import java.io.IOException;
 import java.io.InputStream;
-import java.io.OutputStream;
 import java.io.StringWriter;
 import java.nio.charset.StandardCharsets;
 
@@ -50,7 +47,6 @@
 import org.xml.sax.SAXException;
 import org.xml.sax.helpers.AttributesImpl;
 
-import static org.junit.Assert.assertNull;
 import static org.junit.Assert.assertTrue;
 
 import org.apache.commons.io.IOUtils;
@@ -59,14 +55,11 @@
 import org.apache.fop.accessibility.StructureTreeEventHandler;
 import org.apache.fop.apps.FOPException;
 import org.apache.fop.apps.FOUserAgent;
-import org.apache.fop.apps.FopFactory;
 import org.apache.fop.fo.FODocumentParser;
 import org.apache.fop.fo.FODocumentParser.FOEventHandlerFactory;
 import org.apache.fop.fo.FOEventHandler;
 import org.apache.fop.fo.LoadingException;
 import org.apache.fop.fotreetest.DummyFOEventHandler;
-import org.apache.fop.render.intermediate.IFContext;
-import org.apache.fop.render.pdf.PDFDocumentHandler;
 
 public class FO2StructureTreeConverterTestCase {
 
@@ -137,20 +130,6 @@ private static InputStream getResource(String name) {
         return FO2StructureTreeConverterTestCase.class.getResourceAsStream(name);
     }
 
-    @Test
-    public void testPDFA() throws Exception {
-        FOUserAgent userAgent = FopFactory.newInstance(new File(".").toURI()).newFOUserAgent();
-        userAgent.getRendererOptions().put("pdf-a-mode", "PDF/A-1b");
-        userAgent.setAccessibility(true);
-        PDFDocumentHandler d = new PDFDocumentHandler(new IFContext(userAgent));
-        OutputStream writer = new ByteArrayOutputStream();
-        StreamResult result = new StreamResult(writer);
-        d.setResult(result);
-        d.getStructureTreeEventHandler();
-        d.startDocument();
-        assertNull(d.getStructureTreeEventHandler().startNode("table-body", null, null));
-    }
-
     @Test
     public void testRemoveBlocks() throws Exception {
         keepEmptyTags = false;

fop-core/src/test/java/org/apache/fop/render/pdf/PDFStructureTreeBuilderTestCase.java

@@ -20,7 +20,14 @@
 package org.apache.fop.render.pdf;
 
 import java.io.ByteArrayOutputStream;
+import java.io.File;
 import java.io.IOException;
+import java.util.Arrays;
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
+
+import javax.xml.transform.stream.StreamResult;
 
 import org.junit.Before;
 import org.junit.Test;
@@ -30,16 +37,23 @@
 import static org.junit.Assert.assertEquals;
 import static org.junit.Assert.assertNotNull;
 import static org.junit.Assert.assertNull;
+import static org.mockito.Mockito.mock;
 
+import org.apache.fop.accessibility.StructureTreeElement;
+import org.apache.fop.apps.FOUserAgent;
+import org.apache.fop.apps.FopFactory;
 import org.apache.fop.pdf.PDFDocument;
 import org.apache.fop.pdf.PDFFactory;
 import org.apache.fop.pdf.PDFResources;
 import org.apache.fop.pdf.PDFStructElem;
 import org.apache.fop.pdf.StandardStructureTypes;
+import org.apache.fop.render.intermediate.IFContext;
 
 public class PDFStructureTreeBuilderTestCase {
     private PDFFactory pdfFactory;
 
+    private static final List<String> TABLE_TAGS = Arrays.asList("table-header", "table-footer", "table-body");
+
     @Before
     public void setUp() {
         PDFDocument doc = new PDFDocument("");
@@ -82,4 +96,82 @@ public void testExternalDocumentBuilder() {
         assertEquals("Elem must be of type figure", StandardStructureTypes.Illustration.FIGURE,
                 elem.getStructureType());
     }
+
+    @Test
+    public void testNonFilteredTag() throws Exception {
+        Result result = defaultStartNode(new HashMap<>(), "table-row");
+        assertNotNull("Table row is not one of the filtered tags", result.structTree);
+    }
+
+    @Test
+    public void testPDFATableTags() throws Exception {
+        List<String> invalidPDFAModes = Arrays.asList("PDF/A-1a", "PDF/A-1b");
+
+        Result result;
+        for (String pdfMode : invalidPDFAModes) {
+            Map<String, String> rendererOptionalMap = new HashMap<>();
+            rendererOptionalMap.put("pdf-a-mode", pdfMode);
+
+            for (String tag : TABLE_TAGS) {
+                result = defaultStartNode(rendererOptionalMap, tag);
+                assertNull("These tags are not valid for PDF/A-1", result.structTree);
+            }
+        }
+
+        List<String> validPDFAModes = Arrays.asList("PDF/A-2a", "PDF/A-2b", "PDF/A-2u",
+                "PDF/A-3a", "PDF/A-3b", "PDF/A-3u");
+
+        for (String pdfMode : validPDFAModes) {
+            Map<String, String> rendererOptionalMap = new HashMap<>();
+            rendererOptionalMap.put("pdf-a-mode", pdfMode);
+
+            for (String tag : TABLE_TAGS) {
+                result = defaultStartNode(rendererOptionalMap, tag);
+                assertNotNull("These tags are valid on for PDF/A-2 and PDFA/-3", result.structTree);
+            }
+        }
+    }
+
+    @Test
+    public void testPDFUATableTags() throws Exception {
+        Map<String, String> rendererOptionalMap = new HashMap<>();
+        rendererOptionalMap.put("pdf-ua-mode", "PDF/UA");
+
+        Result result;
+        for (String tag : TABLE_TAGS) {
+            result = defaultStartNode(rendererOptionalMap, tag);
+            assertNotNull("Tags are valid for PDF/UA", result.structTree);
+        }
+    }
+
+    private static class Result {
+        public StructureTreeElement structTree;
+        public PDFDocument pdfDoc;
+
+        public Result(StructureTreeElement structTree, PDFDocument pdfDoc) {
+            this.structTree = structTree;
+            this.pdfDoc = pdfDoc;
+        }
+    }
+
+    private Result defaultStartNode(Map<String, String> rendererOptionalMap, String nodeName)
+            throws Exception {
+        FOUserAgent userAgent = FopFactory.newInstance(new File(".").toURI()).newFOUserAgent();
+        userAgent.getRendererOptions().putAll(rendererOptionalMap);
+        userAgent.setAccessibility(true);
+
+        PDFDocumentHandler documentHandler = new PDFDocumentHandler(new IFContext(userAgent));
+        documentHandler.setResult(new StreamResult(new ByteArrayOutputStream()));
+        documentHandler.getStructureTreeEventHandler();
+        documentHandler.startDocument();
+
+        PDFStructElem divParent = new PDFStructElem(null, StandardStructureTypes.Grouping.DIV);
+        PDFStructElem tableParent = PDFStructureTreeBuilder.createStructureElement("table", divParent,
+                new AttributesImpl(), new PDFFactory(mock(PDFDocument.class)), null);
+
+        StructureTreeElement structElem = documentHandler.getStructureTreeEventHandler()
+                .startNode(nodeName, new AttributesImpl(), tableParent);
+
+        return new Result(structElem, documentHandler.getPDFDocument());
+    }
 }