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

✨ add testify linter and address fixes #1334

Merged
merged 1 commit into from
Oct 4, 2024

Conversation

grokspawn
Copy link
Contributor

Description

While reviewing #1330 we had a discussion about the ability to generally prevent the use of requires within Eventually calls to prevent future flakes, and that led us to evaluate the testifylint-er to give us some cautionary guidelines. It did not resolve the requires-within-eventually issue, but we may try to tackle that with some custom AST in the future.

Reviewer Checklist

  • API Go Documentation
  • Tests: Unit Tests (and E2E Tests, if appropriate)
  • Comprehensive Commit Messages
  • Links to related GitHub Issue(s)

@grokspawn grokspawn requested a review from a team as a code owner October 3, 2024 16:37
Copy link

netlify bot commented Oct 3, 2024

Deploy Preview for olmv1 ready!

Name Link
🔨 Latest commit 2a28346
🔍 Latest deploy log https://app.netlify.com/sites/olmv1/deploys/66ffb48efe8a2d0008d203b9
😎 Deploy Preview https://deploy-preview-1334--olmv1.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.

Copy link

codecov bot commented Oct 3, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 76.37%. Comparing base (117bece) to head (2a28346).
Report is 2 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1334   +/-   ##
=======================================
  Coverage   76.37%   76.37%           
=======================================
  Files          41       41           
  Lines        2438     2438           
=======================================
  Hits         1862     1862           
  Misses        402      402           
  Partials      174      174           
Flag Coverage Δ
e2e 58.44% <ø> (ø)
unit 53.65% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@LalatenduMohanty
Copy link
Member

@grokspawn did you run testifylint locally and the PR code changes are driven by the output of the run?

tmshort
tmshort previously approved these changes Oct 3, 2024
Copy link
Contributor

@tmshort tmshort left a comment

Choose a reason for hiding this comment

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

/lgtm

@openshift-ci openshift-ci bot added the lgtm Indicates that a PR is ready to be merged. label Oct 3, 2024
@LalatenduMohanty
Copy link
Member

Also the commit does not have any details about why this PR was required i.e. some historical context around #1330 would also help.

@LalatenduMohanty
Copy link
Member

/hold Adding hold to get some response before we merge this PR.

@openshift-ci openshift-ci bot added the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Oct 3, 2024
@LalatenduMohanty
Copy link
Member

/hold cancel as we discussed this in slack.

Copy link
Member

@LalatenduMohanty LalatenduMohanty left a comment

Choose a reason for hiding this comment

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

Can you please add some more context in to commit message? It will help anyone looking in to the commit and trying to understand why the change was made.

@LalatenduMohanty
Copy link
Member

/hold cancel

@openshift-ci openshift-ci bot removed the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Oct 3, 2024
@openshift-ci openshift-ci bot removed the lgtm Indicates that a PR is ready to be merged. label Oct 3, 2024
@grokspawn
Copy link
Contributor Author

grokspawn commented Oct 3, 2024

@grokspawn did you run testifylint locally and the PR code changes are driven by the output of the run?

Of course.

@grokspawn
Copy link
Contributor Author

Can you please add some more context in to commit message? It will help anyone looking in to the commit and trying to understand why the change was made.

What are you looking for? The description of this PR already gives a little background on how this evolved from the other PR and includes a link to it.

Copy link
Contributor

@tmshort tmshort left a comment

Choose a reason for hiding this comment

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

/lgtm

@openshift-ci openshift-ci bot added the lgtm Indicates that a PR is ready to be merged. label Oct 3, 2024
@LalatenduMohanty
Copy link
Member

LalatenduMohanty commented Oct 3, 2024

What are you looking for? The description of this PR already gives a little background on how this evolved from the other PR and includes a link to it.

This PR description has useful information/context but the commit does not have it. we should not have to rely on the the github interface to find useful information in general.

While reviewing operator-framework#1330
we had a discussion about the ability to generally prevent the use of `requires`
within `Eventually` calls to prevent future flakes, and that led us to evaluate
the `testifylint`-er to give us some cautionary guidelines.

It did _not_ resolve the requires-within-eventually issue,
but we may try to tackle that with some custom AST in the future.

Signed-off-by: Jordan Keister <jordan@nimblewidget.com>
Copy link

openshift-ci bot commented Oct 4, 2024

New changes are detected. LGTM label has been removed.

@openshift-ci openshift-ci bot removed the lgtm Indicates that a PR is ready to be merged. label Oct 4, 2024
Copy link
Member

@m1kola m1kola left a comment

Choose a reason for hiding this comment

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

Looks good to me.

I updated the commit message to contain PR description. Will merge when this is ready.

Merged via the queue into operator-framework:main with commit 2d4c000 Oct 4, 2024
18 checks passed
@grokspawn grokspawn deleted the testify_linter branch October 4, 2024 12:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants