made WixVersionFileUpdater, GitVersionInformationGenerator injectable

Author: arturcic

src/GitVersionCore.Tests/WixFileTests.cs

@@ -56,12 +56,14 @@ public void UpdateWixVersionFile()
 
             var fileSystem = sp.GetService<IFileSystem>();
             var variableProvider = sp.GetService<IVariableProvider>();
-            var vars = variableProvider.GetVariablesFor(semVer, config, false);
+            var versionVariables = variableProvider.GetVariablesFor(semVer, config, false);
 
-            using var wixVersionFileUpdater = new WixVersionFileUpdater(workingDir, vars, fileSystem, log);
-            wixVersionFileUpdater.Update();
-            fileSystem.ReadAllText(wixVersionFileUpdater.WixVersionFile).
-                ShouldMatchApproved(c => c.SubFolder(Path.Combine("Approved")));
+            using var wixVersionFileUpdater = sp.GetService<IWixVersionFileUpdater>();
+
+            var file = wixVersionFileUpdater.Update(versionVariables, workingDir);
+            fileSystem
+                .ReadAllText(file)
+                .ShouldMatchApproved(c => c.SubFolder(Path.Combine("Approved")));
         }
     }
 }

src/GitVersionCore/Core/GitVersionTool.cs

@@ -14,26 +14,35 @@ namespace GitVersion
     public class GitVersionTool : IGitVersionTool
     {
         private readonly ILog log;
+        private readonly IFileSystem fileSystem;
         private readonly IGitVersionCache gitVersionCache;
         private readonly INextVersionCalculator nextVersionCalculator;
         private readonly IVariableProvider variableProvider;
         private readonly IGitVersionCacheKeyFactory cacheKeyFactory;
-        private readonly IFileSystem fileSystem;
+        private readonly IWixVersionFileUpdater wixVersionFileUpdater;
+        private readonly IGitVersionInformationGenerator gitVersionInformationGenerator;
+
         private readonly IOptions<Arguments> options;
         private readonly GitVersionContext context;
+
         private readonly IBuildServer buildServer;
 
-        public GitVersionTool(ILog log, IGitVersionCache gitVersionCache, INextVersionCalculator nextVersionCalculator, IVariableProvider variableProvider,
-            IGitVersionCacheKeyFactory cacheKeyFactory, IBuildServerResolver buildServerResolver, IFileSystem fileSystem,
+        public GitVersionTool(ILog log, IFileSystem fileSystem, IGitVersionCache gitVersionCache, INextVersionCalculator nextVersionCalculator, IVariableProvider variableProvider,
+            IGitVersionCacheKeyFactory cacheKeyFactory, IBuildServerResolver buildServerResolver,
+            IWixVersionFileUpdater wixVersionFileUpdater, IGitVersionInformationGenerator gitVersionInformationGenerator,
             IOptions<Arguments> options, IOptions<GitVersionContext> versionContext)
         {
             this.log = log ?? throw new ArgumentNullException(nameof(log));
+            this.fileSystem = fileSystem ?? throw new ArgumentNullException(nameof(fileSystem));
             this.gitVersionCache = gitVersionCache ?? throw new ArgumentNullException(nameof(gitVersionCache));
             this.nextVersionCalculator = nextVersionCalculator ?? throw new ArgumentNullException(nameof(nextVersionCalculator));
             this.variableProvider = variableProvider ?? throw new ArgumentNullException(nameof(variableProvider));
             this.options = options ?? throw new ArgumentNullException(nameof(options));
             this.cacheKeyFactory = cacheKeyFactory ?? throw new ArgumentNullException(nameof(cacheKeyFactory));
-            this.fileSystem = fileSystem ?? throw new ArgumentNullException(nameof(fileSystem));
+
+            this.wixVersionFileUpdater = wixVersionFileUpdater ?? throw new ArgumentNullException(nameof(wixVersionFileUpdater));
+            this.gitVersionInformationGenerator = gitVersionInformationGenerator ?? throw new ArgumentNullException(nameof(gitVersionInformationGenerator));
+
             context = versionContext.Value;
             buildServer = buildServerResolver.Resolve();
         }
@@ -107,15 +116,16 @@ public void UpdateWixVersionFile(VersionVariables variables)
 
             if (arguments.UpdateWixVersionFile)
             {
-                using var wixVersionFileUpdater = new WixVersionFileUpdater(arguments.TargetPath, variables, fileSystem, log);
-                wixVersionFileUpdater.Update();
+                using (wixVersionFileUpdater)
+                {
+                    wixVersionFileUpdater.Update(variables, arguments.TargetPath);
+                }
             }
         }
 
         public void GenerateGitVersionInformation(VersionVariables variables, FileWriteInfo fileWriteInfo)
         {
-            var generator = new GitVersionInformationGenerator(fileSystem);
-            generator.Generate(variables, fileWriteInfo);
+            gitVersionInformationGenerator.Generate(variables, fileWriteInfo);
         }
 
         private VersionVariables ExecuteInternal()

src/GitVersionCore/Extensions/GitVersionInformationResources/GitVersionInformationGenerator.cs

@@ -20,7 +20,12 @@ public FileWriteInfo(string workingDirectory, string fileName, string fileExtens
     }
 
 
-    public class GitVersionInformationGenerator
+    public interface IGitVersionInformationGenerator
+    {
+        void Generate(VersionVariables variables, FileWriteInfo writeInfo);
+    }
+
+    public class GitVersionInformationGenerator : IGitVersionInformationGenerator
     {
         private readonly IFileSystem fileSystem;
         private readonly TemplateManager templateManager;

src/GitVersionCore/Extensions/WixVersionFileUpdater.cs

@@ -7,38 +7,43 @@
 
 namespace GitVersion.Extensions
 {
-    public class WixVersionFileUpdater : IDisposable
+    public interface IWixVersionFileUpdater : IDisposable
+    {
+        string Update(VersionVariables variables, string workingDirectory);
+    }
+
+    public class WixVersionFileUpdater : IWixVersionFileUpdater
     {
-        private readonly VersionVariables variables;
         private readonly IFileSystem fileSystem;
         private readonly ILog log;
-        public string WixVersionFile { get; }
+        private string wixVersionFile;
         public const string WixVersionFileName = "GitVersion_WixVersion.wxi";
 
-        public WixVersionFileUpdater(string workingDirectory, VersionVariables variables, IFileSystem fileSystem, ILog log)
+        public WixVersionFileUpdater(IFileSystem fileSystem, ILog log)
         {
-            this.variables = variables;
             this.fileSystem = fileSystem ?? throw new ArgumentNullException(nameof(fileSystem));
             this.log = log ?? throw new ArgumentNullException(nameof(log));
-            WixVersionFile = Path.Combine(workingDirectory, WixVersionFileName);
         }
 
-        public void Update()
+        public string Update(VersionVariables variables, string workingDirectory)
         {
+            wixVersionFile = Path.Combine(workingDirectory, WixVersionFileName);
             log.Info("Updating GitVersion_WixVersion.wxi");
 
             var doc = new XmlDocument();
-            doc.LoadXml(GetWixFormatFromVersionVariables());
+            doc.LoadXml(GetWixFormatFromVersionVariables(variables));
 
             var xmlDecl = doc.CreateXmlDeclaration("1.0", "utf-8", null);
             var root = doc.DocumentElement;
             doc.InsertBefore(xmlDecl, root);
 
-            using var fs = fileSystem.OpenWrite(WixVersionFile);
+            using var fs = fileSystem.OpenWrite(wixVersionFile);
             doc.Save(fs);
+
+            return wixVersionFile;
         }
 
-        private string GetWixFormatFromVersionVariables()
+        private static string GetWixFormatFromVersionVariables(VersionVariables variables)
         {
             var builder = new StringBuilder();
             builder.Append("<Include xmlns=\"http://schemas.microsoft.com/wix/2006/wi\">\n");
@@ -54,7 +59,7 @@ private string GetWixFormatFromVersionVariables()
 
         public void Dispose()
         {
-            log.Info($"Done writing {WixVersionFile}");
+            log.Info($"Done writing {wixVersionFile}");
         }
     }
 }

src/GitVersionCore/GitVersionCoreModule.cs

@@ -3,6 +3,7 @@
 using GitVersion.Configuration;
 using GitVersion.Configuration.Init;
 using GitVersion.Extensions;
+using GitVersion.Extensions.GitVersionInformationResources;
 using GitVersion.Logging;
 using GitVersion.VersionCalculation;
 using GitVersion.VersionCalculation.Cache;
@@ -41,7 +42,8 @@ public void RegisterTypes(IServiceCollection services)
             services.AddSingleton<IGitPreparer, GitPreparer>();
             services.AddSingleton<IGitRepoMetadataProvider, GitRepoMetadataProvider>();
 
-            services.AddSingleton<IGitRepoMetadataProvider, GitRepoMetadataProvider>();
+            services.AddSingleton<IGitVersionInformationGenerator, GitVersionInformationGenerator>();
+            services.AddSingleton<IWixVersionFileUpdater, WixVersionFileUpdater>();
 
             services.AddSingleton(sp => sp.GetService<IConfigFileLocatorFactory>().Create());