Expanded code coverage for issue #611; closes #623;

Author: rubberduck203

RetailCoder.VBE/UnitTesting/NewUnitTestModuleCommand.cs

@@ -1,36 +1,12 @@
 using System;
-using System.IO;
 using System.Linq;
-using System.Reflection;
 using Microsoft.Vbe.Interop;
 using Rubberduck.VBEditor.Extensions;
 
 namespace Rubberduck.UnitTesting
 {
     public static class NewUnitTestModuleCommand
     {
-        public static void EnsureReferenceToAddInLibrary(this VBProject project)
-        {
-            var assembly = Assembly.GetExecutingAssembly();
-
-            var name = assembly.GetName().Name.Replace('.', '_');
-            var referencePath = Path.ChangeExtension(assembly.Location, ".tlb");
-
-            var references = project.References.Cast<Reference>().ToList();
-
-            var reference = references.SingleOrDefault(r => r.Name == name);
-            if (reference != null)
-            {
-                references.Remove(reference);
-                project.References.Remove(reference);
-            }
-
-            if (references.All(r => r.FullPath != referencePath))
-            {
-                project.References.AddFromFile(referencePath);
-            }
-        }
-
         private static readonly string TestModuleEmptyTemplate = String.Concat(
                  "'@TestModule\n"
                 , "'' uncomment for late-binding:\n"
@@ -82,6 +58,7 @@ public static void NewUnitTestModule(VBE vbe)
             }
             catch (Exception exception)
             {
+                //can we please comment when we swallow every possible exception?
             }
         }
 

RetailCoder.VBE/UnitTesting/ProjectTestExtensions.cs

@@ -6,7 +6,8 @@
 using Rubberduck.Parsing.Reflection;
 using Rubberduck.Reflection;
 using Rubberduck.VBEditor.Extensions;
-using Rubberduck.VBEditor.VBEHost;
+using System.Reflection;
+using System.IO;
 
 namespace Rubberduck.UnitTesting
 {
@@ -87,5 +88,27 @@ private static bool IsTestMethod(Member member)
 
             return result;
         }
+
+        public static void EnsureReferenceToAddInLibrary(this VBProject project)
+        {
+            var assembly = Assembly.GetExecutingAssembly();
+
+            var name = assembly.GetName().Name.Replace('.', '_');
+            var referencePath = Path.ChangeExtension(assembly.Location, ".tlb");
+
+            var references = project.References.Cast<Reference>().ToList();
+
+            var reference = references.SingleOrDefault(r => r.Name == name);
+            if (reference != null)
+            {
+                references.Remove(reference);
+                project.References.Remove(reference);
+            }
+
+            if (references.All(r => r.FullPath != referencePath))
+            {
+                project.References.AddFromFile(referencePath);
+            }
+        }
     }
 }

RetailCoder.VBE/UnitTesting/TestEngine.cs

@@ -84,6 +84,9 @@ private void RunMethodCleanup(QualifiedModuleName qualifiedModuleName)
 
         public void Run(IEnumerable<TestMethod> tests, VBProject project)
         {
+            //todo: move this to the "UI" layer. This code doesn't have to run for COM clients.
+            //  COM clients will have to either already have a good reference, or be late bound.
+            //  This is problematic for late bound code, because now we've *forced* them into early binding.
             project.EnsureReferenceToAddInLibrary();
 
             var testMethods = tests as IList<TestMethod> ?? tests.ToList();

RubberduckTests/UnitTesting/EngineTests.cs

@@ -63,25 +63,26 @@ public void Initialize()
 
         private static IEnumerator<Reference> ReferenceList()
         {
-            var ref1 = new Mock<Reference>();
-            ref1.SetupGet(r => r.Name).Returns("VBA");
-            ref1.SetupGet(r => r.FullPath).Returns("C:\\Program Files\\Common Files\\Microsoft Shared\\VBA\\VBA7.1\\VBE7.DLL");
-            yield return ref1.Object;
+            yield return
+                CreateMockReference("VBA", @"C:\Program Files\Common Files\Microsoft Shared\VBA\VBA7.1\VBE7.DLL").Object;
 
-            var ref2 = new Mock<Reference>();
-            ref2.SetupGet(r => r.Name).Returns("Excel");
-            ref2.SetupGet(r => r.FullPath).Returns("C:\\Program Files\\Microsoft Office 15\\Root\\Office15\\EXCEL.EXE");
-            yield return ref2.Object;
+            yield return
+                CreateMockReference("Excel", @"C:\Program Files\Microsoft Office 15\Root\Office15\EXCEL.EXE").Object;
 
-            var ref3 = new Mock<Reference>();
-            ref3.SetupGet(r => r.Name).Returns("stdole");
-            ref3.SetupGet(r => r.FullPath).Returns("C:\\Windows\\System32\\stdole2.tlb");
-            yield return ref3.Object;
+            yield return 
+                CreateMockReference("stdole", @"C:\Windows\System32\stdole2.tlb").Object;
 
-            var ref4 = new Mock<Reference>();
-            ref4.SetupGet(r => r.Name).Returns("Office");
-            ref4.SetupGet(r => r.FullPath).Returns("C:\\Program Files\\Common Files\\Microsoft Shared\\OFFICE15\\MSO.DLL");
-            yield return ref4.Object;
+            yield return
+                CreateMockReference("Office", @"C:\Program Files\Common Files\Microsoft Shared\Office15\MSO.DLL").Object;
+        }
+
+        private static Mock<Reference> CreateMockReference(string name, string filePath)
+        {
+            var reference = new Mock<Reference>();
+            reference.SetupGet(r => r.Name).Returns(name);
+            reference.SetupGet(r => r.FullPath).Returns(filePath);
+            
+            return reference;
         }
 
         [TestMethod]
@@ -231,6 +232,61 @@ public void TestEngine_Run_WhenTestListIsEmpty_Bail()
             Assert.IsFalse(_wasEventRaised, "No methods should run when passed an empty list of tests.");
         }
 
+        //todo: move this to the "UI" layer. This code doesn't have to run for COM clients.
+        //  COM clients will have to either already have a good reference, or be late bound.
+        //  This is problematic for late bound code, because now we've *forced* them into early binding.
+        [TestMethod]
+        public void TestEngine_AfterRun_OldRubberduckReferenceIsRemoved()
+        {
+            var vbaRef = CreateMockReference("VBA", @"C:\Path\To\VBA.DLL");
+            var rubberduckPath = @"C:\Path\To\Rubberduck.dll";
+            var oldRubberduckRef = CreateMockReference("Rubberduck", rubberduckPath);
+
+            var refrenceList = new List<Reference>() {vbaRef.Object, oldRubberduckRef.Object};
+
+            var references = new Mock<References>();
+            references.Setup(r => r.GetEnumerator()).Returns(refrenceList.GetEnumerator());
+            references.As<IEnumerable>().Setup(r => r.GetEnumerator()).Returns(refrenceList.GetEnumerator());
+            references.Setup(r => r.AddFromFile(It.IsAny<string>()));
+
+            var project = new Mock<VBProject>();
+            project.SetupProperty(p => p.Name, "VBAProject");
+            project.SetupGet(p => p.References).Returns(references.Object);
+
+            //act
+            _engine.Run(_engine.AllTests.Keys, project.Object);
+
+            //assert
+            references.Verify(r => r.Remove(It.Is<Reference>(arg => arg == oldRubberduckRef.Object)));
+        }
+
+        //todo: move this to the "UI" layer. This code doesn't have to run for COM clients.
+        //  COM clients will have to either already have a good reference, or be late bound.
+        //  This is problematic for late bound code, because now we've *forced* them into early binding.
+        [TestMethod]
+        public void TestEngine_AfterRun_NewRubberduckReferenceExists()
+        {
+            var vbaRef = CreateMockReference("VBA", @"C:\Path\To\VBA.DLL");
+            var rubberduckPath = @"C:\Path\To\Rubberduck.dll";
+            var oldRubberduckRef = CreateMockReference("Rubberduck", rubberduckPath);
+
+            var refrenceList = new List<Reference>() { vbaRef.Object, oldRubberduckRef.Object };
+
+            var references = new Mock<References>();
+            references.Setup(r => r.GetEnumerator()).Returns(refrenceList.GetEnumerator());
+            references.As<IEnumerable>().Setup(r => r.GetEnumerator()).Returns(refrenceList.GetEnumerator());
+
+            var project = new Mock<VBProject>();
+            project.SetupProperty(p => p.Name, "VBAProject");
+            project.SetupGet(p => p.References).Returns(references.Object);
+
+            //act
+            _engine.Run(_engine.AllTests.Keys, project.Object);
+
+            //assert
+            references.Verify(r => r.AddFromFile(It.IsAny<string>()));
+        }
+
         private void EngineOnTestComplete(object sender, TestCompletedEventArgs testCompletedEventArgs)
         {
             CatchEvent();