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

VReplication workflow package: unit tests for StreamMigrator, Mount et al #16498

Merged
merged 10 commits into from
Aug 21, 2024

Conversation

rohit-nayak-ps
Copy link
Contributor

@rohit-nayak-ps rohit-nayak-ps commented Jul 30, 2024

Description

As part of the vtctldclient migration, we ported over a lot of existing code and wrote new code in the go/vt/vtctl/workflow package. However the unit test frameworks were not. While we have added some unit tests since, the current coverage is still very low.

This is one of multiple PRs that we will create to progressively increase coverage to a more acceptable level.

This PR has tests, among others, for:

  • the Mount commands
  • StreamMigrator
  • ShardRoutingRules

Related Issue(s)

#16499

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

Copy link
Contributor

vitess-bot bot commented Jul 30, 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 Jul 30, 2024
@rohit-nayak-ps rohit-nayak-ps added Type: Enhancement Logical improvement (somewhere between a bug and feature) Component: VReplication Type: Testing labels Jul 30, 2024
@github-actions github-actions bot added this to the v21.0.0 milestone Jul 30, 2024
@rohit-nayak-ps rohit-nayak-ps removed Type: Enhancement Logical improvement (somewhere between a bug and feature) NeedsDescriptionUpdate The description is not clear or comprehensive enough, and needs work NeedsWebsiteDocsUpdate What it says NeedsBackportReason If backport labels have been applied to a PR, a justification is required NeedsIssue A linked issue is missing for this Pull Request labels Jul 30, 2024
Copy link

codecov bot commented Jul 30, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 68.97%. Comparing base (471ab1a) to head (a1aba96).
Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main   #16498      +/-   ##
==========================================
+ Coverage   68.87%   68.97%   +0.10%     
==========================================
  Files        1562     1562              
  Lines      200673   200673              
==========================================
+ Hits       138217   138423     +206     
+ Misses      62456    62250     -206     

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

@rohit-nayak-ps rohit-nayak-ps changed the title VReplication workflow package: Increase unit test coverage VReplication workflow package: unit tests for StreamMigrator, Mount et al Jul 30, 2024
@rohit-nayak-ps rohit-nayak-ps marked this pull request as ready for review July 30, 2024 16:45
@rohit-nayak-ps rohit-nayak-ps requested review from mattlord and a team July 30, 2024 16:46
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.

❤️ Thank you for working on these!

go/vt/vtctl/workflow/utils_test.go Outdated Show resolved Hide resolved
Signed-off-by: Rohit Nayak <rohit@planetscale.com>
Signed-off-by: Rohit Nayak <rohit@planetscale.com>
Signed-off-by: Rohit Nayak <rohit@planetscale.com>
Signed-off-by: Rohit Nayak <rohit@planetscale.com>
Signed-off-by: Rohit Nayak <rohit@planetscale.com>
Signed-off-by: Rohit Nayak <rohit@planetscale.com>
Signed-off-by: Rohit Nayak <rohit@planetscale.com>
Signed-off-by: Rohit Nayak <rohit@planetscale.com>
Signed-off-by: Rohit Nayak <rohit@planetscale.com>
Signed-off-by: Rohit Nayak <rohit@planetscale.com>
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
result := tt.funcUnderTest(streams)
if !reflect.DeepEqual(result, tt.expectedResult) {
Copy link
Contributor

Choose a reason for hiding this comment

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

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Will change in the related followup PRs that improve coverage.

@rohit-nayak-ps rohit-nayak-ps merged commit 5458941 into vitessio:main Aug 21, 2024
127 checks passed
@rohit-nayak-ps rohit-nayak-ps deleted the rohit/refactor-vtctld-1 branch August 21, 2024 11:36
venkatraju pushed a commit to slackhq/vitess that referenced this pull request Aug 29, 2024
…t al (vitessio#16498)

Signed-off-by: Rohit Nayak <rohit@planetscale.com>
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