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

Fix: Ignore extra underscored when Object is an RBAC object in objmetadata #645

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

liamchenoweth
Copy link

Ref. #487
Skips the test for extra underscores when we are dealing with RBAC objects as they are only restricted to path objects for naming. Included new tests for this new use case

Copy link

linux-foundation-easycla bot commented Aug 22, 2024

CLA Signed

  • ✅login: liamchenoweth / (d811228)

The committers listed above are authorized under a signed CLA.

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: liamchenoweth
Once this PR has been reviewed and has the lgtm label, please assign karlkfi 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

@k8s-ci-robot k8s-ci-robot added the cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. label Aug 22, 2024
@k8s-ci-robot
Copy link
Contributor

Welcome @liamchenoweth!

It looks like this is your first PR to kubernetes-sigs/cli-utils 🎉. Please refer to our pull request process documentation to help your PR have a smooth ride to approval.

You will be prompted by a bot to use commands during the review process. Do not be afraid to follow the prompts! It is okay to experiment. Here is the bot commands documentation.

You can also check if kubernetes-sigs/cli-utils has its own contribution guidelines.

You may want to refer to our testing guide if you run into trouble with your tests not passing.

If you are having difficulty getting your pull request seen, please follow the recommended escalation practices. Also, for tips and tricks in the contribution process you may want to read the Kubernetes contributor cheat sheet. We want to make sure your contribution gets all the attention it needs!

Thank you, and welcome to Kubernetes. 😃

@k8s-ci-robot k8s-ci-robot added the needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. label Aug 22, 2024
@k8s-ci-robot
Copy link
Contributor

Hi @liamchenoweth. Thanks for your PR.

I'm waiting for a kubernetes-sigs 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.

@k8s-ci-robot k8s-ci-robot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. and removed cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. labels Aug 22, 2024
@liamchenoweth liamchenoweth changed the title Ignore extra underscored when Object is an RBAC object in objmetadata Fix: Ignore extra underscored when Object is an RBAC object in objmetadata Aug 22, 2024
@liamchenoweth
Copy link
Author

/assign @karlkfi

@liamchenoweth
Copy link
Author

/assign @mortent

@k8s-triage-robot
Copy link

The Kubernetes project currently lacks enough contributors to adequately respond to all PRs.

This bot triages PRs according to the following rules:

  • After 90d of inactivity, lifecycle/stale is applied
  • After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
  • After 30d of inactivity since lifecycle/rotten was applied, the PR is closed

You can:

  • Mark this PR as fresh with /remove-lifecycle stale
  • Close this PR with /close
  • Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/lifecycle stale

@k8s-ci-robot k8s-ci-robot added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Dec 9, 2024
@karlkfi
Copy link
Contributor

karlkfi commented Dec 10, 2024

This seems like it might break the ObjMetadata string format which uses underscores as segment delimiters and double underscores as colons. With this change, an RBAC object with double underscores wouldn't make it through a format+parse cycle. Maybe that's an acceptable limitation in order to support single underscores in RBAC names?

I'm not really sure why underscores were originally chosen. It seems like backslashes would have been a better choice, like we used for the depends-on and apply-time-mutation annotations.

Changing the ID format might be possible, but would probably require migration. And it might prohibit downgrades unless we shipped bi-directional migration beforehand, or made it an opt-in feature for a while.

@karlkfi
Copy link
Contributor

karlkfi commented Dec 10, 2024

/ok-to-test

@k8s-ci-robot k8s-ci-robot added ok-to-test Indicates a non-member PR verified by an org member that is safe to test. and removed needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Dec 10, 2024
@@ -102,6 +102,30 @@ func TestParseObjMetadata(t *testing.T) {
inventory: &ObjMetadata{},
isError: true,
},
"RBAC with underscores": {
Copy link
Contributor

Choose a reason for hiding this comment

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

TestParseObjMetadata only tests parsing, unfortunately, not round-trip format+parse. I think this change would break the round-trip.

@k8s-ci-robot
Copy link
Contributor

@liamchenoweth: 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
cli-utils-presubmit-master-stress d811228 link true /test cli-utils-presubmit-master-stress

Full PR test history. Your PR dashboard. Please help us cut down on flakes by linking to an open issue when you hit one in your PR.

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. ok-to-test Indicates a non-member PR verified by an org member that is safe to test. size/M Denotes a PR that changes 30-99 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants