git/list[1] front-page[2] threads[3] people[4] search[5] about
 

[JGIT PATCH 8/8] Hard failure on unit test cleanups if they fail.

From
Robin Rosenberg <robin.rosenberg@dewire.com>
Date
Nov 30, 2008, 23:40 UTC
Message-ID
<1228088435-23722-9-git-send-email-robin.rosenberg@dewire.com>
In-Reply-To
<1228088435-23722-8-git-send-email-robin.rosenberg@dewire.com>

This only has an effect on Windows that locks open files, but is a nice test that we actually clean up.

Signed-off-by: Robin Rosenberg <robin.rosenberg@dewire.com>
---
 .../org/spearce/jgit/lib/RepositoryTestCase.java   |   52 ++++++++++++--------
 1 files changed, 32 insertions(+), 20 deletions(-)
diff --git a/org.spearce.jgit.test/tst/org/spearce/jgit/lib/RepositoryTestCase.java b/org.spearce.jgit.test/tst/org/spearce/jgit/lib/RepositoryTestCase.java
index 376a76e..22bf395 100644
--- a/org.spearce.jgit.test/tst/org/spearce/jgit/lib/RepositoryTestCase.java
+++ b/org.spearce.jgit.test/tst/org/spearce/jgit/lib/RepositoryTestCase.java
@@ -49,6 +49,7 @@
 import java.util.List;
 
 import junit.framework.TestCase;
+
 import org.spearce.jgit.util.JGitTestUtil;
 
 /**
@@ -93,16 +94,18 @@ protected void configure() {
 
 	/**
 	 * Utility method to delete a directory recursively. It is
-	 * also used internally.
+	 * also used internally. If a file or directory cannote be removed
+	 * it throws an AssertionFailure.
 	 *
 	 * @param dir
 	 */
 	protected void recursiveDelete(final File dir) {
-		recursiveDelete(dir, false, getClass().getName() + "." + getName());
+		recursiveDelete(dir, false, getClass().getName() + "." + getName(), true);
 	}
 
 	protected static boolean recursiveDelete(final File dir, boolean silent,
-			final String name) {
+			final String name, boolean failOnError) {
+		assert !(silent && failOnError);
 		if (!dir.exists())
 			return silent;
 		final File[] ls = dir.listFiles();
@@ -110,32 +113,42 @@ protected static boolean recursiveDelete(final File dir, boolean silent,
 			for (int k = 0; k < ls.length; k++) {
 				final File e = ls[k];
 				if (e.isDirectory()) {
-					silent = recursiveDelete(e, silent, name);
+					silent = recursiveDelete(e, silent, name, failOnError);
 				} else {
 					if (!e.delete()) {
 						if (!silent) {
-							String msg = "Warning: Failed to delete " + e;
-							if (name != null)
-								msg += " in " + name;
-							System.out.println(msg);
+							reportDeleteFailure(name, failOnError, e);
 						}
-						silent = true;
+						silent = !failOnError;
 					}
 				}
 			}
 		}
 		if (!dir.delete()) {
 			if (!silent) {
-				String msg = "Warning: Failed to delete " + dir;
-				if (name != null)
-					msg += " in " + name;
-				System.out.println(msg);
+				reportDeleteFailure(name, failOnError, dir);
 			}
-			silent = true;
+			silent = !failOnError;
 		}
 		return silent;
 	}
 
+	private static void reportDeleteFailure(final String name,
+			boolean failOnError, final File e) {
+		String severity;
+		if (failOnError)
+			severity = "Error";
+		else
+			severity = "Warning";
+		String msg = severity + ": Failed to delete " + e;
+		if (name != null)
+			msg += " in " + name;
+		if (failOnError)
+			fail(msg);
+		else
+			System.out.println(msg);
+	}
+
 	protected static void copyFile(final File src, final File dst)
 			throws IOException {
 		final FileInputStream fis = new FileInputStream(src);
@@ -186,7 +199,7 @@ public void setUp() throws Exception {
 		super.setUp();
 		configure();
 		final String name = getClass().getName() + "." + getName();
-		recursiveDelete(trashParent, true, name);
+		recursiveDelete(trashParent, true, name, false); // Cleanup old failed stuff
 		trash = new File(trashParent,"trash"+System.currentTimeMillis()+"."+(testcount++));
 		trash_git = new File(trash, ".git");
 		if (shutdownhook == null) {
@@ -201,7 +214,7 @@ public void run() {
 					System.gc();
 					for (Runnable r : shutDownCleanups)
 						r.run();
-					recursiveDelete(trashParent, false, null);
+					recursiveDelete(trashParent, false, null, false);
 				}
 			};
 			Runtime.getRuntime().addShutdownHook(shutdownhook);
@@ -241,10 +254,9 @@ protected void tearDown() throws Exception {
 			System.gc();
 
 		final String name = getClass().getName() + "." + getName();
-		recursiveDelete(trash, false, name);
+		recursiveDelete(trash, false, name, true);
 		for (Repository r : repositoriesToClose)
-			recursiveDelete(r.getWorkDir(), false, name);
-
+			recursiveDelete(r.getWorkDir(), false, name, true);
 		repositoriesToClose.clear();
 
 		super.tearDown();
@@ -266,7 +278,7 @@ protected Repository createNewEmptyRepo() throws IOException {
 		final String name = getClass().getName() + "." + getName();
 		shutDownCleanups.add(new Runnable() {
 			public void run() {
-				recursiveDelete(newTestRepo, false, name);
+				recursiveDelete(newTestRepo, false, name, false);
 			}
 		});
 		repositoriesToClose.add(newRepo);
-- 
1.6.0.3.640.g6331a
Previous: Robin RosenbergNext: Shawn O. Pearce
Message 14 of 15 in “RepositoryTestCase cleanups”
  1. 0/4 RepositoryTestCase cleanupsRobin Rosenberg, Nov 27, 2008
  2. Shawn O. PearceNov 27, 2008
  3. Robin RosenbergNov 29, 2008
  4. Johannes SchindelinDec 1, 2008
  5. Robin RosenbergNov 30, 2008
  6. 0/8 Unit test cleanupsRobin Rosenberg, Nov 30, 2008
  7. 1/8 Drop unneeded code in unit testsRobin Rosenberg, Nov 30, 2008
  8. 2/8 Cleanup malformed test casesRobin Rosenberg, Nov 30, 2008
  9. 3/8 Turn off memory mapping in JGit unit tests by defaultRobin Rosenberg, Nov 30, 2008
  10. 4/8 Add a counter to make sure the test repo name is uniqueRobin Rosenberg, Nov 30, 2008
  11. 5/8 Make the cleanup less verbose when it fails to delete temporary stuff.Robin Rosenberg, Nov 30, 2008
  12. 6/8 Cleanup after each test.Robin Rosenberg, Nov 30, 2008
  13. 7/8 Close files opened by unit testing frameworkRobin Rosenberg, Nov 30, 2008
  14. 8/8 Hard failure on unit test cleanups if they fail.Robin Rosenberg, Nov 30, 2008
  15. Shawn O. PearceDec 2, 2008

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.