add custom register/target/targetargs

tonyhallett · tonyhallett · commit 4ff7e1521769 · 2024-01-17T20:31:50.000Z
diff --git a/FineCodeCoverageTests/AppOptionsProvider_Tests.cs b/FineCodeCoverageTests/AppOptionsProvider_Tests.cs
@@ -317,7 +317,10 @@ internal void Should_Use_Deseralized_String_From_Store_For_AppOption_Property(Fu
                 { nameof(IAppOptions.ShowToolWindowToolbar),true},
                 {nameof(IAppOptions.ExcludeAssemblies),new string[]{ "Exclude"} },
                 {nameof(IAppOptions.IncludeAssemblies),new string[]{ "Include"} },
-                {nameof(IAppOptions.NamespaceQualification),NamespaceQualification.AlwaysUnqualified }
+                {nameof(IAppOptions.NamespaceQualification),NamespaceQualification.AlwaysUnqualified },
+                {nameof(IAppOptions.OpenCoverRegister),OpenCoverRegister.Default },
+                {nameof(IAppOptions.OpenCoverTarget),"" },
+                {nameof(IAppOptions.OpenCoverTargetArgs),"" }
             };
             var mockJsonConvertService = autoMocker.GetMock<IJsonConvertService>();
             mockJsonConvertService.Setup(
diff --git a/FineCodeCoverageTests/MsCodeCoverage/RunSettingsTemplateReplacementsFactory_Tests.cs b/FineCodeCoverageTests/MsCodeCoverage/RunSettingsTemplateReplacementsFactory_Tests.cs
@@ -702,5 +702,8 @@ internal class TestCoverageProjectOptions : IAppOptions
         public string[] IncludeAssemblies { get; set; }
         public bool DisabledNoCoverage { get; set; }
         public NamespaceQualification NamespaceQualification { get; set; }
+        public OpenCoverRegister OpenCoverRegister { get; set; }
+        public string OpenCoverTarget { get; set; }
+        public string OpenCoverTargetArgs { get; set; }
     }
 }
diff --git a/FineCodeCoverageTests/OpenCoverExeArgumentsProvider_Tests.cs b/FineCodeCoverageTests/OpenCoverExeArgumentsProvider_Tests.cs
@@ -34,7 +34,7 @@ public void Should_HideSkippedAll()
 
         [TestCase(true)]
         [TestCase(false)]
-        public void Should_Register_Depending_Upon_Project_Is64Bit(bool is64Bit)
+        public void Should_Register_Depending_Upon_Project_Is64Bit_When_Project_OpenCoverRegister_Is_Default(bool is64Bit)
         {
             var openCoverExeArgumentsProvider = new OpenCoverExeArgumentsProvider();
             var mockCoverageProject = SafeMockCoverageProject();
@@ -45,8 +45,23 @@ public void Should_Register_Depending_Upon_Project_Is64Bit(bool is64Bit)
             AssertHasSetting(arguments, is64Bit ? "-register:path64" : "-register:path32");
         }
 
+        [TestCase(OpenCoverRegister.User,":user")]
+        [TestCase(OpenCoverRegister.Path32,":path32")]
+        [TestCase(OpenCoverRegister.Path64,":path64")]
+        [TestCase(OpenCoverRegister.NoArg,"")]
+        public void Should_Register_Using_Project_OpenCoverRegister_When_Not_Default(OpenCoverRegister register, string expectedSuffix)
+        {
+            var openCoverExeArgumentsProvider = new OpenCoverExeArgumentsProvider();
+            var mockCoverageProject = SafeMockCoverageProject();
+            mockCoverageProject.SetupGet(coverageProject => coverageProject.Settings.OpenCoverRegister).Returns(register);
+
+            var arguments = openCoverExeArgumentsProvider.Provide(mockCoverageProject.Object, "");
+            
+            AssertHasSetting(arguments, $"-register{expectedSuffix}");
+        }
+
         [Test]
-        public void Should_Safely_Set_Target_To_MsTestPlatformExePath()
+        public void Should_Safely_Set_Target_To_MsTestPlatformExePath_When_Not_Provided_In_Project_Settings()
         {
             var openCoverExeArgumentsProvider = new OpenCoverExeArgumentsProvider();
             var mockCoverageProject = SafeMockCoverageProject();
@@ -56,6 +71,17 @@ public void Should_Safely_Set_Target_To_MsTestPlatformExePath()
             AssertHasEscapedSetting(arguments, "-target:msTestPlatformExePath");
         }
 
+        [Test]
+        public void Should_Safely_Set_Target_From_Project_Settings_When_Provided()
+        {
+            var openCoverExeArgumentsProvider = new OpenCoverExeArgumentsProvider();
+            var mockCoverageProject = SafeMockCoverageProject();
+            mockCoverageProject.Setup(coverageProject => coverageProject.Settings.OpenCoverTarget).Returns("openCoverTarget");
+            var arguments = openCoverExeArgumentsProvider.Provide(mockCoverageProject.Object, "msTestPlatformExePath");
+
+            AssertHasEscapedSetting(arguments, "-target:openCoverTarget");
+        }
+
         [Test]
         public void Should_Safely_Include_The_TestDLLFile_In_The_TargetArgs()
         {
@@ -81,6 +107,18 @@ public void Should_Safely_Include_The_Project_RunSettingsFile_In_The_TargetArgs_
             AssertHasEscapedSetting(arguments, $"-targetargs:{CommandLineArguments.AddEscapeQuotes("testDllFile")} /Settings:{CommandLineArguments.AddEscapeQuotes("runSettingsFile")}");
         }
 
+        [Test]
+        public void Should_Safely_Include_The_Project_OpenCoverTargetArgs_When_Present()
+        {
+            var openCoverExeArgumentsProvider = new OpenCoverExeArgumentsProvider();
+            var mockCoverageProject = SafeMockCoverageProject();
+            mockCoverageProject.SetupGet(coverageProject => coverageProject.TestDllFile).Returns("testDllFile");
+            mockCoverageProject.SetupGet(coverageProject => coverageProject.Settings.OpenCoverTargetArgs).Returns("openCoverAdditionalTargetArgs");
+            var arguments = openCoverExeArgumentsProvider.Provide(mockCoverageProject.Object, "");
+
+            AssertHasEscapedSetting(arguments, $"-targetargs:{CommandLineArguments.AddEscapeQuotes("testDllFile")} openCoverAdditionalTargetArgs");
+        }
+        
         [Test]
         public void Should_Safely_Output_To_The_Project_CoverageOutputFile()
         {
diff --git a/README.md b/README.md
@@ -287,6 +287,9 @@ If you are using option 1) then project and global options will only be used whe
 |**The "CoverletConsole" settings have precedence Local / CustomPath / Global.**||
 |<br>||
 |**OpenCover**||
+|OpenCoverRegister|Change from Default if FCC determination of path32 or path64 is incorrect.|
+|OpenCoverTarget|Supply your own target if required.|
+|OpenCoverTargetArgs|If supplying your own target you can also supply additional arguments.  FCC supplies the test dll path.|
 |OpenCoverCustomPath|Specify path to open cover exe if you need functionality that the FCC version does not provide.|
 |ThresholdForNPathComplexity|When [npath complexity](https://en.wikipedia.org/wiki/Cyclomatic_complexity) exceeds this value for a method then the method will be present in the risk hotspots tab.|
 |ThresholdForCrapScore|When [crap score](https://testing.googleblog.com/2011/02/this-code-is-crap.html) exceeds this value for a method then the method will be present in the risk hotspots tab.|
diff --git a/SharedProject/Core/OpenCover/OpenCoverExeArgumentsProvider.cs b/SharedProject/Core/OpenCover/OpenCoverExeArgumentsProvider.cs
@@ -1,4 +1,5 @@
 ﻿using FineCodeCoverage.Engine.Model;
+using FineCodeCoverage.Options;
 using System;
 using System.Collections.Generic;
 using System.ComponentModel.Composition;
@@ -139,22 +140,45 @@ string GetAlternateName(string exclude)
         private string GetTargetArgs(ICoverageProject project)
         {
             var runSettings = !string.IsNullOrWhiteSpace(project.RunSettingsFile) ? $@" /Settings:{CommandLineArguments.AddEscapeQuotes(project.RunSettingsFile)}" : default;
-            return $@"""-targetargs:{CommandLineArguments.AddEscapeQuotes(project.TestDllFile)}{runSettings}""";
+            var openCoverTargetArgs = project.Settings.OpenCoverTargetArgs;
+            var additionalTargetArgs = !string.IsNullOrWhiteSpace(openCoverTargetArgs) ? $" {openCoverTargetArgs}" : default;
+            return $@"""-targetargs:{CommandLineArguments.AddEscapeQuotes(project.TestDllFile)}{runSettings}{additionalTargetArgs}""";
+        }
+
+        private void AddTargetAndTargetArgs(ICoverageProject project, List<string> opencoverSettings, string msTestPlatformExePath)
+        {
+            var target = !string.IsNullOrWhiteSpace(project.Settings.OpenCoverTarget) ? project.Settings.OpenCoverTarget : msTestPlatformExePath;
+            opencoverSettings.Add(CommandLineArguments.AddQuotes($"-target:{target}"));
+            opencoverSettings.Add(GetTargetArgs(project));
+        }
+
+        private string GetRegister(ICoverageProject project)
+        {
+            var openCoverRegister = project.Settings.OpenCoverRegister;
+            if (openCoverRegister == OpenCoverRegister.Default)
+            {
+                return $":path{(project.Is64Bit ? "64" : "32")}";
+            }
+            if(openCoverRegister == OpenCoverRegister.NoArg)
+            {
+                return "";
+            }
+            return $":{project.Settings.OpenCoverRegister.ToString().ToLower()}";
         }
 
         public List<string> Provide(ICoverageProject project,string msTestPlatformExePath)
         {
             var opencoverSettings = new List<string>();
-            
-            opencoverSettings.Add(CommandLineArguments.AddQuotes($"-target:{msTestPlatformExePath}"));
-            opencoverSettings.Add(GetTargetArgs(project));
+            AddTargetAndTargetArgs(project, opencoverSettings, msTestPlatformExePath);
+            //opencoverSettings.Add(CommandLineArguments.AddQuotes($"-target:{msTestPlatformExePath}"));
+            //opencoverSettings.Add(GetTargetArgs(project));
 
             opencoverSettings.Add(CommandLineArguments.AddQuotes($"-output:{project.CoverageOutputFile}"));
             
             AddFilter(project, opencoverSettings);
             AddExcludeByFile(project, opencoverSettings);
             AddExcludeByAttribute(project, opencoverSettings);
-            opencoverSettings.Add($"-register:path{(project.Is64Bit ? "64" : "32")}");
+            opencoverSettings.Add($"-register{GetRegister(project)}");
             opencoverSettings.Add("-mergebyhash");
             opencoverSettings.Add("-hideskipped:all");
 
diff --git a/SharedProject/Options/AppOptionsPage.cs b/SharedProject/Options/AppOptionsPage.cs
@@ -315,6 +315,18 @@ You can also ignore additional attributes by adding to this list (short name or
         [Description("Specify path to open cover exe if you need functionality that the FCC version does not provide.")]
         [Category(openCoverToolCategory)]
         public string OpenCoverCustomPath { get; set; }
+
+        [Description("Change from Default if FCC determination of path32 or path64 is incorrect.")]
+        [Category(openCoverToolCategory)]
+        public OpenCoverRegister OpenCoverRegister { get; set; }
+
+        [Category(openCoverToolCategory)]
+        [Description("Supply your own target if required.")]
+        public string OpenCoverTarget { get; set; }
+
+        [Category(openCoverToolCategory)]
+        [Description("If supplying your own target you can also supply additional arguments.  FCC supplies the test dll path.")]
+        public string OpenCoverTargetArgs { get; set; }
         #endregion
 
         public override void SaveSettingsToStorage()
diff --git a/SharedProject/Options/AppOptionsProvider.cs b/SharedProject/Options/AppOptionsProvider.cs
@@ -210,5 +210,8 @@ internal class AppOptions : IAppOptions
         public string[] ExcludeAssemblies { get; set; }
         public string[] IncludeAssemblies { get; set; }
         public NamespaceQualification NamespaceQualification { get; set; }
+        public OpenCoverRegister OpenCoverRegister { get; set; }
+        public string OpenCoverTarget { get; set; }
+        public string OpenCoverTargetArgs { get; set; }
     }
 }
diff --git a/SharedProject/Options/IAppOptions.cs b/SharedProject/Options/IAppOptions.cs
@@ -36,7 +36,17 @@ internal interface IOpenCoverCoverletExcludeIncludeOptions
         string[] ExcludeByFile { get; set; }
         string[] Include { get; set; }
     }
-    internal interface IAppOptions : IMsCodeCoverageOptions, IOpenCoverCoverletExcludeIncludeOptions, IFCCCommonOptions
+
+    internal enum OpenCoverRegister { Default,NoArg, User, Path32, Path64}
+
+    internal interface IOpenCoverOptions
+    {
+        string OpenCoverCustomPath { get; set; }
+        OpenCoverRegister OpenCoverRegister { get; set; }
+        string OpenCoverTarget { get; set; }
+        string OpenCoverTargetArgs { get; set; }
+    }
+    internal interface IAppOptions : IMsCodeCoverageOptions, IOpenCoverCoverletExcludeIncludeOptions, IFCCCommonOptions, IOpenCoverOptions
     {
         bool RunInParallel { get; set; }
         int RunWhenTestsExceed { get; set; }
@@ -47,7 +57,7 @@ internal interface IAppOptions : IMsCodeCoverageOptions, IOpenCoverCoverletExclu
         string CoverletConsoleCustomPath { get; set; }
         bool CoverletConsoleLocal { get; set; }
         string CoverletCollectorDirectoryPath { get; set; }
-        string OpenCoverCustomPath { get; set; }
+        
         string FCCSolutionOutputDirectoryName { get; set; }
         int ThresholdForCyclomaticComplexity { get; set; }
         int ThresholdForNPathComplexity { get; set; }

Original file line number	Diff line number	Diff line change
`@@ -702,5 +702,8 @@ internal class TestCoverageProjectOptions : IAppOptions`
`702`	`702`	`public string[] IncludeAssemblies { get; set; }`
`703`	`703`	`public bool DisabledNoCoverage { get; set; }`
`704`	`704`	`public NamespaceQualification NamespaceQualification { get; set; }`
	`705`	`+ public OpenCoverRegister OpenCoverRegister { get; set; }`
	`706`	`+ public string OpenCoverTarget { get; set; }`
	`707`	`+ public string OpenCoverTargetArgs { get; set; }`
`705`	`708`	`}`
`706`	`709`	`}`
Original file line number	Diff line number	Diff line change
`@@ -210,5 +210,8 @@ internal class AppOptions : IAppOptions`
`210`	`210`	`public string[] ExcludeAssemblies { get; set; }`
`211`	`211`	`public string[] IncludeAssemblies { get; set; }`
`212`	`212`	`public NamespaceQualification NamespaceQualification { get; set; }`
	`213`	`+ public OpenCoverRegister OpenCoverRegister { get; set; }`
	`214`	`+ public string OpenCoverTarget { get; set; }`
	`215`	`+ public string OpenCoverTargetArgs { get; set; }`
`213`	`216`	`}`
`214`	`217`	`}`