Add meaningful message when an external process prevents tests cleanup

yorah · yorah · commit d0f541b4ff18 · 2012-05-25T14:52:51.000+02:00
diff --git a/LibGit2Sharp.Tests/TestHelpers/DirectoryHelper.cs b/LibGit2Sharp.Tests/TestHelpers/DirectoryHelper.cs
@@ -1,4 +1,5 @@
-﻿using System.IO;
+﻿using System;
+using System.IO;
 
 namespace LibGit2Sharp.Tests.TestHelpers
 {
@@ -46,7 +47,19 @@ public static void DeleteDirectory(string directoryPath)
             }
 
             File.SetAttributes(directoryPath, FileAttributes.Normal);
-            Directory.Delete(directoryPath, false);
+            try
+            {
+                Directory.Delete(directoryPath, false);
+            } 
+            catch (IOException ex)
+            {
+                throw new IOException(string.Format("{0}The directory '{1}' could not be deleted!" +
+                                                    "{0}Most of the time, this is due to an external process accessing the files in the temporary repositories created during the test runs, and keeping a handle on the directory, thus preventing the deletion of those files." +
+                                                    "{0}Known and common causes include:" +
+                                                    "{0}- Windows Search Indexer (go to the Indexing Options, in the Windows Control Panel, and exclude the bin folder of LibGit2Sharp.Tests)" +
+                                                    "{0}- Antivirus (exclude the bin folder of LibGit2Sharp.Tests from the paths scanned by your real-time antivirus){0}", 
+                    Environment.NewLine, Path.GetFullPath(directoryPath)), ex);
+            }
         }
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,5 @@`
`1`		`-using System.IO;`
	`1`	`+using System;`
	`2`	`+using System.IO;`
`2`	`3`
`3`	`4`	`namespace LibGit2Sharp.Tests.TestHelpers`
`4`	`5`	`{`
`@@ -46,7 +47,19 @@ public static void DeleteDirectory(string directoryPath)`
`46`	`47`	`}`
`47`	`48`
`48`	`49`	`File.SetAttributes(directoryPath, FileAttributes.Normal);`
`49`		`- Directory.Delete(directoryPath, false);`
	`50`	`+ try`
	`51`	`+ {`
	`52`	`+ Directory.Delete(directoryPath, false);`
	`53`	`+ }`
	`54`	`+ catch (IOException ex)`
	`55`	`+ {`
	`56`	`+ throw new IOException(string.Format("{0}The directory '{1}' could not be deleted!" +`
	`57`	`+ "{0}Most of the time, this is due to an external process accessing the files in the temporary repositories created during the test runs, and keeping a handle on the directory, thus preventing the deletion of those files." +`
	`58`	`+ "{0}Known and common causes include:" +`
	`59`	`+ "{0}- Windows Search Indexer (go to the Indexing Options, in the Windows Control Panel, and exclude the bin folder of LibGit2Sharp.Tests)" +`
	`60`	`+ "{0}- Antivirus (exclude the bin folder of LibGit2Sharp.Tests from the paths scanned by your real-time antivirus){0}",`
	`61`	`+ Environment.NewLine, Path.GetFullPath(directoryPath)), ex);`
	`62`	`+ }`
`50`	`63`	`}`
`51`	`64`	`}`
`52`	`65`	`}`