simplified GitVersionTaskBase

Author: arturcic

src/GitVersion.MsBuild.Tests/Helpers/MsBuildTaskFixture.cs

@@ -23,7 +23,7 @@ public MsBuildTaskFixtureResult<T> Execute<T>(T task) where T : GitVersionTaskBa
 
             task.VersionFile = versionFile;
 
-            var result = task.Execute();
+            var result = GitVersionTasks.Execute(task);
 
             return new MsBuildTaskFixtureResult<T>(fixture)
             {

src/GitVersion.MsBuild.Tests/Tasks/TestTaskBase.cs

@@ -1,10 +1,8 @@
 using GitVersion.Agents;
 using GitVersion.Configuration;
 using GitVersion.Core.Tests.Helpers;
-using GitVersion.Extensions;
 using GitVersion.Helpers;
 using GitVersion.MsBuild.Tests.Helpers;
-using GitVersion.Output;
 using LibGit2Sharp;
 using Microsoft.Build.Utilities.ProjectCreation;
 
@@ -22,7 +20,6 @@ protected static MsBuildTaskFixtureResult<T> ExecuteMsBuildTask<T>(T task) where
     {
         var fixture = CreateLocalRepositoryFixture();
         task.SolutionDirectory = fixture.RepositoryPath;
-        AddOverrides(task);
         var msbuildFixture = new MsBuildTaskFixture(fixture);
         var result = msbuildFixture.Execute(task);
         if (!result.Success) Console.WriteLine(result.Log);
@@ -46,7 +43,6 @@ protected static MsBuildTaskFixtureResult<T> ExecuteMsBuildTaskInAzurePipeline<T
     {
         var fixture = CreateRemoteRepositoryFixture();
         task.SolutionDirectory = fixture.LocalRepositoryFixture.RepositoryPath;
-        AddOverrides(task);
         var msbuildFixture = new MsBuildTaskFixture(fixture);
         var environmentVariables = env.ToList();
         if (buildNumber != null)
@@ -69,7 +65,6 @@ protected static MsBuildTaskFixtureResult<T> ExecuteMsBuildTaskInGitHubActions<T
     {
         var fixture = CreateRemoteRepositoryFixture();
         task.SolutionDirectory = fixture.LocalRepositoryFixture.RepositoryPath;
-        AddOverrides(task);
         var msbuildFixture = new MsBuildTaskFixture(fixture);
         msbuildFixture.WithEnv(new KeyValuePair<string, string?>("GITHUB_ACTIONS", "true"));
         var result = msbuildFixture.Execute(task);
@@ -92,12 +87,6 @@ protected static MsBuildExeFixtureResult ExecuteMsBuildExeInAzurePipeline(Action
         if (!result.MsBuild.OverallSuccess) Console.WriteLine(result.Output);
         return result;
     }
-    private static void AddOverrides(GitVersionTaskBase task) =>
-        task.WithOverrides(services =>
-        {
-            services.AddModule(new GitVersionBuildAgentsModule());
-            services.AddModule(new GitVersionOutputModule());
-        });
 
     private static EmptyRepositoryFixture CreateLocalRepositoryFixture()
     {

src/GitVersion.MsBuild/GitVersionTaskBase.cs

@@ -1,6 +1,5 @@
 using Microsoft.Build.Framework;
 using Microsoft.Build.Utilities;
-using Microsoft.Extensions.DependencyInjection;
 
 namespace GitVersion.MsBuild;
 
@@ -18,11 +17,5 @@ public abstract class GitVersionTaskBase : ITask
 
     public TaskLoggingHelper Log { get; }
 
-    public bool Execute() => OnExecute();
-
-    protected abstract bool OnExecute();
-
-    public Action<IServiceCollection>? Overrides { get; set; }
-
-    public void WithOverrides(Action<IServiceCollection> overrides) => Overrides = overrides;
+    public bool Execute() => GitVersionTasks.Execute(this);
 }

src/GitVersion.MsBuild/GitVersionTasks.cs

@@ -11,24 +11,27 @@ namespace GitVersion.MsBuild;
 
 internal static class GitVersionTasks
 {
-    public static bool GetVersion(GetVersion task) => ExecuteGitVersionTask(task, executor => executor.GetVersion(task));
-
-    public static bool UpdateAssemblyInfo(UpdateAssemblyInfo task) => ExecuteGitVersionTask(task, executor => executor.UpdateAssemblyInfo(task));
-
-    public static bool GenerateGitVersionInformation(GenerateGitVersionInformation task) => ExecuteGitVersionTask(task, executor => executor.GenerateGitVersionInformation(task));
-
-    public static bool WriteVersionInfoToBuildLog(WriteVersionInfoToBuildLog task) => ExecuteGitVersionTask(task, executor => executor.WriteVersionInfoToBuildLog(task));
+    public static bool Execute(GitVersionTaskBase task)
+    {
+        var serviceProvider = BuildServiceProvider(task);
+        var executor = serviceProvider.GetRequiredService<IGitVersionTaskExecutor>();
+        return task switch
+        {
+            GetVersion getVersion => ExecuteGitVersionTask(getVersion, () => executor.GetVersion(getVersion)),
+            UpdateAssemblyInfo updateAssemblyInfo => ExecuteGitVersionTask(updateAssemblyInfo, () => executor.UpdateAssemblyInfo(updateAssemblyInfo)),
+            GenerateGitVersionInformation generateGitVersionInformation => ExecuteGitVersionTask(generateGitVersionInformation, () => executor.GenerateGitVersionInformation(generateGitVersionInformation)),
+            WriteVersionInfoToBuildLog writeVersionInfoToBuildLog => ExecuteGitVersionTask(writeVersionInfoToBuildLog, () => executor.WriteVersionInfoToBuildLog(writeVersionInfoToBuildLog)),
+            _ => throw new NotSupportedException($"Task type {task.GetType().Name} is not supported")
+        };
+    }
 
-    private static bool ExecuteGitVersionTask<T>(T task, Action<IGitVersionTaskExecutor> action)
+    private static bool ExecuteGitVersionTask<T>(T task, Action action)
         where T : GitVersionTaskBase
     {
         var taskLog = task.Log;
         try
         {
-            var sp = BuildServiceProvider(task);
-            var gitVersionTaskExecutor = sp.GetRequiredService<IGitVersionTaskExecutor>();
-
-            action(gitVersionTaskExecutor);
+            action();
         }
         catch (WarningException errorException)
         {
@@ -75,7 +78,6 @@ private static IServiceProvider BuildServiceProvider(GitVersionTaskBase task)
         services.AddModule(new GitVersionOutputModule());
         services.AddModule(new GitVersionMsBuildModule());
         services.AddSingleton<IConsole>(new MsBuildAdapter(task.Log));
-        task.Overrides?.Invoke(services);
 
         var sp = services.BuildServiceProvider();
         Configure(sp, task);

src/GitVersion.MsBuild/PublicAPI.Shipped.txt

@@ -1,5 +1,4 @@
 #nullable enable
-abstract GitVersion.MsBuild.GitVersionTaskBase.OnExecute() -> bool
 GitVersion.MsBuild.GitVersionMsBuildModule
 GitVersion.MsBuild.GitVersionMsBuildModule.GitVersionMsBuildModule() -> void
 GitVersion.MsBuild.GitVersionMsBuildModule.RegisterTypes(Microsoft.Extensions.DependencyInjection.IServiceCollection! services) -> void
@@ -11,13 +10,10 @@ GitVersion.MsBuild.GitVersionTaskBase.GitVersionTaskBase() -> void
 GitVersion.MsBuild.GitVersionTaskBase.HostObject.get -> Microsoft.Build.Framework.ITaskHost!
 GitVersion.MsBuild.GitVersionTaskBase.HostObject.set -> void
 GitVersion.MsBuild.GitVersionTaskBase.Log.get -> Microsoft.Build.Utilities.TaskLoggingHelper!
-GitVersion.MsBuild.GitVersionTaskBase.Overrides.get -> System.Action<Microsoft.Extensions.DependencyInjection.IServiceCollection!>?
-GitVersion.MsBuild.GitVersionTaskBase.Overrides.set -> void
 GitVersion.MsBuild.GitVersionTaskBase.SolutionDirectory.get -> string!
 GitVersion.MsBuild.GitVersionTaskBase.SolutionDirectory.set -> void
 GitVersion.MsBuild.GitVersionTaskBase.VersionFile.get -> string!
 GitVersion.MsBuild.GitVersionTaskBase.VersionFile.set -> void
-GitVersion.MsBuild.GitVersionTaskBase.WithOverrides(System.Action<Microsoft.Extensions.DependencyInjection.IServiceCollection!>! overrides) -> void
 GitVersion.MsBuild.Tasks.GenerateGitVersionInformation
 GitVersion.MsBuild.Tasks.GenerateGitVersionInformation.GenerateGitVersionInformation() -> void
 GitVersion.MsBuild.Tasks.GenerateGitVersionInformation.GitVersionInformationFilePath.get -> string!
@@ -98,7 +94,3 @@ GitVersion.MsBuild.Tasks.UpdateAssemblyInfo.ProjectFile.set -> void
 GitVersion.MsBuild.Tasks.UpdateAssemblyInfo.UpdateAssemblyInfo() -> void
 GitVersion.MsBuild.Tasks.WriteVersionInfoToBuildLog
 GitVersion.MsBuild.Tasks.WriteVersionInfoToBuildLog.WriteVersionInfoToBuildLog() -> void
-override GitVersion.MsBuild.Tasks.GenerateGitVersionInformation.OnExecute() -> bool
-override GitVersion.MsBuild.Tasks.GetVersion.OnExecute() -> bool
-override GitVersion.MsBuild.Tasks.UpdateAssemblyInfo.OnExecute() -> bool
-override GitVersion.MsBuild.Tasks.WriteVersionInfoToBuildLog.OnExecute() -> bool

src/GitVersion.MsBuild/Tasks/GenerateGitVersionInformation.cs

@@ -19,6 +19,4 @@ public class GenerateGitVersionInformation : GitVersionTaskBase
 
     [Output]
     public string GitVersionInformationFilePath { get; set; }
-
-    protected override bool OnExecute() => GitVersionTasks.GenerateGitVersionInformation(this);
 }

src/GitVersion.MsBuild/Tasks/GetVersion.cs

@@ -78,6 +78,4 @@ public class GetVersion : GitVersionTaskBase
 
     [Output]
     public string UncommittedChanges { get; set; }
-
-    protected override bool OnExecute() => GitVersionTasks.GetVersion(this);
 }

src/GitVersion.MsBuild/Tasks/UpdateAssemblyInfo.cs

@@ -18,6 +18,4 @@ public class UpdateAssemblyInfo : GitVersionTaskBase
 
     [Output]
     public string AssemblyInfoTempFilePath { get; set; }
-
-    protected override bool OnExecute() => GitVersionTasks.UpdateAssemblyInfo(this);
 }

src/GitVersion.MsBuild/Tasks/WriteVersionInfoToBuildLog.cs

@@ -1,6 +1,3 @@
 namespace GitVersion.MsBuild.Tasks;
 
-public class WriteVersionInfoToBuildLog : GitVersionTaskBase
-{
-    protected override bool OnExecute() => GitVersionTasks.WriteVersionInfoToBuildLog(this);
-}
+public class WriteVersionInfoToBuildLog : GitVersionTaskBase;