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.

Sign up for GitHub

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

Jump to bottom

Fix empty table when sorting on nonexistent field #119460

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open

Fix empty table when sorting on nonexistent field #119460

wants to merge 4 commits into from

Conversation

philip-peterson
Copy link

@philip-peterson philip-peterson commented Jul 20, 2023 •
edited

What type of PR is this?

/kind bug

What this PR does / why we need it:

If a the JSONPath specified by kubectl get ... --sort-by [json-path] matches no rows, falls back to displaying every row and a warning indicating that no row matched, instead of zero rows.

Which issue(s) this PR fixes:

Fixes kubernetes/kubectl#1343

Special notes for your reviewer:

I wasn't too sure about the errors.Is vs errors.As stuff. It seems to work but not super clear on if it's correct.

Does this PR introduce a user-facing change?

The --sort-by flag will no longer cause zero rows to display when set to a JSONPath which matches zero rows.

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

@k8s-ci-robot k8s-ci-robot added release-note Denotes a PR that will be considered when it comes time to generate release notes. kind/bug Categorizes issue or PR as related to a bug. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Jul 20, 2023
@linux-foundation-easycla
Copy link

linux-foundation-easycla bot commented Jul 20, 2023 •
edited

CLA Signed

The committers listed above are authorized under a signed CLA.

@k8s-ci-robot k8s-ci-robot added cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. do-not-merge/needs-sig Indicates an issue or PR lacks a `sig/foo` label and requires one. labels Jul 20, 2023
@k8s-ci-robot
Copy link
Contributor

Welcome @philip-peterson!

It looks like this is your first PR to kubernetes/kubernetes 🎉. 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/kubernetes 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 needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Jul 20, 2023
@k8s-ci-robot
Copy link
Contributor

This issue is currently awaiting triage.

If a SIG or subproject determines this is a relevant issue, they will accept it by applying the triage/accepted label and provide further guidance.

The triage/accepted label can be added by org members by writing /triage accepted in a comment.

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/test-infra repository.

@k8s-ci-robot
Copy link
Contributor

Hi @philip-peterson. Thanks for your PR.

I'm waiting for a kubernetes 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/test-infra repository.

@k8s-ci-robot k8s-ci-robot added the needs-priority Indicates a PR lacks a `priority/foo` label and requires one. label Jul 20, 2023
@k8s-ci-robot k8s-ci-robot added area/kubectl sig/cli Categorizes an issue or PR as relevant to SIG CLI. and removed do-not-merge/needs-sig Indicates an issue or PR lacks a `sig/foo` label and requires one. labels Jul 20, 2023
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: philip-peterson
Once this PR has been reviewed and has the lgtm label, please assign deads2k 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 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 Jul 20, 2023
@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 Jan 20, 2024
@philipsilo
Copy link

/remove-lifecycle stale

@k8s-ci-robot k8s-ci-robot removed the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Jan 21, 2024
brianpursley
brianpursley reviewed Apr 19, 2024
View reviewed changes
staging/src/k8s.io/kubectl/pkg/cmd/get/sorter.go
@@ -406,15 +430,17 @@ func NewTableSorter(table *metav1.Table, field string) (*TableSorter, error) {
}
}

if len(table.Rows) > 0 && !fieldFoundOnce {
return nil, fmt.Errorf("couldn't find any field with path %q in the list of objects", field)
Copy link
Member

Choose a reason for hiding this comment

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

So I guess the original intention was to fail if the field was not found in the list of objects.

I wonder if anyone (other than kubectl) is depending on this behavior.

I'm wondering if we should preserve the behavior of NewTableSorter, as-is, and handle the error properly in kubectl.

If this error is returned, why isn't it being printed anywhere? 🤔

It looks like the problem is here:

kubernetes/staging/src/k8s.io/kubectl/pkg/cmd/get/get.go

Line 559 in a86380c

printer.PrintObj(info.Object, w)

It's not checking if PrintObj returns an error.

Copy link
Author

Choose a reason for hiding this comment

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

@brianpursley Nice find! Do you think that is what the behavior should be? (The bug report ticket said it should fall back to the behavior where no filter was applied.)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@brianpursley brianpursley brianpursley left review comments

@ardaguclu ardaguclu Awaiting requested review from ardaguclu

Assignees
No one assigned
Labels
area/kubectl cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. kind/bug Categorizes issue or PR as related to a bug. needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. needs-priority Indicates a PR lacks a `priority/foo` label and requires one. needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. 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. size/M Denotes a PR that changes 30-99 lines, ignoring generated files.
Projects
SIG CLI
Status: Needs Triage
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Kubectl get unexpected returns "No resources found..." when sorting on nonexistent field
5 participants
@philip-peterson @k8s-ci-robot @k8s-triage-robot @philipsilo @brianpursley