Add e2e testing for the customized control panel of Karmadactl init. #6728

luyb177 · 2025-09-02T15:05:58Z

What type of PR is this?

/kind feature

What this PR does / why we need it:

E2E testing of Karmadactl init added based on #6637.

Which issue(s) this PR fixes:

Part of #6744

Does this PR introduce a user-facing change?:

Signed-off-by: luyb177 <[email protected]> delete init.go Signed-off-by: luyb177 <[email protected]> format Signed-off-by: luyb177 <[email protected]>

Signed-off-by: luyb177 <[email protected]> fix:The format generated by the genEtcdCipherSuites function has been modified. Signed-off-by: luyb177 <[email protected]> The format of the environment variables in the command has been modified. Signed-off-by: luyb177 <[email protected]> Correct the errors reported in the CI. Signed-off-by: luyb177 <[email protected]> Add additional parameters in the configuration file to customize the control panel. Signed-off-by: luyb177 <[email protected]>

Signed-off-by: luyb177 <[email protected]> fix:Modified some function names, deleted some code comments and TODO markers. Signed-off-by: luyb177 <[email protected]> fix:Delete the unnecessary blank lines. Signed-off-by: luyb177 <[email protected]> fix:Delete the unnecessary blank lines. Signed-off-by: luyb177 <[email protected]>

karmada-bot · 2025-09-02T15:06:02Z

@luyb177: The label(s) kind/test cannot be applied, because the repository doesn't have them.

In response to this:

What type of PR is this?

/kind test

What this PR does / why we need it:

E2E testing of Karmadactl init added based on #6637.

Special notes for your reviewer:
The successful output result of the test is:
Does this PR introduce a user-facing change?:
NONE

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.

gemini-code-assist

Summary of Changes

Hello @luyb177, 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 significantly enhances the karmadactl init command by enabling advanced customization of Karmada control plane components through extra arguments. It also introduces robust end-to-end tests to ensure the reliability of this new functionality. The changes aim to provide greater flexibility for users to fine-tune their Karmada deployments while maintaining a clean and testable codebase.

Highlights

E2E Testing for Karmadactl Init: Introduced comprehensive end-to-end tests for the karmadactl init command, specifically focusing on the ability to customize control plane components with extra arguments.
Customizable Component Arguments: Added new command-line flags and configuration fields to karmadactl init allowing users to pass arbitrary extraArgs to various Karmada control plane components, including Etcd, Karmada API Server, Scheduler, Controller Manager, Webhook, Kube Controller Manager, and Aggregated API Server.
Argument Merging Utility: Implemented a new utility package (pkg/karmadactl/cmdinit/utils) with a KarmadaComponentCommand function to intelligently merge default component arguments with user-provided extraArgs, ensuring proper validation and precedence.
Code Refactoring and Cleanup: Refactored the internal logic for generating component commands in pkg/karmadactl/cmdinit/kubernetes to leverage the new argument merging utility, simplifying the codebase and improving maintainability. This also involved updating Etcd's command generation to a direct executable call instead of a shell script.

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 introduces the ability to pass extra arguments to Karmada components during karmadactl init, enhancing customization. It includes the necessary changes in command-line flags, configuration types, and deployment generation logic. The PR also adds comprehensive unit and e2e tests for the new functionality. My review focuses on improving code clarity and fixing a bug in argument parsing. I've pointed out the use of non-English comments, leftover // todo markers, and some dead code. Most importantly, I've identified a critical bug in the argument parsing logic for extra arguments and provided a suggested fix.

pkg/karmadactl/cmdinit/utils/merge.go

pkg/karmadactl/cmdinit/config/config.go

pkg/karmadactl/cmdinit/kubernetes/deploy.go

pkg/karmadactl/cmdinit/kubernetes/statefulset.go

pkg/util/names/names.go

codecov-commenter · 2025-09-02T15:22:57Z

⚠️ Please install the to ensure uploads and comments are reliably processed by Codecov.

Codecov Report

❌ Patch coverage is 65.50926% with 149 lines in your changes missing coverage. Please review.
✅ Project coverage is 45.78%. Comparing base (d410a0b) to head (4a14612).
⚠️ Report is 72 commits behind head on master.

Files with missing lines	Patch %	Lines
pkg/karmadactl/cmdinit/kubernetes/deploy.go	30.91%	130 Missing and 13 partials ⚠️
pkg/karmadactl/cmdinit/kubernetes/deployments.go	96.77%	2 Missing and 1 partial ⚠️
pkg/karmadactl/cmdinit/utils/merge.go	96.38%	2 Missing and 1 partial ⚠️
❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #6728      +/-   ##
==========================================
+ Coverage   45.35%   45.78%   +0.43%     
==========================================
  Files         688      691       +3     
  Lines       57020    57532     +512     
==========================================
+ Hits        25862    26342     +480     
+ Misses      29547    29542       -5     
- Partials     1611     1648      +37

Flag	Coverage Δ
unittests	`45.78% <65.50%> (+0.43%)`	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

karmada-bot · 2025-09-04T11:13:59Z

[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 liangyuanpeng, xishanyongye-chang 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:

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

luyb177 · 2025-10-07T05:51:58Z

/gemini review

gemini-code-assist

Code Review

This pull request introduces end-to-end testing for the customized control panel of karmadactl init and adds the ability to pass extra arguments to various Karmada components. The changes are extensive, touching testing scripts, command-line definitions, configuration types, and deployment logic. Overall, the implementation is solid, but I have identified a few areas for improvement regarding code clarity, maintainability, and test correctness. My feedback includes suggestions to simplify shell scripts, fix a potential issue in the test helpers, and remove some dead code.

luyb177 · 2025-10-09T04:26:39Z

/gemini review

gemini-code-assist

Code Review

This pull request introduces a valuable feature to customize Karmada components during initialization via karmadactl init, along with comprehensive E2E tests to validate it. The implementation is solid, particularly the refactoring of command-line argument handling for Karmada components.

I've identified a few areas for improvement, mainly in the new test scripts, to enhance robustness and correctness. Please see my detailed comments below.

gemini-code-assist · 2025-10-09T04:29:22Z

test/e2e/suites/init/karmadactl_init_test.go

+
+	out := make([]string, len(args))
+	for i, arg := range args {
+		out[i] = flag + "=" + "\"" + arg + "\""


The wrapArgs function incorrectly adds double quotes around the argument value. When exec.Command is used, arguments are passed directly to the process without shell interpretation. This means the quotes will be part of the argument string, causing parsing to fail downstream because the argument will be \"--foo=bar\" instead of --foo=bar.

The quotes should be removed to ensure the arguments are passed correctly to karmadactl.

Suggested change

out[i] = flag + "=" + "\"" + arg + "\""

out[i] = flag + "=" + arg

gemini-code-assist · 2025-10-09T04:29:22Z

hack/init-e2e-environment.sh

+# step2: prepare and copy the newest crds for karmadactl init
+# step2.1: prepare the newest crds for karmadactl init
+echo "Prepare the newest crds for karmadactl init"
+cd  charts/karmada/


For robustness, it's better to use an absolute path constructed from ${REPO_ROOT} to avoid issues with the script's execution directory. This makes the script less dependent on the current working directory.

Suggested change

cd charts/karmada/

cd "${REPO_ROOT}"/charts/karmada/

gemini-code-assist · 2025-10-09T04:29:23Z

hack/init-e2e-environment.sh

+echo "Prepare the newest crds for karmadactl init"
+cd  charts/karmada/
+cp -r _crds crds
+tar -zcvf ../../crds.tar.gz crds


The temporary crds directory created by cp -r _crds crds is not removed after the tarball is created. This leaves artifacts in the source tree. It's good practice to clean up temporary files and directories.

Suggested change

tar -zcvf ../../crds.tar.gz crds

tar -zcvf ../../crds.tar.gz crds

rm -rf crds

gemini-code-assist · 2025-10-09T04:29:23Z

hack/init-e2e-environment.sh

+# step2.3: Copy the local crds.tar.gz file to the specified path
+DATA_DIR="${HOME}/karmada-data"
+mkdir -p "${DATA_DIR}"
+cp ./crds.tar.gz "${DATA_DIR}/crds.tar.gz"


The crds.tar.gz file is left in the repository root after being copied. It should be cleaned up to avoid polluting the source tree.

Suggested change

cp ./crds.tar.gz "${DATA_DIR}/crds.tar.gz"

cp ./crds.tar.gz "${DATA_DIR}/crds.tar.gz"

rm ./crds.tar.gz

…e use of extraArgs in each component. Modify the functions in merge.go to resolve issues such as leading and trailing spaces in the command line. Signed-off-by: luyb177 <[email protected]> feat:Add a performance testing function that adds capacity to each slice to avoid multiple memory allocations. Signed-off-by: luyb177 <[email protected]> fix:Modified the format of additional parameters in the configuration file Signed-off-by: luyb177 <[email protected]> fix:Modification based on comments Signed-off-by: luyb177 <[email protected]> fix:Streamline and optimize PR Signed-off-by: luyb177 <[email protected]> feat:Add test files. In the Example, add detailed explanations for the use of extraArgs in each component. Modify the functions in merge.go to resolve issues such as leading and trailing spaces in the command line. Signed-off-by: luyb177 <[email protected]> feat:Add a performance testing function that adds capacity to each slice to avoid multiple memory allocations. Signed-off-by: luyb177 <[email protected]> fix:Modified the format of additional parameters in the configuration file Signed-off-by: luyb177 <[email protected]> fix:Modification based on comments Signed-off-by: luyb177 <[email protected]> fix:Streamline and optimize PR Signed-off-by: luyb177 <[email protected]> feat:Add test files. In the Example, add detailed explanations for the use of extraArgs in each component. Modify the functions in merge.go to resolve issues such as leading and trailing spaces in the command line. Signed-off-by: luyb177 <[email protected]> feat:Add a performance testing function that adds capacity to each slice to avoid multiple memory allocations. Signed-off-by: luyb177 <[email protected]> fix:Modified the format of additional parameters in the configuration file Signed-off-by: luyb177 <[email protected]> fix:Modification based on comments Signed-off-by: luyb177 <[email protected]> fix:Modified the logic for accepting configuration files. Signed-off-by: luyb177 <[email protected]>

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

Signed-off-by: luyb177 <[email protected]> fix: add execute permission to init-e2e-environment.sh Signed-off-by: luyb177 <[email protected]> fix:Modified the locations of some environment variables. Signed-off-by: luyb177 <[email protected]> fix:Modify the paths of crds and karmadactl. Signed-off-by: luyb177 <[email protected]> fix:Fix the error that prevents it from running on Linux. Signed-off-by: luyb177 <[email protected]> Revert "fix:Modify the paths of crds and karmadactl." This reverts commit cb269d8. Signed-off-by: luyb177 <[email protected]> fix:Modify the path. Signed-off-by: luyb177 <[email protected]>

luyb177 added 3 commits September 2, 2025 20:38

feat:Add a custom control surface function

43ab8b3

Signed-off-by: luyb177 <[email protected]> delete init.go Signed-off-by: luyb177 <[email protected]> format Signed-off-by: luyb177 <[email protected]>

karmada-bot requested review from Vacant2333, chaunceyjiang, ikaven1024, prodanlabs and zhzhuang-zju September 2, 2025 15:06

karmada-bot added the size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. label Sep 2, 2025

gemini-code-assist bot reviewed Sep 2, 2025

View reviewed changes

luyb177 force-pushed the e2e-3 branch 4 times, most recently from 63d9b06 to 32a29a1 Compare September 3, 2025 14:08

luyb177 force-pushed the e2e-3 branch 12 times, most recently from ab70ff6 to 0caf1f1 Compare September 4, 2025 14:08

luyb177 force-pushed the e2e-3 branch 4 times, most recently from f56e2f9 to 0c7a762 Compare September 5, 2025 12:07

zhzhuang-zju mentioned this pull request Sep 23, 2025

[Summer OSPP 2025] karmadactl init provides the capability to customize component startup flags #6744

Open

4 tasks

luyb177 force-pushed the e2e-3 branch 15 times, most recently from 76fb40e to 4941c29 Compare October 6, 2025 11:17

gemini-code-assist bot reviewed Oct 7, 2025

View reviewed changes

gemini-code-assist bot reviewed Oct 9, 2025

View reviewed changes

luyb177 force-pushed the e2e-3 branch from 4941c29 to 64b50fb Compare October 9, 2025 12:49

luyb177 added 2 commits October 9, 2025 20:53

feat: add e2e test

0ac33a6

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

luyb177 force-pushed the e2e-3 branch from 64b50fb to 1fc6e41 Compare October 9, 2025 12:56

luyb177 force-pushed the e2e-3 branch from 1fc6e41 to 4a14612 Compare October 9, 2025 13:03

	out[i] = flag + "=" + "\"" + arg + "\""
	out[i] = flag + "=" + arg

	tar -zcvf ../../crds.tar.gz crds
	tar -zcvf ../../crds.tar.gz crds
	rm -rf crds

	cp ./crds.tar.gz "${DATA_DIR}/crds.tar.gz"
	cp ./crds.tar.gz "${DATA_DIR}/crds.tar.gz"
	rm ./crds.tar.gz

Add e2e testing for the customized control panel of Karmadactl init. #6728

Are you sure you want to change the base?

Add e2e testing for the customized control panel of Karmadactl init. #6728

Uh oh!

Conversation

luyb177 commented Sep 2, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

karmada-bot commented Sep 2, 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!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

codecov-commenter commented Sep 2, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

karmada-bot commented Sep 4, 2025

Uh oh!

luyb177 commented Oct 7, 2025

Uh oh!

gemini-code-assist bot left a comment

Choose a reason for hiding this comment

Code Review

Uh oh!

luyb177 commented Oct 9, 2025

Uh oh!

gemini-code-assist bot left a comment

Choose a reason for hiding this comment

Code Review

Uh oh!

gemini-code-assist bot Oct 9, 2025

Choose a reason for hiding this comment

Uh oh!

gemini-code-assist bot Oct 9, 2025

Choose a reason for hiding this comment

Uh oh!

gemini-code-assist bot Oct 9, 2025

Choose a reason for hiding this comment

Uh oh!

gemini-code-assist bot Oct 9, 2025

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

luyb177 commented Sep 2, 2025 •

edited

Loading

codecov-commenter commented Sep 2, 2025 •

edited

Loading