Fix kubectl describe ingress when default backend is empty #113664

laphets · 2022-11-07T05:46:33Z

What type of PR is this?

/kind bug
/sig cli

What this PR does / why we need it:

Check ingress backend to prevent a dereference nil panic, when the value is nil, return <default>.
This fixes regression introduced by #108506.

Which issue(s) this PR fixes:

Fixes kubernetes/kubectl#1316

Special notes for your reviewer:

Does this PR introduce a user-facing change?

NONE

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

NONE

k8s-ci-robot · 2022-11-07T05:46:41Z

Welcome @laphets!

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 · 2022-11-07T05:46:42Z

Hi @laphets. 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.

ardaguclu

Thanks for the fix!

ardaguclu · 2022-11-07T10:31:33Z

staging/src/k8s.io/kubectl/pkg/describe/describe.go

@@ -2653,11 +2658,7 @@ func (i *IngressDescriber) describeIngressV1(ing *networkingv1.Ingress, events *
 		w.Write(LEVEL_0, "Ingress Class:\t%v\n", ingressClassName)
 		def := ing.Spec.DefaultBackend
 		ns := ing.Namespace
-		if def == nil {


Don't we do the same thing already in here?. Sorry, but I don't understand what has been fixed/changed with this PR.

Doing this check is not enough, when def == nil, and there is no any ing.Spec.Rules, in

kubernetes/staging/src/k8s.io/kubectl/pkg/describe/describe.go

Line 2683 in 62e9df0

w.Write(LEVEL_1, "%s\t%s\t%s\n", "*", "*", i.describeBackendV1(ns, def))

it will dereference nil inside i.describeBackendV1(ns, def).

ardaguclu · 2022-11-07T10:32:44Z

staging/src/k8s.io/kubectl/pkg/describe/describe_test.go

@@ -2800,6 +2800,30 @@ Rules:
  *           *     default-backend:80 (<error: endpoints "default-backend" not found>)
 Annotations:  <none>
 Events:       <none>
+`,


This test should fail without your changes?

It won't fail as the DefaultBackend is set with &backendV1, my change fixes the case when DefaultBackend is nil.

laphets · 2022-11-07T16:33:30Z

/assign brianpursley soltysh ardaguclu

ardaguclu · 2022-11-08T05:42:14Z

/ok-to-test

ardaguclu · 2022-11-08T06:24:12Z

/triage accepted
/priority backlog

ardaguclu · 2022-11-08T06:46:12Z

Added unit test is failing without the patch(I tried on my local) and it verifies that this patch fixes problem. Thanks @laphets

/approve
/lgtm

k8s-ci-robot · 2022-11-08T06:46:44Z

[APPROVALNOTIFIER] This PR is APPROVED

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

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:

~~staging/src/k8s.io/kubectl/OWNERS~~ [ardaguclu]

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 added 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. labels Nov 7, 2022

k8s-ci-robot requested review from brianpursley and soltysh November 7, 2022 05:47

k8s-ci-robot added the area/kubectl label Nov 7, 2022

ardaguclu reviewed Nov 7, 2022

View reviewed changes

Fix kubectl describe ingress when default backend is empty

653edeb

laphets force-pushed the kubectl-empty-ingress-backend-fix branch from ca95888 to 653edeb Compare November 7, 2022 16:11

laphets requested review from ardaguclu and removed request for soltysh and brianpursley November 7, 2022 16:15

k8s-ci-robot assigned ardaguclu, brianpursley and soltysh Nov 7, 2022

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 Nov 8, 2022

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. labels Nov 8, 2022

k8s-ci-robot removed the needs-priority Indicates a PR lacks a `priority/foo` label and requires one. label Nov 8, 2022

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Nov 8, 2022

k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Nov 8, 2022

k8s-ci-robot merged commit e3d7cb5 into kubernetes:master Nov 8, 2022

k8s-ci-robot added this to the v1.26 milestone Nov 8, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix kubectl describe ingress when default backend is empty #113664

Fix kubectl describe ingress when default backend is empty #113664

laphets commented Nov 7, 2022 •

edited

k8s-ci-robot commented Nov 7, 2022

k8s-ci-robot commented Nov 7, 2022

ardaguclu left a comment

ardaguclu Nov 7, 2022

laphets Nov 7, 2022 •

edited

ardaguclu Nov 7, 2022

laphets Nov 7, 2022

laphets commented Nov 7, 2022

ardaguclu commented Nov 8, 2022

ardaguclu commented Nov 8, 2022

ardaguclu commented Nov 8, 2022

k8s-ci-robot commented Nov 8, 2022

Fix kubectl describe ingress when default backend is empty #113664

Fix kubectl describe ingress when default backend is empty #113664

Conversation

laphets commented Nov 7, 2022 • edited

What type of PR is this?

What this PR does / why we need it:

Which issue(s) this PR fixes:

Special notes for your reviewer:

Does this PR introduce a user-facing change?

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

k8s-ci-robot commented Nov 7, 2022

k8s-ci-robot commented Nov 7, 2022

ardaguclu left a comment

Choose a reason for hiding this comment

ardaguclu Nov 7, 2022

Choose a reason for hiding this comment

laphets Nov 7, 2022 • edited

Choose a reason for hiding this comment

ardaguclu Nov 7, 2022

Choose a reason for hiding this comment

laphets Nov 7, 2022

Choose a reason for hiding this comment

laphets commented Nov 7, 2022

ardaguclu commented Nov 8, 2022

ardaguclu commented Nov 8, 2022

ardaguclu commented Nov 8, 2022

k8s-ci-robot commented Nov 8, 2022

laphets commented Nov 7, 2022 •

edited

laphets Nov 7, 2022 •

edited