🧪 Enhance searchAndRequestFix method (#1112)

[Jenkins linux
Run](https://jenkins-csb-migrationqe-main.dno.corp.redhat.com/job/mta/job/kai-e2e-nightly-linux/237/console)

[Jenkins Windows
Run](https://jenkins-csb-migrationqe-main.dno.corp.redhat.com/job/mta/job/kai-e2e-nightly-windows/114/console)

Introduce ResolutionAction enum and enhance searchAndRequestFix method

**New Features**
- Added `ResolutionAction` enum to define possible resolution actions:
ACCEPT, REJECT, and REVIEW_IN_EDITOR.
- Updated `searchAndRequestFix` method in `VSCode` class to accept an
optional `resolutionAction` parameter, allowing for more flexible
handling of solution requests.
- Refactored test cases to utilize the new method and enum for improved
clarity and functionality.

<sub>✏️ Tip: You can customize this high-level summary in your review
settings.</sub>

<!--
## PR Title Prefix

Every **PR Title** should be prefixed with :text: to indicate its type.

- Breaking change: ⚠️ (`⚠️`)
- Non-breaking feature: ✨ (`✨`)
- Patch fix: 🐛 (`🐛`)
- Docs: 📖 (`📖`)
- Infra/Tests/Other: 🌱 (`🌱`)
- No release note: 👻 (`👻`)

For example, a pull request containing breaking changes might look like
`⚠️ My pull request contains breaking changes`.

Since GitHub supports emoji aliases (ie. `👻`), there is no need to
include
the emoji directly in the PR title -- **please use the alias**. It used
to be
the case that projects using emojis for PR typing had to include the
emoji
directly because GitHub didn't render the alias. Given that `⚠️`
is
easy enough to read as text, easy to parse in release tooling, and
rendered in
GitHub well, we prefer to standardize on the alias.

For more information, please see the Konveyor
[Versioning
Doc](https://github.com/konveyor/release-tools/blob/main/VERSIONING.md).
-->


<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit

* **New Features**
* Added explicit resolution actions: Accept, Reject, Review in Editor,
Apply All, Reject All.

* **Tests**
  * Replaced multi-step UI fix flows with a single action-based flow.
* Integrated previous “accept all” behavior into the new action flow and
removed the legacy UI path.
* Updated wait/confirmation behavior and migrated tests to use the new
action API.

<sub>✏️ Tip: You can customize this high-level summary in your review
settings.</sub>
<!-- end of auto-generated comment: release notes by coderabbit.ai -->

---------

Signed-off-by: mohamed idays <[email protected]>
Signed-off-by: [Your Name] <[email protected]>

Author: midays

tests/e2e/enums/resolution-action.enum.ts

@@ -0,0 +1,7 @@
+export enum ResolutionAction {
+  Accept = 'Accept',
+  Reject = 'Reject',
+  ReviewInEditor = 'Review in Editor',
+  ApplyAll = '^Apply All \\(\\d+\\)$',
+  RejectAll = 'Reject All',
+}

tests/e2e/pages/vscode.page.ts

@@ -8,6 +8,7 @@ import { ProfileActions } from '../enums/profile-action-types.enum';
 import { OutputPanel } from './output.page';
 import path from 'path';
 import { SCREENSHOTS_FOLDER } from '../utilities/consts';
+import { ResolutionAction } from '../enums/resolution-action.enum';
 
 type SortOrder = 'ascending' | 'descending';
 type ListKind = 'issues' | 'files';
@@ -437,16 +438,62 @@ export abstract class VSCode {
     }
   }
 
-  public async searchAndRequestFix(searchTerm: string, fixType: FixTypes) {
+  public async searchAndRequestAction(
+    searchTerm?: string,
+    fixType?: FixTypes,
+    resolutionAction?: ResolutionAction
+  ) {
+    // (midays) todo: add a filesToFix: string[] parameter to define which files to fix
     const analysisView = await this.getView(KAIViews.analysisView);
-    await this.searchViolation(searchTerm);
-    await analysisView.locator('div.pf-v6-c-card__header-toggle').nth(0).click();
-    await analysisView.locator('button#get-solution-button').nth(fixType).click();
-  }
 
-  public async searchViolationAndAcceptAllSolutions(violation: string) {
-    await this.searchAndRequestFix(violation, FixTypes.Issue);
-    await this.acceptAllSolutions();
+    if (searchTerm) {
+      await this.searchViolation(searchTerm);
+      await analysisView.locator('div.pf-v6-c-card__header-toggle').nth(0).click();
+    }
+
+    if (fixType) {
+      await analysisView.locator('button#get-solution-button').nth(fixType).click();
+    }
+
+    if (resolutionAction) {
+      const resolutionView = await this.getView(KAIViews.resolutionDetails);
+      const actionLocator = resolutionView.getByRole('button', {
+        name: new RegExp(resolutionAction),
+      });
+      const headerLocator = resolutionView.locator('h1.pf-v6-c-title.pf-m-2xl', {
+        hasText: 'Generative AI Results',
+      });
+      await expect(headerLocator.locator('.loading-indicator')).toHaveCount(0, {
+        timeout: 600_000,
+      }); // 10 minutes
+      if (resolutionAction === ResolutionAction.Accept) {
+        let fixedFiles: string[] = [];
+        // Parse the "(current of total)" from the header to get file count
+        const reviewHeaderLocator = resolutionView.locator(
+          '.batch-review-expandable-header .batch-review-title'
+        );
+        await reviewHeaderLocator.waitFor({ state: 'visible', timeout: 10000 });
+        let headerText = await reviewHeaderLocator.textContent();
+        const match = headerText && headerText.match(/\((\d+)\s+of\s+(\d+)\)/);
+        const totalFiles = match ? parseInt(match[2], 10) : 1;
+        console.log('Total files found to accept solutions for: ', totalFiles);
+        for (let i = 0; i < totalFiles; i++) {
+          headerText = await reviewHeaderLocator.textContent();
+          const fileNameMatch = headerText && headerText.match(/^Reviewing:\s*([^\(]+)\s*\(/);
+          const fileToFix = fileNameMatch && fileNameMatch[1] ? fileNameMatch[1].trim() : '';
+          console.log('Reviewing file: ', fileToFix);
+          fixedFiles.push(fileToFix);
+          await actionLocator.waitFor({ state: 'visible', timeout: 10000 });
+          await actionLocator.dispatchEvent('click');
+          console.log('Accepted solution for file: ', fileToFix);
+        }
+        return fixedFiles;
+      } else {
+        await actionLocator.waitFor({ state: 'visible', timeout: 30000 });
+        await actionLocator.dispatchEvent('click');
+        return [];
+      }
+    }
   }
 
   public async waitForSolutionConfirmation(): Promise<void> {
@@ -464,29 +511,6 @@ export abstract class VSCode {
     ]);
   }
 
-  public async acceptAllSolutions() {
-    const resolutionView = await this.getView(KAIViews.resolutionDetails);
-    const fixLocator = resolutionView.getByRole('button', { name: 'Accept' });
-    const loadingIndicator = resolutionView.locator('.loading-indicator');
-
-    await this.waitDefault();
-    // Avoid fixing issues forever
-    const MAX_FIXES = 500;
-
-    for (let i = 0; i < MAX_FIXES; i++) {
-      await expect(fixLocator.first()).toBeVisible({ timeout: 300_000 });
-      // Ensures the button is clicked even if there are notifications overlaying it due to screen size
-      await fixLocator.first().dispatchEvent('click');
-      await this.waitDefault();
-
-      if ((await loadingIndicator.count()) === 0) {
-        return;
-      }
-    }
-
-    throw new Error('MAX_FIXES limit reached while requesting solutions');
-  }
-
   public async waitDefault() {
     await this.window.waitForTimeout(process.env.CI ? 5000 : 3000);
   }

tests/e2e/tests/analyze_coolstore.test.ts

@@ -6,9 +6,10 @@ import { DEFAULT_PROVIDER, getAvailableProviders } from '../fixtures/provider-co
 import path from 'path';
 import { runEvaluation } from '../../kai-evaluator/core';
 import { prepareEvaluationData, saveOriginalAnalysisFile } from '../utilities/evaluation.utils';
-import { KAIViews } from '../enums/views.enum';
 import { isAWSConfigured } from '../../kai-evaluator/utils/s3.utils';
 import * as VSCodeFactory from '../utilities/vscode.factory';
+import { ResolutionAction } from '../enums/resolution-action.enum';
+import { FixTypes } from '../enums/fix-types.enum';
 
 const providers = process.env.CI ? getAvailableProviders() : [DEFAULT_PROVIDER];
 
@@ -64,10 +65,7 @@ providers.forEach((config) => {
     test('Fix all issues', async () => {
       test.setTimeout(3600000);
       await vscodeApp.openAnalysisView();
-      const analysisView = await vscodeApp.getView(KAIViews.analysisView);
-      await analysisView.locator('button#get-solution-button').first().click({ timeout: 300000 });
-
-      await vscodeApp.acceptAllSolutions();
+      await vscodeApp.searchAndRequestAction(undefined, FixTypes.Issue, ResolutionAction.Accept);
     });
 
     test.afterEach(async () => {

tests/e2e/tests/base/fix-one-issue.test.ts

@@ -2,13 +2,13 @@ import { expect, test } from '../../fixtures/test-repo-fixture';
 import { VSCode } from '../../pages/vscode.page';
 import { getAvailableProviders } from '../../fixtures/provider-configs.fixture';
 import { generateRandomString, parseLogEntries } from '../../utilities/utils';
-import { KAIViews } from '../../enums/views.enum';
 import { FixTypes } from '../../enums/fix-types.enum';
 import * as VSCodeFactory from '../../utilities/vscode.factory';
 import { Configuration } from '../../pages/configuration.page';
 import { logLevel } from '../../enums/configuration-options.enum';
 import { LogLevel } from '../../enums/Log-level.enum';
 import { OutputChannel } from '../../enums/output.enum';
+import { ResolutionAction } from '../../enums/resolution-action.enum';
 
 getAvailableProviders().forEach((provider) => {
   test.describe(`@tier0 Run analysis and fix one issue - ${provider.model}`, () => {
@@ -40,12 +40,11 @@ getAvailableProviders().forEach((provider) => {
     test('Fix one issue', async () => {
       test.setTimeout(600000);
       await vscodeApp.openAnalysisView();
-      await vscodeApp.searchAndRequestFix('InventoryEntity', FixTypes.Incident);
-      const resolutionView = await vscodeApp.getView(KAIViews.resolutionDetails);
-      const fixLocator = resolutionView.getByRole('button', { name: 'Accept' }).first();
-      await expect(fixLocator).toBeVisible({ timeout: 60000 });
-      // Ensures the button is clicked even if there are notifications overlaying it due to screen size
-      await fixLocator.dispatchEvent('click');
+      await vscodeApp.searchAndRequestAction(
+        'InventoryEntity',
+        FixTypes.Incident,
+        ResolutionAction.Accept
+      );
       await expect(vscodeApp.getWindow().getByText('Analysis completed').first()).toBeVisible({
         timeout: 600000,
       });

tests/e2e/tests/base/llm-revert-check.test.ts

@@ -7,6 +7,8 @@ import { generateRandomString } from '../../utilities/utils';
 import path from 'path';
 import { getFileImports } from '../../utilities/file.utils';
 import * as VSCodeFactory from '../../utilities/vscode.factory';
+import { FixTypes } from '../../enums/fix-types.enum';
+import { ResolutionAction } from '../../enums/resolution-action.enum';
 /**
  * Automates https://github.com/konveyor/kai/issues/798
  * Tests that fixes applied by the LLM do not unintentionally revert .
@@ -56,7 +58,7 @@ getAvailableProviders().forEach((provider) => {
       const violation = "The package 'javax' has been replaced by 'jakarta'";
 
       await vscodeApp.openAnalysisView();
-      await vscodeApp.searchViolationAndAcceptAllSolutions(violation);
+      await vscodeApp.searchAndRequestAction(violation, FixTypes.Issue, ResolutionAction.Accept);
       await vscodeApp.openAnalysisView();
       await vscodeApp.waitForSolutionConfirmation();
 
@@ -69,7 +71,7 @@ getAvailableProviders().forEach((provider) => {
         'Implicit name determination for sequences and tables associated with identifier generation has changed';
 
       await vscodeApp.openAnalysisView();
-      await vscodeApp.searchViolationAndAcceptAllSolutions(violation);
+      await vscodeApp.searchAndRequestAction(violation, FixTypes.Issue, ResolutionAction.Accept);
       await vscodeApp.openAnalysisView();
       await vscodeApp.waitForSolutionConfirmation();
 

tests/e2e/tests/solution-server/analysis-validation.test.ts

@@ -11,6 +11,7 @@ import {
   SuccessRateResponse,
 } from '../../../mcp-client/mcp-client-responses.model';
 import * as VSCodeFactory from '../../utilities/vscode.factory';
+import { ResolutionAction } from '../../enums/resolution-action.enum';
 
 test.describe(`Solution server analysis validations`, () => {
   let vsCode: VSCode;
@@ -83,9 +84,10 @@ test.describe(`Solution server analysis validations`, () => {
    * 7. Asserts that the UI displays the correct success rate counts
    */
   async function requestFixAndAssertSolution(accept: boolean) {
-    await vsCode.searchAndRequestFix(
+    await vsCode.searchAndRequestAction(
       'Replace the `javax.persistence` import statement with `jakarta.persistence`',
-      FixTypes.Incident
+      FixTypes.Incident,
+      ResolutionAction.Accept
     );
 
     const resolutionView = await vsCode.getView(KAIViews.resolutionDetails);

tests/e2e/tests/solution-server/partially-migrated-apps-scenario.test.ts

@@ -28,6 +28,7 @@ import * as fs from 'fs';
 import { TestLogger } from '../../utilities/logger';
 import { solutionServerEnabled } from '../../enums/configuration-options.enum';
 import * as VSCodeFactory from '../../utilities/vscode.factory';
+import { ResolutionAction } from '../../enums/resolution-action.enum';
 
 class SolutionServerWorkflowHelper {
   public logger: TestLogger;
@@ -206,7 +207,11 @@ class SolutionServerWorkflowHelper {
 
       const violationText =
         'Replace `FileSystemAuditLogger` instantiation with `StreamableAuditLogger` over TCP';
-      await vsCode.searchAndRequestFix(violationText, FixTypes.Incident);
+      await vsCode.searchAndRequestAction(
+        violationText,
+        FixTypes.Incident,
+        ResolutionAction.Accept
+      );
 
       const resolutionView = await vsCode.getView(KAIViews.resolutionDetails);
 
@@ -251,7 +256,11 @@ class SolutionServerWorkflowHelper {
 
       const violationText =
         'The java.annotation (Common Annotations) module has been removed from OpenJDK 11';
-      await vsCode.searchAndRequestFix(violationText, FixTypes.Incident);
+      await vsCode.searchAndRequestAction(
+        violationText,
+        FixTypes.Incident,
+        ResolutionAction.Accept
+      );
 
       const resolutionView = await vsCode.getView(KAIViews.resolutionDetails);