Add tests for setFontProvider+setFontFamily pair and for deprecated Property.FONT as String

DEVSIX-2525

Author: yulian-gaponenko

kernel/src/main/java/com/itextpdf/kernel/PdfException.java

@@ -165,6 +165,7 @@ public class PdfException extends RuntimeException {
     public static final String FlushedPageCannotBeAddedOrInserted = "Flushed page cannot be added or inserted.";
     public static final String FontAndSizeMustBeSetBeforeWritingAnyText = "Font and size must be set before writing any text.";
     public static final String FontEmbeddingIssue = "Font embedding issue.";
+    public static final String FontProviderNotSetFontFamilyNotResolved = "FontProvider and FontSet are empty. Cannot resolve font family name (see ElementPropertyContainer#setFontFamily) without initialized FontProvider (see RootElement#setFontProvider).";
     @Deprecated
     public static final String FontSizeIsTooSmall = "Font size is too small.";
     public static final String FormXObjectMustHaveBbox = "Form XObject must have BBox.";

layout/src/main/java/com/itextpdf/layout/renderer/AbstractRenderer.java

@@ -46,6 +46,7 @@ This file is part of the iText (R) project.
 import com.itextpdf.io.LogMessageConstant;
 import com.itextpdf.io.util.MessageFormatUtil;
 import com.itextpdf.io.util.NumberUtil;
+import com.itextpdf.kernel.PdfException;
 import com.itextpdf.kernel.colors.Color;
 import com.itextpdf.kernel.font.PdfFont;
 import com.itextpdf.kernel.geom.AffineTransform;
@@ -2163,7 +2164,7 @@ PdfFont resolveFirstPdfFont() {
             }
             FontProvider provider = this.<FontProvider>getProperty(Property.FONT_PROVIDER);
             if (provider == null) {
-                throw new IllegalStateException("Invalid font type. FontProvider expected. Cannot resolve font with string value");
+                throw new IllegalStateException(PdfException.FontProviderNotSetFontFamilyNotResolved);
             }
             FontCharacteristics fc = createFontCharacteristics();
             return resolveFirstPdfFont((String[]) font, provider, fc);

layout/src/main/java/com/itextpdf/layout/renderer/TextRenderer.java

@@ -52,6 +52,7 @@ This file is part of the iText (R) project.
 import com.itextpdf.io.util.EnumUtil;
 import com.itextpdf.io.util.MessageFormatUtil;
 import com.itextpdf.io.util.TextUtil;
+import com.itextpdf.kernel.PdfException;
 import com.itextpdf.kernel.colors.Color;
 import com.itextpdf.kernel.font.PdfFont;
 import com.itextpdf.kernel.font.PdfType0Font;
@@ -1218,7 +1219,7 @@ protected boolean resolveFonts(List<IRenderer> addTo) {
             FontProvider provider = this.<FontProvider>getProperty(Property.FONT_PROVIDER);
             FontSet fontSet = this.<FontSet>getProperty(Property.FONT_SET);
             if (provider.getFontSet().isEmpty() && (fontSet == null || fontSet.isEmpty())) {
-                throw new IllegalStateException("Invalid font type. FontProvider and FontSet are empty. Cannot resolve font with string value.");
+                throw new IllegalStateException(PdfException.FontProviderNotSetFontFamilyNotResolved);
             }
             FontCharacteristics fc = createFontCharacteristics();
             FontSelectorStrategy strategy = provider.getStrategy(strToBeConverted, Arrays.asList((String[])font), fc, fontSet);
@@ -1235,7 +1236,7 @@ protected boolean resolveFonts(List<IRenderer> addTo) {
             }
             return true;
         } else {
-            throw new IllegalStateException("Invalid font type.");
+            throw new IllegalStateException("Invalid FONT property value type.");
         }
     }
 

layout/src/test/java/com/itextpdf/layout/FontProviderTest.java

@@ -45,6 +45,7 @@ This file is part of the iText (R) project.
 import com.itextpdf.io.font.PdfEncodings;
 import com.itextpdf.io.font.constants.StandardFontFamilies;
 import com.itextpdf.io.font.constants.StandardFonts;
+import com.itextpdf.kernel.PdfException;
 import com.itextpdf.kernel.font.PdfFont;
 import com.itextpdf.kernel.font.PdfFontFactory;
 import com.itextpdf.kernel.font.PdfType3Font;
@@ -63,8 +64,10 @@ This file is part of the iText (R) project.
 import com.itextpdf.test.annotations.type.IntegrationTest;
 import org.junit.Assert;
 import org.junit.BeforeClass;
+import org.junit.Rule;
 import org.junit.Test;
 import org.junit.experimental.categories.Category;
+import org.junit.rules.ExpectedException;
 
 import java.io.FileInputStream;
 import java.io.FileOutputStream;
@@ -75,6 +78,9 @@ This file is part of the iText (R) project.
 @Category(IntegrationTest.class)
 public class FontProviderTest extends ExtendedITextTest {
 
+    @Rule
+    public ExpectedException junitExpectedException = ExpectedException.none();
+
     private static class PdfFontProvider extends FontProvider {
 
         private List<FontInfo> pdfFontInfos = new ArrayList<>();
@@ -188,4 +194,22 @@ public void customFontProvider2() throws Exception {
         Assert.assertNull(new CompareTool().compareByContent(outFileName, cmpFileName, destinationFolder, "diff" + fileName));
     }
 
+    @Test
+    public void fontProviderNotSetExceptionTest() throws Exception {
+        junitExpectedException.expect(IllegalStateException.class);
+        junitExpectedException.expectMessage(PdfException.FontProviderNotSetFontFamilyNotResolved);
+
+        String fileName = "fontProviderNotSetExceptionTest.pdf";
+        String outFileName = destinationFolder + fileName + ".pdf";
+
+        PdfDocument pdfDoc = new PdfDocument(new PdfWriter(new FileOutputStream(outFileName)));
+        Document doc = new Document(pdfDoc);
+
+        Paragraph paragraph = new Paragraph("Hello world!")
+                .setFontFamily("ABRACADABRA_NO_FONT_PROVIDER_ANYWAY");
+        doc.add(paragraph);
+
+        doc.close();
+    }
+
 }

layout/src/test/java/com/itextpdf/layout/FontSelectorTest.java

@@ -42,6 +42,7 @@ This file is part of the iText (R) project.
  */
 package com.itextpdf.layout;
 
+import com.itextpdf.io.LogMessageConstant;
 import com.itextpdf.io.font.PdfEncodings;
 import com.itextpdf.io.font.constants.StandardFontFamilies;
 import com.itextpdf.io.font.constants.StandardFonts;
@@ -62,6 +63,8 @@ This file is part of the iText (R) project.
 import com.itextpdf.layout.font.RangeBuilder;
 import com.itextpdf.layout.property.Property;
 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 org.junit.Assert;
 import org.junit.BeforeClass;
@@ -121,7 +124,6 @@ public void cyrillicAndLatinGroup() throws Exception {
     }
 
     @Test
-    // TODO DEVSIX-2120 The font-family name of Puritan2.otf is 'Puritan 2.0' but this name doesn't match font-family name pattern
     public void cyrillicAndLatinGroup2() throws Exception {
         String fileName = "cyrillicAndLatinGroup2";
         String outFileName = destinationFolder + fileName + ".pdf";
@@ -147,6 +149,61 @@ public void cyrillicAndLatinGroup2() throws Exception {
         Assert.assertNull(new CompareTool().compareByContent(outFileName, cmpFileName, destinationFolder, "diff" + fileName));
     }
 
+    @Test
+    public void cyrillicAndLatinGroup3() throws Exception {
+        String fileName = "cyrillicAndLatinGroup3";
+        String outFileName = destinationFolder + fileName + ".pdf";
+        String cmpFileName = sourceFolder + "cmp_" + fileName + ".pdf";
+
+        FontProvider sel = new FontProvider();
+
+        Assert.assertTrue(sel.addFont(fontsFolder + "FreeSans.ttf"));
+        Assert.assertTrue(sel.addFont(fontsFolder + "NotoSans-Regular.ttf"));
+        Assert.assertTrue(sel.addFont(fontsFolder + "Puritan2.otf"));
+
+
+        String s = "Hello world! Здравствуй мир! Hello world! Здравствуй мир!";
+        PdfDocument pdfDoc = new PdfDocument(new PdfWriter(new FileOutputStream(outFileName)));
+        Document doc = new Document(pdfDoc);
+
+        doc.setFontProvider(sel);
+        doc.setFontFamily(Arrays.asList("Puritan 2.0", "Noto Sans"));
+        Text text = new Text(s).setBackgroundColor(ColorConstants.LIGHT_GRAY);
+        Paragraph paragraph = new Paragraph(text);
+        doc.add(paragraph);
+        doc.close();
+
+        Assert.assertNull(new CompareTool().compareByContent(outFileName, cmpFileName, destinationFolder, "diff" + fileName));
+    }
+
+    @Test
+    @LogMessages(messages = @LogMessage(messageTemplate = LogMessageConstant.FONT_PROPERTY_OF_STRING_TYPE_IS_DEPRECATED_USE_STRINGS_ARRAY_INSTEAD))
+    public void cyrillicAndLatinGroupDeprecatedFontAsStringValue() throws Exception {
+        String fileName = "cyrillicAndLatinGroupDeprecatedFontAsStringValue";
+        String outFileName = destinationFolder + fileName + ".pdf";
+        String cmpFileName = sourceFolder + "cmp_" + fileName + ".pdf";
+
+        FontProvider sel = new FontProvider();
+
+        Assert.assertTrue(sel.addFont(fontsFolder + "FreeSans.ttf"));
+        Assert.assertTrue(sel.addFont(fontsFolder + "NotoSans-Regular.ttf"));
+        Assert.assertTrue(sel.addFont(fontsFolder + "Puritan2.otf"));
+
+
+        String s = "Hello world! Здравствуй мир! Hello world! Здравствуй мир!";
+        PdfDocument pdfDoc = new PdfDocument(new PdfWriter(new FileOutputStream(outFileName)));
+        Document doc = new Document(pdfDoc);
+
+        doc.setFontProvider(sel);
+        doc.setProperty(Property.FONT, "'Puritan', \"FreeSans\"");
+        Text text = new Text(s).setBackgroundColor(ColorConstants.LIGHT_GRAY);
+        Paragraph paragraph = new Paragraph(text);
+        doc.add(paragraph);
+        doc.close();
+
+        Assert.assertNull(new CompareTool().compareByContent(outFileName, cmpFileName, destinationFolder, "diff" + fileName));
+    }
+
     @Test
     public void latinAndNotdefGroup() throws Exception {
         String fileName = "latinAndNotdefGroup";