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

refac: Remove duplicate forAllShards methods from vt/vtctl/workflow #17025

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

Conversation

beingnoble03
Copy link
Member

@beingnoble03 beingnoble03 commented Oct 21, 2024

Description

This PR removes some duplicate code from vt/vtctl/workflow

  • Removes multiple forAllShards methods
  • Moves validateSourceTablesExist from server.go to utils.go removing the method receiver.
  • Adds unit tests for validateSourceTablesExist

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

Copy link
Contributor

vitess-bot bot commented Oct 21, 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 Oct 21, 2024
@github-actions github-actions bot added this to the v22.0.0 milestone Oct 22, 2024
Copy link

codecov bot commented Oct 22, 2024

Codecov Report

Attention: Patch coverage is 96.66667% with 1 line in your changes missing coverage. Please review.

Project coverage is 67.13%. Comparing base (aba477f) to head (8268a52).
Report is 8 commits behind head on main.

Files with missing lines Patch % Lines
go/vt/vtctl/workflow/resharder.go 80.00% 1 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main   #17025      +/-   ##
==========================================
- Coverage   67.15%   67.13%   -0.02%     
==========================================
  Files        1571     1571              
  Lines      251763   251794      +31     
==========================================
- Hits       169080   169053      -27     
- Misses      82683    82741      +58     

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

@mattlord
Copy link
Contributor

Just FYI, there are also some unit tests that cover the workflow package in rpc_vreplication_test.go as well. That is needed to test the tablet side (the database queries) of the work where we’ve replaced vexec usage with specific RPCs.

@beingnoble03
Copy link
Member Author

beingnoble03 commented Oct 22, 2024

@mattlord thanks for letting me know. I don't think we need unit tests added here then. I think I probably missed that because I just checked coverage for vt/vtctl/workflow and the function was uncovered.

@beingnoble03 beingnoble03 changed the title test: Add unit tests for vt/vtctl/workflow refac: Remove duplicate forAllShards methods from vt/vtctl/workflow Oct 22, 2024
@beingnoble03 beingnoble03 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 Oct 22, 2024
@beingnoble03 beingnoble03 marked this pull request as ready for review October 22, 2024 14:09
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