Add tests for ShowExistingFailureLogsPlugin and update snapshots

Copilot · iclanton · Copilot · commit 8f36a2803f9e · 2025-11-18T22:54:44.000Z
Co-authored-by: iclanton &lt;5010588+iclanton@users.noreply.github.com&gt;
diff --git a/libraries/rush-lib/src/api/test/__snapshots__/RushCommandLine.test.ts.snap b/libraries/rush-lib/src/api/test/__snapshots__/RushCommandLine.test.ts.snap
@@ -1318,6 +1318,14 @@ Object {
           "required": false,
           "shortName": undefined,
         },
+        Object {
+          "description": "Skips execution of operations and instead displays any existing failure logs for the selected projects. This is useful for reviewing failures from a previous run without re-executing the operations. Operations without existing failure logs will be silenced.",
+          "environmentVariable": undefined,
+          "kind": "Flag",
+          "longName": "--show-existing-failure-logs",
+          "required": false,
+          "shortName": undefined,
+        },
         Object {
           "description": "Selects a single instead of the default locale (en-us) for non-ship builds or all locales for ship builds.",
           "environmentVariable": undefined,
@@ -1480,6 +1488,14 @@ Object {
           "required": false,
           "shortName": undefined,
         },
+        Object {
+          "description": "Skips execution of operations and instead displays any existing failure logs for the selected projects. This is useful for reviewing failures from a previous run without re-executing the operations. Operations without existing failure logs will be silenced.",
+          "environmentVariable": undefined,
+          "kind": "Flag",
+          "longName": "--show-existing-failure-logs",
+          "required": false,
+          "shortName": undefined,
+        },
         Object {
           "description": "Perform a production build, including minification and localization steps",
           "environmentVariable": undefined,
@@ -1629,6 +1645,14 @@ Object {
           "required": false,
           "shortName": undefined,
         },
+        Object {
+          "description": "Skips execution of operations and instead displays any existing failure logs for the selected projects. This is useful for reviewing failures from a previous run without re-executing the operations. Operations without existing failure logs will be silenced.",
+          "environmentVariable": undefined,
+          "kind": "Flag",
+          "longName": "--show-existing-failure-logs",
+          "required": false,
+          "shortName": undefined,
+        },
         Object {
           "description": "Perform a production build, including minification and localization steps",
           "environmentVariable": undefined,
diff --git a/libraries/rush-lib/src/cli/test/__snapshots__/CommandLineHelp.test.ts.snap b/libraries/rush-lib/src/cli/test/__snapshots__/CommandLineHelp.test.ts.snap
@@ -192,7 +192,7 @@ exports[`CommandLineHelp prints the help for each action: build 1`] = `
                   [--from-version-policy VERSION_POLICY_NAME] [-v]
                   [--include-phase-deps] [-c] [--ignore-hooks]
                   [--node-diagnostic-dir DIRECTORY] [--debug-build-cache-ids]
-                  [-s] [-m]
+                  [--show-existing-failure-logs] [-s] [-m]
                   
 
 This command is similar to \\"rush rebuild\\", except that \\"rush build\\" performs 
@@ -334,6 +334,12 @@ Optional arguments:
                         Logs information about the components of the build 
                         cache ids for individual operations. This is useful 
                         for debugging the incremental build logic.
+  --show-existing-failure-logs
+                        Skips execution of operations and instead displays 
+                        any existing failure logs for the selected projects. 
+                        This is useful for reviewing failures from a previous 
+                        run without re-executing the operations. Operations 
+                        without existing failure logs will be silenced.
   -s, --ship            Perform a production build, including minification 
                         and localization steps
   -m, --minimal         Perform a fast build, which disables certain tasks 
@@ -488,6 +494,7 @@ exports[`CommandLineHelp prints the help for each action: import-strings 1`] = `
                            [--include-phase-deps] [--ignore-hooks]
                            [--node-diagnostic-dir DIRECTORY]
                            [--debug-build-cache-ids]
+                           [--show-existing-failure-logs]
                            [--locale {en-us,fr-fr,es-es,zh-cn}]
                            
 
@@ -612,6 +619,12 @@ Optional arguments:
                         Logs information about the components of the build 
                         cache ids for individual operations. This is useful 
                         for debugging the incremental build logic.
+  --show-existing-failure-logs
+                        Skips execution of operations and instead displays 
+                        any existing failure logs for the selected projects. 
+                        This is useful for reviewing failures from a previous 
+                        run without re-executing the operations. Operations 
+                        without existing failure logs will be silenced.
   --locale {en-us,fr-fr,es-es,zh-cn}
                         Selects a single instead of the default locale 
                         (en-us) for non-ship builds or all locales for ship 
@@ -1129,7 +1142,8 @@ exports[`CommandLineHelp prints the help for each action: rebuild 1`] = `
                     [--from-version-policy VERSION_POLICY_NAME] [-v]
                     [--include-phase-deps] [--ignore-hooks]
                     [--node-diagnostic-dir DIRECTORY]
-                    [--debug-build-cache-ids] [-s] [-m]
+                    [--debug-build-cache-ids] [--show-existing-failure-logs]
+                    [-s] [-m]
                     
 
 This command assumes that the package.json file for each project contains a 
@@ -1259,6 +1273,12 @@ Optional arguments:
                         Logs information about the components of the build 
                         cache ids for individual operations. This is useful 
                         for debugging the incremental build logic.
+  --show-existing-failure-logs
+                        Skips execution of operations and instead displays 
+                        any existing failure logs for the selected projects. 
+                        This is useful for reviewing failures from a previous 
+                        run without re-executing the operations. Operations 
+                        without existing failure logs will be silenced.
   -s, --ship            Perform a production build, including minification 
                         and localization steps
   -m, --minimal         Perform a fast build, which disables certain tasks 
diff --git a/libraries/rush-lib/src/logic/operations/test/ShowExistingFailureLogsPlugin.test.ts b/libraries/rush-lib/src/logic/operations/test/ShowExistingFailureLogsPlugin.test.ts
@@ -0,0 +1,97 @@
+// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
+// See LICENSE in the project root for license information.
+
+jest.mock('@rushstack/node-core-library');
+
+import { FileSystem } from '@rushstack/node-core-library';
+import { StringBufferTerminalProvider, Terminal } from '@rushstack/terminal';
+
+import { ShowExistingFailureLogsPlugin } from '../ShowExistingFailureLogsPlugin';
+import { PhasedCommandHooks } from '../../../pluginFramework/PhasedCommandHooks';
+import { OperationStatus } from '../OperationStatus';
+
+describe(ShowExistingFailureLogsPlugin.name, () => {
+  let mockTerminalProvider: StringBufferTerminalProvider;
+  let mockTerminal: Terminal;
+  let hooks: PhasedCommandHooks;
+  let plugin: ShowExistingFailureLogsPlugin;
+
+  beforeEach(() => {
+    mockTerminalProvider = new StringBufferTerminalProvider(false);
+    mockTerminal = new Terminal(mockTerminalProvider);
+    hooks = new PhasedCommandHooks();
+    plugin = new ShowExistingFailureLogsPlugin({ terminal: mockTerminal });
+  });
+
+  afterEach(() => {
+    jest.restoreAllMocks();
+  });
+
+  it('should apply the plugin to hooks', () => {
+    plugin.apply(hooks);
+    expect(hooks.beforeExecuteOperation.isUsed()).toBe(true);
+  });
+
+  it('should handle operations with existing error logs', async () => {
+    // Mock FileSystem.existsAsync to return true (error log exists)
+    jest.spyOn(FileSystem, 'existsAsync').mockResolvedValue(true);
+
+    // Apply the plugin
+    plugin.apply(hooks);
+
+    // Create a minimal mock context
+    const mockRunnerContext = {
+      operation: {
+        logFilenameIdentifier: 'test-operation',
+        associatedProject: {
+          projectFolder: '/test/project',
+          packageName: 'test-package'
+        }
+      },
+      _operationMetadataManager: {
+        tryRestoreAsync: jest.fn()
+      },
+      // eslint-disable-next-line @typescript-eslint/no-explicit-any
+      runWithTerminalAsync: jest.fn(async (callback: any) => {
+        await callback(mockTerminal, mockTerminalProvider);
+      })
+      // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    } as any;
+
+    // Trigger the beforeExecuteOperation hook
+    const result = await hooks.beforeExecuteOperation.promise(mockRunnerContext);
+
+    expect(result).toBe(OperationStatus.Failure);
+    expect(FileSystem.existsAsync).toHaveBeenCalled();
+  });
+
+  it('should handle operations without error logs', async () => {
+    // Mock FileSystem.existsAsync to return false (no error log)
+    jest.spyOn(FileSystem, 'existsAsync').mockResolvedValue(false);
+
+    // Apply the plugin
+    plugin.apply(hooks);
+
+    // Create a minimal mock context
+    const mockRunnerContext = {
+      operation: {
+        logFilenameIdentifier: 'test-operation',
+        associatedProject: {
+          projectFolder: '/test/project'
+        }
+      },
+      _operationMetadataManager: {
+        tryRestoreAsync: jest.fn()
+      },
+      runWithTerminalAsync: jest.fn()
+      // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    } as any;
+
+    // Trigger the beforeExecuteOperation hook
+    const result = await hooks.beforeExecuteOperation.promise(mockRunnerContext);
+
+    expect(result).toBe(OperationStatus.Skipped);
+    expect(FileSystem.existsAsync).toHaveBeenCalled();
+    expect(mockRunnerContext.runWithTerminalAsync).not.toHaveBeenCalled();
+  });
+});
