Merge pull request #4806 from arturcic/feature/replace-logging-with-ms-extensions

Replace logging own implementation with withMicrosoft Extensions Logging

Author: arturcic

BREAKING_CHANGES.md

@@ -1,3 +1,26 @@
+## Unreleased
+
+### Logging System Replacement
+
+* The custom `ILog` logging abstraction has been replaced with the industry-standard `Microsoft.Extensions.Logging` (M.E.L.) infrastructure using Serilog as the underlying provider.
+
+* **Removed public types** from `GitVersion.Logging` namespace:
+  * `ILog` interface
+  * `ILogAppender` interface
+  * `LogLevel` enum
+  * `LogAction` delegate
+  * `LogActionEntry` delegate
+  * `LogExtensions` class
+
+* **Migration for custom integrations**:
+  * If you were injecting `ILog`, inject `ILogger<T>` instead
+  * If you implemented `ILogAppender`, implement `ILoggerProvider` instead
+  * The `Verbosity` enum is preserved for CLI usage and maps to Serilog log levels internally
+
+* **Preserved types**:
+  * `Verbosity` enum (Quiet/Minimal/Normal/Verbose/Diagnostic) - still used for CLI verbosity control
+  * `IConsole` interface - moved from `GitVersion.Logging` to `GitVersion` namespace
+
 ## v6.2.0
 
 * The configuration property `label-number-pattern` was removed. The functionality can be still used by changing the label and the branch name regular expression for pull-request branches.

src/Directory.Build.props

@@ -116,6 +116,8 @@
     <ItemGroup Label="MicrosoftExtensionsUsings">
         <Using Include="Microsoft.Extensions.DependencyInjection" />
         <Using Include="Microsoft.Extensions.DependencyInjection.Extensions" />
+        <Using Include="Microsoft.Extensions.Logging" />
+        <Using Include="Microsoft.Extensions.Logging.Abstractions" />
         <Using Include="Microsoft.Extensions.Options" />
     </ItemGroup>
 

src/Directory.Packages.props

@@ -14,7 +14,14 @@
         <PackageVersion Include="Microsoft.CSharp" Version="4.7.0" />
         <PackageVersion Include="Microsoft.Extensions.DependencyInjection" Version="10.0.3" />
         <PackageVersion Include="Microsoft.Extensions.DependencyInjection.Abstractions" Version="10.0.3" />
+        <PackageVersion Include="Microsoft.Extensions.Logging" Version="10.0.3" />
+        <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.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" />
         <PackageVersion Include="Polly" Version="8.6.5" />
         <PackageVersion Include="Roslynator.Analyzers" Version="4.15.0" />
         <PackageVersion Include="Roslynator.Formatting.Analyzers" Version="4.15.0" />
@@ -59,4 +66,4 @@
         <PackageVersion Include="Microsoft.Build.Tasks.Core" Version="18.0.2" />
         <PackageVersion Include="Microsoft.Build.Utilities.Core" Version="18.0.2" />
     </ItemGroup>
-</Project>
+</Project>

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

@@ -37,8 +37,8 @@ public void LogPathContainsForwardSlash()
     }
 
     [Theory]
-    [TestCase("", "INFO [")]
-    [TestCase("-verbosity NORMAL", "INFO [")]
+    [TestCase("", "INFO")]
+    [TestCase("-verbosity NORMAL", "INFO")]
     [TestCase("-verbosity quiet", "")]
     public void CheckBuildServerVerbosityConsole(string verbosityArg, string expectedOutput)
     {
@@ -80,7 +80,7 @@ public void WorkingDirectoryWithoutCommitsFailsWithInformativeMessage()
     {
         using var fixture = new EmptyRepositoryFixture();
 
-        var result = GitVersionHelper.ExecuteIn(fixture.RepositoryPath, null, false);
+        var result = GitVersionHelper.ExecuteIn(fixture.RepositoryPath, " /l console", false);
 
         result.ExitCode.ShouldNotBe(0);
         result.Output.ShouldNotBeNull();

src/GitVersion.App.Tests/ExecCmdLineArgumentTest.cs

@@ -18,7 +18,6 @@
     <ItemGroup>
         <Compile Include="..\GitVersion.Core.Tests\Helpers\TestConsoleAdapter.cs" Link="Helpers\TestConsoleAdapter.cs" />
         <Compile Include="..\GitVersion.Core.Tests\Helpers\TestEnvironment.cs" Link="Helpers\TestEnvironment.cs" />
-        <Compile Include="..\GitVersion.Core.Tests\Helpers\TestLogAppender.cs" Link="Helpers\TestLogAppender.cs" />
         <Compile Include="..\GitVersion.Core.Tests\Helpers\TestBase.cs" Link="Helpers\TestBase.cs" />
         <Compile Include="..\GitVersion.Core.Tests\Helpers\GitVersionCoreTestModule.cs" Link="Helpers\GitVersionCoreTestModule.cs" />
         <Compile Include="..\GitVersion.Core.Tests\Extensions\GitVersionVariablesExtensions.cs" Link="Extensions\GitVersionVariablesExtensions.cs" />

src/GitVersion.App.Tests/GitVersion.App.Tests.csproj

@@ -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,6 +1,5 @@
 using GitVersion.Core.Tests.Helpers;
 using GitVersion.Extensions;
-using GitVersion.Logging;
 
 namespace GitVersion.App.Tests;
 
@@ -17,8 +16,7 @@ public ProgramFixture(string workingDirectory = "")
     {
         this.workingDirectory = workingDirectory;
         var logBuilder = new StringBuilder();
-        var logAppender = new TestLogAppender(m => logBuilder.AppendLine(m));
-        ILog log = new Log(logAppender);
+        var testLoggerFactory = new TestLoggerFactory(m => logBuilder.AppendLine(m));
 
         var consoleBuilder = new StringBuilder();
         var consoleAdapter = new TestConsoleAdapter(consoleBuilder);
@@ -27,7 +25,8 @@ public ProgramFixture(string workingDirectory = "")
 
         WithOverrides(services =>
         {
-            services.AddSingleton(log);
+            services.AddSingleton<ILoggerFactory>(testLoggerFactory);
+            services.AddSingleton(typeof(ILogger<>), typeof(TestLogger<>));
             services.AddSingleton<IConsole>(consoleAdapter);
             services.AddSingleton<IEnvironment>(this.environment);
         });

src/GitVersion.App.Tests/Helpers/ProgramFixture.cs

@@ -1,33 +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, ' ');
@@ -48,8 +60,6 @@ public Arguments ParseArguments(string[] commandLineArguments)
 
             AddAuthentication(args);
 
-            args.NoFetch = this.buildAgent.PreventFetch();
-
             return args;
         }
 
@@ -58,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();
@@ -104,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);
 
@@ -204,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"))
         {
@@ -292,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;
         }
 
@@ -437,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)
@@ -466,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();
     }
 
@@ -506,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");
@@ -547,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");