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

chore: Enable nilerr, nilnesserr #4346

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

Conversation

alexandear
Copy link
Contributor

@alexandear alexandear commented Feb 21, 2025

What type of PR is this?

/kind cleanup

What this PR does / why we need it:

Enable nilerr and nilnesserr linters to find places where returning nil may be wrong.
nilerr finds places that return nil even if it checks that the error is not nil.
nilnesserr reports constructs that checks for err != nil, but returns a different nil value error.

Special notes for your reviewer:

The nilerr linter founds two places where err is not nil, but returned value is nil:

  1. In the clustersReconciler.Reconcile:
	err := c.localClient.Get(ctx, req.NamespacedName, cluster)
	if client.IgnoreNotFound(err) != nil {
		return reconcile.Result{}, err
	}
	log.V(2).Info("Reconcile MultiKueueCluster")

	if err != nil || !cluster.DeletionTimestamp.IsZero() {
		c.stopAndRemoveCluster(req.Name)
		return reconcile.Result{}, nil
	}

Returning nil is expected because err is NotFound and we ignore it. To silence the linter, I changed nil to client.IgnoreNotFound(err).

  1. In the JobSet.RunWithPodSetsInfo:
	if err := podset.Merge(&template.ObjectMeta, &template.Spec, info); err != nil {
		return nil
	}

I suspect there is a bug here, and I changed to return err.

Does this PR introduce a user-facing change?

NONE

@k8s-ci-robot k8s-ci-robot added kind/cleanup Categorizes issue or PR as related to cleaning up code, process, or technical debt. release-note-none Denotes a PR that doesn't merit a release note. labels Feb 21, 2025
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: alexandear
Once this PR has been reviewed and has the lgtm label, please assign mimowo for approval. For more information see the 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: yes Indicates the PR's author has signed the CNCF CLA. label Feb 21, 2025
@k8s-ci-robot
Copy link
Contributor

Hi @alexandear. 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 needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Feb 21, 2025
Copy link

netlify bot commented Feb 21, 2025

Deploy Preview for kubernetes-sigs-kueue ready!

Name Link
🔨 Latest commit ff3fd8a
🔍 Latest deploy log https://app.netlify.com/sites/kubernetes-sigs-kueue/deploys/67b871080f99fb00084f17ac
😎 Deploy Preview https://deploy-preview-4346--kubernetes-sigs-kueue.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@mbobrovskyi
Copy link
Contributor

/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 Feb 21, 2025
@gabesaba
Copy link
Contributor

/assign

@@ -400,7 +400,7 @@ func (c *clustersReconciler) Reconcile(ctx context.Context, req reconcile.Reques

if err != nil || !cluster.DeletionTimestamp.IsZero() {
c.stopAndRemoveCluster(req.Name)
return reconcile.Result{}, nil
return reconcile.Result{}, client.IgnoreNotFound(err)
Copy link
Contributor

Choose a reason for hiding this comment

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

I think that returning nil here is intentional, as either the cluster is deleted, or not found (since the only err that will cause us to hit this branch is NotFound). If we return an error, I think we will repeatedly keep trying to process this deleted or not found cluster.

Is there a possible refactor that will make this more readable, and make the linter happy?

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. kind/cleanup Categorizes issue or PR as related to cleaning up code, process, or technical debt. ok-to-test Indicates a non-member PR verified by an org member that is safe to test. release-note-none Denotes a PR that doesn't merit a release note. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants