Merge pull request #4756 from devlead/feature/gh-4456

GH4456: DotNetMSBuild Use MSBuild /verbosity not dotnet --verbosity

Author: devlead

src/Cake.Common.Tests/Unit/Tools/DotNet/MSBuild/DotNetMSBuildBuilderTests.cs

@@ -1,4 +1,4 @@
-// Licensed to the .NET Foundation under one or more agreements.
+// Licensed to the .NET Foundation under one or more agreements.
 // The .NET Foundation licenses this file to you under the MIT license.
 // See the LICENSE file in the project root for more information.
 
@@ -911,6 +911,26 @@ public void Should_Add_Host_Arguments()
                 Assert.Equal("--diagnostics msbuild", result.Args);
             }
 
+            [Theory]
+            [InlineData(DotNetVerbosity.Quiet, "/verbosity:quiet")]
+            [InlineData(DotNetVerbosity.Minimal, "/verbosity:minimal")]
+            [InlineData(DotNetVerbosity.Normal, "/verbosity:normal")]
+            [InlineData(DotNetVerbosity.Detailed, "/verbosity:detailed")]
+            [InlineData(DotNetVerbosity.Diagnostic, "/verbosity:diagnostic")]
+            public void Should_Use_MSBuild_Verbosity_Not_DotNet_Verbosity_When_Verbosity_Is_Specified(DotNetVerbosity verbosity, string expectedMsBuildVerbosity)
+            {
+                // Given: DotNetMSBuildSettings.Verbosity (not ConsoleLoggerSettings) causes MSB1016 if passed as dotnet --verbosity
+                var fixture = new DotNetMSBuildBuilderFixture();
+                fixture.Settings.Verbosity = verbosity;
+
+                // When
+                var result = fixture.Run();
+
+                // Then: must use MSBuild /verbosity switch, not dotnet --verbosity (see https://github.com/cake-build/cake/issues/4456)
+                Assert.Contains(expectedMsBuildVerbosity, result.Args);
+                Assert.DoesNotContain("--verbosity", result.Args);
+            }
+
             [Fact]
             public void Should_Use_Node_Reuse_If_Specified()
             {

src/Cake.Common/Tools/DotNet/MSBuild/DotNetMSBuildBuilder.cs

@@ -1,4 +1,4 @@
-// Licensed to the .NET Foundation under one or more agreements.
+// Licensed to the .NET Foundation under one or more agreements.
 // The .NET Foundation licenses this file to you under the MIT license.
 // See the LICENSE file in the project root for more information.
 
@@ -13,6 +13,10 @@ namespace Cake.Common.Tools.DotNet.MSBuild
     /// <summary>
     /// .NET Core project builder.
     /// </summary>
+    /// <remarks>
+    /// Verbosity is passed as MSBuild /verbosity (not dotnet --verbosity) because dotnet msbuild forwards
+    /// arguments to MSBuild, which does not accept the dotnet CLI --verbosity form and fails with MSB1016.
+    /// </remarks>
     public sealed class DotNetMSBuildBuilder : DotNetTool<DotNetMSBuildSettings>
     {
         private readonly ICakeEnvironment _environment;
@@ -39,13 +43,18 @@ public DotNetMSBuildBuilder(
         /// <param name="projectOrDirectory">The target project path.</param>
         /// <param name="settings">The settings.</param>
         /// <param name="standardOutputAction">The action to invoke with the standard output.</param>
+        /// <remarks>
+        /// Calls Run directly so that dotnet --verbosity is not appended (it would cause MSB1016);
+        /// verbosity is passed as MSBuild /verbosity in the arguments instead.
+        /// </remarks>
         public void Build(string projectOrDirectory, DotNetMSBuildSettings settings, Action<IEnumerable<string>> standardOutputAction)
         {
             ArgumentNullException.ThrowIfNull(settings);
 
-            RunCommand(
+            var arguments = GetArguments(projectOrDirectory, settings);
+            Run(
                 settings,
-                GetArguments(projectOrDirectory, settings),
+                arguments,
                 standardOutputAction == null ? null : new ProcessSettings { RedirectStandardOutput = true },
                 standardOutputAction == null ? null : new Action<IProcess>(process => standardOutputAction(process.GetStandardOutput())));
         }

src/Cake.Common/Tools/DotNet/MSBuild/MSBuildArgumentBuilderExtensions.cs

@@ -1,4 +1,4 @@
-// Licensed to the .NET Foundation under one or more agreements.
+// Licensed to the .NET Foundation under one or more agreements.
 // The .NET Foundation licenses this file to you under the MIT license.
 // See the LICENSE file in the project root for more information.
 
@@ -41,6 +41,12 @@ public static void AppendMSBuildSettings(this ProcessArgumentBuilder builder, Do
 
             var msBuilder = new ProcessArgumentBuilder();
 
+            // Verbosity: use MSBuild /verbosity switch (dotnet msbuild does not support --verbosity; it forwards to MSBuild which expects /verbosity:x)
+            if (settings.Verbosity.HasValue)
+            {
+                msBuilder.AppendMSBuildSwitch("verbosity", GetMSBuildVerbosityValue(settings.Verbosity.Value));
+            }
+
             // Got any targets?
             if (settings.Targets.Any())
             {
@@ -288,6 +294,20 @@ private static string GetLoggerArgument(int index, MSBuildFileLoggerSettings log
             return $"/fileLogger{counter} /fileloggerparameters{counter}:{parameters}";
         }
 
+        /// <summary>
+        /// Maps <see cref="DotNet.DotNetVerbosity"/> to MSBuild verbosity string (quiet, minimal, normal, detailed, diagnostic).
+        /// </summary>
+        private static string GetMSBuildVerbosityValue(DotNet.DotNetVerbosity verbosity)
+            => verbosity switch
+            {
+                DotNet.DotNetVerbosity.Quiet => "quiet",
+                DotNet.DotNetVerbosity.Minimal => "minimal",
+                DotNet.DotNetVerbosity.Normal => "normal",
+                DotNet.DotNetVerbosity.Detailed => "detailed",
+                DotNet.DotNetVerbosity.Diagnostic => "diagnostic",
+                _ => throw new ArgumentOutOfRangeException(nameof(verbosity), verbosity, "Invalid value"),
+            };
+
         private static string GetToolVersionValue(MSBuildVersion toolVersion)
         {
             switch (toolVersion)

tests/integration/Cake.Common/Tools/DotNet/DotNetAliases.cake

@@ -216,8 +216,8 @@ Task("Cake.Common.Tools.DotNet.DotNetAliases.DotNetMSBuild")
     var project = path.CombineWithFilePath("hwapp/hwapp.csproj");
     var assembly = path.CombineWithFilePath("hwapp/bin/Debug/net10.0/hwapp.dll");
 
-    // When
-    DotNetMSBuild(project.FullPath);
+    // When (Verbosity.Quiet exercises MSBuild /verbosity, not dotnet --verbosity; see https://github.com/cake-build/cake/issues/4456)
+    DotNetMSBuild(project.FullPath, new DotNetMSBuildSettings { Verbosity = DotNetVerbosity.Quiet });
 
     // Then
     Assert.True(System.IO.File.Exists(assembly.FullPath));