Skip to content

Remove extraneous .ObjectMeta references #4714

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

Merged
merged 1 commit into from
Apr 9, 2025

Conversation

sebrandon1
Copy link
Contributor

@sebrandon1 sebrandon1 commented Apr 3, 2025

Broken out from #4712 for easier reviewing.

The object references for .ObjectMeta. are extra and not needed. They are flagged by the newer versions of GolangCI-lint too.

Summary by Sourcery

Remove unnecessary .ObjectMeta references in cluster-related code

Enhancements:

  • Simplify code by directly accessing object names instead of using .ObjectMeta.Name

Chores:

  • Update code to comply with newer GolangCI-lint linting rules

Copy link

sourcery-ai bot commented Apr 3, 2025

Reviewer's Guide by Sourcery

This pull request removes unnecessary .ObjectMeta references when accessing the Name field of Kubernetes objects. This simplifies the code and aligns with newer versions of GolangCI-lint.

Updated class diagram for Kubernetes object access

classDiagram
  class KubernetesObject {
    +Name string
  }
  note for KubernetesObject "Represents a generic Kubernetes object."

  class ClusterOperator {
    -ObjectMeta ObjectMeta
    +Name string
  }
  note for ClusterOperator "Represents a cluster operator with metadata."

  class CertificateSigningRequest {
    -ObjectMeta ObjectMeta
    +Name string
  }
  note for CertificateSigningRequest "Represents a certificate signing request."

  KubernetesObject <|-- ClusterOperator : inherits
  KubernetesObject <|-- CertificateSigningRequest : inherits
Loading

File-Level Changes

Change Details Files
Replaced instances of c.ObjectMeta.Name with c.Name to directly access the name of the object.
  • Replaced c.ObjectMeta.Name with c.Name when checking if the operator name is in the selector.
  • Replaced c.ObjectMeta.Name with c.Name when logging that an operator is not available.
  • Replaced c.ObjectMeta.Name with c.Name when adding an operator to the list of unavailable operators.
  • Replaced c.ObjectMeta.Name with c.Name when logging that an operator is degraded.
  • Replaced c.ObjectMeta.Name with c.Name when adding an operator to the list of degraded operators.
  • Replaced c.ObjectMeta.Name with c.Name when logging that an operator is progressing.
  • Replaced c.ObjectMeta.Name with c.Name when adding an operator to the list of progressing operators.
  • Replaced c.ObjectMeta.Name with c.Name when logging that an operator is disabled.
  • Replaced c.ObjectMeta.Name with c.Name when logging an unexpected operator status.
  • Replaced csr.ObjectMeta.Name with csr.Name when logging that a CSR is being approved.
  • Replaced csr.ObjectMeta.Name with csr.Name when approving a CSR.
pkg/crc/cluster/clusteroperator.go
pkg/crc/cluster/cert_renewal.go

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!
  • Generate a plan of action for an issue: Comment @sourcery-ai plan on
    an issue to generate a plan of action for it.

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@openshift-ci openshift-ci bot requested review from gbraad and praveenkumar April 3, 2025 19:16
Copy link

openshift-ci bot commented Apr 3, 2025

[APPROVALNOTIFIER] This PR is NOT APPROVED

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

Copy link

openshift-ci bot commented Apr 3, 2025

Hi @sebrandon1. Thanks for your PR.

I'm waiting for a crc-org 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.

Copy link

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

Hey @sebrandon1 - I've reviewed your changes - here's some feedback:

Overall Comments:

  • This change improves readability by directly accessing the name field.
Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟢 Documentation: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@sebrandon1 sebrandon1 force-pushed the remove_extraneous_objectmeta branch from cb05b32 to a5fe17c Compare April 8, 2025 16:54
@praveenkumar praveenkumar merged commit 0292bcb into crc-org:main Apr 9, 2025
23 of 30 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants