Add E2E tests for Member Clusters in the dashboard #270

SunsetB612 · 2025-09-12T03:01:48Z

No description provided.

karmada-bot · 2025-09-12T03:01:53Z

[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 warjiang for approval. For more information see the Kubernetes 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:

OWNERS

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

gemini-code-assist

Summary of Changes

Hello @SunsetB612, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request focuses on refactoring and updating the End-to-End (E2E) test suite for the dashboard. It removes outdated namespace-related tests and repurposes an existing namespace list test to cover cronjob listing functionality. Additionally, it introduces a new dependency, @kubernetes/client-node, which suggests an expansion of the dashboard's capabilities or testing approach. While the PR title mentions adding E2E tests for member clusters, the current changes primarily involve cleanup and re-scoping of existing tests rather than the introduction of new member cluster-specific tests.

Highlights

E2E Test Suite Refactoring: Several existing E2E tests related to namespace management (creation, deletion, network error handling) have been removed, streamlining the test suite.
Namespace List Test Repurposed to CronJob List Test: The E2E test previously responsible for listing namespaces has been renamed and updated to validate the display and functionality of the CronJob list in the dashboard.
New Dependency Added: @kubernetes/client-node: The @kubernetes/client-node package has been added as a dependency, indicating potential future enhancements or more direct Kubernetes API interactions within the dashboard or its testing infrastructure.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.

Feature	Command	Description
Code Review	`/gemini review`	Performs a code review for the current pull request in its current state.
Pull Request Summary	`/gemini summary`	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in issue comments and review comments.
Help	`/gemini help`	Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

gemini-code-assist

Code Review

This pull request adds a new end-to-end test for the CronJob list page and removes several E2E tests related to namespaces. While adding new tests is great, the removal of existing tests for namespace creation, deletion, and network error handling is concerning. Please clarify if this functionality is now covered by other tests.

The PR title, "Add E2E tests for Member Clusters in the dashboard," does not seem to accurately reflect the changes. A more descriptive title would be helpful.

I've added a few review comments focusing on improving the new test's clarity and robustness, and a high-severity comment regarding a new dependency in package.json that might be better suited as a development dependency to avoid bloating the production bundle.

gemini-code-assist · 2025-09-12T03:03:24Z

ui/apps/dashboard/package.json

    "@karmada/i18n-tool": "workspace:*",
    "@karmada/terminal": "workspace:*",
    "@karmada/utils": "workspace:*",
+    "@kubernetes/client-node": "^1.3.0",


The @kubernetes/client-node package has been added to dependencies. This package is typically used for backend services. If it's only used for development purposes, such as in E2E tests for test setup, it should be moved to devDependencies. This will prevent it from being included in the production frontend bundle, which would unnecessarily increase the application's size. Please clarify its usage and move it if it's not a runtime dependency for the client application.

gemini-code-assist · 2025-09-12T03:03:24Z

ui/apps/dashboard/e2e/workload/cronjob/cronjob-list.spec.ts

 */

-// apps/dashboard/e2e/namespace-list.spec.ts
+// apps/dashboard/e2e/cronjob-list.spec.ts


The file path in this comment is incorrect. It should be updated to match the actual file path for better maintainability.

Suggested change

// apps/dashboard/e2e/cronjob-list.spec.ts

// apps/dashboard/e2e/workload/cronjob/cronjob-list.spec.ts

gemini-code-assist · 2025-09-12T03:03:24Z

ui/apps/dashboard/e2e/workload/cronjob/cronjob-list.spec.ts

+    const statefulsetTab = page.locator('role=option[name="Cronjob"]');
+    await statefulsetTab.waitFor({ state: 'visible', timeout: 30000 });
+    await statefulsetTab.click();
+
+    // 验证选中状态
+    await expect(statefulsetTab).toHaveAttribute('aria-selected', 'true');


The variable statefulsetTab is used to locate and interact with the "Cronjob" tab, which is misleading. For clarity and maintainability, it should be renamed to cronjobTab. Additionally, the comment on line 45 is in Chinese; please use English for consistency with the rest of the codebase.

Suggested change

const statefulsetTab = page.locator('role=option[name="Cronjob"]');

await statefulsetTab.waitFor({ state: 'visible', timeout: 30000 });

await statefulsetTab.click();

// 验证选中状态

await expect(statefulsetTab).toHaveAttribute('aria-selected', 'true');

const cronjobTab = page.locator('role=option[name="Cronjob"]');

await cronjobTab.waitFor({ state: 'visible', timeout: 30000 });

await cronjobTab.click();

// Verify selected state

await expect(cronjobTab).toHaveAttribute('aria-selected', 'true');

gemini-code-assist · 2025-09-12T03:03:24Z

ui/apps/dashboard/e2e/workload/cronjob/cronjob-list.spec.ts

+    await expect(statefulsetTab).toHaveAttribute('aria-selected', 'true');
+
+
+    // 验证 StatefulSet 列表表格可见


This comment is in Chinese and incorrectly refers to StatefulSet. Please update it to English and refer to CronJob to accurately reflect the test's context.

Suggested change

// 验证 StatefulSet 列表表格可见

// Verify that the CronJob list table is visible

gemini-code-assist · 2025-09-12T03:03:24Z

ui/apps/dashboard/e2e/workload/cronjob/cronjob-list.spec.ts

    const table = page.locator('table');
    await expect(table).toBeVisible({ timeout: 30000 });


This test only verifies that a <table> element is visible. To make the test more robust, consider adding an assertion to check for the presence of expected content, such as table headers (e.g., 'Name', 'Namespace'). This would help ensure that the table is not just rendered but also correctly populated.

SunsetB612 · 2025-09-12T09:13:59Z

/hold

SunsetB612 · 2025-09-20T11:40:44Z

/unhold

XiShanYongYe-Chang

Thanks~

XiShanYongYe-Chang · 2025-10-22T07:26:24Z

ui/apps/dashboard/e2e/member clusters/test-utils.ts

+ * Generate test Member Cluster kubeconfig YAML with timestamp
+ * Note: The Member Cluster creation page expects kubeconfig format, not Cluster resource format
+ */
+export function generateTestMemberClusterYaml() {


It is recommended to rename it to generateTestClusterKubeConfig.

XiShanYongYe-Chang · 2025-10-22T07:27:20Z

ui/apps/dashboard/e2e/member clusters/test-utils.ts

+ */
+export function generateTestMemberClusterYaml() {
+    const timestamp = Date.now();
+    return `apiVersion: v1


A bit curious, can we join the cluster without needing the cluster's certificate and key?

@XiShanYongYe-Chang here in the kubeconfig, specify insecure-skip-tls-verify: true in cluster field

ui/apps/dashboard/e2e/member clusters/member-cluster-create.spec.ts

XiShanYongYe-Chang · 2025-10-22T07:39:24Z

ui/apps/dashboard/e2e/member clusters/test-utils.ts

+ * Generate test Member Cluster resource YAML with timestamp in Cluster resource format
+ * Note: This generates a Cluster resource that can be created via Karmada API
+ */
+export function generateTestMemberClusterResourceYaml() {


I feel that this method can be abstracted to be more general, independent of specific resource types.

That makes sense. Though since each resource has pretty different YAML fields, maybe keeping it specific is fine for now?

ui/apps/dashboard/e2e/member clusters/member-cluster-delete.spec.ts

ui/apps/dashboard/e2e/member clusters/member-cluster-edit.spec.ts

Signed-off-by: SunsetB612 <[email protected]>

XiShanYongYe-Chang · 2025-10-25T04:02:06Z

Thanks~
LGTM

warjiang · 2025-10-27T02:21:17Z

/assign

warjiang · 2025-10-27T02:37:33Z

ui/apps/dashboard/e2e/member clusters/test-utils.ts

+export async function createK8sMemberCluster(yamlContent: string): Promise<void> {
+    try {
+        const k8sApi = createKarmadaCustomObjectsApiClient();
+        const yamlObject = parse(yamlContent) as any;


here we can use const yamlObject = parse(yamlContent) as Record<string, any>; as a tradeoff, a better way is to generate the corresponding typescript definition based on the membercluster api resource

warjiang · 2025-10-27T02:38:41Z

ui/apps/dashboard/e2e/member clusters/test-utils.ts

+        });
+
+    } catch (error: any) {
+        throw new Error(`Failed to create member cluster: ${error.message}`);


fix lint problem // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access

warjiang · 2025-10-27T02:39:08Z

ui/apps/dashboard/e2e/member clusters/test-utils.ts

+            // Member Cluster not found - already deleted, this is fine
+            return;
+        }
+        throw new Error(`Failed to delete member cluster: ${error.message}`);


warjiang · 2025-10-27T02:39:42Z

ui/apps/dashboard/e2e/member clusters/test-utils.ts

+export function getMemberClusterNameFromResourceYaml(yamlContent: string): string {
+    const yamlObject = parse(yamlContent);
+    // For Cluster resource format, get the name from metadata.name
+    const memberClusterName = _.get(yamlObject, 'metadata.name');


warjiang · 2025-10-27T02:40:12Z

ui/apps/dashboard/e2e/member clusters/test-utils.ts

+export function getMemberClusterNameFromYaml(yamlContent: string): string {
+    const yamlObject = parse(yamlContent);
+    // For kubeconfig format, get the cluster name from clusters[0].name
+    const memberClusterName = _.get(yamlObject, 'clusters[0].name');


warjiang · 2025-10-27T02:43:11Z

@SunsetB612 another suggestion is that, for the folder name, use member-cluster or member_cluster should be better

XiShanYongYe-Chang · 2025-10-27T02:58:53Z

@SunsetB612 another suggestion is that, for the folder name, use member-cluster or member_cluster should be better

I didn't notice that. 👍

karmada-bot requested review from devadapter and warjiang September 12, 2025 03:01

karmada-bot added the size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. label Sep 12, 2025

gemini-code-assist bot reviewed Sep 12, 2025

View reviewed changes

karmada-bot added the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Sep 12, 2025

XiShanYongYe-Chang mentioned this pull request Sep 10, 2025

[Umbrella][Summer OSPP 2025] Introduce E2E for the Karmada Dashboard #261

Open

18 tasks

SunsetB612 force-pushed the add-e2e-memberclusters branch from cb9b1b9 to d77203a Compare September 20, 2025 05:35

karmada-bot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. and removed size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. labels Sep 20, 2025

SunsetB612 force-pushed the add-e2e-memberclusters branch from d77203a to b2c4512 Compare September 20, 2025 08:44

karmada-bot added size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. and removed size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Sep 20, 2025

SunsetB612 force-pushed the add-e2e-memberclusters branch from b2c4512 to 4840ff0 Compare September 20, 2025 09:30

karmada-bot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. and removed size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. labels Sep 20, 2025

SunsetB612 force-pushed the add-e2e-memberclusters branch from 4840ff0 to db3579a Compare September 20, 2025 11:01

karmada-bot added size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. and removed size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Sep 20, 2025

SunsetB612 force-pushed the add-e2e-memberclusters branch from db3579a to 05c40cb Compare September 20, 2025 11:05

karmada-bot removed the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Sep 20, 2025

XiShanYongYe-Chang reviewed Oct 22, 2025

View reviewed changes

Add E2E tests for Member Clusters in the dashboard

0bc94a9

Signed-off-by: SunsetB612 <[email protected]>

SunsetB612 force-pushed the add-e2e-memberclusters branch from 05c40cb to 0bc94a9 Compare October 24, 2025 12:10

karmada-bot assigned warjiang Oct 27, 2025

warjiang reviewed Oct 27, 2025

View reviewed changes

	// apps/dashboard/e2e/cronjob-list.spec.ts
	// apps/dashboard/e2e/workload/cronjob/cronjob-list.spec.ts

		await expect(statefulsetTab).toHaveAttribute('aria-selected', 'true');


		// 验证 StatefulSet 列表表格可见

	// 验证 StatefulSet 列表表格可见
	// Verify that the CronJob list table is visible

		const table = page.locator('table');
		await expect(table).toBeVisible({ timeout: 30000 });

Add E2E tests for Member Clusters in the dashboard #270

Are you sure you want to change the base?

Add E2E tests for Member Clusters in the dashboard #270

Conversation

SunsetB612 commented Sep 12, 2025

Uh oh!

karmada-bot commented Sep 12, 2025

Uh oh!

gemini-code-assist bot left a comment

Choose a reason for hiding this comment

Summary of Changes

Highlights

Footnotes

Uh oh!

gemini-code-assist bot left a comment

Choose a reason for hiding this comment

Code Review

Uh oh!

gemini-code-assist bot Sep 12, 2025

Choose a reason for hiding this comment

Uh oh!

gemini-code-assist bot Sep 12, 2025

Choose a reason for hiding this comment

Uh oh!

gemini-code-assist bot Sep 12, 2025

Choose a reason for hiding this comment

Uh oh!

gemini-code-assist bot Sep 12, 2025

Choose a reason for hiding this comment

Uh oh!

gemini-code-assist bot Sep 12, 2025

Choose a reason for hiding this comment

Uh oh!

SunsetB612 commented Sep 12, 2025

Uh oh!

SunsetB612 commented Sep 20, 2025

Uh oh!

XiShanYongYe-Chang left a comment

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!

Uh oh!

Uh oh!

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!

Uh oh!

Uh oh!

XiShanYongYe-Chang commented Oct 25, 2025

Uh oh!

warjiang commented Oct 27, 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!

warjiang commented Oct 27, 2025

Uh oh!

XiShanYongYe-Chang commented Oct 27, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone