Add MSBuild logger

src/Microsoft.Sbom.Extensions.DependencyInjection/MSBuildLogger.cs

@@ -0,0 +1,47 @@
+// Copyright (c) Microsoft. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+
+namespace Microsoft.Sbom.Extensions.DependencyInjection;
+
+using System;
+using Microsoft.Build.Framework;
+using Microsoft.Build.Utilities;
+using Serilog;
+using Serilog.Events;
+using ILogger = Serilog.ILogger;
+
+/// <summary>
+/// A class to remap Errors logged from ComponentDetection assemblies to Warnings.
+/// </summary>
+public class MSBuildLogger : ILogger
+{
+    private readonly TaskLoggingHelper loggingHelper;
+
+    public MSBuildLogger(TaskLoggingHelper loggingHelperToWrap)
+    {
+        loggingHelper = loggingHelperToWrap;
+    }
+
+    public void Write(LogEvent logEvent)
+    {
+        var logLevel = logEvent.Level;
+        switch (logLevel)
+        {
+            case LogEventLevel.Debug:
+                loggingHelper.LogMessage(MessageImportance.Low, logEvent.RenderMessage());
+                break;
+            case LogEventLevel.Information:
+                loggingHelper.LogMessage(MessageImportance.High, logEvent.RenderMessage());
+                break;
+            case LogEventLevel.Warning:
+                loggingHelper.LogWarning(logEvent.RenderMessage());
+                break;
+            case LogEventLevel.Error:
+            case LogEventLevel.Fatal:
+                loggingHelper.LogError(logEvent.RenderMessage());
+                break;
+            default:
+                break;
+        }
+    }
+}

src/Microsoft.Sbom.Extensions.DependencyInjection/Microsoft.Sbom.Extensions.DependencyInjection.csproj

@@ -18,6 +18,7 @@
 
   <ItemGroup>
     <PackageReference Include="AutoMapper.Extensions.Microsoft.DependencyInjection" />
+    <PackageReference Include="Microsoft.Build.Utilities.Core" />
     <PackageReference Include="Microsoft.Extensions.Hosting" />
     <PackageReference Include="Microsoft.Extensions.Http" />
     <PackageReference Include="Scrutor" />

src/Microsoft.Sbom.Extensions.DependencyInjection/ServiceCollectionExtensions.cs

@@ -2,6 +2,7 @@
 // Licensed under the MIT license. See LICENSE file in the project root for full license information.
 
 using System.Collections.Concurrent;
+using Microsoft.Build.Utilities;
 using Microsoft.ComponentDetection.Orchestrator;
 using Microsoft.ComponentDetection.Orchestrator.Extensions;
 using Microsoft.Extensions.DependencyInjection;
@@ -59,15 +60,15 @@ public static IServiceCollection AddSbomConfiguration(this IServiceCollection se
         return services;
     }
 
-    public static IServiceCollection AddSbomTool(this IServiceCollection services, LogEventLevel logLevel = LogEventLevel.Information)
+    public static IServiceCollection AddSbomTool(this IServiceCollection services, LogEventLevel logLevel = LogEventLevel.Information, TaskLoggingHelper? taskLoggingHelper = null)
     {
         services
             .AddSingleton<IConfiguration, Configuration>()
-            .AddTransient(_ => FileSystemUtilsProvider.CreateInstance(CreateLogger(logLevel)))
+            .AddTransient(_ => FileSystemUtilsProvider.CreateInstance(CreateLogger(logLevel, taskLoggingHelper)))
             .AddTransient(x =>
             {
                 logLevel = x.GetService<InputConfiguration>()?.Verbosity?.Value ?? logLevel;
-                return Log.Logger = CreateLogger(logLevel);
+                return Log.Logger = CreateLogger(logLevel, taskLoggingHelper);
             })
             .AddTransient<IWorkflow<SbomParserBasedValidationWorkflow>, SbomParserBasedValidationWorkflow>()
             .AddTransient<IWorkflow<SbomGenerationWorkflow>, SbomGenerationWorkflow>()
@@ -200,26 +201,33 @@ public static IServiceCollection ConfigureLoggingProviders(this IServiceCollecti
         return services;
     }
 
-    private static ILogger CreateLogger(LogEventLevel logLevel)
+    private static ILogger CreateLogger(LogEventLevel logLevel, TaskLoggingHelper? taskLoggingHelper = null)
     {
-        return new RemapComponentDetectionErrorsToWarningsLogger(
-            new LoggerConfiguration()
-                .MinimumLevel.ControlledBy(new LoggingLevelSwitch { MinimumLevel = logLevel })
-                .Filter.ByExcluding(Matching.FromSource("System.Net.Http.HttpClient"))
-                .Enrich.With<LoggingEnricher>()
-                .Enrich.FromLogContext()
-                .WriteTo.Map(
-                    LoggingEnricher.LogFilePathPropertyName,
-                    (logFilePath, wt) => wt.Async(x => x.File($"{logFilePath}")),
-                    1) // sinkMapCountLimit
-                .WriteTo.Map<bool>(
-                    LoggingEnricher.PrintStderrPropertyName,
-                    (printLogsToStderr, wt) => wt.Logger(lc => lc
-                        .WriteTo.Console(outputTemplate: Constants.LoggerTemplate, standardErrorFromLevel: printLogsToStderr ? LogEventLevel.Debug : null)
+        if (taskLoggingHelper == null)
+        {
+            return new RemapComponentDetectionErrorsToWarningsLogger(
+                new LoggerConfiguration()
+                    .MinimumLevel.ControlledBy(new LoggingLevelSwitch { MinimumLevel = logLevel })
+                    .Filter.ByExcluding(Matching.FromSource("System.Net.Http.HttpClient"))
+                    .Enrich.With<LoggingEnricher>()
+                    .Enrich.FromLogContext()
+                    .WriteTo.Map(
+                        LoggingEnricher.LogFilePathPropertyName,
+                        (logFilePath, wt) => wt.Async(x => x.File($"{logFilePath}")),
+                        1) // sinkMapCountLimit
+                    .WriteTo.Map<bool>(
+                        LoggingEnricher.PrintStderrPropertyName,
+                        (printLogsToStderr, wt) => wt.Logger(lc => lc
+                            .WriteTo.Console(outputTemplate: Constants.LoggerTemplate, standardErrorFromLevel: printLogsToStderr ? LogEventLevel.Debug : null)
 
-                        // Don't write the detection times table from DetectorProcessingService to the console, only the log file
-                        .Filter.ByExcluding(Matching.WithProperty<string>("DetectionTimeLine", x => !string.IsNullOrEmpty(x)))),
-                    1) // sinkMapCountLimit
-                .CreateLogger());
+                            // Don't write the detection times table from DetectorProcessingService to the console, only the log file
+                            .Filter.ByExcluding(Matching.WithProperty<string>("DetectionTimeLine", x => !string.IsNullOrEmpty(x)))),
+                        1) // sinkMapCountLimit
+                    .CreateLogger());
+        }
+        else
+        {
+            return new MSBuildLogger(taskLoggingHelper);
+        }
     }
 }

src/Microsoft.Sbom.Targets/GenerateSbomTask.cs

@@ -19,8 +19,9 @@ namespace Microsoft.Sbom.Targets;
 using Microsoft.Sbom.Contracts.Interfaces;
 using Microsoft.Sbom.Extensions;
 using Microsoft.Sbom.Extensions.DependencyInjection;
+using Serilog.Events;
 using SPDX22 = Microsoft.Sbom.Parsers.Spdx22SbomParser;
-using SPDX30= Microsoft.Sbom.Parsers.Spdx30SbomParser;
+using SPDX30 = Microsoft.Sbom.Parsers.Spdx30SbomParser;
 
 /// <summary>
 /// MSBuild task for generating SBOMs from build output.
@@ -34,10 +35,11 @@ public partial class GenerateSbom : Task
     /// </summary>
     public GenerateSbom()
     {
+        var taskLoggingHelper = new TaskLoggingHelper(this);
         var host = Host.CreateDefaultBuilder()
             .ConfigureServices((host, services) =>
                 services
-                .AddSbomTool()
+                .AddSbomTool(LogEventLevel.Information, taskLoggingHelper)
                 /* Manually adding some dependencies since `AddSbomTool()` does not add them when
                  * running the MSBuild Task from another project.
                  */
@@ -118,7 +120,7 @@ private IList<SbomSpecification> ValidateAndAssignSpecifications()
     {
         if (!string.IsNullOrWhiteSpace(this.ManifestInfo))
         {
-           return [SbomSpecification.Parse(this.ManifestInfo)];
+            return [SbomSpecification.Parse(this.ManifestInfo)];
         }
 
         return null;

src/Microsoft.Sbom.Tool/Microsoft.Sbom.Tool.csproj

@@ -24,5 +24,6 @@
   <ItemGroup>
     <PackageReference Include="AutoMapper.Extensions.Microsoft.DependencyInjection" />
     <PackageReference Include="Microsoft.Extensions.Hosting" />
+    <PackageReference Include="Microsoft.Build.Utilities.Core" />
   </ItemGroup>
 </Project>