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

test: replace t.Errorf and t.Fatalf with assert and require #17720

Open
wants to merge 10 commits into
base: main
Choose a base branch
from

Conversation

akagami-harsh
Copy link

@akagami-harsh akagami-harsh commented Feb 8, 2025

Description

  • replace instances of t.Errorf and t.Fatalf with assert and require

Related Issue(s)

Checklist

  • "Backport to:" labels have been added if this change should be back-ported to release branches
  • If this change is to be back-ported to previous releases, a justification is included in the PR description
  • Tests were added or are not required
  • Did the new or modified tests pass consistently locally and on CI?
  • Documentation was added or is not required

Deployment Notes

Signed-off-by: Your Name <[email protected]>
Copy link
Contributor

vitess-bot bot commented Feb 8, 2025

Review Checklist

Hello reviewers! 👋 Please follow this checklist when reviewing this Pull Request.

General

  • Ensure that the Pull Request has a descriptive title.
  • Ensure there is a link to an issue (except for internal cleanup and flaky test fixes), new features should have an RFC that documents use cases and test cases.

Tests

  • Bug fixes should have at least one unit or end-to-end test, enhancement and new features should have a sufficient number of tests.

Documentation

  • Apply the release notes (needs details) label if users need to know about this change.
  • New features should be documented.
  • There should be some code comments as to why things are implemented the way they are.
  • There should be a comment at the top of each new or modified test to explain what the test does.

New flags

  • Is this flag really necessary?
  • Flag names must be clear and intuitive, use dashes (-), and have a clear help text.

If a workflow is added or modified:

  • Each item in Jobs should be named in order to mark it as required.
  • If the workflow needs to be marked as required, the maintainer team must be notified.

Backward compatibility

  • Protobuf changes should be wire-compatible.
  • Changes to _vt tables and RPCs need to be backward compatible.
  • RPC changes should be compatible with vitess-operator
  • If a flag is removed, then it should also be removed from vitess-operator and arewefastyet, if used there.
  • vtctl command output order should be stable and awk-able.

@vitess-bot vitess-bot bot added NeedsBackportReason If backport labels have been applied to a PR, a justification is required NeedsDescriptionUpdate The description is not clear or comprehensive enough, and needs work NeedsIssue A linked issue is missing for this Pull Request NeedsWebsiteDocsUpdate What it says labels Feb 8, 2025
@github-actions github-actions bot added this to the v22.0.0 milestone Feb 8, 2025
@akagami-harsh akagami-harsh changed the title test: replace of t.Errorf and t.Fatalf with assert and require test: replace t.Errorf and t.Fatalf with assert and require Feb 8, 2025
@mattlord mattlord added Type: Internal Cleanup Component: Build/CI and removed NeedsDescriptionUpdate The description is not clear or comprehensive enough, and needs work NeedsWebsiteDocsUpdate What it says NeedsIssue A linked issue is missing for this Pull Request NeedsBackportReason If backport labels have been applied to a PR, a justification is required labels Feb 8, 2025
Copy link

codecov bot commented Feb 8, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 67.95%. Comparing base (10a6916) to head (50c19b5).
Report is 4 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main   #17720   +/-   ##
=======================================
  Coverage   67.94%   67.95%           
=======================================
  Files        1586     1586           
  Lines      255173   255195   +22     
=======================================
+ Hits       173389   173405   +16     
- Misses      81784    81790    +6     

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

@akagami-harsh akagami-harsh force-pushed the modernize-tests branch 2 times, most recently from b20f549 to 363eb5c Compare February 8, 2025 20:27
Signed-off-by: Your Name <[email protected]>
Copy link
Contributor

@shlomi-noach shlomi-noach left a comment

Choose a reason for hiding this comment

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

Thank you for this pull request! The changes are desired and align with modern testing methodologies which we practice today. I have left multiple comments on how to improve the testing even further, while we're at it, using testify's more user-friendly functionality in some places, or more formal functions in others. These suggestions repeat themselves and so I have not commented on every single change. Would you be open to rewrite those changes as per suggestions?

go/cache/lru_cache_test.go Outdated Show resolved Hide resolved
go/cache/lru_cache_test.go Outdated Show resolved Hide resolved
go/cache/lru_cache_test.go Outdated Show resolved Hide resolved
go/cache/lru_cache_test.go Outdated Show resolved Hide resolved
go/cache/lru_cache_test.go Outdated Show resolved Hide resolved
go/cache/lru_cache_test.go Outdated Show resolved Hide resolved
go/cache/lru_cache_test.go Outdated Show resolved Hide resolved
go/event/event_test.go Outdated Show resolved Hide resolved
go/event/event_test.go Show resolved Hide resolved
go/exit/exit_test.go Show resolved Hide resolved
Signed-off-by: Your Name <[email protected]>
Signed-off-by: Your Name <[email protected]>
@shlomi-noach
Copy link
Contributor

BTW, we have a preference for normal git push as opposed to force-push. With force-push it 's difficult to keep track of changes and especially related to code review.

Copy link
Contributor

@shlomi-noach shlomi-noach left a comment

Choose a reason for hiding this comment

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

Please consider this subset of comments for removing superfluous text, as testify's functions already report as much. The same form of comments applies to the entirety of the PR.

go/cache/lru_cache_test.go Outdated Show resolved Hide resolved
go/cache/lru_cache_test.go Outdated Show resolved Hide resolved
go/cache/lru_cache_test.go Outdated Show resolved Hide resolved
go/cache/lru_cache_test.go Outdated Show resolved Hide resolved
go/cache/lru_cache_test.go Outdated Show resolved Hide resolved
go/cache/lru_cache_test.go Outdated Show resolved Hide resolved
go/cache/lru_cache_test.go Outdated Show resolved Hide resolved
go/cache/lru_cache_test.go Outdated Show resolved Hide resolved
Signed-off-by: Your Name <[email protected]>
Signed-off-by: Your Name <[email protected]>
@arthurschreiber
Copy link
Contributor

The Sign-off messages in your commits look off? 🤔

Signed-off-by: Harshvir Potpose <[email protected]>
@akagami-harsh
Copy link
Author

The Sign-off messages in your commits look off? 🤔

I had misconfigured it on my new Linux setup, got it fixed now! 😅

Copy link
Contributor

@shlomi-noach shlomi-noach left a comment

Choose a reason for hiding this comment

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

Again thank you for your efforts. In this review I have dozens of comments. I stopped at some point as I see those are repeating. Some notes:

  • Please be very cautious, and use require when the original code otherwise issues a return.
  • If using EqualValues, which we encourage, get rid of casting.
  • Use ErrorContains to both check that an error is not nil, as well as that it contains some text
  • Sometimes you will use require where an assert seems more compatible with the original code.

go/sqltypes/type_test.go Outdated Show resolved Hide resolved
go/sqltypes/type_test.go Outdated Show resolved Hide resolved
go/pools/id_pool_test.go Outdated Show resolved Hide resolved
go/pools/id_pool_test.go Outdated Show resolved Hide resolved
go/pools/id_pool_test.go Outdated Show resolved Hide resolved
go/mysql/binlog_event_common_test.go Outdated Show resolved Hide resolved
go/mysql/binlog_event_common_test.go Outdated Show resolved Hide resolved
go/mysql/binlog_event_common_test.go Outdated Show resolved Hide resolved
go/history/history_test.go Outdated Show resolved Hide resolved
go/history/history_test.go Outdated Show resolved Hide resolved
Signed-off-by: Harshvir Potpose <[email protected]>
Signed-off-by: Harshvir Potpose <[email protected]>
Signed-off-by: Harshvir Potpose <[email protected]>
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.

4 participants