You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@pdfbox.apache.org by ms...@apache.org on 2020/11/17 06:47:15 UTC

svn commit: r1883507 - /pdfbox/trunk/preflight/src/test/java/org/apache/pdfbox/preflight/integration/InvalidFileTester.java

Author: msahyoun
Date: Tue Nov 17 06:47:15 2020
New Revision: 1883507

URL: http://svn.apache.org/viewvc?rev=1883507&view=rev
Log:
PDFBOX-5017: new helper class for Isartor testing

Added:
    pdfbox/trunk/preflight/src/test/java/org/apache/pdfbox/preflight/integration/InvalidFileTester.java

Added: pdfbox/trunk/preflight/src/test/java/org/apache/pdfbox/preflight/integration/InvalidFileTester.java
URL: http://svn.apache.org/viewvc/pdfbox/trunk/preflight/src/test/java/org/apache/pdfbox/preflight/integration/InvalidFileTester.java?rev=1883507&view=auto
==============================================================================
--- pdfbox/trunk/preflight/src/test/java/org/apache/pdfbox/preflight/integration/InvalidFileTester.java (added)
+++ pdfbox/trunk/preflight/src/test/java/org/apache/pdfbox/preflight/integration/InvalidFileTester.java Tue Nov 17 06:47:15 2020
@@ -0,0 +1,149 @@
+package org.apache.pdfbox.preflight.integration;
+
+import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertFalse;
+import static org.junit.jupiter.api.Assertions.assertTrue;
+import static org.junit.jupiter.api.Assertions.fail;
+
+/*****************************************************************************
+ * 
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
+ * 
+ * http://www.apache.org/licenses/LICENSE-2.0
+ * 
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ * 
+ ****************************************************************************/
+
+import java.io.File;
+import java.io.FileOutputStream;
+import java.io.OutputStream;
+
+import org.apache.commons.logging.Log;
+import org.apache.commons.logging.LogFactory;
+import org.apache.pdfbox.io.IOUtils;
+import org.apache.pdfbox.preflight.ValidationResult;
+import org.apache.pdfbox.preflight.ValidationResult.ValidationError;
+import org.apache.pdfbox.preflight.parser.PreflightParser;
+
+public class InvalidFileTester
+{
+
+    /**
+     * where result information are pushed
+     */
+    protected OutputStream outputResult = null;
+
+    /**
+     * carry the path of the file validated during current test
+     */
+    protected File path;
+
+    protected static Log staticLogger = LogFactory.getLog("Test");
+
+    protected Log logger = null;
+
+    /**
+     * Prepare the test for one file
+     * 
+     * @param path  pdf/a file to test
+     * @param error expected error for this test
+     * @throws Exception
+     */
+    public InvalidFileTester(String resultKeyFile) throws Exception
+    {
+        this.logger = LogFactory.getLog(this.getClass());
+        before(resultKeyFile);
+    }
+
+    public final void validate(File path, String expectedError) throws Exception
+    {
+        if (path == null)
+        {
+            logger.warn("This is an empty test");
+            return;
+        }
+        ValidationResult result = PreflightParser.validate(path);
+        assertFalse(result.isValid(), path + " : Isartor file should be invalid (" + path + ")");
+        assertTrue(result.getErrorsList().size() > 0, path + " : Should find at least one error");
+        // could contain more than one error
+        boolean found = false;
+        if (expectedError != null)
+        {
+            for (ValidationError error : result.getErrorsList())
+            {
+                if (error.getErrorCode().equals(expectedError))
+                {
+                    found = true;
+                    if (outputResult == null)
+                    {
+                        break;
+                    }
+                }
+                if (outputResult != null)
+                {
+                    String log = path.getName().replace(".pdf", "") + "#" + error.getErrorCode()
+                            + "#" + error.getDetails() + "\n";
+                    outputResult.write(log.getBytes());
+                }
+            }
+        }
+
+        if (result.getErrorsList().size() > 0)
+        {
+            if (expectedError == null)
+            {
+                logger.info("File invalid as expected (no expected code) :"
+                        + this.path.getAbsolutePath());
+            }
+            else if (!found)
+            {
+                StringBuilder message = new StringBuilder(100);
+                message.append(path).append(" : Invalid error code returned. Expected ");
+                message.append(expectedError).append(", found ");
+                for (ValidationError error : result.getErrorsList())
+                {
+                    message.append(error.getErrorCode()).append(" ");
+                }
+                fail(message.toString());
+            }
+        }
+        else
+        {
+            assertEquals(path + " : Invalid error code returned.", expectedError,
+                    result.getErrorsList().get(0).getErrorCode());
+        }
+    }
+
+    public void before(String resultKeyFile) throws Exception
+    {
+        String irp = System.getProperty(resultKeyFile);
+
+        if (irp == null)
+        {
+            // no log file defined, use system.err
+            outputResult = System.err;
+        }
+        else
+        {
+            outputResult = new FileOutputStream(irp);
+        }
+    }
+
+    public void after() throws Exception
+    {
+        IOUtils.closeQuietly(outputResult);
+    }
+
+}