");
- pw.println("Generated at " + new java.util.Date());
- pw.println("
");
- pw.println("");
-
- pw.println("");
-
- pw.flush();
-
- }
-
- /**
- * writes the list of added files
- *
- * @param pw write to write to
- * @param added set of added files
- */
- protected void writeAdded(PrintWriter pw, Set added) {
- writeDiffSet(pw, "Added", added);
- }
-
- /**
- * writes the list of removed files
- *
- * @param pw write to write to
- * @param removed set of removed files
- */
- protected void writeRemoved(PrintWriter pw, Set removed) {
- writeDiffSet(pw, "Removed", removed);
- }
-
- /**
- * writes the list of modified files
- *
- * @param pw write to write to
- * @param changed set of modified files
- */
- protected void writeChanged(PrintWriter pw, Set changed) {
- writeDiffSet(pw, "Changed", changed);
- }
-
- /**
- * writes a set of differences
- *
- * @param pw write to write to
- * @param name heading
- * @param s set
- */
- protected void writeDiffSet(PrintWriter pw, String name, Set s) {
- pw.println("
");
- pw.println("
");
- pw.println("
" + name + " (" + s.size() + " entries)
");
- pw.println("
");
- pw.println("
");
- pw.println("
");
- pw.println("
");
- pw.println("
");
- if (s.size() > 0) {
- pw.println("
");
- Iterator iter = s.iterator();
- while (iter.hasNext()) {
- String key = (String) iter.next();
- pw.print("
");
- pw.print(key);
- pw.println("
");
- }
- pw.println("
");
- }
- pw.println("
");
- pw.println("
");
- pw.println("
");
-
- }
-
- /**
- * generates the style-html-tag.
- *
- * @return content of style-tag
- */
- protected String getStyleTag() {
- StringBuffer sb = new StringBuffer();
-
- sb.append("\n");
-
- return sb.toString();
- }
-
-}
diff --git a/src/main/zipdiff/output/XmlBuilder.java b/src/main/zipdiff/output/XmlBuilder.java
deleted file mode 100644
index 3cbe9c9..0000000
--- a/src/main/zipdiff/output/XmlBuilder.java
+++ /dev/null
@@ -1,112 +0,0 @@
-/* zipdiff is available under the terms of the
- * Apache License, version 2.0
- *
- * Link: http://www.apache.org/licenses/
- */
-package zipdiff.output;
-
-import java.io.OutputStream;
-import java.io.PrintWriter;
-import java.util.Iterator;
-import java.util.Set;
-
-import zipdiff.Differences;
-
-/**
- *
- * Generates xml output for a Differences instance
- *
- * @author Sean C. Sullivan
- *
- */
-public class XmlBuilder extends AbstractBuilder {
-
- /**
- * builds the output
- *
- * @param out OutputStream to write to
- * @param d differences
- */
- @Override
- public void build(OutputStream out, Differences d) {
- PrintWriter pw = new PrintWriter(out);
-
- pw.println("");
- pw.print("");
-
- pw.println("");
- writeAdded(pw, d.getAdded().keySet());
- writeRemoved(pw, d.getRemoved().keySet());
- writeChanged(pw, d.getChanged().keySet());
- pw.println("");
- pw.println("");
-
- pw.flush();
- }
-
- /**
- * writes the list of added files
- *
- * @param pw write to write to
- * @param added set of added files
- */
- protected void writeAdded(PrintWriter pw, Set added) {
- Iterator iter = added.iterator();
- while (iter.hasNext()) {
- String key = (String) iter.next();
- pw.print("");
- pw.print(key);
- pw.println("");
- }
-
- }
-
- /**
- * writes the list of removed files
- *
- * @param pw write to write to
- * @param removed set of removed files
- */
- protected void writeRemoved(PrintWriter pw, Set removed) {
- Iterator iter = removed.iterator();
- while (iter.hasNext()) {
- String key = (String) iter.next();
- pw.print("");
- pw.print(key);
- pw.println("");
- }
- }
-
- /**
- * writes the list of modified files
- *
- * @param pw write to write to
- * @param changed set of modified files
- */
- protected void writeChanged(PrintWriter pw, Set changed) {
- Iterator iter = changed.iterator();
- while (iter.hasNext()) {
- String key = (String) iter.next();
- pw.print("");
- pw.print(key);
- pw.println("");
- }
- }
-
-}
diff --git a/src/main/zipdiff/package.html b/src/main/zipdiff/package.html
deleted file mode 100755
index c615f27..0000000
--- a/src/main/zipdiff/package.html
+++ /dev/null
@@ -1,16 +0,0 @@
-
-
-
-
-
-
-
-Utilities for comparing the contents of 2 different zip files.
-
-
-
-
diff --git a/src/metadata/JAR-manifest.txt b/src/metadata/JAR-manifest.txt
deleted file mode 100644
index 7c72894..0000000
--- a/src/metadata/JAR-manifest.txt
+++ /dev/null
@@ -1,4 +0,0 @@
-Manifest-Version: 1.0
-Created-By: Sean C. Sullivan
-Class-Path: commons-cli-1.0.jar
-Main-Class: zipdiff.Main
diff --git a/xdocs/sample-output.html b/src/site/sample-output.html
similarity index 100%
rename from xdocs/sample-output.html
rename to src/site/sample-output.html
diff --git a/xdocs/navigation.xml b/src/site/site.xml
similarity index 100%
rename from xdocs/navigation.xml
rename to src/site/site.xml
diff --git a/xdocs/credits.xml b/src/site/xdoc/credits.xml
similarity index 100%
rename from xdocs/credits.xml
rename to src/site/xdoc/credits.xml
diff --git a/src/site/xdoc/index.xml b/src/site/xdoc/index.xml
new file mode 100644
index 0000000..dbdbcdc
--- /dev/null
+++ b/src/site/xdoc/index.xml
@@ -0,0 +1,86 @@
+
+
+
+
+
+ Welcome
+
+
+
+
+
+
+ Use the zipdiff tool when you need to compare the contents of two zip files.
+ It is equally suited for comparing
+ JAR files,
+ WAR files,
+ EAR files or
+ RAR files.
+
+
+ Run it standalone or as an
+ Ant task.
+ The tool supports four output formats: plain text, XML, HTML and zip.
+
+
+
+
diff --git a/xdocs/output.xml b/src/site/xdoc/output.xml
similarity index 100%
rename from xdocs/output.xml
rename to src/site/xdoc/output.xml
diff --git a/xdocs/related.xml b/src/site/xdoc/related.xml
similarity index 100%
rename from xdocs/related.xml
rename to src/site/xdoc/related.xml
diff --git a/xdocs/tools.xml b/src/site/xdoc/tools.xml
similarity index 100%
rename from xdocs/tools.xml
rename to src/site/xdoc/tools.xml
diff --git a/src/test/zipdiff/DifferenceCalculatorTest.java b/src/test/java/zipdiff/DifferenceCalculatorTest.java
similarity index 58%
rename from src/test/zipdiff/DifferenceCalculatorTest.java
rename to src/test/java/zipdiff/DifferenceCalculatorTest.java
index a67d793..3ba234e 100755
--- a/src/test/zipdiff/DifferenceCalculatorTest.java
+++ b/src/test/java/zipdiff/DifferenceCalculatorTest.java
@@ -3,8 +3,11 @@
*
* Link: http://www.apache.org/licenses/
*/
+
package zipdiff;
+import static org.junit.Assert.*;
+
import java.io.BufferedOutputStream;
import java.io.ByteArrayOutputStream;
import java.io.File;
@@ -14,8 +17,11 @@
import java.util.Map;
import java.util.jar.JarEntry;
import java.util.jar.JarOutputStream;
+import java.util.zip.ZipEntry;
+
+import org.junit.BeforeClass;
+import org.junit.Test;
-import junit.framework.TestCase;
import zipdiff.output.AbstractBuilder;
import zipdiff.output.HtmlBuilder;
import zipdiff.output.TextBuilder;
@@ -26,30 +32,66 @@
*
* @author jastewart
*/
-public class DifferenceCalculatorTest extends TestCase {
- private static String ENTRYA = "A";
+public class DifferenceCalculatorTest {
+ /**
+ * Field ENTRYA.
+ */
+ private static final String ENTRYA = "A";
- private static String ENTRYB = "B";
+ /**
+ * Field ENTRYB.
+ */
+ private static final String ENTRYB = "B";
- private static String ENTRY_CVS = "CVS/Root";
+ /**
+ * Field ENTRY_CVS.
+ */
+ private static final String ENTRY_CVS = "CVS/Root";
+ /**
+ * Field SYSTEM_TMP_DIR_PROPERTY.
+ * (value is ""java.io.tmpdir"")
+ */
public static final String SYSTEM_TMP_DIR_PROPERTY = "java.io.tmpdir";
+ /**
+ * Field TEST_DIR_POSTFIX.
+ * (value is "File.separator + "UnitTestsDifferenceCalculatorTest"")
+ */
public static final String TEST_DIR_POSTFIX = File.separator + "UnitTestsDifferenceCalculatorTest";
+ /**
+ * Field testDirPathName.
+ */
private static String testDirPathName;
- // naming convention The Capital letter denotes the entry so A will be the same as A
- // OneEntry denotes that the jar has one entry
+ /** Naming conventions:
+ * a Capital letter denotes the entry, so A will be the same as A
+ * OneEntry denotes that the jar has one entry
+ * Field testJarOneEntryA1Filename.
+ */
private static String testJarOneEntryA1Filename;
+ /**
+ * Field testJarOneEntryA2Filename.
+ */
private static String testJarOneEntryA2Filename;
+ /**
+ * Field testJarOneEntryB1Filename.
+ */
private static String testJarOneEntryB1Filename;
+ /**
+ * Field testJarOneEntryAContentsChangedFilename.
+ */
private static String testJarOneEntryAContentsChangedFilename;
- {
+ /**
+ * Method setup.
+ */
+ @BeforeClass
+ public static void setup() {
testDirPathName = System.getProperty(SYSTEM_TMP_DIR_PROPERTY);
if (testDirPathName == null) {
testDirPathName = File.separator + "temp" + TEST_DIR_POSTFIX;
@@ -62,24 +104,26 @@ public class DifferenceCalculatorTest extends TestCase {
/**
* Create a jar with only one entry in it. That entry being A
- *
* @throws FileNotFoundException
* @throws IOException
*/
- public void createJarOneEntryA1() throws FileNotFoundException, IOException {
- // create a jar file with no duplicates
+ public void createJarOneEntryA1() throws IOException {
+ // create a jar file with no duplicates
File testDir = new File(testDirPathName);
testDir.mkdirs();
- JarOutputStream testJarOS = new JarOutputStream(new BufferedOutputStream(new FileOutputStream(testJarOneEntryA1Filename)));
+ JarOutputStream testJarOS =
+ new JarOutputStream(
+ new BufferedOutputStream(
+ new FileOutputStream(testJarOneEntryA1Filename)));
// ad an entry
- JarEntry entry1 = new JarEntry(ENTRYA);
- testJarOS.putNextEntry(entry1);
- byte data1[] = new byte[2048];
- for (int i = 0; i < data1.length; i++) {
- data1[i] = 'a';
+ JarEntry entry = new JarEntry(ENTRYA);
+ testJarOS.putNextEntry(entry);
+ byte[] data = new byte[2048];
+ for (int i = 0; i < data.length; i++) {
+ data[i] = 'a';
}
- testJarOS.write(data1);
+ testJarOS.write(data);
testJarOS.flush();
testJarOS.close();
@@ -87,24 +131,26 @@ public void createJarOneEntryA1() throws FileNotFoundException, IOException {
/**
* Create a jar with only one entry in it. That entry being A
- *
* @throws FileNotFoundException
* @throws IOException
*/
- public void createJarOneEntryA2() throws FileNotFoundException, IOException {
- // create a jar file with no duplicates
+ public void createJarOneEntryA2() throws IOException {
+ // create a jar file with no duplicates
File testDir = new File(testDirPathName);
testDir.mkdirs();
- JarOutputStream testJarOS = new JarOutputStream(new BufferedOutputStream(new FileOutputStream(testJarOneEntryA2Filename)));
+ JarOutputStream testJarOS =
+ new JarOutputStream(
+ new BufferedOutputStream(
+ new FileOutputStream(testJarOneEntryA2Filename)));
// ad an entry
- JarEntry entry1 = new JarEntry(ENTRYA);
- testJarOS.putNextEntry(entry1);
- byte data1[] = new byte[2048];
- for (int i = 0; i < data1.length; i++) {
- data1[i] = 'a';
+ JarEntry entry = new JarEntry(ENTRYA);
+ testJarOS.putNextEntry(entry);
+ byte[] data = new byte[2048];
+ for (int i = 0; i < data.length; i++) {
+ data[i] = 'a';
}
- testJarOS.write(data1);
+ testJarOS.write(data);
testJarOS.flush();
testJarOS.close();
@@ -112,26 +158,28 @@ public void createJarOneEntryA2() throws FileNotFoundException, IOException {
/**
* Create a jar with only one entry in it. That entry being A
- *
* @throws FileNotFoundException
* @throws IOException
*/
- public void createJarOneEntryAContentsChanged() throws FileNotFoundException, IOException {
- // create a jar file with no duplicates
+ public void createJarOneEntryAContentsChanged() throws IOException {
+ // create a jar file with no duplicates
File testDir = new File(testDirPathName);
testDir.mkdirs();
- JarOutputStream testJarOS = new JarOutputStream(new BufferedOutputStream(new FileOutputStream(testJarOneEntryAContentsChangedFilename)));
+ JarOutputStream testJarOS =
+ new JarOutputStream(
+ new BufferedOutputStream(
+ new FileOutputStream(testJarOneEntryAContentsChangedFilename)));
// add an entry
- JarEntry entry1 = new JarEntry(ENTRYA);
- testJarOS.putNextEntry(entry1);
- byte data1[] = new byte[2048];
- for (int i = 0; i < data1.length; i++) {
- data1[i] = 'a';
+ JarEntry entry = new JarEntry(ENTRYA);
+ testJarOS.putNextEntry(entry);
+ byte[] data = new byte[2048];
+ for (int i = 0; i < data.length; i++) {
+ data[i] = 'a';
}
// set a different content so that it will come up as changed
- data1[data1.length - 1] = 'b';
- testJarOS.write(data1);
+ data[data.length - 1] = 'b';
+ testJarOS.write(data);
// add another entry
JarEntry cvs = new JarEntry(ENTRY_CVS);
@@ -142,65 +190,71 @@ public void createJarOneEntryAContentsChanged() throws FileNotFoundException, IO
}
/**
- * Create a jar with only one entry in it. That entry being A
- *
+ * Create a jar with only one entry in it. That entry being B
* @throws FileNotFoundException
* @throws IOException
*/
- public void createJarOneEntryB1() throws FileNotFoundException, IOException {
- // create a jar file with no duplicates
+ public void createJarOneEntryB1() throws IOException {
+ // create a jar file with no duplicates
File testDir = new File(testDirPathName);
testDir.mkdirs();
- JarOutputStream testJarOS = new JarOutputStream(new BufferedOutputStream(new FileOutputStream(testJarOneEntryB1Filename)));
+ JarOutputStream testJarOS =
+ new JarOutputStream(
+ new BufferedOutputStream(
+ new FileOutputStream(testJarOneEntryB1Filename)));
// ad an entry
- JarEntry entry1 = new JarEntry(ENTRYB);
- testJarOS.putNextEntry(entry1);
- byte data1[] = new byte[2048];
- for (int i = 0; i < data1.length; i++) {
- data1[i] = 'b';
+ JarEntry entry = new JarEntry(ENTRYB);
+ testJarOS.putNextEntry(entry);
+ byte[] data = new byte[2048];
+ for (int i = 0; i < data.length; i++) {
+ data[i] = 'b';
}
- testJarOS.write(data1);
+ testJarOS.write(data);
testJarOS.flush();
testJarOS.close();
}
-
/**
* Test for Differences calculateDifferences(ZipFile, ZipFile)
* with the same file - no differences should be found
+ * @throws FileNotFoundException
+ * @throws IOException
*/
- public void testCalculateDifferencesSameZip() throws FileNotFoundException, IOException {
+ @Test
+ public void testCalculateDifferencesSameZip() throws IOException {
createJarOneEntryA1();
DifferenceCalculator calc = new DifferenceCalculator(testJarOneEntryA1Filename, testJarOneEntryA1Filename);
Differences differences = calc.getDifferences();
assertFalse(differences.hasDifferences());
- Map addedEntries = differences.getAdded();
+ Map addedEntries = differences.getAdded();
assertTrue(addedEntries.size() == 0);
- Map removedEntries = differences.getRemoved();
+ Map removedEntries = differences.getRemoved();
assertTrue(removedEntries.size() == 0);
- Map changedEntries = differences.getChanged();
+ Map changedEntries = differences.getChanged();
assertTrue(changedEntries.size() == 0);
exerciseOutputBuilders(differences);
-
}
/**
* Test for Differences calculateDifferences(ZipFile, ZipFile)
+ * @throws FileNotFoundException
+ * @throws IOException
*/
- public void testCalculateDifferencesZipsSameEntries() throws FileNotFoundException, IOException {
+ @Test
+ public void testCalculateDifferencesZipsSameEntries() throws IOException {
createJarOneEntryA1();
createJarOneEntryA2();
DifferenceCalculator calc = new DifferenceCalculator(testJarOneEntryA1Filename, testJarOneEntryA2Filename);
Differences differences = calc.getDifferences();
assertFalse(differences.hasDifferences());
- Map addedEntries = differences.getAdded();
+ Map addedEntries = differences.getAdded();
assertTrue(addedEntries.size() == 0);
- Map removedEntries = differences.getRemoved();
+ Map removedEntries = differences.getRemoved();
assertTrue(removedEntries.size() == 0);
- Map changedEntries = differences.getChanged();
+ Map changedEntries = differences.getChanged();
assertTrue(changedEntries.size() == 0);
exerciseOutputBuilders(differences);
@@ -210,48 +264,55 @@ public void testCalculateDifferencesZipsSameEntries() throws FileNotFoundExcepti
* Test for Differences calculateDifferences(ZipFile, ZipFile)
* Test that the differences between two zips with A in one and B in the second.
* A will have been removed and B will have been added.
+ * @throws FileNotFoundException
+ * @throws IOException
*/
- public void testCalculateDifferencesZipsDifferentEntries() throws FileNotFoundException, IOException {
+ @Test
+ public void testCalculateDifferencesZipsDifferentEntries() throws IOException {
createJarOneEntryA1();
createJarOneEntryB1();
DifferenceCalculator calc = new DifferenceCalculator(testJarOneEntryA1Filename, testJarOneEntryB1Filename);
Differences differences = calc.getDifferences();
assertTrue(differences.hasDifferences());
- Map addedEntries = differences.getAdded();
+ Map addedEntries = differences.getAdded();
assertTrue(addedEntries.containsKey("B"));
- Map removedEntries = differences.getRemoved();
+ Map removedEntries = differences.getRemoved();
assertTrue(removedEntries.containsKey("A"));
- Map changedEntries = differences.getChanged();
+ Map changedEntries = differences.getChanged();
assertTrue(changedEntries.size() == 0);
exerciseOutputBuilders(differences);
-
}
-
/**
* Test for Differences calculateDifferences(ZipFile, ZipFile)
* Test that the differences between two zips with A in one and A in the second with different content.
* A will have been removed and B will have been added.
+ * @throws FileNotFoundException
+ * @throws IOException
*/
- public void testCalculateDifferencesZipsSameEntriesDifferentContent() throws FileNotFoundException, IOException {
+ @Test
+ public void testCalculateDifferencesZipsSameEntriesDifferentContent() throws IOException {
createJarOneEntryA1();
createJarOneEntryAContentsChanged();
DifferenceCalculator calc = new DifferenceCalculator(testJarOneEntryA1Filename, testJarOneEntryAContentsChangedFilename);
- calc.setIgnoreCVSFiles(true);
+ calc.setExcludeSCMFiles(true);
Differences differences = calc.getDifferences();
assertTrue(differences.hasDifferences());
- Map addedEntries = differences.getAdded();
+ Map addedEntries = differences.getAdded();
assertTrue(addedEntries.size() == 0);
- Map removedEntries = differences.getRemoved();
+ Map removedEntries = differences.getRemoved();
assertTrue(removedEntries.size() == 0);
- Map changedEntries = differences.getChanged();
+ Map changedEntries = differences.getChanged();
assertTrue(changedEntries.containsKey("A"));
exerciseOutputBuilders(differences);
-
}
+ /**
+ * Method exerciseHtmlBuilder.
+ * @param differences Differences
+ */
private void exerciseHtmlBuilder(Differences differences) {
assertNotNull(differences);
@@ -263,6 +324,10 @@ private void exerciseHtmlBuilder(Differences differences) {
assertTrue(baos.size() > 0);
}
+ /**
+ * Method exerciseXmlBuilder.
+ * @param differences Differences
+ */
private void exerciseXmlBuilder(Differences differences) {
assertNotNull(differences);
@@ -274,6 +339,10 @@ private void exerciseXmlBuilder(Differences differences) {
assertTrue(baos.size() > 0);
}
+ /**
+ * Method exerciseTextBuilder.
+ * @param differences Differences
+ */
private void exerciseTextBuilder(Differences differences) {
assertNotNull(differences);
@@ -285,11 +354,14 @@ private void exerciseTextBuilder(Differences differences) {
assertTrue(baos.size() > 0);
}
+ /**
+ * Method exerciseOutputBuilders.
+ * @param differences Differences
+ */
private void exerciseOutputBuilders(Differences differences) {
assertNotNull(differences);
exerciseHtmlBuilder(differences);
exerciseXmlBuilder(differences);
exerciseTextBuilder(differences);
}
-
}
diff --git a/xdocs/index.xml b/xdocs/index.xml
deleted file mode 100644
index 475f058..0000000
--- a/xdocs/index.xml
+++ /dev/null
@@ -1,56 +0,0 @@
-
-
-
-
-
- Welcome
-
-
-
-
-
-
- Use the zipdiff tool when you need to compare the contents of two zip files.
- It is equally suited for comparing jar files, EAR files, WAR files or RAR files.
-
-
- Run it standalone or as an
- Ant task.
- The tool supports three output formats: plain text, XML, and HTML.
-