Add tests to reset outlineHandler and cover resolveAgainstBaseUri. Refactor Html2PdfTest

DEVSIX-6137

Author: nikitakovaliov92

src/test/java/com/itextpdf/html2pdf/Html2PdfTest.java

@@ -42,167 +42,103 @@ This file is part of the iText (R) project.
  */
 package com.itextpdf.html2pdf;
 
-import com.itextpdf.html2pdf.attach.IHtmlProcessor;
-import com.itextpdf.html2pdf.attach.impl.DefaultHtmlProcessor;
-import com.itextpdf.html2pdf.resolver.font.DefaultFontProvider;
 import com.itextpdf.html2pdf.logs.Html2PdfLogMessageConstant;
-import com.itextpdf.io.logs.IoLogMessageConstant;
-import com.itextpdf.io.util.UrlUtil;
-import com.itextpdf.kernel.pdf.PdfDocument;
-import com.itextpdf.kernel.pdf.PdfWriter;
-import com.itextpdf.kernel.utils.CompareTool;
-import com.itextpdf.layout.Document;
-import com.itextpdf.layout.font.FontProvider;
-import com.itextpdf.styledxmlparser.IXmlParser;
 import com.itextpdf.styledxmlparser.logs.StyledXmlParserLogMessageConstant;
-import com.itextpdf.styledxmlparser.css.media.MediaDeviceDescription;
-import com.itextpdf.styledxmlparser.css.media.MediaType;
-import com.itextpdf.styledxmlparser.node.IDocumentNode;
-import com.itextpdf.styledxmlparser.node.impl.jsoup.JsoupHtmlParser;
-import com.itextpdf.test.ExtendedITextTest;
 import com.itextpdf.test.annotations.LogMessage;
 import com.itextpdf.test.annotations.LogMessages;
 import com.itextpdf.test.annotations.type.IntegrationTest;
 
-import java.io.FileInputStream;
-import org.junit.Assert;
+import java.io.IOException;
 import org.junit.BeforeClass;
 import org.junit.Test;
 import org.junit.experimental.categories.Category;
 
-import java.io.File;
-import java.io.IOException;
-
 @Category(IntegrationTest.class)
-public class Html2PdfTest extends ExtendedITextTest {
+public class Html2PdfTest extends ExtendedHtmlConversionITextTest {
 
-    public static final String sourceFolder = "./src/test/resources/com/itextpdf/html2pdf/Html2PdfTest/";
-    public static final String destinationFolder = "./target/test/com/itextpdf/html2pdf/Html2PdfTest/";
+    public static final String SOURCE_FOLDER = "./src/test/resources/com/itextpdf/html2pdf/Html2PdfTest/";
+    public static final String DESTINATION_FOLDER = "./target/test/com/itextpdf/html2pdf/Html2PdfTest/";
 
     @BeforeClass
     public static void beforeClass() {
-        createDestinationFolder(destinationFolder);
+        createOrClearDestinationFolder(DESTINATION_FOLDER);
     }
 
     @Test
     public void helloWorldParagraphTest() throws IOException, InterruptedException {
-        convertAndCompare(sourceFolder + "hello_paragraph.html", destinationFolder + "hello_paragraph.pdf",
-                sourceFolder + "cmp_hello_paragraph.pdf", destinationFolder, "diff01_");
+        convertToPdfAndCompare("hello_paragraph", SOURCE_FOLDER, DESTINATION_FOLDER);
     }
 
     @Test
     public void helloParagraphTableTest() throws IOException, InterruptedException {
-        convertAndCompare(sourceFolder + "hello_paragraph_table.html", destinationFolder + "hello_paragraph_table.pdf",
-                sourceFolder + "cmp_hello_paragraph_table.pdf", destinationFolder, "diff02_");
+        convertToPdfAndCompare("hello_paragraph_table", SOURCE_FOLDER, DESTINATION_FOLDER);
     }
 
     @Test
     public void helloMalformedDocumentTest() throws IOException, InterruptedException {
-        convertAndCompare(sourceFolder + "hello_malformed.html", destinationFolder + "hello_malformed.pdf",
-                sourceFolder + "cmp_hello_malformed.pdf", destinationFolder, "diff03_");
+        convertToPdfAndCompare("hello_malformed", SOURCE_FOLDER, DESTINATION_FOLDER);
     }
 
     @Test
     public void helloParagraphJunkSpacesDocumentTest() throws IOException, InterruptedException {
-        convertAndCompare(sourceFolder + "hello_paragraph_junk_spaces.html", destinationFolder + "hello_paragraph_junk_spaces.pdf",
-                sourceFolder + "cmp_hello_paragraph_junk_spaces.pdf", destinationFolder, "diff03_");
+        convertToPdfAndCompare("hello_paragraph_junk_spaces", SOURCE_FOLDER, DESTINATION_FOLDER);
     }
 
     @Test
     public void helloParagraphNestedInTableDocumentTest() throws IOException, InterruptedException {
-        convertAndCompare(sourceFolder + "hello_paragraph_nested_in_table.html", destinationFolder + "hello_paragraph_nested_in_table.pdf",
-                sourceFolder + "cmp_hello_paragraph_nested_in_table.pdf", destinationFolder, "diff03_");
+        convertToPdfAndCompare("hello_paragraph_nested_in_table", SOURCE_FOLDER, DESTINATION_FOLDER);
     }
 
     @Test
     public void helloParagraphWithSpansDocumentTest() throws IOException, InterruptedException {
-        convertAndCompare(sourceFolder + "hello_paragraph_with_span.html", destinationFolder + "hello_paragraph_with_span.pdf",
-                sourceFolder + "cmp_hello_paragraph_with_span.pdf", destinationFolder, "diff03_");
+        convertToPdfAndCompare("hello_paragraph_with_span", SOURCE_FOLDER, DESTINATION_FOLDER);
     }
 
     @Test
     public void helloDivDocumentTest() throws IOException, InterruptedException {
-        convertAndCompare(sourceFolder + "hello_div.html", destinationFolder + "hello_div.pdf",
-                sourceFolder + "cmp_hello_div.pdf", destinationFolder, "diff03_");
+        convertToPdfAndCompare("hello_div", SOURCE_FOLDER, DESTINATION_FOLDER);
     }
 
     @Test
     public void aBlockInPTagTest() throws IOException, InterruptedException {
-        convertAndCompare(sourceFolder + "aBlockInPTag.html", destinationFolder + "aBlockInPTag.pdf",
-                sourceFolder + "cmp_aBlockInPTag.pdf", destinationFolder, "diff03_");
+        convertToPdfAndCompare("aBlockInPTag", SOURCE_FOLDER, DESTINATION_FOLDER);
     }
 
     @Test
     public void base64svgTest() throws IOException, InterruptedException {
-        HtmlConverter.convertToPdf(new File(sourceFolder + "objectTag_base64svg.html"), new File(destinationFolder + "objectTag_base64svg.pdf"));
-        Assert.assertNull(new CompareTool().compareByContent(destinationFolder + "objectTag_base64svg.pdf", sourceFolder + "cmp_objectTag_base64svg.pdf", destinationFolder, "diff01_"));
+        convertToPdfAndCompare("objectTag_base64svg", SOURCE_FOLDER, DESTINATION_FOLDER);
     }
 
     @Test
-    @LogMessages(messages = {@LogMessage(messageTemplate = StyledXmlParserLogMessageConstant.UNABLE_TO_RETRIEVE_STREAM_WITH_GIVEN_BASE_URI, count = 1),
+    @LogMessages(messages = {
+            @LogMessage(messageTemplate =
+                    StyledXmlParserLogMessageConstant.UNABLE_TO_RETRIEVE_STREAM_WITH_GIVEN_BASE_URI, count = 1),
             @LogMessage(messageTemplate = Html2PdfLogMessageConstant.WORKER_UNABLE_TO_PROCESS_OTHER_WORKER, count = 1)})
     public void htmlObjectIncorrectBase64Test() throws IOException, InterruptedException {
-        HtmlConverter.convertToPdf(new File(sourceFolder + "objectTag_incorrectBase64svg.html"), new File(destinationFolder + "objectTag_incorrectBase64svg.pdf"));
-        Assert.assertNull(new CompareTool().compareByContent(destinationFolder + "objectTag_incorrectBase64svg.pdf", sourceFolder + "cmp_objectTag_incorrectBase64svg.pdf", destinationFolder, "diff01_"));
-
+        convertToPdfAndCompare("objectTag_incorrectBase64svg", SOURCE_FOLDER, DESTINATION_FOLDER);
     }
 
     @Test
-    @LogMessages(messages = {@LogMessage(messageTemplate = Html2PdfLogMessageConstant.WORKER_UNABLE_TO_PROCESS_IT_S_TEXT_CONTENT, count = 1),
+    //TODO: update after DEVSIX-1346
+    @LogMessages(messages = {
+            @LogMessage(messageTemplate = Html2PdfLogMessageConstant.WORKER_UNABLE_TO_PROCESS_IT_S_TEXT_CONTENT,
+                    count = 1),
             @LogMessage(messageTemplate = Html2PdfLogMessageConstant.WORKER_UNABLE_TO_PROCESS_OTHER_WORKER, count = 2),
     })
     public void htmlObjectAltTextTest() throws IOException, InterruptedException {
-        //update after DEVSIX-1346
-        HtmlConverter.convertToPdf(new File(sourceFolder + "objectTag_altText.html"), new File(destinationFolder + "objectTag_altText.pdf"));
-        Assert.assertNull(new CompareTool().compareByContent(destinationFolder + "objectTag_altText.pdf", sourceFolder + "cmp_objectTag_altText.pdf", destinationFolder, "diff01_"));
-
+        convertToPdfAndCompare("objectTag_altText", SOURCE_FOLDER, DESTINATION_FOLDER);
     }
 
     @Test
-    @LogMessages(messages = {@LogMessage(messageTemplate = Html2PdfLogMessageConstant.WORKER_UNABLE_TO_PROCESS_OTHER_WORKER, count = 1),})
+    @LogMessages(messages = {
+            @LogMessage(messageTemplate = Html2PdfLogMessageConstant.WORKER_UNABLE_TO_PROCESS_OTHER_WORKER,
+                    count = 1),})
     public void htmlObjectNestedObjectTest() throws IOException, InterruptedException {
-        HtmlConverter.convertToPdf(new File(sourceFolder + "objectTag_nestedTag.html"), new File(destinationFolder + "objectTag_nestedTag.pdf"));
-        Assert.assertNull(new CompareTool().compareByContent(destinationFolder + "objectTag_nestedTag.pdf", sourceFolder + "cmp_objectTag_nestedTag.pdf", destinationFolder, "diff01_"));
+        convertToPdfAndCompare("objectTag_nestedTag", SOURCE_FOLDER, DESTINATION_FOLDER);
     }
 
     @Test
-    @LogMessages(ignore = true, messages = {
-            @LogMessage(messageTemplate = StyledXmlParserLogMessageConstant.RULE_IS_NOT_SUPPORTED),
-            @LogMessage(messageTemplate = Html2PdfLogMessageConstant.CSS_PROPERTY_IN_PERCENTS_NOT_SUPPORTED),
-            @LogMessage(messageTemplate = Html2PdfLogMessageConstant.PADDING_VALUE_IN_PERCENT_NOT_SUPPORTED),
-            @LogMessage(messageTemplate = Html2PdfLogMessageConstant.MARGIN_VALUE_IN_PERCENT_NOT_SUPPORTED),
-            @LogMessage(messageTemplate = Html2PdfLogMessageConstant.ERROR_PARSING_CSS_SELECTOR),
-            @LogMessage(messageTemplate = IoLogMessageConstant.WIDOWS_CONSTRAINT_VIOLATED),
-    })
-    public void batchConversionTest() throws IOException, InterruptedException {
-        ConverterProperties properties = new ConverterProperties().setBaseUri(sourceFolder)
-                .setMediaDeviceDescription(new MediaDeviceDescription(MediaType.PRINT));
-        FontProvider fontProvider = new DefaultFontProvider(true, false, false);
-        fontProvider.addDirectory(sourceFolder + "fonts/");
-        properties.setFontProvider(fontProvider);
-        IHtmlProcessor processor = new DefaultHtmlProcessor(properties);
-
-        IXmlParser parser = new JsoupHtmlParser();
-        String outPdfPath = destinationFolder + "smashing1.pdf";
-        PdfDocument pdfDocument = new PdfDocument(new PdfWriter(outPdfPath));
-        IDocumentNode doc = parser.parse(new FileInputStream(sourceFolder + "smashing01.html"),
-                properties.getCharset());
-        Document document = processor.processDocument(doc, pdfDocument);
-        document.close();
-
-        Assert.assertNull(new CompareTool().compareByContent(outPdfPath,
-                sourceFolder + "cmp_smashing1.pdf", destinationFolder, "diff01_"));
-    }
-
-    @Test
-    public  void htmlImgBase64SVGTest() throws IOException, InterruptedException {
-        HtmlConverter.convertToPdf(new File(sourceFolder + "imgTag_base64svg.html"), new File(destinationFolder + "imgTag_base64svg.pdf"));
-        Assert.assertNull(new CompareTool().compareByContent(destinationFolder + "imgTag_base64svg.pdf", sourceFolder + "cmp_imgTag_base64svg.pdf", destinationFolder, "diff01_"));
-    }
-
-    private void convertAndCompare(String srcFilename, String outFilename, String cmpFilename, String outFolder, String diff) throws IOException, InterruptedException {
-        HtmlConverter.convertToPdf(new File(srcFilename), new File(outFilename));
-        System.out.println("html: " + UrlUtil.getNormalizedFileUriString(srcFilename) + "\n");
-        Assert.assertNull(new CompareTool().compareByContent(outFilename, cmpFilename, outFolder, diff));
+    public void htmlImgBase64SVGTest() throws IOException, InterruptedException {
+        convertToPdfAndCompare("imgTag_base64svg", SOURCE_FOLDER, DESTINATION_FOLDER);
     }
 }

src/test/java/com/itextpdf/html2pdf/attach/impl/OutlineHandlerTest.java

@@ -125,4 +125,18 @@ public void defaultOutlineHandlerWithHTagHavingIdTest() throws IOException, Inte
         Assert.assertNull(new CompareTool().compareByContent(outFile, cmpFile, DESTINATION_FOLDER, "diff_defaultOutlineHandlerWithHTagHavingIdTest"));
     }
 
+    @Test
+    public void resetOutlineHandlerTest() throws IOException, InterruptedException {
+        OutlineHandler outlineHandler = OutlineHandler.createStandardHandler();
+
+        for (int i = 1; i <= 3; i++) {
+            String srcHtml = SOURCE_FOLDER + "outlines0" + i + ".html";
+            String outPdf = DESTINATION_FOLDER + "outlines0" + i + ".pdf";
+            String cmpPdf = SOURCE_FOLDER + "cmp_outlines0" + i + ".pdf";
+
+            HtmlConverter.convertToPdf(new File(srcHtml), new File(outPdf),
+                    new ConverterProperties().setOutlineHandler(outlineHandler));
+            Assert.assertNull(new CompareTool().compareByContent(outPdf, cmpPdf, DESTINATION_FOLDER, "diff_" + i));
+        }
+    }
 }

src/test/java/com/itextpdf/html2pdf/resolver/UriResolverTest.java

@@ -0,0 +1,64 @@
+/*
+    This file is part of the iText (R) project.
+    Copyright (c) 1998-2021 iText Group NV
+    Authors: iText Software.
+
+    This program is offered under a commercial and under the AGPL license.
+    For commercial licensing, contact us at https://itextpdf.com/sales.  For AGPL licensing, see below.
+
+    AGPL licensing:
+    This program is free software: you can redistribute it and/or modify
+    it under the terms of the GNU Affero General Public License as published by
+    the Free Software Foundation, either version 3 of the License, or
+    (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU Affero General Public License for more details.
+
+    You should have received a copy of the GNU Affero General Public License
+    along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ */
+package com.itextpdf.html2pdf.resolver;
+
+import com.itextpdf.html2pdf.ConverterProperties;
+import com.itextpdf.html2pdf.HtmlConverter;
+import com.itextpdf.kernel.utils.CompareTool;
+import com.itextpdf.styledxmlparser.logs.StyledXmlParserLogMessageConstant;
+import com.itextpdf.test.ExtendedITextTest;
+import com.itextpdf.test.annotations.LogMessage;
+import com.itextpdf.test.annotations.LogMessages;
+import com.itextpdf.test.annotations.type.IntegrationTest;
+
+import java.io.File;
+import java.io.IOException;
+import org.junit.Assert;
+import org.junit.BeforeClass;
+import org.junit.Test;
+import org.junit.experimental.categories.Category;
+
+@Category(IntegrationTest.class)
+public class UriResolverTest extends ExtendedITextTest {
+
+    private static final String SOURCE_FOLDER = "./src/test/resources/com/itextpdf/html2pdf/resolver/UriResolverTest/";
+    private static final String DESTINATION_FOLDER =
+            "./target/test/resources/com/itextpdf/html2pdf/resolver/UriResolverTest/";
+
+    @BeforeClass
+    public static void before() throws IOException {
+        createOrClearDestinationFolder(DESTINATION_FOLDER);
+    }
+
+    @Test
+    @LogMessages(messages = {@LogMessage(messageTemplate = StyledXmlParserLogMessageConstant.UNABLE_TO_RETRIEVE_IMAGE_WITH_GIVEN_BASE_URI)})
+    public void illegalColonCharTest() throws IOException, InterruptedException {
+        String srcHtml = SOURCE_FOLDER + "illegalColonChar.html";
+        String outPdf = DESTINATION_FOLDER + "illegalColonChar.pdf";
+        String cmpPdf = SOURCE_FOLDER + "cmp_illegalColonChar.pdf";
+
+        ConverterProperties properties = new ConverterProperties().setBaseUri(SOURCE_FOLDER);
+        HtmlConverter.convertToPdf(new File(srcHtml), new File(outPdf), properties);
+        Assert.assertNull(new CompareTool().compareByContent(outPdf, cmpPdf, DESTINATION_FOLDER, "diff_"));
+    }
+}