1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
|
/*
* 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.render.pdf;
import java.io.File;
import javax.xml.transform.Source;
import javax.xml.transform.Transformer;
import javax.xml.transform.TransformerException;
import javax.xml.transform.TransformerFactory;
import javax.xml.transform.sax.SAXResult;
import javax.xml.transform.stream.StreamSource;
import org.xml.sax.SAXException;
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;
/**
* Base class for automated tests that create PDF files
*/
public class BasePDFTestCase extends AbstractFOPTestCase {
/** the FopFactory */
protected final FopFactory fopFactory = FopFactory.newInstance();
/** the JAXP TransformerFactory */
protected final TransformerFactory tFactory = TransformerFactory.newInstance();
/**
* Main constructor
* @param name the name of the test case
*/
protected BasePDFTestCase(String name) {
super(name);
init();
}
/**
* initalizes the test
*/
protected void init() {
final File uc = getUserConfigFile();
try {
fopFactory.setUserConfig(uc);
} catch (Exception e) {
throw new RuntimeException("fopFactory.setUserConfig ("
+ uc.getAbsolutePath() + ") failed: " + e.getMessage());
}
}
/**
* Convert a test FO file to PDF
* @param foFile the FO file
* @param ua the preconfigured user agent
* @param dumpPdfFile if true, dumps the generated PDF file to a file name (foFile).pdf
* @return the generated PDF data
* @throws Exception if the conversion fails
*/
protected byte[] convertFO(File foFile, FOUserAgent ua, boolean dumpPdfFile)
throws Exception {
ByteArrayOutputStream baout = new ByteArrayOutputStream();
Fop fop = fopFactory.newFop(MimeConstants.MIME_PDF, ua, baout);
Transformer transformer = tFactory.newTransformer();
Source src = new StreamSource(foFile);
SAXResult res = new SAXResult(fop.getDefaultHandler());
try {
transformer.transform(src, res);
final byte[] result = baout.toByteArray();
if (dumpPdfFile) {
final File outFile = new File(foFile.getParentFile(), foFile.getName() + ".pdf");
FileUtils.writeByteArrayToFile(outFile, result);
}
return result;
} catch (TransformerException e) {
throw extractOriginalException(e);
}
}
private static Exception extractOriginalException(Exception e) {
if (e.getCause() != null) {
return extractOriginalException((Exception)e.getCause());
} else if (e instanceof SAXException) {
SAXException se = (SAXException)e;
if (se.getException() != null) {
return extractOriginalException(se.getException());
}
}
return e;
}
/**
* get FOP config File
* @return user config file to be used for testing
*/
protected File getUserConfigFile() {
return new File("test/test.xconf");
}
}
|
