Don't spam log during TryOpenRepository test

Fixed `RepoDirExistsFalse_ReturnFalse` test.

Author: jcansdale

src/GitHub.Exports/Services/IVSServices.cs

@@ -10,6 +10,6 @@ public interface IVSServices
         void ActivityLogMessage(string message);
         void ActivityLogWarning(string message);
         void ActivityLogError(string message);
-        bool TryOpenRepository(string directory);
+        bool TryOpenRepository(string directory, bool logErrors = true);
     }
 }

src/GitHub.Exports/Services/VSServices.cs

@@ -84,24 +84,24 @@ public void ActivityLogWarning(string message)
         /// </remarks>
         /// <param name="repoPath">The path to the repository to open</param>
         /// <returns>True if a transient solution was successfully created in target directory (which should trigger opening of repository).</returns>
-        public bool TryOpenRepository(string repoPath)
+        public bool TryOpenRepository(string repoPath, bool logErrors = true)
         {
             var os = serviceProvider.TryGetService<IOperatingSystem>();
             if (os == null)
             {
-                log.Error("TryOpenRepository couldn't find IOperatingSystem service");
+                if (logErrors) log.Error("TryOpenRepository couldn't find IOperatingSystem service");
                 return false;
             }
 
             var dte = serviceProvider.TryGetService<DTE>();
             if (dte == null)
             {
-                log.Error("TryOpenRepository couldn't find DTE service");
+                if (logErrors) log.Error("TryOpenRepository couldn't find DTE service");
                 return false;
             }
 
             var repoDir = os.Directory.GetDirectory(repoPath);
-            if(!repoDir.Exists)
+            if (!repoDir.Exists)
             {
                 return false;
             }
@@ -116,16 +116,16 @@ public bool TryOpenRepository(string repoPath)
             }
             catch (Exception e)
             {
-                log.Error(e, "Error opening repository");
+                if (logErrors) log.Error(e, "Error opening repository");
             }
             finally
             {
-                TryCleanupSolutionUserFiles(os, repoPath, TempSolutionName);
+                TryCleanupSolutionUserFiles(os, repoPath, TempSolutionName, logErrors);
             }
             return solutionCreated;
         }
 
-        void TryCleanupSolutionUserFiles(IOperatingSystem os, string repoPath, string slnName)
+        void TryCleanupSolutionUserFiles(IOperatingSystem os, string repoPath, string slnName, bool logErrors)
         {
             var vsTempPath = Path.Combine(repoPath, ".vs", slnName);
             try
@@ -139,7 +139,7 @@ void TryCleanupSolutionUserFiles(IOperatingSystem os, string repoPath, string sl
             }
             catch (Exception e)
             {
-                log.Error(e, "Couldn't clean up {TempPath}", vsTempPath);
+                if (logErrors) log.Error(e, "Couldn't clean up {TempPath}", vsTempPath);
             }
         }
 
@@ -162,7 +162,7 @@ string GetVSVersion()
                 if (asm != null)
                     return asm.GetName().Version.ToString();
             }
-            catch(Exception ex)
+            catch (Exception ex)
             {
                 log.Error(ex, "Error getting the Visual Studio version");
             }

test/UnitTests/GitHub.Exports/VSServicesTests.cs

@@ -31,7 +31,7 @@ public void SolutionCreateThrows_ReturnsFalse()
                 ci => { throw new COMException(); });
             var target = CreateVSServices(repoDir, dte: dte);
 
-            var success = target.TryOpenRepository("");
+            var success = target.TryOpenRepository(repoDir, logErrors: false);
 
             Assert.False(success);
         }
@@ -40,11 +40,7 @@ public void SolutionCreateThrows_ReturnsFalse()
         public void RepoDirExistsFalse_ReturnFalse()
         {
             var repoDir = @"x:\repo";
-            var os = Substitute.For<IOperatingSystem>();
-            //var directoryInfo = Substitute.For<IDirectoryInfo>();
-            //directoryInfo.Exists.Returns(false);
-            //os.Directory.GetDirectory(repoDir).Returns(directoryInfo);
-            var target = CreateVSServices(null, os: os);
+            var target = CreateVSServices(repoDir, repoDirExists: false);
 
             var success = target.TryOpenRepository(repoDir);
 
@@ -64,7 +60,7 @@ public void DeleteThrowsIOException_ReturnTrue()
                 ci => { throw new IOException(); });
             var target = CreateVSServices(repoDir, os: os);
 
-            var success = target.TryOpenRepository(repoDir);
+            var success = target.TryOpenRepository(repoDir, logErrors: false);
 
             Assert.True(success);
         }
@@ -85,15 +81,15 @@ public void SolutionCreate_DeleteVsSolutionSubdir()
             directoryInfo.Received().Delete(true);
         }
 
-        VSServices CreateVSServices(string repoDir, IOperatingSystem os = null, DTE dte = null)
+        VSServices CreateVSServices(string repoDir, IOperatingSystem os = null, DTE dte = null, bool repoDirExists = true)
         {
             os = os ?? Substitute.For<IOperatingSystem>();
             dte = dte ?? Substitute.For<DTE>();
 
             if (repoDir != null)
             {
                 var directoryInfo = Substitute.For<IDirectoryInfo>();
-                directoryInfo.Exists.Returns(true);
+                directoryInfo.Exists.Returns(repoDirExists);
                 os.Directory.GetDirectory(repoDir).Returns(directoryInfo);
             }