com.openhtmltopdf.test.ReferenceComparison Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of openhtmltopdf-core Show documentation
Show all versions of openhtmltopdf-core Show documentation
Open HTML to PDF is a CSS 2.1 renderer written in Java. This artifact contains the core rendering and layout code.
package com.openhtmltopdf.test;
import com.openhtmltopdf.layout.LayoutContext;
import com.openhtmltopdf.render.Box;
import com.openhtmltopdf.swing.BoxRenderer;
import com.openhtmltopdf.util.IOUtil;
import java.io.*;
import java.util.Arrays;
import java.util.HashMap;
import java.util.Iterator;
import java.util.Map;
/**
* ReferenceComparison runs a comparison of rendering a set of source XHTML files against a
*/
public class ReferenceComparison {
private int width;
private boolean isVerbose;
private static final String LINE_SEPARATOR = "\n";
public static void main(String[] args) throws IOException {
// TODO: check args
ReferenceComparison rc = new ReferenceComparison(1024, false);
File source = new File(args[0]);
File reference = new File(args[1]);
File failed = new File(args[2]);
rc.compareDirectory(source, reference, failed);
}
/**
* Initializes (does not launch) the reference comparison.
*
* @param width width at which pages should be rendered
* @param verbose
*/
public ReferenceComparison(int width, boolean verbose) {
this.width = width;
this.isVerbose = verbose;
}
public void compareDirectory(File sourceDirectory, File referenceDir, File failedDirectory) throws IOException {
checkDirectories(sourceDirectory, referenceDir, failedDirectory);
log("Starting comparison using width " + width);
IOUtil.deleteAllFiles(failedDirectory);
boolean wasEnabled = enableLogging(false);
try {
Iterator fileIt = listSourceFiles(sourceDirectory);
CompareStatistics stats = new CompareStatistics();
while (fileIt.hasNext()) {
File file = (File) fileIt.next();
try {
compareFile(file, referenceDir, failedDirectory, stats);
} catch (IOException e) {
stats.failedIOException(e);
}
}
stats.report();
} finally {
enableLogging(wasEnabled);
}
}
private boolean enableLogging(final boolean isEnabled) {
final String prop = "xr.util-logging.loggingEnabled";
final boolean orgVal = Boolean.valueOf(System.getProperty(prop)).booleanValue();
System.setProperty(prop, Boolean.valueOf(isEnabled).toString());
return orgVal;
}
private void checkDirectories(File sourceDirectory, File referenceDir, File failedDirectory) {
if (!sourceDirectory.exists() || !sourceDirectory.isDirectory()) {
throw new IllegalArgumentException("Source dir. doesn't exist, or not a directory: " + sourceDirectory);
}
if (!referenceDir.exists() || !referenceDir.isDirectory()) {
throw new IllegalArgumentException("Reference dir. doesn't exist, or not a directory: " + referenceDir);
}
if (failedDirectory.exists() && !failedDirectory.isDirectory()) {
throw new IllegalArgumentException("Need directory for failed matches, not a directory: " + failedDirectory);
} else if (!failedDirectory.exists()) {
if (!failedDirectory.mkdirs()) {
throw new RuntimeException(
"Could not create directory path (.mkdirs failed without an exception) " +
failedDirectory.getAbsolutePath()
);
}
}
}
private boolean verbose() {
return isVerbose;
}
private Iterator listSourceFiles(File sourceDirectory) {
return Arrays.asList(
sourceDirectory.listFiles(new FilenameFilter() {
public boolean accept(File file, String s) {
return Regress.EXTENSIONS.contains(s.substring(s.lastIndexOf(".") + 1));
}
})
).iterator();
}
public void compareFile(File source, File referenceDir, File failedDirectory, CompareStatistics stat) throws IOException {
log("Comparing " + source.getPath());
stat.checking(source);
// TODO: reuse code from Regress
BoxRenderer renderer = new BoxRenderer(source, width);
Box box;
try {
log("rendering");
box = renderer.render();
log("rendered");
} catch (Exception e) {
e.printStackTrace();
stat.failedToRender(e);
storeFailed(failedDirectory, source);
log("Could not render input file, skipping: " + source + " err: " + e.getMessage());
return;
}
LayoutContext layoutContext = renderer.getLayoutContext();
String inputFileName = source.getName();
String refRendered = trimTrailingLS(readReference(referenceDir, inputFileName, Regress.RENDER_SFX));
String rendered = trimTrailingLS(box.dump(layoutContext, "", Box.DUMP_RENDER));
if (!compareLines(refRendered, rendered, stat)) {
storeFailed(failedDirectory, new File(referenceDir, inputFileName), Regress.RENDER_SFX, rendered);
}
final String refLaidOut = trimTrailingLS(readReference(referenceDir, inputFileName, Regress.LAYOUT_SFX));
final String laidOut = trimTrailingLS(box.dump(layoutContext, "", Box.DUMP_LAYOUT));
if (!compareLines(refLaidOut, laidOut, stat)) {
storeFailed(failedDirectory, new File(referenceDir, inputFileName), Regress.LAYOUT_SFX, laidOut);
}
}
private String trimTrailingLS(String s) {
if (s.endsWith(LINE_SEPARATOR)) {
s = s.substring(0, s.length() - LINE_SEPARATOR.length());
}
return s;
}
private void storeFailed(File failedDirectory, File refFile, String suffix, String compareTo) {
copyToFailed(failedDirectory, refFile, "");
copyToFailed(failedDirectory, refFile, Regress.PNG_SFX);
copyToFailed(failedDirectory, refFile, suffix);
OutputStreamWriter fw = null;
try {
fw = new OutputStreamWriter(new FileOutputStream(new File(failedDirectory, refFile.getName() + ".err" + suffix)), "UTF-8");
BufferedWriter bw = new BufferedWriter(fw);
try {
bw.write(compareTo);
bw.flush();
} catch (IOException e) {
throw new RuntimeException("unexpected IO exception on writing 'failed' info for test.", e);
} finally {
try {
bw.close();
} catch (IOException e) {
// swallow
}
}
} catch (IOException e) {
throw new RuntimeException("unexpected IO exception on writing 'failed' info for test.", e);
} finally {
if (fw != null) {
try {
fw.close();
} catch (IOException e) {
// swallow
}
}
}
}
private void copyToFailed(File failedDirectory, File refFile, String suffix) {
File source = new File(failedDirectory, refFile.getName() + suffix);
if (!source.exists()) {
source = new File(refFile.getAbsoluteFile().getParentFile(), refFile.getName() + suffix);
try {
IOUtil.copyFile(source, failedDirectory);
} catch (IOException e) {
System.err.println("Failed to copy file (reference) " + source + " to failed directory, err " + e.getMessage());
}
}
}
private boolean compareLines(String refText, String text, CompareStatistics statistics) throws IOException {
log("running comparison");
LineNumberReader lnrRef = new LineNumberReader(new StringReader(refText));
LineNumberReader lnrOther = new LineNumberReader(new StringReader(text));
String lineRef;
String lineOther;
while ((lineRef = lnrRef.readLine()) != null) {
lineOther = lnrOther.readLine();
if (lineOther == null) {
statistics.failedRefIsLonger();
return false;
}
if (!lineRef.equals(lineOther)) {
statistics.failedDontMatch(lineRef, lineOther);
return false;
}
}
if (lnrOther.readLine() != null) {
statistics.failedOtherIsLonger();
return false;
}
return true;
}
private void storeFailed(File failedDirectory, File sourceFile) {
try {
IOUtil.copyFile(sourceFile, failedDirectory);
} catch (IOException e) {
System.err.println("Failed to copy file to failed directory: " + sourceFile + ", err: " + e.getMessage());
}
}
private String readReference(File referenceDir, String input, String sfx) throws IOException {
BufferedReader rdr = null;
StringBuffer sb;
File f = new File(referenceDir, input + sfx);
rdr = new BufferedReader(new InputStreamReader(new FileInputStream(f), "UTF-8"));
try {
String line;
sb = new StringBuffer();
while ((line = rdr.readLine()) != null) {
sb.append(line);
sb.append(LINE_SEPARATOR);
}
} finally {
try {
rdr.close();
} catch (IOException e) {
// swallow
}
}
return sb.toString();
}
private void log(final String msg) {
if (verbose()) {
System.out.println(msg);
}
}
private static class CompareStatistics {
private File currentFile;
private static final Result OK = new ResultOK();
private Map files;
public CompareStatistics() {
files = new HashMap();
}
public void failedToRender(Exception e) {
files.put(currentFile, new RenderFailed(e));
}
public void failedRefIsLonger() {
files.put(currentFile, new RefIsLonger());
}
public void failedDontMatch(String lineRef, String lineOther) {
files.put(currentFile, new LineMismatch(lineRef, lineOther));
}
public void failedOtherIsLonger() {
files.put(currentFile, new OtherIsLonger());
}
public void failedIOException(IOException e) {
files.put(currentFile, new FailedIO(e));
}
public boolean failed() {
return files.get(currentFile) instanceof FailedResult;
}
public void checking(File source) {
currentFile = source;
files.put(currentFile, OK);
}
public boolean succeeded() {
return files.get(currentFile) instanceof ResultOK;
}
public void report() {
int failed = 0;
for (Iterator it = files.keySet().iterator(); it.hasNext();) {
File file = (File) it.next();
Result result = (Result) files.get(file);
if (result instanceof FailedResult) {
failed++;
System.out.println(result.describe(file));
}
}
System.out.println("Checked " + files.keySet().size() + " files, " + (failed > 0 ? failed + " failed." : "all OK."));
}
private static class RenderFailed implements Result {
private final Exception exception;
public RenderFailed(Exception exception) {
this.exception = exception;
}
public String describe(File file) {
return "FAIL: Render operation threw exception for " + file.getName() + ", err " + exception.getMessage();
}
}
private static class RefIsLonger implements FailedResult {
public String describe(File file) {
return "FAIL: reference is longer (more lines): " + file.getName();
}
}
private static class LineMismatch implements FailedResult {
private final String lineRef;
private final String lineOther;
public LineMismatch(String lineRef, String lineOther) {
this.lineRef = lineRef;
this.lineOther = lineOther;
}
public String describe(File file) {
return "FAIL: line content doesn't match for " + file.getName() + LINE_SEPARATOR + "ref: " + lineRef + LINE_SEPARATOR + "other: " + lineOther;
}
}
private static class OtherIsLonger implements FailedResult {
public String describe(File file) {
return "FAIL: new rendered output is longer (more lines): " + file.getName();
}
}
private static class FailedIO implements FailedResult {
private final IOException exception;
public FailedIO(IOException e) {
this.exception = e;
}
public String describe(File file) {
return "FAIL: IOException when comparing: " + file + " (err: " + exception.getMessage();
}
}
private interface Result {
String describe(File file);
}
private interface FailedResult extends Result {}
private static class ResultOK implements Result {
public String describe(File file) {
return "OK: " + file.getName();
}
}
}
}