test(e2e): add Github Insights plugin tests #2818

natifridman · 2025-04-29T09:17:54Z

Description

Add Github Insights plugin tests
https://github.com/RoadieHQ/roadie-backstage-plugins/tree/main/plugins/frontend/backstage-plugin-github-insights

Which issue(s) does this PR fix

Fixes RHIDP-6712

PR acceptance criteria

Please make sure that the following steps are complete:

GitHub Actions are completed and successful
Unit Tests are updated and passing
E2E Tests are updated and passing
Documentation is updated if necessary (requirement for new features)
Add a screenshot if the change is UX/UI related

How to test changes / Special notes to the reviewer

openshift-ci · 2025-04-29T09:18:02Z

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please assign albarbaro for approval. For more information see the Code Review Process.

The full list of commands accepted by this bot can be found here.

Needs approval from an approver in each of these files:

.ibm/OWNERS
e2e-tests/OWNERS

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

openshift-ci · 2025-04-29T09:18:06Z

Hi @natifridman. Thanks for your PR.

I'm waiting for a redhat-developer member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

github-actions · 2025-04-29T10:00:49Z

The image is available at:

natifridman · 2025-04-30T11:12:37Z

/cc @subhashkhileri @gustavolira

github-actions · 2025-05-08T02:54:09Z

This PR is stale because it has been open 7 days with no activity. Remove stale label or comment or this will be closed in 21 days.

gustavolira · 2025-05-09T13:35:40Z

/ok-to-test

gustavolira · 2025-05-09T13:37:44Z

e2e-tests/playwright/e2e/plugins/github-insights/github-insights.spec.ts

+import { Common } from "../../../utils/common";
+import { UI_HELPER_ELEMENTS } from "../../../support/pageObjects/global-obj";
+
+// Test to verify if the GitHub Insights plugin is installed - runs independently


This comment has the same text of the test description.

gustavolira · 2025-05-09T13:37:50Z

e2e-tests/playwright/e2e/plugins/github-insights/github-insights.spec.ts

+
+  const uiHelper = new UIhelper(page);
+
+  // Navigate to the Administration in the sidebar


Excessive Comments:
While comments are useful, some explain actions that are already obvious from the function names.

gustavolira · 2025-05-09T13:38:08Z

e2e-tests/playwright/e2e/plugins/github-insights/github-insights.spec.ts

+
+  // Wait for the page to load
+  await page.waitForLoadState("networkidle");
+


Move to a function into UiHelper

gustavolira · 2025-05-09T13:38:22Z

e2e-tests/playwright/e2e/plugins/github-insights/github-insights.spec.ts

+  await uiHelper.openSidebar("Extensions");
+
+  // Wait for the page to load
+  await page.waitForLoadState("networkidle");


Using page.waitForLoadState('networkidle') and page.waitForLoadState('domcontentloaded') is not recommended for modern web applications. These methods rely on global states that can be unreliable in dynamic applications with ongoing network requests (e.g., WebSockets or API polling). Instead, it’s better to wait for specific elements or components that indicate the page is fully loaded and interactive. For example, use
page.waitForSelector('[data-testid="something"]') to ensure tests are more reliable and maintainable.

gustavolira · 2025-05-09T13:38:50Z

e2e-tests/playwright/e2e/plugins/github-insights/github-insights.spec.ts

+    await uiHelper.openSidebar("Catalog");
+    await uiHelper.selectMuiBox("Kind", "Component");
+    await uiHelper.clickByDataTestId("user-picker-all");


There's a function on UiHelper openCatalogSidebar you can reuse it
https://github.com/redhat-developer/rhdh/blob/main/e2e-tests/playwright/utils/ui-helper.ts#L207

gustavolira · 2025-05-09T13:39:02Z

e2e-tests/playwright/e2e/plugins/github-insights/github-insights.spec.ts

+    await uiHelper.clickLink(repoWithGitHubInsights);
+
+    // Wait for entity page to load
+    await page.waitForLoadState("networkidle");


gustavolira · 2025-05-09T13:40:58Z

e2e-tests/playwright/e2e/plugins/github-insights/github-insights.spec.ts

+    await uiHelper.verifyTextinCard("Compliance report", "License");
+    await uiHelper.verifyTextinCard("Compliance report", "Apache License");


Suggested change

await uiHelper.verifyTextinCard("Compliance report", "License");

await uiHelper.verifyTextinCard("Compliance report", "Apache License");

await uiHelper.verifyMultipleTextsInCard("Compliance report", ["License", "Apache License"]);

github-actions · 2025-05-11T09:00:23Z

The image is available at:

github-actions · 2025-05-14T12:31:09Z

The image is available at:

gustavolira · 2025-05-17T11:29:06Z

/test e2e-tests-nightly-auth-providers

openshift-ci · 2025-05-17T11:29:10Z

@gustavolira: The specified target(s) for /test were not found.
The following commands are available to trigger required jobs:

/test e2e-tests

The following commands are available to trigger optional jobs:

/test cleanup-mapt-destroy-orphaned-aks-clusters

/test e2e-tests-aks-helm-nightly

/test e2e-tests-aks-operator-nightly

/test e2e-tests-gke-helm-nightly

/test e2e-tests-gke-operator-nightly

/test e2e-tests-nightly

/test e2e-tests-operator-nightly

/test e2e-tests-osd-gcp-helm-nightly

/test e2e-tests-osd-gcp-operator-nightly

/test e2e-tests-upgrade-nightly

Use /test all to run the following jobs that were automatically triggered:

pull-ci-redhat-developer-rhdh-main-e2e-tests

In response to this:

/test e2e-tests-nightly-auth-providers

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

albarbaro · 2025-05-27T10:44:49Z

e2e-tests/playwright.config.ts

-      testMatch: ["**/playwright/e2e/authProviders/*.spec.ts"],
+      testMatch: [
+        "**/playwright/e2e/authProviders/*.spec.ts",
+        "**/playwright/e2e/plugins/github-insights/*.spec.ts",


The auth-providers job is not the best place to run any GitHub plugin-related test; this job is going to be refactored soon and will not include any plugin test. Also, just adding the files in testMatch list is not enough to run them in this job, as they do not run against a single RHDH instance, but multiple ones are created and deleted dynamically during the tests execution.
I would recommend to setup the Github integration and the Github auth provider in the e2e main job configuration files and run the plugins tests along with the other plugins tests.
I'm going to create the OAuth for you and provide the necessary changes to update the configuration.

Hi @albarbaro, any update on this?

I have created the Oauth client. You need to update the configuration with following:

load the new environment variable from vault by adding here these lines

GITHUB_OAUTH_APP_ID=$(cat /tmp/secrets/GITHUB_OAUTH_APP_ID) GITHUB_OAUTH_APP_SECRET=$(cat /tmp/secrets/GITHUB_OAUTH_APP_SECRET)

update the app-config to add the github auth provider by adding this config in here

auth: github: production: clientSecret: ${GITHUB_OAUTH_APP_SECRET} clientId: ${GITHUB_OAUTH_APP_ID} callbackUrl: ${RHDH_BASE_URL}/api/auth/github/handler/frame

the github-org plugin is apparently already enabled: you might want to adjust the sync frequency if the users are not ingested immediately

move **/playwright/e2e/plugins/github-insights/*.spec.ts out of the showcase-auth-providers playwright project and place them in the showcase one

The main configuration uses RHBK as the default signIn page: this means that your tests might need to be updated to login from the settings page if interactive login is required (but this is plugin specific).
cc @subhashkhileri @gustavolira please double check or raise any concern/error if you spot some.

github-actions · 2025-06-14T02:10:13Z

This PR is stale because it has been open 7 days with no activity. Remove stale label or comment or this will be closed in 21 days.

natifridman · 2025-06-19T07:09:16Z

Comment to remove stale

natifridman · 2025-06-19T12:22:16Z

/remove stale

github-actions · 2025-06-29T02:14:14Z

This PR is stale because it has been open 7 days with no activity. Remove stale label or comment or this will be closed in 21 days.

github-actions · 2025-06-29T08:31:39Z

The image is available at:

subhashkhileri · 2025-06-30T05:01:33Z

.ibm/pipelines/resources/config_map/app-config-rhdh.yaml

@@ -104,6 +104,11 @@ auth:
        signIn:
          resolvers:
            - resolver: emailLocalPartMatchingUserEntityName
+    github:


there is already one github auth configured, lets not duplicate it. https://github.com/redhat-developer/rhdh/pull/2818/files#diff-feaa002a3b212bd3fbc10b72ef2f2cb16c8dcc1ab3f91698ffbc694281af55c2R92

subhashkhileri · 2025-06-30T05:02:40Z

.ibm/pipelines/auth/secrets-rhdh-secrets.yaml

@@ -17,6 +17,8 @@ data:
  GITHUB_URL: $GITHUB_URL
  GITHUB_ORG: $GITHUB_ORG
  GITHUB_ORG_2: $GITHUB_ORG_2
+  GITHUB_OAUTH_APP_SECRET: $GITHUB_OAUTH_APP_SECRET


GITHUB_OAUTH secrete and app ID is already present in secrets

subhashkhileri · 2025-06-30T05:03:22Z

.ibm/pipelines/env_variables.sh

@@ -57,6 +57,9 @@ QE_USER5_PASS=$(cat /tmp/secrets/QE_USER5_PASS)
 QE_USER6_ID=$(cat /tmp/secrets/QE_USER6_ID)
 QE_USER6_PASS=$(cat /tmp/secrets/QE_USER6_PASS)

+GITHUB_OAUTH_APP_ID=$(cat /tmp/secrets/GITHUB_OAUTH_APP_ID)


GITHUB_OAUTH secrete and app ID is already present in env_variables.sh

subhashkhileri · 2025-06-30T05:05:33Z

e2e-tests/playwright/utils/ui-helper.ts

+   * Navigates to the Extensions page in the Administration section
+   * and selects the Installed tab
+   */
+  async navigateToExtensions() {


there is already one method for this in PR #3013

please check the quoted comments "This method is doing more than just navigation. would it make sense to move other clicks in test itself so in future someone want to use this method other than installed Tab they can use it."

subhashkhileri · 2025-06-30T05:12:00Z

e2e-tests/playwright/utils/ui-helper.ts

+   * @param texts Array of strings or RegExp to verify in the card
+   * @param exact Whether to match exact text
+   */
+  async verifyMultipleTextsInCard(


@natifridman accepting [] in verifyTextinCard is fine without a need for another method ``verifyMultipleTextsInCard`

gustavolira · 2025-05-12T19:02:50Z

e2e-tests/playwright/e2e/plugins/github-insights/github-insights.spec.ts

+
+    // Click on the repo link and wait for entity page heading to appear
+    await uiHelper.clickLink(repoWithGitHubInsights);
+    await page.waitForSelector("h1", { state: "visible" });


we have waitForTitle on UIHelper

Hi @natifridman can you please update this one?

github-actions · 2025-07-08T02:13:34Z

This PR is stale because it has been open 7 days with no activity. Remove stale label or comment or this will be closed in 21 days.

github-actions · 2025-07-10T08:44:02Z

The image is available at:

openshift-ci · 2025-07-10T08:44:03Z

@natifridman: The following test failed, say /retest to rerun all failed tests or /retest-required to rerun all mandatory failed tests:

Test name	Commit	Details	Required	Rerun command
ci/prow/e2e-tests	`dc4458c`	link	true	`/test e2e-tests`

Full PR test history. Your PR dashboard.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. I understand the commands that are listed here.

github-actions · 2025-07-19T02:13:46Z

This PR is stale because it has been open 7 days with no activity. Remove stale label or comment or this will be closed in 21 days.

openshift-ci bot requested review from albarbaro and zdrapela April 29, 2025 09:18

openshift-ci bot added the needs-ok-to-test label Apr 29, 2025

natifridman changed the title ~~test(e2e): Add Github Insights plugin tests~~ test(e2e): add Github Insights plugin tests Apr 29, 2025

openshift-ci bot requested review from gustavolira and subhashkhileri April 30, 2025 11:12

github-actions bot added the Stale label May 8, 2025

openshift-ci bot added ok-to-test and removed needs-ok-to-test labels May 9, 2025

gustavolira requested changes May 9, 2025

View reviewed changes

gustavolira reviewed May 9, 2025

View reviewed changes

github-actions bot removed the Stale label May 10, 2025

natifridman force-pushed the github-insight branch from a1ff257 to c6d0128 Compare May 11, 2025 08:05

natifridman requested a review from gustavolira May 13, 2025 08:50

natifridman force-pushed the github-insight branch from 6dedea6 to 3e37596 Compare May 14, 2025 12:33

natifridman force-pushed the github-insight branch 2 times, most recently from 3e37596 to 37aba26 Compare May 21, 2025 08:16

albarbaro requested changes May 27, 2025

View reviewed changes

natifridman force-pushed the github-insight branch from 37aba26 to a95e1ee Compare June 3, 2025 10:32

natifridman force-pushed the github-insight branch 2 times, most recently from 73b1c53 to e929f9d Compare June 5, 2025 06:32

github-actions bot added the Stale label Jun 14, 2025

github-actions bot removed the Stale label Jun 21, 2025

github-actions bot added the Stale label Jun 29, 2025

natifridman force-pushed the github-insight branch from e929f9d to 12f1eb1 Compare June 29, 2025 07:54

github-actions bot removed the Stale label Jun 30, 2025

subhashkhileri reviewed Jun 30, 2025

View reviewed changes

gustavolira reviewed Jun 30, 2025

View reviewed changes

github-actions bot added the Stale label Jul 8, 2025

natifridman added 4 commits July 10, 2025 11:05

test(e2e): Add Github Insights plugin tests

bddc784

Fix review comments

6a72b6a

Set Github authentication

273f2a5

Fix failed tests in new environment

dc4458c

natifridman force-pushed the github-insight branch from 12f1eb1 to dc4458c Compare July 10, 2025 08:05

github-actions bot removed the Stale label Jul 11, 2025

github-actions bot added the Stale label Jul 19, 2025


		const uiHelper = new UIhelper(page);

		// Navigate to the Administration in the sidebar


		// Wait for the page to load
		await page.waitForLoadState("networkidle");

		await uiHelper.verifyTextinCard("Compliance report", "License");
		await uiHelper.verifyTextinCard("Compliance report", "Apache License");

	await uiHelper.verifyTextinCard("Compliance report", "License");
	await uiHelper.verifyTextinCard("Compliance report", "Apache License");
	await uiHelper.verifyMultipleTextsInCard("Compliance report", ["License", "Apache License"]);

test(e2e): add Github Insights plugin tests #2818

Are you sure you want to change the base?

test(e2e): add Github Insights plugin tests #2818

Uh oh!

Conversation

natifridman commented Apr 29, 2025 • edited by openshift-ci bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Which issue(s) does this PR fix

PR acceptance criteria

How to test changes / Special notes to the reviewer

Uh oh!

openshift-ci bot commented Apr 29, 2025

Uh oh!

openshift-ci bot commented Apr 29, 2025

Uh oh!

github-actions bot commented Apr 29, 2025

Uh oh!

natifridman commented Apr 30, 2025

Uh oh!

github-actions bot commented May 8, 2025

Uh oh!

gustavolira commented May 9, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

github-actions bot commented May 11, 2025

Uh oh!

github-actions bot commented May 14, 2025

Uh oh!

gustavolira commented May 17, 2025

Uh oh!

openshift-ci bot commented May 17, 2025

Uh oh!

albarbaro May 27, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

github-actions bot commented Jun 14, 2025

Uh oh!

natifridman commented Jun 19, 2025

Uh oh!

natifridman commented Jun 19, 2025

Uh oh!

github-actions bot commented Jun 29, 2025

Uh oh!

github-actions bot commented Jun 29, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

subhashkhileri Jun 30, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

natifridman commented Apr 29, 2025 •

edited by openshift-ci bot

Loading

albarbaro May 27, 2025 •

edited

Loading

subhashkhileri Jun 30, 2025 •

edited

Loading