From d62784c73d3d2a6f460cd612c84b39a9c7fc9cb3 Mon Sep 17 00:00:00 2001
From: Niki Roo <niki@nikiroo.be>
Date: Sun, 23 Sep 2018 05:24:49 +0200
Subject: [PATCH 1/1] Version 4.4.2: test assert can compare files/dir

---
 VERSION                                 |   2 +-
 changelog.md                            |   4 +
 src/be/nikiroo/utils/test/TestCase.java | 138 +++++++++++++++++++++++-
 3 files changed, 141 insertions(+), 3 deletions(-)

diff --git a/VERSION b/VERSION
index cca25a9..1d068c6 100644
--- a/VERSION
+++ b/VERSION
@@ -1 +1 @@
-4.4.1
+4.4.2
diff --git a/changelog.md b/changelog.md
index ffeb68d..f0947f7 100644
--- a/changelog.md
+++ b/changelog.md
@@ -1,5 +1,9 @@
 # nikiroo-utils
 
+## Version 4.4.2
+
+- Test assertions: can now compare files/dir content
+
 ## Version 4.4.1
 
 - Image: fix undocumented exception on save images
diff --git a/src/be/nikiroo/utils/test/TestCase.java b/src/be/nikiroo/utils/test/TestCase.java
index 85a65d7..9b8086f 100644
--- a/src/be/nikiroo/utils/test/TestCase.java
+++ b/src/be/nikiroo/utils/test/TestCase.java
@@ -1,6 +1,12 @@
 package be.nikiroo.utils.test;
 
+import java.io.File;
+import java.util.Arrays;
 import java.util.List;
+import java.util.Map;
+import java.util.Map.Entry;
+
+import be.nikiroo.utils.IOUtils;
 
 /**
  * A {@link TestCase} that can be run with {@link TestLauncher}.
@@ -308,8 +314,6 @@ abstract public class TestCase {
 	 *            the expected value
 	 * @param actual
 	 *            the actual value
-	 * @param errorMessage
-	 *            the error message to display if they differ
 	 * 
 	 * @throws AssertException
 	 *             in case they differ
@@ -330,6 +334,136 @@ abstract public class TestCase {
 		}
 	}
 
+	/**
+	 * Check that 2 {@link File}s are equals, by doing a line-by-line
+	 * comparison.
+	 * 
+	 * @param expected
+	 *            the expected value
+	 * @param actual
+	 *            the actual value
+	 * @param errorMessage
+	 *            the error message to display if they differ
+	 * 
+	 * @throws AssertException
+	 *             in case they differ
+	 */
+	public void assertEquals(File expected, File actual) throws AssertException {
+		assertEquals(generateAssertMessage(expected, actual), expected, actual);
+	}
+
+	/**
+	 * Check that 2 {@link File}s are equals, by doing a line-by-line
+	 * comparison.
+	 * 
+	 * @param errorMessage
+	 *            the error message to display if they differ
+	 * @param expected
+	 *            the expected value
+	 * @param actual
+	 *            the actual value
+	 * 
+	 * @throws AssertException
+	 *             in case they differ
+	 */
+	public void assertEquals(String errorMessage, File expected, File actual)
+			throws AssertException {
+		assertEquals(errorMessage, expected, actual, null);
+	}
+
+	/**
+	 * Check that 2 {@link File}s are equals, by doing a line-by-line
+	 * comparison.
+	 * 
+	 * @param errorMessage
+	 *            the error message to display if they differ
+	 * @param expected
+	 *            the expected value
+	 * @param actual
+	 *            the actual value
+	 * @param skipCompare
+	 *            skip the lines starting with some values for the given files
+	 *            (relative path from base directory in recursive mode)
+	 * 
+	 * @throws AssertException
+	 *             in case they differ
+	 */
+	public void assertEquals(String errorMessage, File expected, File actual,
+			Map<String, List<String>> skipCompare) throws AssertException {
+		assertEquals(errorMessage, expected, actual, skipCompare, null);
+	}
+
+	private void assertEquals(String errorMessage, File expected, File actual,
+			Map<String, List<String>> skipCompare, String removeFromName)
+			throws AssertException {
+
+		if (expected.isDirectory() || actual.isDirectory()) {
+			assertEquals(errorMessage + ": type mismatch: expected a "
+					+ (expected.isDirectory() ? "directory" : "file")
+					+ ", received a "
+					+ (actual.isDirectory() ? "directory" : "file"),
+					expected.isDirectory(), actual.isDirectory());
+
+			List<String> expectedFiles = Arrays.asList(expected.list());
+			expectedFiles.sort(null);
+			List<String> actualFiles = Arrays.asList(actual.list());
+			actualFiles.sort(null);
+
+			assertEquals(errorMessage, expectedFiles, actualFiles);
+			for (int i = 0; i < actualFiles.size(); i++) {
+				File expectedFile = new File(expected, expectedFiles.get(i));
+				File actualFile = new File(actual, actualFiles.get(i));
+
+				assertEquals(errorMessage, expectedFile, actualFile,
+						skipCompare, expected.getAbsolutePath());
+			}
+		} else {
+			try {
+				List<String> expectedLines = Arrays.asList(IOUtils
+						.readSmallFile(expected).split("\n"));
+				List<String> resultLines = Arrays.asList(IOUtils.readSmallFile(
+						actual).split("\n"));
+
+				String name = expected.getAbsolutePath();
+				if (removeFromName != null && name.startsWith(removeFromName)) {
+					name = expected.getName()
+							+ name.substring(removeFromName.length());
+				}
+
+				assertEquals(errorMessage + ": " + name
+						+ ": the number of lines is not the same",
+						expectedLines.size(), resultLines.size());
+
+				for (int j = 0; j < expectedLines.size(); j++) {
+					String expectedLine = expectedLines.get(j);
+					String resultLine = resultLines.get(j);
+
+					boolean skip = false;
+					for (Entry<String, List<String>> skipThose : skipCompare
+							.entrySet()) {
+						for (String skipStart : skipThose.getValue()) {
+							if (name.endsWith(skipThose.getKey())
+									&& expectedLine.startsWith(skipStart)
+									&& resultLine.startsWith(skipStart)) {
+								skip = true;
+							}
+						}
+					}
+
+					if (skip) {
+						continue;
+					}
+
+					assertEquals(errorMessage + ": line " + (j + 1)
+							+ " is not the same in file " + name, expectedLine,
+							resultLine);
+				}
+			} catch (Exception e) {
+				throw new AssertException(errorMessage, e);
+			}
+		}
+	}
+
 	/**
 	 * Check that given {@link Object} is not NULL.
 	 * 
-- 
2.27.0