Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

KEP-4292: Add e2e test for custom profile in kubectl debug #127187

Merged
merged 6 commits into from
Oct 22, 2024

Conversation

ardaguclu
Copy link
Member

@ardaguclu ardaguclu commented Sep 6, 2024

What type of PR is this?

/kind feature

What this PR does / why we need it:

This PR adds e2e for custom profiling in kubectl debug as promised in enhancement as prerequisite for promotion to stable.

Special notes for your reviewer:

Does this PR introduce a user-facing change?

Locking the feature custom profiling in kubectl debug to true.

Additional documentation e.g., KEPs (Kubernetes Enhancement Proposals), usage docs, etc.:

- [KEP]:  https://github.com/kubernetes/enhancements/tree/master/keps/sig-cli/4292-kubectl-debug-custom-profile

@k8s-ci-robot k8s-ci-robot added release-note Denotes a PR that will be considered when it comes time to generate release notes. do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. kind/feature Categorizes issue or PR as related to a new feature. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. do-not-merge/needs-sig Indicates an issue or PR lacks a `sig/foo` label and requires one. needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. needs-priority Indicates a PR lacks a `priority/foo` label and requires one. area/kubectl area/test sig/cli Categorizes an issue or PR as relevant to SIG CLI. sig/testing Categorizes an issue or PR as relevant to SIG Testing. approved Indicates a PR has been approved by an approver from all required OWNERS files. and removed do-not-merge/needs-sig Indicates an issue or PR lacks a `sig/foo` label and requires one. labels Sep 6, 2024
@ardaguclu
Copy link
Member Author

/triage accepted
/priority backlog

@k8s-ci-robot k8s-ci-robot added triage/accepted Indicates an issue or PR is ready to be actively worked on. priority/backlog Higher priority than priority/awaiting-more-evidence. and removed needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. needs-priority Indicates a PR lacks a `priority/foo` label and requires one. labels Sep 6, 2024
@ardaguclu ardaguclu force-pushed the promote-4292-ga branch 3 times, most recently from 30a6a9d to 4420f7f Compare September 9, 2024 10:34
@ardaguclu ardaguclu changed the title WIP: KEP-4292: Add e2e test for custom profile in kubectl debug KEP-4292: Add e2e test for custom profile in kubectl debug Sep 9, 2024
@k8s-ci-robot k8s-ci-robot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Sep 9, 2024
Copy link
Contributor

@soltysh soltysh left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

mostly lgtm, except for that env var removal

/hold
to make sure it's brought back

@k8s-ci-robot k8s-ci-robot added the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Oct 1, 2024
@ardaguclu
Copy link
Member Author

/label tide/merge-method-squash

@k8s-ci-robot k8s-ci-robot added the tide/merge-method-squash Denotes a PR that should be squashed by tide when it merges. label Oct 1, 2024
@ardaguclu
Copy link
Member Author

I think, this is ready to merge;
/hold cancel

@k8s-ci-robot k8s-ci-robot removed the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Oct 9, 2024
test/e2e/kubectl/debug.go Outdated Show resolved Hide resolved
test/e2e/kubectl/debug.go Outdated Show resolved Hide resolved
test/e2e/kubectl/debug.go Show resolved Hide resolved
framework.ExpectNoError(err)
output := e2ekubectl.RunKubectlOrDie(ns, "get", "pod", debugPodName, "-o", "jsonpath={.spec.ephemeralContainers[*]}")
ginkgo.By("verifying NET_ADMIN is added")
if !strings.Contains(output, "NET_ADMIN") {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Change all three conditions to use this form:

gomega.Expect(output).To(gomega.MatchError(gomega.ContainSubstring("NET_ADMIN")))

which on error will provide more explainable output, see here for reference.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Used in this form;

gomega.Expect(output).To(gomega.ContainSubstring("NET_ADMIN"))

customProfileFile := "custom.yaml"
framework.ExpectNoError(err)
defer os.Remove(tmpDir) //nolint:errcheck
framework.ExpectNoError(os.WriteFile(filepath.Join(tmpDir, customProfileFile), []byte(`
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please make sure to add an explanation to the framework.ExpectNoError(err error, explain ...interface{}) invocation, that is then helpful when debugging problems. See my other comment for reference.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added. Hope it is explanatory.

"sleep 3600")

ginkgo.By("verifying the container debugger is running")
err = wait.PollUntilContextTimeout(ctx, 3*time.Second, 2*time.Minute, false, func(ctx context.Context) (bool, error) {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How about using WaitForPodContainerStarted from k8s.io/kubernetes/test/e2e/framework/pod?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

After your suggestion, I've found a better one WaitForPodsWithLabelRunning since I'm focusing on the running status

test/e2e/kubectl/debug.go Show resolved Hide resolved
Copy link
Contributor

@soltysh soltysh left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/lgtm
/approve

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Oct 22, 2024
@k8s-ci-robot
Copy link
Contributor

LGTM label has been added.

Git tree hash: 0fb80ec427eba62e3ac8942145a07e1567a013f1

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: ardaguclu, soltysh

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

The pull request process is described 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

@k8s-ci-robot k8s-ci-robot merged commit 1caf9a1 into kubernetes:master Oct 22, 2024
15 checks passed
@k8s-ci-robot k8s-ci-robot added this to the v1.32 milestone Oct 22, 2024
@ardaguclu ardaguclu deleted the promote-4292-ga branch October 22, 2024 18:56
scott-grimes pushed a commit to scott-grimes/kubernetes that referenced this pull request Oct 23, 2024
…s#127187)

* Remove KUBECTL_DEBUG_CUSTOM_PROFILE env var

* Add e2e test for custom profile in kubectl debug

* Keep feature flag until 1.33

* Update comment

* Simplify tests by relying on test framework functionality

* Rename import alias to better to pass verify-import-alias
richabanker pushed a commit to richabanker/kubernetes that referenced this pull request Oct 29, 2024
…s#127187)

* Remove KUBECTL_DEBUG_CUSTOM_PROFILE env var

* Add e2e test for custom profile in kubectl debug

* Keep feature flag until 1.33

* Update comment

* Simplify tests by relying on test framework functionality

* Rename import alias to better to pass verify-import-alias
felipeagger pushed a commit to felipeagger/kubernetes that referenced this pull request Nov 6, 2024
…s#127187)

* Remove KUBECTL_DEBUG_CUSTOM_PROFILE env var

* Add e2e test for custom profile in kubectl debug

* Keep feature flag until 1.33

* Update comment

* Simplify tests by relying on test framework functionality

* Rename import alias to better to pass verify-import-alias
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. area/kubectl area/test cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. kind/feature Categorizes issue or PR as related to a new feature. lgtm "Looks good to me", indicates that a PR is ready to be merged. priority/backlog Higher priority than priority/awaiting-more-evidence. release-note Denotes a PR that will be considered when it comes time to generate release notes. sig/cli Categorizes an issue or PR as relevant to SIG CLI. sig/testing Categorizes an issue or PR as relevant to SIG Testing. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. tide/merge-method-squash Denotes a PR that should be squashed by tide when it merges. triage/accepted Indicates an issue or PR is ready to be actively worked on.
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

3 participants