org.apache.fop.tools.anttasks.FileCompare Maven / Gradle / Ivy
/*
* 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: FileCompare.java 1761020 2016-09-16 11:17:35Z ssteiner $ */
package org.apache.fop.tools.anttasks;
import java.io.BufferedInputStream;
import java.io.File;
import java.io.IOException;
import java.io.PrintWriter;
import java.text.DateFormat;
import java.util.Date;
import java.util.List;
import java.util.StringTokenizer;
import org.apache.commons.io.IOUtils;
import org.apache.tools.ant.BuildException;
/**
* This class is an extension of Ant, a script utility from
* http://ant.apache.org.
* It provides methods to compare two files.
*/
public class FileCompare {
private String referenceDirectory;
private String testDirectory;
private String[] filenameList;
/**
* Sets directory for test files.
* @param testDirectory the test directory
*/
public void setTestDirectory(String testDirectory) {
if (!(testDirectory.endsWith("/") || testDirectory.endsWith("\\"))) {
testDirectory += File.separator;
}
this.testDirectory = testDirectory;
}
/**
* Sets directory for reference files.
* @param referenceDirectory the reference directory
*/
public void setReferenceDirectory(String referenceDirectory) {
if (!(referenceDirectory.endsWith("/")
|| referenceDirectory.endsWith("\\"))) {
referenceDirectory += File.separator;
}
this.referenceDirectory = referenceDirectory;
}
/**
* Sets the comma-separated list of files to process.
* @param filenames list of files, comma-separated
*/
public void setFilenames(String filenames) {
StringTokenizer tokens = new StringTokenizer(filenames, ",");
List filenameListTmp = new java.util.ArrayList(20);
while (tokens.hasMoreTokens()) {
filenameListTmp.add(tokens.nextToken());
}
filenameList = new String[filenameListTmp.size()];
filenameList = (String[])filenameListTmp.toArray(new String[filenameListTmp.size()]);
}
/**
* Compares two files to see if they are equal
* @param f1 first file to compare
* @param f2 second file to compare
* @return true if files are same, false otherwise
* @throws IOException if not caught
*/
public static boolean compareFiles(File f1, File f2) throws IOException {
return (compareFileSize(f1, f2) && compareBytes(f1, f2));
}
/**
* Compare the contents of two files.
* @param file1 the first file to compare
* @param file2 the second file to compare
* @return true if files are same byte-by-byte, false otherwise
*/
private static boolean compareBytes(File file1, File file2) throws IOException {
boolean same = true;
BufferedInputStream file1Input
= new BufferedInputStream(new java.io.FileInputStream(file1));
BufferedInputStream file2Input
= new BufferedInputStream(new java.io.FileInputStream(file2));
int charact1 = 0;
int charact2 = 0;
while (charact1 != -1) {
if (charact1 == charact2) {
charact1 = file1Input.read();
charact2 = file2Input.read();
} else {
same = false;
break;
}
}
IOUtils.closeQuietly(file1Input);
IOUtils.closeQuietly(file2Input);
return same;
}
/**
* Does a file size compare of two files
* @param oldFile the first file to compare
* @param newFile the second file to compare
* @return true if files are same length, false otherwise
*/
private static boolean compareFileSize(File oldFile, File newFile) {
return oldFile.length() == newFile.length();
}
private boolean filesExist(File oldFile, File newFile) {
if (!oldFile.exists()) {
System.err.println("Task Compare - ERROR: File "
+ referenceDirectory + oldFile.getName()
+ " doesn't exist!");
return false;
} else if (!newFile.exists()) {
System.err.println("Task Compare - ERROR: File " + testDirectory
+ newFile.getName() + " doesn't exist!");
return false;
} else {
return true;
}
}
private void writeHeader(PrintWriter results) {
String dateTime = DateFormat.getDateTimeInstance(DateFormat.MEDIUM,
DateFormat.MEDIUM).format(new Date());
results.println("Test Results \n");
results.println("Compare Results
");
results.println("created " + dateTime
+ "
");
results.println(""
+ "reference file "
+ "test file "
+ "identical? ");
}
/**
* Main method of task compare
* @throws BuildException If the execution fails.
*/
public void execute() throws BuildException {
boolean identical = false;
File oldFile;
File newFile;
try {
PrintWriter results
= new PrintWriter(new java.io.FileWriter("results.html"), true);
this.writeHeader(results);
for (String aFilenameList : filenameList) {
oldFile = new File(referenceDirectory + aFilenameList);
newFile = new File(testDirectory + aFilenameList);
if (filesExist(oldFile, newFile)) {
identical = compareFileSize(oldFile, newFile);
if (identical) {
identical = compareBytes(oldFile, newFile);
}
if (!identical) {
System.out.println("Task Compare: \nFiles "
+ referenceDirectory
+ oldFile.getName() + " - "
+ testDirectory
+ newFile.getName()
+ " are *not* identical.");
results.println(""
+ oldFile.getName()
+ " " + newFile.getName() + ""
+ " No "
+ oldFile.getName()
+ " " + newFile.getName() + ""
+ " Yes
");
} catch (IOException ioe) {
System.err.println("ERROR: " + ioe);
}
} // end: execute()
}