When a tool fails, attempt to show lines that contain error information (#152)

Before this change, when there's an error with a tool it's unclear why
it's happening. Users must know to re-run with "--verbose" option to see
the error text.

After this change, here's what the output looks like when there's an
error in MakeAppx:
```
PS D:\temp\rigvgl1m.zgh> winapp.exe pack .
[ERROR] - MakeAppx : error: Error info: error C00CE169: App manifest validation error: The app manifest must be valid as per schema: Line 38, Column 7, Reason: 'InvalidValue' violates enumeration constraint of 'appContainer mediumIL'.
[ERROR] - The attribute '{http://schemas.microsoft.com/appx/manifest/uap/windows10/10}TrustLevel' with value 'InvalidValue' failed to parse.
[ERROR] - MakeAppx : error: Package creation failed.
[ERROR] - MakeAppx : error: 0x80080204 - The specified package format is not valid: The package manifest is not valid.
[ERROR] - makeappx.exe reported an error. The above text is only part of the tool output. Please re-run with --verbose to see the full output.
❌ Failed to create MSIX package: Failed to create MSIX package: makeappx.exe execution failed with exit code 1
```

Here's what it looks like when there's an error in MakePri:
```
PS D:\temp\rigvgl1m.zgh> winapp.exe pack .
[ERROR] - ERROR: PRI191: 0x80004005 - Appx manifest not found or is invalid. Please ensure well-formed manifest file is present. Or specify an index name with /in switch.
End tag 'InvalidEndTag' does not match the start tag 'InvalidTag'.


[ERROR] - makepri.exe reported an error. The above text is only part of the tool output. Please re-run with --verbose to see the full output.
❌ Failed to create MSIX package: Failed to create MSIX package: Failed to generate PRI file: makepri.exe execution failed with exit code -2147467259
```

---------

Co-authored-by: Nikola Metulev <[email protected]>
Co-authored-by: Alexandre Zollinger Chohfi <[email protected]>

Author: 3 people

src/winapp-CLI/WinApp.Cli.Tests/BuildToolsServiceTests.cs

@@ -1,6 +1,8 @@
 // Copyright (c) Microsoft Corporation. All rights reserved.
 // Licensed under the MIT License.
 
+using WinApp.Cli.Tools;
+
 namespace WinApp.Cli.Tests;
 
 [TestClass]
@@ -157,7 +159,7 @@ public async Task RunBuildToolAsync_WithValidTool_ReturnsOutput()
         File.WriteAllText(fakeToolPath, "@echo Hello from fake tool");
 
         // Act
-        var (stdout, stderr) = await _buildToolsService.RunBuildToolAsync("echo.cmd", "", TestContext.CancellationToken);
+        var (stdout, stderr) = await _buildToolsService.RunBuildToolAsync(new GenericTool("echo.cmd"), "", TestContext.CancellationToken);
 
         // Assert
         Assert.Contains("Hello from fake tool", stdout);
@@ -173,7 +175,7 @@ public async Task RunBuildToolAsync_WithNonExistentTool_ThrowsFileNotFoundExcept
         // Act & Assert
         await Assert.ThrowsExactlyAsync<FileNotFoundException>(async () =>
         {
-            await _buildToolsService.RunBuildToolAsync("nonexistent.exe", "", TestContext.CancellationToken);
+            await _buildToolsService.RunBuildToolAsync(new GenericTool("nonexistent.exe"), "", TestContext.CancellationToken);
         });
     }
 
@@ -320,7 +322,7 @@ public async Task RunBuildToolAsync_WithNoExistingPackage_AutoInstallsAndRuns()
         {
             // Create a simple batch command that outputs something
             // This will either succeed (if BuildTools installs successfully) or throw an exception
-            await _buildToolsService.RunBuildToolAsync("echo.cmd", "test", TestContext.CancellationToken);
+            await _buildToolsService.RunBuildToolAsync(new GenericTool("echo.cmd"), "test", TestContext.CancellationToken);
 
             // If we reach here, the auto-installation worked - test passes
         }
@@ -347,7 +349,7 @@ public async Task RunBuildToolAsync_WithExistingTool_RunsDirectly()
         File.WriteAllText(batchFile, "@echo Hello from test tool");
 
         // Act
-        var (stdout, stderr) = await _buildToolsService.RunBuildToolAsync("test.cmd", "", TestContext.CancellationToken);
+        var (stdout, stderr) = await _buildToolsService.RunBuildToolAsync(new GenericTool("test.cmd"), "", TestContext.CancellationToken);
 
         // Assert
         Assert.Contains("Hello from test tool", stdout);

src/winapp-CLI/WinApp.Cli/Services/BuildToolsService.cs

@@ -6,6 +6,7 @@
 using System.Text.RegularExpressions;
 using WinApp.Cli.Helpers;
 using WinApp.Cli.Models;
+using WinApp.Cli.Tools;
 
 namespace WinApp.Cli.Services;
 
@@ -285,16 +286,16 @@ public async Task<FileInfo> EnsureBuildToolAvailableAsync(string toolName, Cance
     /// <summary>
     /// Execute a build tool with the specified arguments
     /// </summary>
-    /// <param name="toolName">Name of the tool (e.g., 'mt.exe', 'signtool.exe')</param>
+    /// <param name="tool">The tool to execute</param>
     /// <param name="arguments">Arguments to pass to the tool</param>
     /// <param name="cancellationToken">Cancellation token</param>
     /// <returns>Tuple containing (stdout, stderr)</returns>
-    public async Task<(string stdout, string stderr)> RunBuildToolAsync(string toolName, string arguments, CancellationToken cancellationToken = default)
+    public async Task<(string stdout, string stderr)> RunBuildToolAsync(Tool tool, string arguments, CancellationToken cancellationToken = default)
     {
         cancellationToken.ThrowIfCancellationRequested();
 
         // Ensure the build tool is available, installing BuildTools if necessary
-        var toolPath = await EnsureBuildToolAvailableAsync(toolName, cancellationToken: cancellationToken);
+        var toolPath = await EnsureBuildToolAvailableAsync(tool.ExecutableName, cancellationToken: cancellationToken);
 
         var psi = new ProcessStartInfo
         {
@@ -308,7 +309,7 @@ public async Task<FileInfo> EnsureBuildToolAvailableAsync(string toolName, Cance
 
         cancellationToken.ThrowIfCancellationRequested();
 
-        using var p = Process.Start(psi) ?? throw new InvalidOperationException($"Failed to start {toolName} process");
+        using var p = Process.Start(psi) ?? throw new InvalidOperationException($"Failed to start {tool.ExecutableName} process");
         var stdout = await p.StandardOutput.ReadToEndAsync(cancellationToken);
         var stderr = await p.StandardError.ReadToEndAsync(cancellationToken);
         await p.WaitForExitAsync(cancellationToken);
@@ -325,7 +326,14 @@ public async Task<FileInfo> EnsureBuildToolAvailableAsync(string toolName, Cance
 
         if (p.ExitCode != 0)
         {
-            throw new InvalidBuildToolException(p.Id, stdout, stderr, $"{toolName} execution failed with exit code {p.ExitCode}");
+            // Print tool-specific error output when not in verbose mode
+            // In verbose mode, all output is already visible via LogDebug above
+            if (!logger.IsEnabled(LogLevel.Debug))
+            {
+                tool.PrintErrorText(stdout, stderr, logger);
+            }
+            
+            throw new InvalidBuildToolException(p.Id, stdout, stderr, $"{tool.ExecutableName} execution failed with exit code {p.ExitCode}");
         }
 
         return (stdout, stderr);

src/winapp-CLI/WinApp.Cli/Services/CertificateService.cs

@@ -2,6 +2,7 @@
 // Licensed under the MIT License.
 
 using WinApp.Cli.Helpers;
+using WinApp.Cli.Tools;
 using System.Diagnostics.Eventing.Reader;
 using System.Text.RegularExpressions;
 using Microsoft.Extensions.Logging;
@@ -207,7 +208,7 @@ public async Task SignFileAsync(FileInfo filePath, FileInfo certificatePath, str
 
         try
         {
-            await buildToolsService.RunBuildToolAsync("signtool.exe", arguments, cancellationToken: cancellationToken);
+            await buildToolsService.RunBuildToolAsync(new GenericTool("signtool.exe"), arguments, cancellationToken: cancellationToken);
 
             logger.LogDebug("File signed successfully");
         }

src/winapp-CLI/WinApp.Cli/Services/IBuildToolsService.cs

@@ -1,6 +1,8 @@
 // Copyright (c) Microsoft Corporation. All rights reserved.
 // Licensed under the MIT License.
 
+using WinApp.Cli.Tools;
+
 namespace WinApp.Cli.Services;
 
 internal interface IBuildToolsService
@@ -26,5 +28,13 @@ internal interface IBuildToolsService
     Task<FileInfo> EnsureBuildToolAvailableAsync(string toolName, CancellationToken cancellationToken = default);
 
     Task<DirectoryInfo?> EnsureBuildToolsAsync(bool forceLatest = false, CancellationToken cancellationToken = default);
-    Task<(string stdout, string stderr)> RunBuildToolAsync(string toolName, string arguments, CancellationToken cancellationToken = default);
+    
+    /// <summary>
+    /// Execute a build tool with the specified arguments
+    /// </summary>
+    /// <param name="tool">The tool to execute</param>
+    /// <param name="arguments">Arguments to pass to the tool</param>
+    /// <param name="cancellationToken">Cancellation token</param>
+    /// <returns>Tuple containing (stdout, stderr)</returns>
+    Task<(string stdout, string stderr)> RunBuildToolAsync(Tool tool, string arguments, CancellationToken cancellationToken = default);
 }

src/winapp-CLI/WinApp.Cli/Services/MsixService.cs

@@ -9,6 +9,7 @@
 using System.Xml;
 using WinApp.Cli.Helpers;
 using WinApp.Cli.Models;
+using WinApp.Cli.Tools;
 
 namespace WinApp.Cli.Services;
 
@@ -522,7 +523,7 @@ public async Task<FileInfo> CreatePriConfigAsync(DirectoryInfo packageDir, strin
 
         try
         {
-            await buildToolsService.RunBuildToolAsync("makepri.exe", arguments, cancellationToken: cancellationToken);
+            await buildToolsService.RunBuildToolAsync(new MakePriTool(), arguments, cancellationToken: cancellationToken);
 
             logger.LogDebug("PRI configuration created: {ConfigPath}", configPath);
 
@@ -577,7 +578,7 @@ public async Task<List<FileInfo>> GeneratePriFileAsync(DirectoryInfo packageDir,
 
         try
         {
-            var (stdout, stderr) = await buildToolsService.RunBuildToolAsync("makepri.exe", arguments, cancellationToken: cancellationToken);
+            var (stdout, stderr) = await buildToolsService.RunBuildToolAsync(new MakePriTool(), arguments, cancellationToken: cancellationToken);
 
             // Parse the output to extract resource files
             var resourceFiles = new List<FileInfo>();
@@ -1129,13 +1130,13 @@ private async Task CreateMsixPackageFromFolderAsync(DirectoryInfo inputFolder, F
 
         logger.LogDebug("Creating MSIX package...");
 
-        await buildToolsService.RunBuildToolAsync("makeappx.exe", makeappxArguments, cancellationToken: cancellationToken);
+        await buildToolsService.RunBuildToolAsync(new MakeAppxTool(), makeappxArguments, cancellationToken: cancellationToken);
     }
 
     private async Task RunMtToolAsync(string arguments, CancellationToken cancellationToken = default)
     {
         // Use BuildToolsService to run mt.exe
-        await buildToolsService.RunBuildToolAsync("mt.exe", arguments, cancellationToken: cancellationToken);
+        await buildToolsService.RunBuildToolAsync(new GenericTool("mt.exe"), arguments, cancellationToken: cancellationToken);
     }
 
     private static void TryDeleteFile(FileInfo path)

src/winapp-CLI/WinApp.Cli/Tools/GenericTool.cs

@@ -0,0 +1,21 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+namespace WinApp.Cli.Tools;
+
+/// <summary>
+/// Generic tool wrapper for build tools without specific error parsing logic
+/// </summary>
+public class GenericTool : Tool
+{
+    private readonly string _executableName;
+
+    public GenericTool(string executableName)
+    {
+        _executableName = executableName;
+    }
+
+    public override string ExecutableName => _executableName;
+
+    // Uses default PrintErrorText implementation (prints stdout and stderr)
+}

src/winapp-CLI/WinApp.Cli/Tools/MakeAppxTool.cs

@@ -0,0 +1,69 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+using Microsoft.Extensions.Logging;
+
+namespace WinApp.Cli.Tools;
+
+/// <summary>
+/// Tool wrapper for makeappx.exe with specific error parsing
+/// </summary>
+public class MakeAppxTool : Tool
+{
+    public override string ExecutableName => "makeappx.exe";
+
+    /// <summary>
+    /// Print error text from makeappx.exe output, extracting relevant error lines
+    /// </summary>
+    public override void PrintErrorText(string stdout, string stderr, ILogger logger)
+    {
+        // Example makeappx.exe error output -- this goes to stdout:
+        //  Processing "\\?\D:\temp\rigvgl1m.zgh\priconfig.xml" as a payload file.  Its path in the package will be "priconfig.xml".
+        //  Processing "\\?\D:\temp\rigvgl1m.zgh\resources.pri" as a payload file.  Its path in the package will be "resources.pri".
+        //  MakeAppx : error: Error info: error C00CE169: App manifest validation error: The app manifest must be valid as per schema: Line 38, Column 7, Reason: 'InvalidValue' violates enumeration constraint of 'appContainer mediumIL'.
+        //  The attribute '{http://schemas.microsoft.com/appx/manifest/uap/windows10/10}TrustLevel' with value 'InvalidValue' failed to parse.
+
+        //  MakeAppx : error: Package creation failed.
+        //  MakeAppx : error: 0x80080204 - The specified package format is not valid: The package manifest is not valid.
+
+        // Now, find the first error line in stdout and print out the rest of the output from there.
+        if (!string.IsNullOrWhiteSpace(stdout))
+        {
+            var lines = stdout.Split(['\r', '\n'], StringSplitOptions.RemoveEmptyEntries);
+            var firstErrorIndex = -1;
+
+            // Find the first line containing "error"
+            for (int i = 0; i < lines.Length; i++)
+            {
+                if (lines[i].Contains("error", StringComparison.OrdinalIgnoreCase))
+                {
+                    firstErrorIndex = i;
+                    break;
+                }
+            }
+
+            // Print from the first error line onwards
+            if (firstErrorIndex >= 0)
+            {
+                for (int i = firstErrorIndex; i < lines.Length; i++)
+                {
+                    logger.LogError("{ErrorLine}", lines[i]);
+                }
+                logger.LogError("{ExeName} reported an error. The above text is only part of the tool output. Please re-run with --verbose to see the full output.", ExecutableName);
+                return;
+            }
+        }
+
+        // If no error pattern found or stderr has content, use default behavior
+        if (!string.IsNullOrWhiteSpace(stderr))
+        {
+            logger.LogError("{Stderr}", stderr);
+            logger.LogError("{ExeName} reported an error. The above text is only part of the tool output. Please re-run with --verbose to see the full output.", ExecutableName);
+        }
+        else
+        {
+            // Fallback to base implementation
+            base.PrintErrorText(stdout, stderr, logger);
+        }
+    }
+}

src/winapp-CLI/WinApp.Cli/Tools/MakePriTool.cs

@@ -0,0 +1,32 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+using Microsoft.Extensions.Logging;
+using System.Text.RegularExpressions;
+
+namespace WinApp.Cli.Tools;
+
+/// <summary>
+/// Tool wrapper for makepri.exe with specific error parsing
+/// </summary>
+public partial class MakePriTool : Tool
+{
+    public override string ExecutableName => "makepri.exe";
+
+    /// <summary>
+    /// Print error text from makepri.exe output, extracting relevant error lines
+    /// </summary>
+    public override void PrintErrorText(string stdout, string stderr, ILogger logger)
+    {
+        // makepri.exe writes errors to stderr, so just print stderr if there is any.
+        if (string.IsNullOrWhiteSpace(stderr))
+        {
+            base.PrintErrorText(stdout, stderr, logger);
+        }
+        else
+        {
+            logger.LogError("{Stderr}", stderr);
+            logger.LogError("{ExeName} reported an error. The above text is only part of the tool output. Please re-run with --verbose to see the full output.", ExecutableName);
+        }
+    }
+}

src/winapp-CLI/WinApp.Cli/Tools/Tool.cs

@@ -0,0 +1,38 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+using Microsoft.Extensions.Logging;
+
+namespace WinApp.Cli.Tools;
+
+/// <summary>
+/// Base class for Windows SDK build tools
+/// </summary>
+public abstract class Tool
+{
+    /// <summary>
+    /// The executable name (e.g., "signtool.exe", "makeappx.exe")
+    /// </summary>
+    public abstract string ExecutableName { get; }
+
+    /// <summary>
+    /// Print error text from stdout/stderr.
+    /// Tool can parse and print what it believes to be the error output.
+    /// Default implementation prints both stdout and stderr.
+    /// </summary>
+    /// <param name="stdout">Standard output from the tool</param>
+    /// <param name="stderr">Standard error from the tool</param>
+    /// <param name="logger">Logger for outputting error messages</param>
+    public virtual void PrintErrorText(string stdout, string stderr, ILogger logger)
+    {
+        // We don't know this tool, so print all output.
+        if (!string.IsNullOrWhiteSpace(stdout))
+        {
+            logger.LogError("{Stdout}", stdout);
+        }
+        if (!string.IsNullOrWhiteSpace(stderr))
+        {
+            logger.LogError("{Stderr}", stderr);
+        }
+    }
+}