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

Add vtctldclient missing cmds #17442

Draft
wants to merge 6 commits into
base: main
Choose a base branch
from

Conversation

mattlord
Copy link
Contributor

@mattlord mattlord commented Dec 27, 2024

Description

This implements client commands in vtctldclient that were never ported during the client migration. These are things that were identified while moving all endtoend tests to use vtctldclient exclusively in #17441.

We will (after merging in main once #17441 is merged) also then replace all remaining vtctlclient usage in the e2e tests with usage of these new vtctldclient commands.

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

Copy link
Contributor

vitess-bot bot commented Dec 27, 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 Dec 27, 2024
@mattlord mattlord added Type: Internal Cleanup Component: vtctldclient and removed NeedsBackportReason If backport labels have been applied to a PR, a justification is required labels Dec 27, 2024
@github-actions github-actions bot added this to the v22.0.0 milestone Dec 27, 2024
Copy link

codecov bot commented Dec 27, 2024

Codecov Report

Attention: Patch coverage is 11.30435% with 204 lines in your changes missing coverage. Please review.

Project coverage is 67.61%. Comparing base (059d01a) to head (a091042).
Report is 8 commits behind head on main.

Files with missing lines Patch % Lines
go/vt/vtctl/grpcvtctldserver/server.go 8.23% 78 Missing ⚠️
go/cmd/vtctldclient/command/schema.go 20.00% 48 Missing ⚠️
go/cmd/vtctldclient/command/permissions.go 8.51% 43 Missing ⚠️
go/cmd/vtctldclient/command/topology.go 9.67% 28 Missing ⚠️
go/vt/vtctl/grpcvtctldclient/client_gen.go 0.00% 5 Missing ⚠️
go/vt/vtctl/localvtctldclient/client_gen.go 0.00% 2 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main   #17442      +/-   ##
==========================================
- Coverage   67.68%   67.61%   -0.07%     
==========================================
  Files        1583     1585       +2     
  Lines      254321   254558     +237     
==========================================
- Hits       172131   172120      -11     
- Misses      82190    82438     +248     

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

@mattlord mattlord force-pushed the vtctldclient_missing_cmds branch 2 times, most recently from 9824c10 to ec59343 Compare December 27, 2024 12:41
@mattlord mattlord force-pushed the vtctldclient_missing_cmds branch from ec59343 to 851ccac Compare December 27, 2024 22:53
Signed-off-by: Matt Lord <[email protected]>
@mattlord mattlord force-pushed the vtctldclient_missing_cmds branch from 8c5f3e9 to 05c4c1d Compare December 27, 2024 23:47
Signed-off-by: Matt Lord <[email protected]>
@mattlord mattlord 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 labels Dec 28, 2024
}

message ValidatePermissionsKeyspaceResponse {
}
Copy link
Contributor

Choose a reason for hiding this comment

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

Does this not contain any results?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yeah, it returns an error if there's a validation failure:

vitess/go/vt/vtctl/vtctl.go

Lines 3259 to 3269 in 76abae4

func commandValidatePermissionsKeyspace(ctx context.Context, wr *wrangler.Wrangler, subFlags *pflag.FlagSet, args []string) error {
if err := subFlags.Parse(args); err != nil {
return err
}
if subFlags.NArg() != 1 {
return fmt.Errorf("the <keyspace name> argument is required for the ValidatePermissionsKeyspace command")
}
keyspace := subFlags.Arg(0)
return wr.ValidatePermissionsKeyspace(ctx, keyspace)
}

We could change that, of course, but here I'm primarily just porting these missing commands over.

Comment on lines -289 to -290
// testCopySchemaShards tests that schema from source is correctly applied to destination
func testCopySchemaShards(t *testing.T, source string, shard int) {
Copy link
Contributor Author

Choose a reason for hiding this comment

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

I removed the CopySchemaShard client command tests since this client command is no longer used anywhere that I could find so we can kill it off.

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