refactor(logging): Integrate Serilog with MS.Extensions.Hosting

Removes static logging configuration and enables dynamic verbosity control through an injectable `LoggingLevelSwitch`

Author: arturcic

src/Directory.Packages.props

@@ -18,7 +18,7 @@
         <PackageVersion Include="Microsoft.Extensions.Logging.Abstractions" Version="10.0.3" />
         <PackageVersion Include="Microsoft.IO.Redist" Version="6.1.3" />
         <PackageVersion Include="Serilog" Version="4.3.0" />
-        <PackageVersion Include="Serilog.Extensions.Logging" Version="10.0.0" />
+        <PackageVersion Include="Serilog.Extensions.Hosting" Version="10.0.0" />
         <PackageVersion Include="Serilog.Sinks.Console" Version="6.1.1" />
         <PackageVersion Include="Serilog.Sinks.File" Version="7.0.0" />
         <PackageVersion Include="Serilog.Sinks.Map" Version="2.0.0" />

src/GitVersion.App.Tests/ArgumentParserOnBuildServerTests.cs

@@ -31,6 +31,7 @@ public void EmptyMeansUseCurrentDirectory()
         arguments.TargetPath.ShouldBe(SysEnv.CurrentDirectory);
         arguments.LogFilePath.ShouldBe(null);
         arguments.IsHelp.ShouldBe(false);
+        arguments.NoFetch.ShouldBe(false);
     }
 
     [Test]
@@ -737,22 +738,22 @@ public void NocacheTrueWhenDefined()
         arguments.NoCache.ShouldBe(true);
     }
 
-    [TestCase("-verbosity x", true, Verbosity.Normal)]
-    [TestCase("-verbosity diagnostic", false, Verbosity.Diagnostic)]
-    [TestCase("-verbosity Minimal", false, Verbosity.Minimal)]
-    [TestCase("-verbosity NORMAL", false, Verbosity.Normal)]
-    [TestCase("-verbosity quiet", false, Verbosity.Quiet)]
-    [TestCase("-verbosity Verbose", false, Verbosity.Verbose)]
+    [TestCase("x", true, Verbosity.Normal)]
+    [TestCase("diagnostic", false, Verbosity.Diagnostic)]
+    [TestCase("Minimal", false, Verbosity.Minimal)]
+    [TestCase("NORMAL", false, Verbosity.Normal)]
+    [TestCase("quiet", false, Verbosity.Quiet)]
+    [TestCase("Verbose", false, Verbosity.Verbose)]
     public void CheckVerbosityParsing(string command, bool shouldThrow, Verbosity expectedVerbosity)
     {
         if (shouldThrow)
         {
-            Assert.Throws<WarningException>(() => this.argumentParser.ParseArguments(command));
+            Assert.Throws<WarningException>(() => ArgumentParser.ParseVerbosity(command));
         }
         else
         {
-            var arguments = this.argumentParser.ParseArguments(command);
-            arguments.Verbosity.ShouldBe(expectedVerbosity);
+            var verbosity = ArgumentParser.ParseVerbosity(command);
+            verbosity.ShouldBe(expectedVerbosity);
         }
     }
 

src/GitVersion.App.Tests/ArgumentParserTests.cs

@@ -28,7 +28,7 @@ public void AllArgsAreInHelp()
 
             { nameof(Arguments.Diag) , "/diag" },
             { nameof(Arguments.LogFilePath) , "/l" },
-            { nameof(Arguments.Verbosity), "/verbosity" },
+            { "verbosity", "/verbosity" },
             { nameof(Arguments.Output) , "/output" },
             { nameof(Arguments.OutputFile) , "/outputfile" },
             { nameof(Arguments.ShowVariable), "/showvariable" },

src/GitVersion.App.Tests/HelpWriterTests.cs

@@ -1,32 +1,45 @@
 using System.IO.Abstractions;
-using GitVersion.Agents;
 using GitVersion.Extensions;
 using GitVersion.FileSystemGlobbing;
 using GitVersion.Helpers;
+using GitVersion.Logging;
 using GitVersion.OutputVariables;
+using Serilog.Core;
+using Serilog.Events;
 
 namespace GitVersion;
 
-internal class ArgumentParser(IEnvironment environment,
-                              IFileSystem fileSystem,
-                              ICurrentBuildAgent buildAgent,
-                              IConsole console,
-                              IHelpWriter helpWriter,
-                              IVersionWriter versionWriter,
-                              IGlobbingResolver globbingResolver)
+internal class ArgumentParser(
+    IEnvironment environment,
+    IFileSystem fileSystem,
+    IConsole console,
+    IHelpWriter helpWriter,
+    IVersionWriter versionWriter,
+    IGlobbingResolver globbingResolver,
+    LoggingLevelSwitch loggingLevelSwitch
+)
     : IArgumentParser
 {
     private readonly IEnvironment environment = environment.NotNull();
     private readonly IFileSystem fileSystem = fileSystem.NotNull();
-    private readonly ICurrentBuildAgent buildAgent = buildAgent.NotNull();
     private readonly IConsole console = console.NotNull();
     private readonly IHelpWriter helpWriter = helpWriter.NotNull();
     private readonly IVersionWriter versionWriter = versionWriter.NotNull();
     private readonly IGlobbingResolver globbingResolver = globbingResolver.NotNull();
+    private readonly LoggingLevelSwitch loggingLevelSwitch = loggingLevelSwitch.NotNull();
 
     private const string defaultOutputFileName = "GitVersion.json";
     private static readonly IEnumerable<string> availableVariables = GitVersionVariables.AvailableVariables;
 
+    private static readonly Dictionary<Verbosity, LogEventLevel> VerbosityMaps = new()
+    {
+        { Verbosity.Verbose, LogEventLevel.Verbose },
+        { Verbosity.Diagnostic, LogEventLevel.Debug },
+        { Verbosity.Normal, LogEventLevel.Information },
+        { Verbosity.Minimal, LogEventLevel.Warning },
+        { Verbosity.Quiet, LogEventLevel.Error }
+    };
+
     public Arguments ParseArguments(string commandLineArguments)
     {
         var arguments = QuotedStringHelpers.SplitUnquoted(commandLineArguments, ' ');
@@ -47,8 +60,6 @@ public Arguments ParseArguments(string[] commandLineArguments)
 
             AddAuthentication(args);
 
-            args.NoFetch = this.buildAgent.PreventFetch();
-
             return args;
         }
 
@@ -57,20 +68,14 @@ public Arguments ParseArguments(string[] commandLineArguments)
         if (firstArgument.IsHelp())
         {
             this.helpWriter.Write();
-            return new Arguments
-            {
-                IsHelp = true
-            };
+            return new Arguments { IsHelp = true };
         }
 
         if (firstArgument.IsSwitch("version"))
         {
             var assembly = Assembly.GetExecutingAssembly();
             this.versionWriter.Write(assembly);
-            return new Arguments
-            {
-                IsVersion = true
-            };
+            return new Arguments { IsVersion = true };
         }
 
         var arguments = new Arguments();
@@ -103,7 +108,6 @@ public Arguments ParseArguments(string[] commandLineArguments)
         arguments.TargetPath = arguments.TargetPath.TrimEnd('/', '\\');
 
         if (!arguments.EnsureAssemblyInfo) arguments.UpdateAssemblyInfoFileName = ResolveFiles(arguments.TargetPath, arguments.UpdateAssemblyInfoFileName).ToHashSet();
-        arguments.NoFetch = arguments.NoFetch || this.buildAgent.PreventFetch();
 
         ValidateConfigurationFile(arguments);
 
@@ -203,7 +207,7 @@ private void ParseTargetPath(Arguments arguments, string? name, IReadOnlyList<st
         throw new WarningException(couldNotParseMessage);
     }
 
-    private static bool ParseSwitches(Arguments arguments, string? name, IReadOnlyList<string>? values, string? value)
+    private bool ParseSwitches(Arguments arguments, string? name, IReadOnlyList<string>? values, string? value)
     {
         if (name.IsSwitch("l"))
         {
@@ -291,7 +295,8 @@ private static bool ParseSwitches(Arguments arguments, string? name, IReadOnlyLi
 
         if (name.IsSwitch("verbosity"))
         {
-            ParseVerbosity(arguments, value);
+            var verbosity = ParseVerbosity(value);
+            loggingLevelSwitch.MinimumLevel = VerbosityMaps[verbosity];
             return true;
         }
 
@@ -436,12 +441,14 @@ private static void ParseOutput(Arguments arguments, IEnumerable<string>? values
         }
     }
 
-    private static void ParseVerbosity(Arguments arguments, string? value)
+    internal static Verbosity ParseVerbosity(string? value)
     {
-        if (!Enum.TryParse(value, true, out arguments.Verbosity))
+        if (!Enum.TryParse(value, true, out Verbosity verbosity))
         {
             throw new WarningException($"Could not parse Verbosity value '{value}'");
         }
+
+        return verbosity;
     }
 
     private static void ParseOverrideConfig(Arguments arguments, IReadOnlyCollection<string>? values)
@@ -465,8 +472,10 @@ private static void ParseOverrideConfig(Arguments arguments, IReadOnlyCollection
             {
                 throw new WarningException($"Could not parse /overrideconfig option: {keyValueOption}. Unsupported 'key'.");
             }
+
             parser.SetValue(optionKey, keyAndValue[1]);
         }
+
         arguments.OverrideConfiguration = parser.GetOverrideConfiguration();
     }
 
@@ -505,6 +514,7 @@ private static void ParseUpdateAssemblyInfo(Arguments arguments, string? value,
         {
             throw new WarningException("Cannot specify both updateprojectfiles and updateassemblyinfo in the same run. Please rerun GitVersion with only one parameter");
         }
+
         if (arguments.UpdateAssemblyInfoFileName.Count > 1 && arguments.EnsureAssemblyInfo)
         {
             throw new WarningException("Can't specify multiple assembly info files when using -ensureassemblyinfo switch, either use a single assembly info file or do not specify -ensureassemblyinfo and create assembly info files manually");
@@ -546,6 +556,7 @@ private static void ParseUpdateProjectInfo(Arguments arguments, string? value, I
         {
             throw new WarningException("Cannot specify both updateassemblyinfo and updateprojectfiles in the same run. Please rerun GitVersion with only one parameter");
         }
+
         if (arguments.EnsureAssemblyInfo)
         {
             throw new WarningException("Cannot specify -ensureassemblyinfo with updateprojectfiles: please ensure your project file exists before attempting to update it");

src/GitVersion.App/ArgumentParser.cs

@@ -3,6 +3,7 @@
 
 namespace GitVersion;
 
+#pragma warning disable S1144
 internal static class ArgumentParserExtensions
 {
     private static readonly string[] TrueValues = ["1", "true"];
@@ -85,3 +86,4 @@ public bool ArgumentRequiresValue(int argumentIndex)
         }
     }
 }
+#pragma warning restore S1144

src/GitVersion.App/ArgumentParserExtensions.cs

@@ -1,5 +1,4 @@
 using GitVersion.Git;
-using GitVersion.Logging;
 
 namespace GitVersion;
 
@@ -32,7 +31,6 @@ internal class Arguments
     public string? Format;
     public string? OutputFile;
     public ISet<OutputType> Output = new HashSet<OutputType>();
-    public Verbosity Verbosity = Verbosity.Normal;
 
     public bool UpdateWixVersionFile;
     public bool UpdateProjectFiles;
@@ -94,7 +92,6 @@ public GitVersionOptions ToOptions()
             LogFilePath = LogFilePath,
             ShowVariable = ShowVariable,
             Format = Format,
-            Verbosity = Verbosity,
             Output = Output,
             OutputFile = OutputFile
         };

src/GitVersion.App/Arguments.cs

@@ -2,14 +2,24 @@
 using GitVersion.Configuration;
 using GitVersion.Extensions;
 using GitVersion.Output;
+using Serilog;
+using Serilog.Core;
 
 namespace GitVersion;
 
 internal static class CliHost
 {
     internal static HostApplicationBuilder CreateCliHostBuilder(string[] args)
     {
+        var bootstrapSwitch = new LoggingLevelSwitch();
+
+        Log.Logger = new LoggerConfiguration()
+            .MinimumLevel.ControlledBy(bootstrapSwitch)
+            .WriteTo.Console()
+            .CreateBootstrapLogger();
+
         var builder = Host.CreateApplicationBuilder(args);
+        builder.Services.AddSingleton(bootstrapSwitch);
 
         RegisterGitVersionModules(builder.Services, args);
 

src/GitVersion.App/CliHost.cs

@@ -1,5 +1,4 @@
 using GitVersion.Extensions;
-using GitVersion.Logging;
 
 namespace GitVersion;
 
@@ -17,8 +16,6 @@ public Task RunAsync(CancellationToken _)
         try
         {
             var gitVersionOptions = this.options.Value;
-            LoggingEnricher.Configure(gitVersionOptions);
-
             if (gitVersionOptions.IsHelp || gitVersionOptions.IsVersion)
             {
                 SysEnv.ExitCode = 0;

src/GitVersion.App/GitVersionApp.cs

@@ -3,6 +3,7 @@
 using GitVersion.Extensions;
 using GitVersion.Git;
 using GitVersion.Helpers;
+using Serilog;
 
 namespace GitVersion;
 
@@ -42,12 +43,7 @@ public int Execute(GitVersionOptions gitVersionOptions)
 
         if (exitCode != 0)
         {
-            // Inform user where to find detailed logs if a log file was configured
-            var logFilePath = gitVersionOptions.LogFilePath;
-            if (!logFilePath.IsNullOrWhiteSpace() && !logFilePath.Equals("console", StringComparison.OrdinalIgnoreCase))
-            {
-                this.console.WriteLine($"See log file for more details: {logFilePath}");
-            }
+            Log.CloseAndFlush();
         }
 
         return exitCode;