Skip to content

Conversation

@shivansh-gohem
Copy link

@shivansh-gohem shivansh-gohem commented Dec 25, 2025

This PR adds unit test coverage for the dropTargetShards function in traffic_switcher.go, which previously had 0% test coverage.

Adds TestDropTargetShards_NoOp to verify that dropTargetShards() can be called safely within a configured workflow environment. The test uses the standard newTestEnv test fixture pattern consistent with other tests in the file (similar to TestCancelMigration_TABLES and TestCancelMigration_SHARDS).

Coverage Impact:

  • Before: dropTargetShards had 0% test coverage
  • After: 75% coverage for traffic_switcher.go:1399:dropTargetShards

Verification:
go test ./go/vt/vtctl/workflow -run TestDropTargetShards_NoOp -v
go test ./go/vt/vtctl/workflow -run TestDropTargetShards_NoOp -coverpkg=./go/vt/vtctl/workflow -coverprofile=c.out
go tool cover -func=c.out | grep dropTargetShards

Result: traffic_switcher.go:1399: dropTargetShards 75.0%

Backporting: Not required - this is a test-only change that improves code coverage without any functional modifications.

Documentation: Not required - no user-facing changes or new features introduced.

Related Issue(s)

Fixes #17284

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

No deployment impact. This is a test-only change that increases code coverage.

@github-actions github-actions bot added this to the v24.0.0 milestone Dec 25, 2025
@vitess-bot vitess-bot bot added NeedsWebsiteDocsUpdate What it says NeedsDescriptionUpdate The description is not clear or comprehensive enough, and needs work 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 Dec 25, 2025
@vitess-bot
Copy link
Contributor

vitess-bot bot commented Dec 25, 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.

Adds TestDropTargetShards_NoOp to verify dropTargetShards can be called
safely with a configured workflow. Increases coverage from 0% to 75%.

Signed-off-by: Shivansh Sahu <[email protected]>
@shivansh-gohem shivansh-gohem force-pushed the test-traffic-switcher-drop-target-shards branch from 262f556 to b2fd8bf Compare December 25, 2025 12:30
@shivansh-gohem
Copy link
Author

@timvaillancourt timvaillancourt added Component: Build/CI Type: CI/Build Component: vtctl and removed 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 labels Dec 27, 2025
@shivansh-gohem
Copy link
Author

/cc @timvaillancourt

Comment on lines +483 to +484
err = ts.dropTargetShards(ctx)
require.NoError(t, err)
Copy link
Member

Choose a reason for hiding this comment

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

@shivansh-gohem This may improve the test coverage number, but I don't see how it adds any actual testing value? We should be checking the associated state before and after to ensure that it did what it's supposed to do. Can you please add that?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Component: Build/CI Component: vtctl NeedsIssue A linked issue is missing for this Pull Request Type: CI/Build

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants