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.

Sign up for GitHub

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

Jump to bottom

VReplication: refactor denied tables unit test, add couple more tests #15995

Merged
merged 3 commits into from
May 27, 2024
Merged

VReplication: refactor denied tables unit test, add couple more tests #15995

merged 3 commits into from
May 27, 2024

Conversation

rohit-nayak-ps
Copy link
Contributor

Description

While debugging an issue reported around denied tables, I ended up refactoring a unit test. It turned out the report was on an older version which had been fixed. But thought it worthwhile to push the test changes.

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

@rohit-nayak-ps
Refactor existing tests to make it easer to add more
9b4e1dd 
Signed-off-by: Rohit Nayak <rohit@planetscale.com>
@rohit-nayak-ps
Add more unit tests. Remove old tests kept previously in comments.
d76d73c 
Signed-off-by: Rohit Nayak <rohit@planetscale.com>
@vitess-bot vitess-bot
Copy link
Contributor

vitess-bot bot commented May 22, 2024

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 May 22, 2024
@rohit-nayak-ps rohit-nayak-ps added Type: Internal Cleanup Component: VReplication 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 May 22, 2024
@github-actions github-actions bot added this to the v20.0.0 milestone May 22, 2024
@codecov Codecov
Copy link

codecov bot commented May 22, 2024 •
edited
Loading

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 68.25%. Comparing base (3b09eb2) to head (152a2ae).
Report is 16 commits behind head on main.

Additional details and impacted files 
@@            Coverage Diff             @@
##             main   #15995      +/-   ##
==========================================
- Coverage   68.47%   68.25%   -0.23%     
==========================================
  Files        1562     1562              
  Lines      197083   197319     +236     
==========================================
- Hits       134962   134678     -284     
- Misses      62121    62641     +520

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

@rohit-nayak-ps rohit-nayak-ps marked this pull request as ready for review May 23, 2024 04:27
mattlord
mattlord approved these changes May 23, 2024
View reviewed changes
Copy link
Contributor

@mattlord mattlord left a comment

Choose a reason for hiding this comment

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

Thanks! ❤️

go/vt/topo/shard_test.go Outdated Show resolved Hide resolved
go/vt/topo/shard_test.go
Comment on lines +273 to +274
require.Error(t, err)
require.Contains(t, err.Error(), tcase.wantError)
Copy link
Contributor

Choose a reason for hiding this comment

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

We can use require.EqualError to replace both of these checks.

@rohit-nayak-ps
Address review comemnt
152a2ae 
Signed-off-by: Rohit Nayak <rohit@planetscale.com>
@rohit-nayak-ps rohit-nayak-ps merged commit 4321194 into vitessio:main May 27, 2024
93 checks passed
@rohit-nayak-ps rohit-nayak-ps deleted the rohit/movetables-denied-tables-bug branch May 27, 2024 08:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@mattlord mattlord mattlord approved these changes

@GuptaManan100 GuptaManan100 GuptaManan100 approved these changes

@deepthi deepthi Awaiting requested review from deepthi deepthi is a code owner

Assignees
No one assigned
Labels
Component: VReplication Type: Internal Cleanup
Projects
None yet
Milestone
v20.0.0
Development

Successfully merging this pull request may close these issues.

None yet
3 participants
@rohit-nayak-ps @mattlord @GuptaManan100