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:kustomize cfg grep with no arguments causes panic #5707

Merged
merged 2 commits into from
Jul 10, 2024

Conversation

deszhou
Copy link
Member

@deszhou deszhou commented May 28, 2024

  • Before the Fix
➜  ✗ kustomize cfg grep                                
panic: runtime error: index out of range [0] with length 0

goroutine 1 [running]:
sigs.k8s.io/kustomize/cmd/config/internal/commands.(*GrepRunner).preRunE(0x104cf5ad0?, 0x0?, {0x105ac5f68?, 0x104cf0f8c?, 0x1400018bd00?})
          /Users/denniszh/kustomize/cmd/config/internal/commands/grep.go:69 +0x3bc
github.com/spf13/cobra.(*Command).execute(0x14000287b08, {0x105ac5f68, 0x0, 0x0})
        /Users/denniszh/go/pkg/mod/github.com/spf13/[email protected]/command.go:968 +0x7e8
github.com/spf13/cobra.(*Command).ExecuteC(0x140001e2608)
         /Users/denniszh/go/pkg/mod/github.com/spf13/[email protected]/command.go:1115 +0x344
github.com/spf13/cobra.(*Command).Execute(0x1059bbfa8?)
        /Users/denniszh/go/pkg/mod/github.com/spf13/[email protected]/command.go:1039 +0x1c
main.main()
       /Users/denniszh/kustomize/kustomize/main.go:14 +0x20
  • After the Fix
➜ ✗ kustomize cfg grep
Error: missing required argument: QUERY
Usage:
 kustomize cfg grep QUERY [DIR] [flags]

Examples:

   # find Deployment Resources
   kustomize cfg grep "kind=Deployment" my-dir/

   # find Resources named nginx
   kustomize cfg grep "metadata.name=nginx" my-dir/

   # use tree to display matching Resources
   kustomize cfg grep "metadata.name=nginx" my-dir/ | kustomize cfg tree

   # look for Resources matching a specific container image
   kustomize cfg grep "spec.template.spec.containers[name=nginx].image=nginx:1\.7\.9" my-dir/ | kustomize cfg tree

Flags:
     --annotate              annotate resources with their file origins. (default true)
 -h, --help                  help for grep
     --invert-match          Selected Resources are those not matching any of the specified patterns..
 -R, --recurse-subpackages   also print resources recursively in all the nested subpackages (default true)

Global Flags:
     --stack-trace   print a stack-trace on error

Fixes: #5701

@k8s-ci-robot k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label May 28, 2024
@k8s-ci-robot
Copy link
Contributor

Welcome @yeedove!

It looks like this is your first PR to kubernetes-sigs/kustomize 🎉. 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/kustomize 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 May 28, 2024
@k8s-ci-robot
Copy link
Contributor

Hi @yeedove. 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 the size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. label May 28, 2024
Copy link
Member

@stormqueen1990 stormqueen1990 left a comment

Choose a reason for hiding this comment

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

Hello there, @yeedove! 👋🏻

Thank you very much for your contribution! 🙏🏻

Could you please also add a test case to cmd/config/internal/commands/grep_test.go, so we can prevent regressions in the future?

Thanks in advance!

@k8s-ci-robot
Copy link
Contributor

This PR has multiple commits, and the default merge method is: merge.
You can request commits to be squashed using the label: tide/merge-method-squash

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/S Denotes a PR that changes 10-29 lines, ignoring generated files. and removed size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels May 29, 2024
Copy link
Member

@stormqueen1990 stormqueen1990 left a comment

Choose a reason for hiding this comment

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

Thanks!

/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jun 5, 2024
@stormqueen1990
Copy link
Member

/ok-to-test
/label tide/merge-method-squash

@k8s-ci-robot k8s-ci-robot added tide/merge-method-squash Denotes a PR that should be squashed by tide when it merges. 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 Jun 5, 2024
Copy link
Member

@varshaprasad96 varshaprasad96 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
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: deszhou, varshaprasad96

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 added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Jul 10, 2024
@k8s-ci-robot k8s-ci-robot merged commit 7cbaf78 into kubernetes-sigs:master Jul 10, 2024
10 checks passed
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. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. lgtm "Looks good to me", indicates that a PR is ready to be merged. ok-to-test Indicates a non-member PR verified by an org member that is safe to test. size/S Denotes a PR that changes 10-29 lines, ignoring generated files. tide/merge-method-squash Denotes a PR that should be squashed by tide when it merges.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

kustomize cfg grep with no arguments causes panic
4 participants