[release-1.5] chore(e2e): add/move Github login specific test case to github Auth provider test suite. (#2489)

openshift-cherrypick-robot · subhashkhileri · web-flow · commit bd58c5d02fa0 · 2025-03-04T07:01:54.000Z
* add github plugins tests

* add github plugins tests

* add github plugins tests

* add github plugins tests

* add github plugins tests

* add github plugins tests

* add github plugins tests

* add github plugins tests

* add github plugins tests

* add github plugins tests

* add github plugins tests

* add github plugins tests - add github plugins

* add github plugins tests - add github plugins

* add github plugins tests - add github plugins

* add github plugins tests - add github plugins

* add github plugins tests - add github plugins

* add github plugins tests - add github plugins

* add github plugins tests

* add github plugins tests

* add github plugins tests

---------

Co-authored-by: Subhash Khileri &lt;skhileri@redhat.com&gt;
diff --git a/.ibm/pipelines/value_files/values_showcase-auth-providers.yaml b/.ibm/pipelines/value_files/values_showcase-auth-providers.yaml
@@ -54,11 +54,19 @@ upstream:
                 privateKey: ${AUTH_ORG1_PRIVATE_KEY}
                 webhookSecret: ${AUTH_ORG_WEBHOOK_SECRET}
       catalog:
+        import:
+          entityFilename: catalog-info.yaml
+          # pullRequestBranchName: rhdh-integration
+          pullRequestBranchName: backstage-integration
         locations:
           - type: url
             target: https://github.com/janus-qe/auth-providers/blob/main/location.yaml
+          - type: url
+            target: https://github.com/redhat-developer/rhdh/blob/main/catalog-entities/all.yaml
+          - type: url
+            target: https://github.com/redhat-developer/red-hat-developer-hub-software-templates/blob/main/templates.yaml
         rules:
-          - allow: [Component, Group, User, Resource, Location, Template]          
+          - allow: [API, Component, Group, User, Resource, Location, System, Template]          
         providers:
           githubOrg:
             - id: github
diff --git a/e2e-tests/playwright/e2e/authProviders/github-happy-path.spec.ts b/e2e-tests/playwright/e2e/authProviders/github-happy-path.spec.ts
@@ -1,22 +1,27 @@
 import { test, expect, Page } from "@playwright/test";
-import { UIhelper } from "../utils/ui-helper";
-import { Common, setupBrowser } from "../utils/common";
-import { RESOURCES } from "../support/testData/resources";
+import { UIhelper } from "../../utils/ui-helper";
+import { Common, setupBrowser } from "../../utils/common";
+import { RESOURCES } from "../../support/testData/resources";
 import {
   BackstageShowcase,
   CatalogImport,
-} from "../support/pages/catalog-import";
-import { TEMPLATES } from "../support/testData/templates";
+} from "../../support/pages/catalog-import";
+import { TEMPLATES } from "../../support/testData/templates";
+import { HelmActions } from "../../utils/helm";
+import * as constants from "../../utils/authenticationProviders/constants";
+import { LOGGER } from "../../utils/logger";
+import { waitForNextSync } from "../../utils/helper";
 
 let page: Page;
 
 // TODO: replace skip with serial
-test.describe.skip("GitHub Happy path", () => {
+test.describe.serial("GitHub Happy path", () => {
   //TODO: skipping due to RHIDP-4992
   let common: Common;
   let uiHelper: UIhelper;
   let catalogImport: CatalogImport;
   let backstageShowcase: BackstageShowcase;
+  const syncTime = 60;
 
   const component =
     "https://github.com/redhat-developer/rhdh/blob/main/catalog-entities/all.yaml";
@@ -28,12 +33,92 @@ test.describe.skip("GitHub Happy path", () => {
     common = new Common(page);
     catalogImport = new CatalogImport(page);
     backstageShowcase = new BackstageShowcase(page);
-    await common.loginAsGithubUser();
   });
 
-  test.beforeEach(
-    async () => await new Common(page).checkAndClickOnGHloginPopup(),
-  );
+  test("Setup Github authentication provider and wait for first sync", async () => {
+    test.setTimeout(300 * 1000);
+
+    LOGGER.info(`Base Url is ${process.env.BASE_URL}`);
+    LOGGER.info(
+      "Execute testcase: Setup Github authentication provider and wait for first sync",
+    );
+
+    await HelmActions.upgradeHelmChartWithWait(
+      constants.AUTH_PROVIDERS_RELEASE,
+      constants.AUTH_PROVIDERS_CHART,
+      constants.AUTH_PROVIDERS_NAMESPACE,
+      constants.AUTH_PROVIDERS_VALUES_FILE,
+      constants.CHART_VERSION,
+      constants.QUAY_REPO,
+      constants.TAG_NAME,
+      [
+        "--set upstream.backstage.appConfig.signInPage=github",
+        "--set upstream.backstage.appConfig.auth.environment=production",
+        "--set upstream.backstage.appConfig.catalog.providers.githubOrg[0].orgs[0]=janus-qe",
+        "--set upstream.backstage.appConfig.catalog.providers.microsoftGraphOrg=null",
+        "--set upstream.backstage.appConfig.catalog.providers.keycloakOrg=null",
+        "--set upstream.backstage.appConfig.auth.providers.microsoft=null",
+        "--set upstream.backstage.appConfig.auth.providers.oidc=null",
+        "--set upstream.backstage.appConfig.permission.enabled=false",
+        "--set upstream.postgresql.primary.persistence.enabled=false",
+        `--set-json global.dynamic.plugins='[
+          {
+            "package": "./dynamic-plugins/dist/backstage-plugin-scaffolder-backend-module-github-dynamic",
+            "disabled": false
+          },
+          {
+            "package": "./dynamic-plugins/dist/backstage-plugin-catalog-backend-module-github-dynamic",
+            "disabled": false,
+            "pluginConfig": {
+              "catalog": {
+                "providers": {
+                  "github": {
+                    "my-test-org": {
+                      "organization": "janus-qe",
+                      "catalogPath": "/catalog-info.yaml",
+                      "schedule": {
+                        "frequency": {
+                          "minutes": 1
+                        },
+                        "timeout": {
+                          "minutes": 1
+                        },
+                        "initialDelay": {
+                          "seconds": 15
+                        }
+                      }
+                    }
+                  }
+                }
+              }
+            }
+          },
+          {
+            "package": "./dynamic-plugins/dist/backstage-community-plugin-github-issues",
+            "disabled": false
+          },
+          {
+            "package": "./dynamic-plugins/dist/roadiehq-backstage-plugin-github-pull-requests",
+            "disabled": false
+          },
+          {
+            "package": "./dynamic-plugins/dist/backstage-community-plugin-github-actions",
+            "disabled": false
+          },
+          {
+            "package": "./dynamic-plugins/dist/backstage-plugin-catalog-backend-module-github-org-dynamic",
+            "disabled": false
+          }
+        ]'`,
+      ],
+    );
+
+    await waitForNextSync("github", syncTime);
+  });
+
+  test("Login as a Github user.", async () => {
+    await common.loginAsGithubUser();
+  });
 
   test("Verify Profile is Github Account Name in the Settings page", async () => {
     await uiHelper.goToSettingsPage();
@@ -71,7 +156,7 @@ test.describe.skip("GitHub Happy path", () => {
 
     await uiHelper.openSidebar("Catalog");
     await uiHelper.selectMuiBox("Kind", "User");
-    await uiHelper.searchInputAriaLabel("rhdh");
+    await uiHelper.searchInputPlaceholder("rhdh");
     await uiHelper.verifyRowsInTable(["rhdh-qe"]);
   });
 
@@ -111,8 +196,10 @@ test.describe.skip("GitHub Happy path", () => {
     await common.clickOnGHloginPopup();
     const openIssues = await backstageShowcase.getGithubOpenIssues();
 
-    const issuesCountText = `All repositories (${openIssues.length} Issues)*`;
-    await expect(page.locator(`text=${issuesCountText}`)).toBeVisible();
+    const issuesCountText = new RegExp(
+      `All repositories \\(${openIssues.length} Issue.*\\)`,
+    );
+    await expect(page.getByText(issuesCountText)).toBeVisible();
 
     for (const issue of openIssues.slice(0, 5)) {
       await uiHelper.verifyText(issue.title.replace(/\s+/g, " "));
@@ -132,8 +219,7 @@ test.describe.skip("GitHub Happy path", () => {
     await backstageShowcase.verifyPRRows(closedPRs, 0, 5);
   });
 
-  // TODO https://issues.redhat.com/browse/RHIDP-3159 The last ~10 GitHub Pull Requests are missing from the list
-  test.skip("Click on the arrows to verify that the next/previous/first/last pages of PRs are loaded", async () => {
+  test("Click on the arrows to verify that the next/previous/first/last pages of PRs are loaded", async () => {
     console.log("Fetching all PRs from GitHub");
     const allPRs = await BackstageShowcase.getShowcasePRs("all", true);
 
@@ -145,32 +231,37 @@ test.describe.skip("GitHub Happy path", () => {
     await backstageShowcase.clickNextPage();
     await backstageShowcase.verifyPRRows(allPRs, 5, 10);
 
-    const lastPagePRs = Math.floor((allPRs.length - 1) / 5) * 5;
+    // const lastPagePRs = Math.floor((allPRs.length - 1) / 5) * 5;
+    const lastPagePRs = 996; // redhat-developer/rhdh have more than 1000 PRs open/closed and by default the latest 1000 PR results are displayed.
 
     console.log("Clicking on Last Page button");
     await backstageShowcase.clickLastPage();
-    await backstageShowcase.verifyPRRows(allPRs, lastPagePRs, allPRs.length);
+    await backstageShowcase.verifyPRRows(allPRs, lastPagePRs, 1000);
 
     console.log("Clicking on Previous Page button");
     await backstageShowcase.clickPreviousPage();
-    await backstageShowcase.verifyPRRows(allPRs, lastPagePRs - 5, lastPagePRs);
+    await common.waitForLoad();
+    await backstageShowcase.verifyPRRows(
+      allPRs,
+      lastPagePRs - 5,
+      lastPagePRs - 1,
+    );
   });
 
-  //FIXME
-  test.skip("Verify that the 5, 10, 20 items per page option properly displays the correct number of PRs", async () => {
+  test("Verify that the 5, 10, 20 items per page option properly displays the correct number of PRs", async () => {
     await uiHelper.openSidebar("Catalog");
+    await uiHelper.clickByDataTestId("user-picker-all");
     await uiHelper.clickLink("Backstage Showcase");
     await common.clickOnGHloginPopup();
     await uiHelper.clickTab("Pull/Merge Requests");
-    await uiHelper.clickButton("ALL", { force: false });
-    const allPRs = await BackstageShowcase.getShowcasePRs("all");
+    const allPRs = await BackstageShowcase.getShowcasePRs("open");
     await backstageShowcase.verifyPRRowsPerPage(5, allPRs);
     await backstageShowcase.verifyPRRowsPerPage(10, allPRs);
     await backstageShowcase.verifyPRRowsPerPage(20, allPRs);
   });
 
   test("Verify that the CI tab renders 5 most recent github actions and verify the table properly displays the actions when page sizes are changed and filters are applied", async () => {
-    await uiHelper.clickTab("CI");
+    await page.locator("a").getByText("CI", { exact: true }).first().click();
     await common.checkAndClickOnGHloginPopup();
 
     const workflowRuns = await backstageShowcase.getWorkflowRuns();
diff --git a/e2e-tests/playwright/support/pages/catalog-import.ts b/e2e-tests/playwright/support/pages/catalog-import.ts
@@ -71,8 +71,8 @@ export class BackstageShowcase {
     paginated = false,
   ) {
     return await APIHelper.getGitHubPRs(
-      "janus-idp",
-      "backstage-showcase",
+      "redhat-developer",
+      "rhdh",
       state,
       paginated,
     );
@@ -99,7 +99,7 @@ export class BackstageShowcase {
     await this.uiHelper.verifyText(allPRs[rows - 1].title, false);
     await this.uiHelper.verifyLink(allPRs[rows].number, {
       exact: false,
-      notVisible: false,
+      notVisible: true,
     });
 
     const tableRows = this.page.locator(
diff --git a/e2e-tests/playwright/utils/common.ts b/e2e-tests/playwright/utils/common.ts
@@ -79,9 +79,8 @@ export class Common {
       await this.page.waitForTimeout(60000);
       await this.page.fill("#app_totp", this.getGitHub2FAOTP(userid));
     }
-    await expect(this.page.locator("#app_totp")).toBeHidden({
-      timeout: 120000,
-    });
+
+    await this.page.waitForTimeout(3_000);
   }
 
   async logintoKeycloak(userid: string, password: string) {
diff --git a/e2e-tests/playwright/utils/ui-helper.ts b/e2e-tests/playwright/utils/ui-helper.ts
@@ -135,7 +135,7 @@ export class UIhelper {
     let linkLocator: Locator;
     let notVisibleCheck: boolean;
 
-    if (typeof arg === "string") {
+    if (typeof arg != "object") {
       linkLocator = this.page
         .locator("a")
         .getByText(arg, { exact: options.exact })

Original file line number	Diff line number	Diff line change
`@@ -79,9 +79,8 @@ export class Common {`
`79`	`79`	`await this.page.waitForTimeout(60000);`
`80`	`80`	`await this.page.fill("#app_totp", this.getGitHub2FAOTP(userid));`
`81`	`81`	`}`
`82`		`- await expect(this.page.locator("#app_totp")).toBeHidden({`
`83`		`- timeout: 120000,`
`84`		`- });`
	`82`	`+`
	`83`	`+ await this.page.waitForTimeout(3_000);`
`85`	`84`	`}`
`86`	`85`
`87`	`86`	`async logintoKeycloak(userid: string, password: string) {`