refactor

Author: tonyhallett

FineCodeCoverageTests/MsCodeCoverage/RunSettingsTemplate_Tests.cs

@@ -13,7 +13,7 @@ public class RunSettingsTemplate_Tests
         public void Should_Be_Replaceable_With_Recommended_You_Do_Not_Change_Elements_When_Not_Provided(bool isDotNetFramework)
         {
             var runSettingsTemplate = new RunSettingsTemplate();
-            var template = runSettingsTemplate.ToString();
+            var template = runSettingsTemplate.Get();
             var useVerifiableInstrumentation = isDotNetFramework ? "False" : "True";
 
             var replacements = new RunSettingsTemplateReplacements
@@ -118,7 +118,7 @@ public void Should_Be_Replaceable_With_Recommended_You_Do_Not_Change_Elements_Wh
         public void Should_Be_ReplacedTestAdapter_When_Template_Has_The_FCC_TestAdapter_Placeholder()
         {
             var runSettingsTemplate = new RunSettingsTemplate();
-            var template = runSettingsTemplate.ToString();
+            var template = runSettingsTemplate.Get();
             Assert.True(runSettingsTemplate.ReplaceTemplate(template, new RunSettingsTemplateReplacements(), true).ReplacedTestAdapter);
         }
 

FineCodeCoverageTests/MsCodeCoverage/TemplatedRunSettingsService_Tests.cs

@@ -32,7 +32,7 @@ public async Task Should_Create_Run_Settings_From_Template_Async(bool isDotNetFr
             var coverageProjects = new List<ICoverageProject> { coverageProject};
 
             var mockRunSettingsTemplate = autoMocker.GetMock<IRunSettingsTemplate>();
-            mockRunSettingsTemplate.Setup(runSettingsTemplate => runSettingsTemplate.ToString()).Returns("<MockRunSettingsTemplate/>");
+            mockRunSettingsTemplate.Setup(runSettingsTemplate => runSettingsTemplate.Get()).Returns("<MockRunSettingsTemplate/>");
 
             var runSettingsTemplateReplacements = new RunSettingsTemplateReplacements();
             var mockRunSettingsTemplateReplacementFactory = autoMocker.GetMock<IRunSettingsTemplateReplacementsFactory>();

SharedProject/Core/MsTestPlatform/CodeCoverage/IRunSettingsTemplate.cs

@@ -16,7 +16,11 @@ ITemplateReplacementResult ReplaceTemplate(
             IRunSettingsTemplateReplacements replacements, 
             bool isNetFrameworkProject);
         string Replace(string templatedXml, IRunSettingsTemplateReplacements replacements);
-        
+
+        // returns a string representation of the runsettings xml containing markers for string replacement
+        string Get();
+
+        // returns a string representation of the runsettings xml containing markers for string replacement
         string ConfigureCustom(string runSettingsTemplate);
 
         string DataCollectionRunSettingsElement { get; }

SharedProject/Core/MsTestPlatform/CodeCoverage/IRunSettingsTemplateReplacements.cs

@@ -1,10 +1,14 @@
 namespace FineCodeCoverage.Engine.MsTestPlatform.CodeCoverage
 {
+    // string values for string.Replace of templated values - e.g %fcc_modulepaths_exclude%
     internal interface IRunSettingsTemplateReplacements
     {
         string Enabled { get; }
         string ResultsDirectory { get; }
         string TestAdapter { get; }
+
+        // the following are xml fragments as strings
+        // e.g <ModulePath>path1</ModulePath><ModulePath>path2</ModulePath>
         string ModulePathsExclude { get; }
         string ModulePathsInclude { get; }
         string FunctionsExclude { get; }

SharedProject/Core/MsTestPlatform/CodeCoverage/RunSettingsTemplate.cs

@@ -164,10 +164,7 @@ public RunSettingsTemplate()
 ";
         }
 
-        public override string ToString()
-        {
-            return template;
-        }
+        public string Get() => template;
 
         public ITemplateReplacementResult ReplaceTemplate(
             string runSettingsTemplate, 

SharedProject/Core/MsTestPlatform/CodeCoverage/TemplatedRunSettingsService.cs

@@ -129,8 +129,8 @@ string fccMsTestAdapterPath
             return coverageProjects.Select(coverageProject =>
             {
                 var projectDirectory = Path.GetDirectoryName(coverageProject.ProjectFile);
-                var (runSettingsTemplate, customTemplatePath) = GetRunSettingsTemplate(projectDirectory, solutionDirectory);
-                var templateReplaceResult = ReplaceTemplate(coverageProject, runSettingsTemplate, fccMsTestAdapterPath);
+                var (replaceableTemplate, customTemplatePath) = GetRunSettingsTemplate(projectDirectory, solutionDirectory);
+                var templateReplaceResult = ReplaceTemplate(coverageProject, replaceableTemplate, fccMsTestAdapterPath);
 
                 return new TemplatedCoverageProjectRunSettingsResult
                 {
@@ -143,28 +143,28 @@ string fccMsTestAdapterPath
             }).ToList();
         }
 
-        private (string Template, string CustomPath) GetRunSettingsTemplate(string projectDirectory, string solutionDirectory)
+        private (string ReplaceableTemplate, string CustomPath) GetRunSettingsTemplate(string projectDirectory, string solutionDirectory)
         {
             string customPath = null;
-            string template;
+            string replaceableTemplate;
             var customRunSettingsTemplateDetails = customRunSettingsTemplateProvider.Provide(projectDirectory, solutionDirectory);
             if (customRunSettingsTemplateDetails != null)
             {
                 customPath = customRunSettingsTemplateDetails.Path;
-                template = runSettingsTemplate.ConfigureCustom(customRunSettingsTemplateDetails.Template);
+                replaceableTemplate = runSettingsTemplate.ConfigureCustom(customRunSettingsTemplateDetails.Template);
             }
             else
             {
-                template = runSettingsTemplate.ToString();
+                replaceableTemplate = runSettingsTemplate.Get();
             }
-            return (template, customPath);
+            return (replaceableTemplate, customPath);
         }
 
-        private ITemplateReplacementResult ReplaceTemplate(ICoverageProject coverageProject, string runSettingsTemplate, string fccMsTestAdapterPath)
+        private ITemplateReplacementResult ReplaceTemplate(ICoverageProject coverageProject, string replaceableTemplate, string fccMsTestAdapterPath)
         {
             var replacements = runSettingsTemplateReplacementsFactory.Create(coverageProject, fccMsTestAdapterPath);
 
-            return this.runSettingsTemplate.ReplaceTemplate(runSettingsTemplate, replacements, coverageProject.IsDotNetFramework);
+            return this.runSettingsTemplate.ReplaceTemplate(replaceableTemplate, replacements, coverageProject.IsDotNetFramework);
         }
 
         public Task CleanUpAsync(List<ICoverageProject> coverageProjects)