Add column-gap tests

DEVSIX-7558

Author: Andrei Stryhelski

src/test/java/com/itextpdf/html2pdf/css/multicol/ColumnCountTest.java

@@ -63,8 +63,7 @@ public void convertBasicPTest() throws IOException, InterruptedException {
 
     @Test
     public void diffElementsInsidePTest() throws IOException, InterruptedException {
-        convertToPdfAndCompare("diffElementsInsidePTest", SOURCE_FOLDER, DESTINATION_FOLDER, false,
-                new ConverterProperties().setMulticolEnabled(true).setBaseUri(SOURCE_FOLDER));
+        runTest("diffElementsInsidePTest");
     }
 
     //TODO: DEVSIX-7591 support nested multicol layouting
@@ -91,20 +90,17 @@ public void convertBasicTableTest() throws IOException, InterruptedException {
 
     @Test
     public void tableColspanTest() throws IOException, InterruptedException {
-        convertToPdfAndCompare("tableColspanTest",
-                SOURCE_FOLDER, DESTINATION_FOLDER, false, new ConverterProperties().setMulticolEnabled(true));
+        runTest("tableColspanTest");
     }
 
     @Test
     public void tableRowspanTest() throws IOException, InterruptedException {
-        convertToPdfAndCompare("tableRowspanTest",
-                SOURCE_FOLDER, DESTINATION_FOLDER, false, new ConverterProperties().setMulticolEnabled(true));
+        runTest("tableRowspanTest");
     }
 
     @Test
     public void tableColspanRowspanTest() throws IOException, InterruptedException {
-        convertToPdfAndCompare("tableColspanRowspanTest",
-                SOURCE_FOLDER, DESTINATION_FOLDER, false, new ConverterProperties().setMulticolEnabled(true));
+        runTest("tableColspanRowspanTest");
     }
 
     //TODO: DEVSIX-7591 Support nested multicol layouting
@@ -153,99 +149,84 @@ public void convertImagesWithDifferentColValuesTest() throws IOException, Interr
         runTest("imagesWithDifferentColValuesTest");
     }
 
-    private void runTest(String testName) throws IOException, InterruptedException {
-        convertToPdfAndCompare(testName,
-                SOURCE_FOLDER, DESTINATION_FOLDER, false,
-                new ConverterProperties().setMulticolEnabled(true).setBaseUri(SOURCE_FOLDER));
-    }
-
-
     @Test
     public void paddingsMarginsBorderBackgrounds() throws IOException, InterruptedException {
-        convertToPdfAndCompare("paddingsMarginsBorderBackgrounds",
-                SOURCE_FOLDER, DESTINATION_FOLDER, false, new ConverterProperties().setMulticolEnabled(true));
+        runTest("paddingsMarginsBorderBackgrounds");
     }
 
 
     @Test
     public void borderOnlyTest() throws IOException, InterruptedException {
-        convertToPdfAndCompare("borderOnly",
-                SOURCE_FOLDER, DESTINATION_FOLDER, false, new ConverterProperties().setMulticolEnabled(true));
+        runTest("borderOnly");
     }
 
 
     @Test
     public void paddingOnlyTest() throws IOException, InterruptedException {
-        convertToPdfAndCompare("paddingOnly",
-                SOURCE_FOLDER, DESTINATION_FOLDER, false, new ConverterProperties().setMulticolEnabled(true));
+        runTest("paddingOnly");
     }
 
 
     @Test
     public void marginOnlyTest() throws IOException, InterruptedException {
-        convertToPdfAndCompare("marginOnly",
-                SOURCE_FOLDER, DESTINATION_FOLDER, false, new ConverterProperties().setMulticolEnabled(true));
+        runTest("marginOnly");
     }
 
 
     @Test
     public void splitInnerParagraphBetweenColumns() throws IOException, InterruptedException {
-        convertToPdfAndCompare("splitInnerParagraphBetweenColumns",
-                SOURCE_FOLDER, DESTINATION_FOLDER, false, new ConverterProperties().setMulticolEnabled(true));
+        runTest("splitInnerParagraphBetweenColumns");
     }
 
     @Test
     public void splitInnerParagraphWithoutMarginBetweenColumns() throws IOException, InterruptedException {
-        convertToPdfAndCompare("splitInnerParagraphWithoutMarginBetweenColumns",
-                SOURCE_FOLDER, DESTINATION_FOLDER, false, new ConverterProperties().setMulticolEnabled(true));
+        runTest("splitInnerParagraphWithoutMarginBetweenColumns");
     }
 
     @Test
     public void splitEmptyBlockElementsBetweenColumns() throws IOException, InterruptedException {
-        convertToPdfAndCompare("splitEmptyBlockElementsBetweenColumns",
-                SOURCE_FOLDER, DESTINATION_FOLDER, false, new ConverterProperties().setMulticolEnabled(true));
+        runTest("splitEmptyBlockElementsBetweenColumns");
     }
 
 
     @Test
     public void splitEmptyParagraphElementsBetweenColumns() throws IOException, InterruptedException {
-        convertToPdfAndCompare("splitEmptyParagraphElementsBetweenColumns",
-                SOURCE_FOLDER, DESTINATION_FOLDER, false, new ConverterProperties().setMulticolEnabled(true));
+        runTest("splitEmptyParagraphElementsBetweenColumns");
     }
 
     @Test
     public void splitEmptyContinuousBlockElementBetweenColumns() throws IOException, InterruptedException {
-        convertToPdfAndCompare("splitEmptyContinuousBlockElementBetweenColumns",
-                SOURCE_FOLDER, DESTINATION_FOLDER, false, new ConverterProperties().setMulticolEnabled(true));
+        runTest("splitEmptyContinuousBlockElementBetweenColumns");
     }
 
     @Test
     public void basicHiTest() throws IOException, InterruptedException {
-        convertToPdfAndCompare("basicHiTest",
-                SOURCE_FOLDER, DESTINATION_FOLDER, false, new ConverterProperties().setMulticolEnabled(true));
+        runTest("basicHiTest");
     }
 
     @Test
     public void basicFooterHeaderTest() throws IOException, InterruptedException {
-        convertToPdfAndCompare("basicFooterHeaderTest",
-                SOURCE_FOLDER, DESTINATION_FOLDER, false, new ConverterProperties().setMulticolEnabled(true));
+        runTest("basicFooterHeaderTest");
     }
 
     @Test
     public void basicDlTest() throws IOException, InterruptedException {
-        convertToPdfAndCompare("basicDlTest",
-                SOURCE_FOLDER, DESTINATION_FOLDER, false, new ConverterProperties().setMulticolEnabled(true));
+        runTest("basicDlTest");
     }
 
     @Test
     public void basicInlineElementsTest() throws IOException, InterruptedException {
-        convertToPdfAndCompare("basicInlineElementsTest",
-                SOURCE_FOLDER, DESTINATION_FOLDER, false, new ConverterProperties().setMulticolEnabled(true));
+        runTest("basicInlineElementsTest");
     }
 
     @Test
     public void basicBlockquoteTest() throws IOException, InterruptedException {
-        convertToPdfAndCompare("basicBlockquoteTest",
-                SOURCE_FOLDER, DESTINATION_FOLDER, false, new ConverterProperties().setMulticolEnabled(true));
+        runTest("basicBlockquoteTest");
+    }
+
+    private void runTest(String testName) throws IOException, InterruptedException {
+        convertToPdfAndCompare(testName,
+                SOURCE_FOLDER, DESTINATION_FOLDER, false,
+                new ConverterProperties().setMulticolEnabled(true).setBaseUri(SOURCE_FOLDER));
     }
 }

src/test/java/com/itextpdf/html2pdf/css/multicol/ColumnGapTest.java

@@ -0,0 +1,116 @@
+/*
+    This file is part of the iText (R) project.
+    Copyright (c) 1998-2023 Apryse Group NV
+    Authors: Apryse 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.css.multicol;
+
+import com.itextpdf.html2pdf.ConverterProperties;
+import com.itextpdf.html2pdf.ExtendedHtmlConversionITextTest;
+import com.itextpdf.html2pdf.logs.Html2PdfLogMessageConstant;
+import com.itextpdf.test.annotations.LogMessage;
+import com.itextpdf.test.annotations.LogMessages;
+import com.itextpdf.test.annotations.type.IntegrationTest;
+
+import java.io.IOException;
+import org.junit.BeforeClass;
+import org.junit.Test;
+import org.junit.experimental.categories.Category;
+
+@Category(IntegrationTest.class)
+public class ColumnGapTest extends ExtendedHtmlConversionITextTest {
+    public static final String SOURCE_FOLDER = "./src/test/resources/com/itextpdf/html2pdf/css/multicol/ColumnGapTest/";
+    public static final String DESTINATION_FOLDER = "./target/test/com/itextpdf/html2pdf/css/multicol/ColumnGapTest/";
+
+    @BeforeClass
+    public static void beforeClass() {
+        createOrClearDestinationFolder(DESTINATION_FOLDER);
+    }
+
+    @Test
+    public void convertBasicTest() throws IOException, InterruptedException {
+        runTest("basicTest");
+    }
+
+    @Test
+    public void convertLargeColumnGapValueTest() throws IOException, InterruptedException {
+        runTest("largeColumnGapValueTest");
+    }
+
+    @Test
+    @LogMessages(messages = @LogMessage(messageTemplate =
+            Html2PdfLogMessageConstant.INVALID_CSS_PROPERTY_DECLARATION, count = 2))
+    public void convertNegativeColumnGapValueTest() throws IOException, InterruptedException {
+        runTest("negativeColumnGapValueTest");
+    }
+
+    @Test
+    public void convertSmallColumnGapValueTest() throws IOException, InterruptedException {
+        runTest("smallColumnGapValueTest");
+    }
+
+    @Test
+    public void convertFloatColumnGapValueTest() throws IOException, InterruptedException {
+        runTest("floatColumnGapValueTest");
+    }
+
+    @Test
+    @LogMessages(messages = @LogMessage(messageTemplate =
+            Html2PdfLogMessageConstant.INVALID_CSS_PROPERTY_DECLARATION, count = 2))
+    public void convertDifferentUnitsTest() throws IOException, InterruptedException {
+        runTest("differentUnitsTest");
+    }
+
+    @Test
+    public void convertColumnsAndGapTest() throws IOException, InterruptedException {
+        runTest("columnsAndGapTest");
+    }
+
+    @Test
+    public void convertMarginTest() throws IOException, InterruptedException {
+        runTest("marginTest");
+    }
+
+    @Test
+    public void convertPaddingTest() throws IOException, InterruptedException {
+        runTest("paddingTest");
+    }
+
+    @Test
+    public void convertMixedElementsTest() throws IOException, InterruptedException {
+        runTest("mixedElementsTest");
+    }
+
+    @Test
+    public void convertNestedElementsTest() throws IOException, InterruptedException {
+        runTest("nestedElementsTest");
+    }
+
+    @Test
+    public void convertGapShorthandTest() throws IOException, InterruptedException {
+        runTest("gapShorthandTest");
+    }
+
+    private void runTest(String testName) throws IOException, InterruptedException {
+        convertToPdfAndCompare(testName,
+                SOURCE_FOLDER, DESTINATION_FOLDER, false,
+                new ConverterProperties().setMulticolEnabled(true).setBaseUri(SOURCE_FOLDER));
+    }
+}

src/test/resources/com/itextpdf/html2pdf/css/multicol/ColumnGapTest/basicTest.html

@@ -0,0 +1,47 @@
+<!DOCTYPE html>
+<html>
+  <head> </head>
+  <body>
+    <h2>Basic column-gap test</h2>
+    <h3>column-count: 3; column-gap: 100px</h3>
+    <div style="column-count: 3; column-gap: 100px; border: solid">
+      Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod
+      tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim
+      veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea
+      commodo consequat. Duis aute irure dolor in reprehenderit in voluptate
+      velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat
+      cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id
+      est laborum.
+    </div>
+    <h3>columns: 4; column-gap: 150px</h3>
+    <div style="columns: 4; column-gap: 150px; border: solid">
+      Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod
+      tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim
+      veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea
+      commodo consequat. Duis aute irure dolor in reprehenderit in voluptate
+      velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat
+      cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id
+      est laborum.
+    </div>
+    <h3>columns: 7; column-gap: 30px</h3>
+    <div style="columns: 7; column-gap: 30px; border: solid">
+      Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod
+      tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim
+      veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea
+      commodo consequat. Duis aute irure dolor in reprehenderit in voluptate
+      velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat
+      cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id
+      est laborum.
+    </div>
+    <h3>column-count: 12; column-gap: 50px</h3>
+    <div style="column-count: 12; column-gap: 50px; border: solid">
+      Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod
+      tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim
+      veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea
+      commodo consequat. Duis aute irure dolor in reprehenderit in voluptate
+      velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat
+      cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id
+      est laborum.
+    </div>
+  </body>
+</html>