Stricter user config file validation.

Add a configuration parameter (strict-configuration), enabled by default, which makes FOP throw an exception instead of logging an error when a problem occurs.
Invalid resource paths should be catched now. Fixes bug #40120.
Submitted by: Adrian Cumiskey (fop-dev AT cumiskey DOT com)


git-svn-id: https://svn.apache.org/repos/asf/xmlgraphics/fop/trunk@507539 13f79535-47bb-0310-9956-ffa450edef68

10 files changed, 463 insertions, 3 deletions

diff --git a/test/java/org/apache/fop/config/BaseUserConfigTestCase.java b/test/java/org/apache/fop/config/BaseUserConfigTestCase.java
new file mode 100644
index 000000000..3a97f4303
--- /dev/null
+++ b/test/java/org/apache/fop/config/BaseUserConfigTestCase.java
@@ -0,0 +1,125 @@
+/*
+ * 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.
+ */
+
+/* $Id$ */
+
+package org.apache.fop.config;
+
+import java.io.ByteArrayInputStream;
+import java.io.File;
+import java.io.IOException;
+
+import org.apache.avalon.framework.configuration.Configuration;
+import org.apache.avalon.framework.configuration.ConfigurationException;
+import org.apache.avalon.framework.configuration.DefaultConfigurationBuilder;
+import org.apache.commons.logging.Log;
+import org.apache.commons.logging.LogFactory;
+import org.apache.fop.apps.FOPException;
+import org.apache.fop.apps.FOUserAgent;
+import org.apache.fop.render.pdf.BasePDFTestCase;
+import org.xml.sax.SAXException;
+
+/**
+ * Basic runtime test for FOP's font configuration. It is used to verify that 
+ * nothing obvious is broken after compiling.
+ */
+public abstract class BaseUserConfigTestCase extends BasePDFTestCase {
+
+    protected static DefaultConfigurationBuilder cfgBuilder = new DefaultConfigurationBuilder();
+
+    /** logging instance */
+    protected Log log = LogFactory.getLog(BaseUserConfigTestCase.class);
+
+
+    /**
+     * @see junit.framework.TestCase#TestCase(String)
+     */
+    public BaseUserConfigTestCase(String name) {
+        super(name);
+    }
+
+    /**
+     * @see org.apache.fop.render.pdf.BasePDFTestCase#init()
+     */
+    protected void init() {
+        // do nothing
+    }
+
+    /**
+     * Test using a standard FOP font
+     * @throws Exception checkstyle wants a comment here, even a silly one
+     */
+    public void testUserConfig() throws Exception {
+        try {
+            fopFactory.setUserConfig(getUserConfig());        
+            final File baseDir = getBaseDir();
+            final String fontFOFilePath = getFontFOFilePath();
+            File foFile = new File(baseDir, fontFOFilePath);
+            final boolean dumpOutput = false;
+            FOUserAgent foUserAgent = fopFactory.newFOUserAgent();
+            convertFO(foFile, foUserAgent, dumpOutput);
+            fail( getName() + ": Expected Configuration Exception" );
+        } catch (FOPException e) {
+            // this *should* happen!
+        } catch (Exception e) {
+            fail( getName() + ": Expected FOPException but got: " + e.getMessage() );
+        }
+    }
+
+
+    /**
+     * get test FOP config File
+     * @return fo test filepath
+     */
+    protected String getFontFOFilePath() {
+        return "test/xml/bugtests/font.fo";
+    }
+
+    /**
+     * get test FOP Configuration
+     * @return fo test filepath
+     * @throws IOException 
+     * @throws SAXException 
+     * @throws ConfigurationException 
+     */
+    protected Configuration getUserConfig(String configString)
+            throws ConfigurationException, SAXException, IOException {
+        return cfgBuilder.build(new ByteArrayInputStream(configString.getBytes()));
+    }
+
+    /**
+     * get test FOP Configuration
+     * @return fo test filepath
+     * @throws IOException 
+     * @throws SAXException 
+     * @throws ConfigurationException 
+     */
+    protected Configuration getUserConfig()
+            throws ConfigurationException, SAXException, IOException {
+        return cfgBuilder.buildFromFile(getUserConfigFile());
+    }
+    
+    /** get base config directory */
+    protected String getBaseConfigDir() {
+        return "test/config";
+    }
+    
+    /**
+     * @return user config File
+     */
+    protected abstract File getUserConfigFile();
+}
diff --git a/test/java/org/apache/fop/config/EmbedUrlBadTestCase.java b/test/java/org/apache/fop/config/EmbedUrlBadTestCase.java
new file mode 100644
index 000000000..2934004fd
--- /dev/null
+++ b/test/java/org/apache/fop/config/EmbedUrlBadTestCase.java
@@ -0,0 +1,41 @@
+/*
+ * 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.
+ */
+
+/* $Id$ */
+
+package org.apache.fop.config;
+
+import java.io.File;
+
+// 
+/**
+ * this font has an embed-url that does not exist on filesystem.
+ */
+public class EmbedUrlBadTestCase extends BaseUserConfigTestCase {
+
+    public EmbedUrlBadTestCase(String name) {
+        super(name);
+    }
+
+    protected File getUserConfigFile() {
+        return new File( getBaseConfigDir() + "/test_embedurl_bad.xconf");
+    }
+    
+    public String getName() {
+        return "test_embedurl_bad.xconf";
+    }
+}
diff --git a/test/java/org/apache/fop/config/EmbedUrlMalformedTestCase.java b/test/java/org/apache/fop/config/EmbedUrlMalformedTestCase.java
new file mode 100644
index 000000000..ab622fd69
--- /dev/null
+++ b/test/java/org/apache/fop/config/EmbedUrlMalformedTestCase.java
@@ -0,0 +1,38 @@
+/*
+ * 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.
+ */
+
+/* $Id$ */
+
+package org.apache.fop.config;
+
+import java.io.File;
+
+// this font has a malformed embed-url
+public class EmbedUrlMalformedTestCase extends BaseUserConfigTestCase {
+
+    public EmbedUrlMalformedTestCase(String name) {
+        super(name);
+    }
+
+    protected File getUserConfigFile() {
+        return new File( getBaseConfigDir() + "/test_embedurl_malformed.xconf");
+    }
+    
+    public String getName() {
+        return "test_embedurl_malformed.xconf";
+    }
+}
diff --git a/test/java/org/apache/fop/config/FontAttributesMissingTestCase.java b/test/java/org/apache/fop/config/FontAttributesMissingTestCase.java
new file mode 100644
index 000000000..fc5b10a60
--- /dev/null
+++ b/test/java/org/apache/fop/config/FontAttributesMissingTestCase.java
@@ -0,0 +1,38 @@
+/*
+ * 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.
+ */
+
+/* $Id$ */
+
+package org.apache.fop.config;
+
+import java.io.File;
+
+// this font is without a metrics-url or an embed-url
+public class FontAttributesMissingTestCase extends BaseUserConfigTestCase {
+
+    public FontAttributesMissingTestCase(String name) {
+        super(name);
+    }
+
+    protected File getUserConfigFile() {
+        return new File( getBaseConfigDir() + "/test_fontattributes_missing.xconf");
+    }
+    
+    public String getName() {
+        return "test_fontattributes_missing.xconf";
+    }
+}
diff --git a/test/java/org/apache/fop/config/FontBaseBadTestCase.java b/test/java/org/apache/fop/config/FontBaseBadTestCase.java
new file mode 100644
index 000000000..d22670d8a
--- /dev/null
+++ b/test/java/org/apache/fop/config/FontBaseBadTestCase.java
@@ -0,0 +1,44 @@
+/*
+ * 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.
+ */
+
+/* $Id$ */
+
+package org.apache.fop.config;
+
+import java.io.File;
+
+// this font base does not exist and a relative font path is used
+public class FontBaseBadTestCase extends BaseUserConfigTestCase {
+
+    public FontBaseBadTestCase(String name) {
+        super(name);
+    }
+
+    /**
+     * @see org.apache.fop.config.BaseUserConfigTestCase#getUserConfigFile()
+     */
+    protected File getUserConfigFile() {
+        return new File( getBaseConfigDir() + "/test_fontbase_bad.xconf");
+    }
+    
+    /**
+     * @return configuration filename
+     */
+    public String getName() {
+        return "test_fontbase_bad.xconf";
+    }
+}
diff --git a/test/java/org/apache/fop/config/FontTripletAttributeMissingTestCase.java b/test/java/org/apache/fop/config/FontTripletAttributeMissingTestCase.java
new file mode 100644
index 000000000..c321926f8
--- /dev/null
+++ b/test/java/org/apache/fop/config/FontTripletAttributeMissingTestCase.java
@@ -0,0 +1,38 @@
+/*
+ * 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.
+ */
+
+/* $Id$ */
+
+package org.apache.fop.config;
+
+import java.io.File;
+
+// this font has an embed-url that does not exist on filesystem
+public class FontTripletAttributeMissingTestCase extends BaseUserConfigTestCase {
+
+    public FontTripletAttributeMissingTestCase(String name) {
+        super(name);
+    }
+
+    protected File getUserConfigFile() {
+        return new File( getBaseConfigDir() + "/test_fonttripletattribute_missing.xconf");
+    }
+    
+    public String getName() {
+        return "test_fonttripletattribute_missing.xconf";
+    }
+}
diff --git a/test/java/org/apache/fop/config/MetricsUrlBadTestCase.java b/test/java/org/apache/fop/config/MetricsUrlBadTestCase.java
new file mode 100644
index 000000000..80f7e285b
--- /dev/null
+++ b/test/java/org/apache/fop/config/MetricsUrlBadTestCase.java
@@ -0,0 +1,44 @@
+/*
+ * 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.
+ */
+
+/* $Id$ */
+
+package org.apache.fop.config;
+
+import java.io.File;
+
+// this font has a metrics-url that does not exist on filesystem
+public class MetricsUrlBadTestCase extends BaseUserConfigTestCase {
+
+    /**
+     * @see junit.framework.TestCase#TestCase(String)
+     */
+    public MetricsUrlBadTestCase(String name) {
+        super(name);
+    }
+
+    /**
+     * @see org.apache.fop.config.BaseUserConfigTestCase#getUserConfigFile()
+     */
+    protected File getUserConfigFile() {
+        return new File( getBaseConfigDir() + "/test_metricsurl_bad.xconf");
+    }
+    
+    public String getName() {
+        return "test_metricsurl_bad.xconf";
+    }
+}
diff --git a/test/java/org/apache/fop/config/MetricsUrlMalformedTestCase.java b/test/java/org/apache/fop/config/MetricsUrlMalformedTestCase.java
new file mode 100644
index 000000000..6b623e06e
--- /dev/null
+++ b/test/java/org/apache/fop/config/MetricsUrlMalformedTestCase.java
@@ -0,0 +1,38 @@
+/*
+ * 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.
+ */
+
+/* $Id$ */
+
+package org.apache.fop.config;
+
+import java.io.File;
+
+// this font has a malformed metrics-url
+public class MetricsUrlMalformedTestCase extends BaseUserConfigTestCase {
+
+    public MetricsUrlMalformedTestCase(String name) {
+        super(name);
+    }
+
+    protected File getUserConfigFile() {
+        return new File( getBaseConfigDir() + "/test_metricsurl_malformed.xconf");
+    }
+    
+    public String getName() {
+        return "test_metricsurl_malformed.xconf";
+    }
+}
diff --git a/test/java/org/apache/fop/config/UserConfigTestSuite.java b/test/java/org/apache/fop/config/UserConfigTestSuite.java
new file mode 100644
index 000000000..ab612d043
--- /dev/null
+++ b/test/java/org/apache/fop/config/UserConfigTestSuite.java
@@ -0,0 +1,49 @@
+/*
+ * 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.
+ */
+
+/* $Id$ */
+
+package org.apache.fop.config;
+
+import junit.framework.Test;
+import junit.framework.TestSuite;
+
+/**
+ * Test suite for font configuration.
+ */
+public class UserConfigTestSuite {
+
+    /**
+     * Builds the test suite
+     * @return the test suite
+     */
+    public static Test suite() {
+        TestSuite suite = new TestSuite(
+            "Basic functionality test suite for user configuration");
+        //$JUnit-BEGIN$
+        suite.addTest(new TestSuite(FontBaseBadTestCase.class));
+        suite.addTest(new TestSuite(FontAttributesMissingTestCase.class));
+        suite.addTest(new TestSuite(FontTripletAttributeMissingTestCase.class));
+        suite.addTest(new TestSuite(MetricsUrlBadTestCase.class));
+        suite.addTest(new TestSuite(EmbedUrlBadTestCase.class));
+        suite.addTest(new TestSuite(MetricsUrlMalformedTestCase.class));
+        suite.addTest(new TestSuite(EmbedUrlMalformedTestCase.class));
+        //$JUnit-END$
+        return suite;
+    }
+
+}
diff --git a/test/java/org/apache/fop/render/pdf/BasePDFTestCase.java b/test/java/org/apache/fop/render/pdf/BasePDFTestCase.java
index 54e2ba9d8..3e399e064 100644
--- a/test/java/org/apache/fop/render/pdf/BasePDFTestCase.java
+++ b/test/java/org/apache/fop/render/pdf/BasePDFTestCase.java
@@ -29,17 +29,16 @@ import javax.xml.transform.stream.StreamSource;
 
 import org.apache.commons.io.FileUtils;
 import org.apache.commons.io.output.ByteArrayOutputStream;
+import org.apache.fop.AbstractFOPTestCase;
 import org.apache.fop.apps.FOUserAgent;
 import org.apache.fop.apps.Fop;
 import org.apache.fop.apps.FopFactory;
 import org.apache.fop.apps.MimeConstants;
 
-import junit.framework.TestCase;
-
 /**
  * Base class for automated tests that create PDF files
  */
-public class BasePDFTestCase extends TestCase {
+public class BasePDFTestCase extends AbstractFOPTestCase {
 
     /** the FopFactory */
     protected final FopFactory fopFactory = FopFactory.newInstance();
@@ -53,7 +52,13 @@ public class BasePDFTestCase extends TestCase {
      */
     protected BasePDFTestCase(String name) {
         super(name);
+        init();
+    }
 
+    /**
+     * initalizes the test
+     */
+    protected void init() {
         final File uc = getUserConfigFile();
 
         try {