Scripts to Add Labels to SBOM

Signed-off-by: mrrajan <86094767+mrrajan@users.noreply.github.com.>

Author: mrrajan

tests/ui/features/@sbom-explorer/sbom-explorer.feature

@@ -124,4 +124,21 @@ Feature: SBOM Explorer - View SBOM details
         # Bug: https://issues.redhat.com/browse/TC-2598
         Examples:
         | sbomName |
-        | quarkus-bom |
+        | quarkus-bom |
+
+    Scenario Outline: Add Labels to SBOM from SBOM List Page
+        Given An ingested SBOM "<sbomName>" is available
+        When User Adds Labels "<Labels>" to "<sbomName>" SBOM from List Page
+        Then The Label list "<Labels>" added to the SBOM "<sbomName>" on List Page
+        Examples:
+        | sbomName | Labels |
+        | quarkus-bom | env=test, list_page, qe_sbom_test |
+
+    Scenario Outline: Add Labels to SBOM from SBOM Explorer Page
+        Given An ingested SBOM "<sbomName>" is available
+        When User visits SBOM details Page of "<sbomName>"
+        When User Adds Labels "<Labels>" to "<sbomName>" SBOM from Explorer Page
+        Then The Label list "<Labels>" added to the SBOM "<sbomName>" on Explorer Page
+        Examples:
+        | sbomName | Labels |
+        | quarkus-bom | env1=test1, explorer_page, qe_sbom_test1 |

tests/ui/features/@sbom-explorer/sbom-explorer.step.ts

@@ -8,6 +8,7 @@ export const { Given, When, Then } = createBdd();
 
 const PACKAGE_TABLE_NAME = "Package table";
 const VULN_TABLE_NAME = "Vulnerability table";
+const SBOM_TABLE_NAME = "sbom-table";
 
 Given("An ingested SBOM {string} is available", async ({ page }, sbomName) => {
   const searchPage = new SearchPage(page, "SBOMs");
@@ -187,3 +188,40 @@ Then("Sorting of {string} Columns Works", async ({ page }, columnHeaders) => {
   const vulnTableTopPagination = `xpath=//div[@id="vulnerability-table-pagination-top"]`;
   await toolbarTable.verifySorting(vulnTableTopPagination, headers);
 });
+
+When(
+  "User Adds Labels {string} to {string} SBOM from List Page",
+  async ({ page }, labelList, sbomName) => {
+    const toolbarTable = new ToolbarTable(page, SBOM_TABLE_NAME);
+    await toolbarTable.editLabelsListPage(sbomName);
+    const detailsPage = new DetailsPage(page);
+    await detailsPage.addLabels(labelList);
+  }
+);
+
+Then(
+  "The Label list {string} added to the SBOM {string} on List Page",
+  async ({ page }, labelList, sbomName) => {
+    const detailsPage = new DetailsPage(page);
+    await detailsPage.verifyLabels(labelList, sbomName);
+  }
+);
+
+When(
+  "User Adds Labels {string} to {string} SBOM from Explorer Page",
+  async ({ page }, labelList, sbomName) => {
+    const detailsPage = new DetailsPage(page);
+    await detailsPage.editLabelsDetailsPage();
+    await detailsPage.addLabels(labelList);
+  }
+);
+
+Then(
+  "The Label list {string} added to the SBOM {string} on Explorer Page",
+  async ({ page }, labelList, sbomName) => {
+    const detailsPage = new DetailsPage(page);
+    await detailsPage.selectTab(`Info`);
+    let infoSection = page.locator("#refTabInfoSection");
+    detailsPage.verifyLabels(labelList, sbomName, infoSection);
+  }
+);

tests/ui/helpers/DetailsPage.ts

@@ -1,4 +1,4 @@
-import { expect, Page } from "@playwright/test";
+import { expect, Locator, Page } from "@playwright/test";
 
 /**
  * Describes the Details of an Entity. E.g. SBOM Details Page.
@@ -153,4 +153,63 @@ export class DetailsPage {
     }
     return counts;
   }
+
+  /**
+   * To click on Edit labels button on Details page
+   */
+  async editLabelsDetailsPage() {
+    await this.selectTab(`Info`);
+    await this.page.getByRole("button", { name: "Edit" }).click();
+  }
+
+  /**
+   * To add labels to edit model window
+   * @param labels List of labels to add to the entity
+   */
+  async addLabels(labelList: string) {
+    let labels = labelList.split(",").map((label) => label.trim());
+    await this.page.getByText("Edit labels").isVisible();
+    for (let label of labels) {
+      await this.page.getByPlaceholder("Add label").fill(label);
+      await this.page.getByPlaceholder("Add label").press("Enter");
+    }
+    await this.page.getByLabel("submit").click();
+  }
+
+  /**
+   * To verify the given labels exist with the Entity
+   * @param labels List of expected labels
+   * @param entity Entity name to which the Labels needs to be verified
+   * @param parentElem Parent element to identify the Labels element - Defaults to List page table rows
+   */
+  async verifyLabels(
+    labelList: string,
+    entity: string = "",
+    parentElem: Locator | undefined = undefined
+  ) {
+    let labels = labelList.split(",").map((label) => label.trim());
+    if (!parentElem) {
+      parentElem = this.page.locator(`xpath=//td[.='${entity}']/parent::tr/td`);
+    }
+    //Waiting for Edit label modal window to close
+    let editLabels = await this.page.getByText("Edit labels");
+    await editLabels.waitFor({ state: "hidden", timeout: 5000 });
+    let moreElem = await parentElem.getByRole("button", { name: "more" });
+    if (await moreElem.isVisible()) {
+      await moreElem.click();
+    }
+    let labelText = `xpath=//ul[@aria-label='Label group category']/li`;
+    let labelElement0 = await parentElem.locator(
+      `xpath=//ul[@aria-label='Label group category']/li[.="${labels[0]}"]`
+    );
+    await labelElement0.waitFor({ state: "visible", timeout: 5000 });
+    let labelElements = await parentElem.locator(labelText).all();
+    for (let elem of labelElements) {
+      let labelUI = await elem.innerText();
+      labels = labels.filter((label) => label !== labelUI);
+    }
+    expect(labels.length, `Labels missing from the given list ${labels}`).toBe(
+      0
+    );
+  }
 }

tests/ui/helpers/ToolbarTable.ts

@@ -449,6 +449,19 @@ export class ToolbarTable {
     }
   }
 
+  /**
+   * To Add given labels to an SBOM from list page
+   * @param entity Target SBOM
+   * @param labels List of Labels
+   */
+  async editLabelsListPage(entity: string) {
+    await this.waitForTableContent();
+    let sbomAction = `xpath=//td[.='${entity}']/parent::tr/td/button`;
+    let table = this.getTable();
+    await table.locator(sbomAction).click();
+    await this._page.getByRole("menuitem", { name: "Edit labels" }).click();
+  }
+
   private getTable() {
     return this._page.locator(`table[aria-label="${this._tableName}"]`);
   }