Add vtctldclient missing cmds and remove remaining vtctl[client] usage in e2e tests #17442

mattlord · 2024-12-27T01:41:27Z

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. The missing commands being:

CopySchemaShard
ValidatePermissionsKeyspace
ValidatePermissionsShard
ValidateSchemaShard
WriteTopologyPath

Command examples:

CopySchemaShard

# no output on success
❯ vtctlclient CopySchemaShard commerce/0 customer/0
W0102 09:07:46.299694   36486 log.go:39] Failed to read in config : Config File "vtconfig" Not Found in "[/Users/matt/git/vitess]". This is optional, and can be ignored if you are not using config files. For a detailed explanation, see https://github.com/vitessio/vitess/blob/main/doc/viper/viper.md#config-files.
CopySchemaShard Error: rpc error: code = Unknown desc = GetShard(customer, 0) failed: node doesn't exist: /vitess/global/keyspaces/customer/shards/0/Shard
E0102 09:07:46.308410   36486 main.go:105] remote error: rpc error: code = Unknown desc = GetShard(customer, 0) failed: node doesn't exist: /vitess/global/keyspaces/customer/shards/0/Shard

❯ vtctldclient CopySchemaShard commerce/0 customer/0
E0102 09:02:53.867987   33032 main.go:56] rpc error: code = Unknown desc = GetShard(customer, 0) failed: node doesn't exist: /vitess/global/keyspaces/customer/shards/0/Shard

ValidatePermissionsKeyspace, ValidatePermissionsShard

❯ vtctlclient ValidatePermissionsKeyspace commerce
W0101 13:58:38.218227   32307 log.go:39] Failed to read in config : Config File "vtconfig" Not Found in "[/Users/matt/git/vitess]". This is optional, and can be ignored if you are not using config files. For a detailed explanation, see https://github.com/vitessio/vitess/blob/main/doc/viper/viper.md#config-files.
ValidatePermissionsKeyspace Error: rpc error: code = Unknown desc = permissions diffs: zone1-0000000100 has an extra user localhost:mlord;zone1-0000000100 has an extra user localhost:mlord
E0101 13:58:38.237814   32307 main.go:105] remote error: rpc error: code = Unknown desc = permissions diffs: zone1-0000000100 has an extra user localhost:mlord;zone1-0000000100 has an extra user localhost:mlord

❯ vtctldclient ValidatePermissionsKeyspace commerce
E0101 13:58:55.687067   32429 main.go:56] rpc error: code = Unknown desc = permissions diffs: zone1-0000000100 has an extra user localhost:mlord

❯ vtctlclient ValidatePermissionsShard commerce/0
W0101 13:59:55.640410   32898 log.go:39] Failed to read in config : Config File "vtconfig" Not Found in "[/Users/matt/git/vitess]". This is optional, and can be ignored if you are not using config files. For a detailed explanation, see https://github.com/vitessio/vitess/blob/main/doc/viper/viper.md#config-files.
ValidatePermissionsShard Error: rpc error: code = Unknown desc = permissions diffs: zone1-0000000100 has an extra user localhost:mlord;zone1-0000000100 has an extra user localhost:mlord
E0101 13:59:55.655940   32898 main.go:105] remote error: rpc error: code = Unknown desc = permissions diffs: zone1-0000000100 has an extra user localhost:mlord;zone1-0000000100 has an extra user localhost:mlord

❯ vtctldclient ValidatePermissionsShard commerce/0
E0101 13:59:59.051856   33004 main.go:56] rpc error: code = Unknown desc = permissions diffs: zone1-0000000100 has an extra user localhost:mlord

ValidateSchemaShard

❯ vtctlclient ValidateSchemaShard commerce/0
W0102 09:09:54.960557   37634 log.go:39] Failed to read in config : Config File "vtconfig" Not Found in "[/Users/matt/git/vitess]". This is optional, and can be ignored if you are not using config files. For a detailed explanation, see https://github.com/vitessio/vitess/blob/main/doc/viper/viper.md#config-files.
ValidatePermissionsShard Error: rpc error: code = Unknown desc = permissions diffs: zone1-0000000100 has an extra user localhost:mlord;zone1-0000000100 has an extra user localhost:mlord
E0102 09:09:54.981317   37634 main.go:105] remote error: rpc error: code = Unknown desc = permissions diffs: zone1-0000000100 has an extra user localhost:mlord;zone1-0000000100 has an extra user localhost:mlord

❯ vtctldclient ValidateSchemaShard commerce/0
[
  "zone1-0000000100 has an extra table named mlord",
  "zone1-0000000100 has an extra table named mlord"
]

WriteTopologyPath

❯ vtctlclient TopoCp -- --to_topo /tmp/foo.txt "/tmp"
W0102 09:19:10.219407   42425 log.go:39] Failed to read in config : Config File "vtconfig" Not Found in "[/Users/matt/git/vitess]". This is optional, and can be ignored if you are not using config files. For a detailed explanation, see https://github.com/vitessio/vitess/blob/main/doc/viper/viper.md#config-files.

❯ vtctldclient --server=internal WriteTopologyPath "/tmp" /tmp/foo.txt

With these in place (and after merging in main after #17441 was merged) we then also replace all remaining vtctl[client] usage in the e2e tests with usage of vtctldclient.

Related Issue(s)

Follow-up to: Move all e2e tests to vtctldclient #17441

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: Update docs for https://github.com/vitessio/vitess/pull/17442 website#1912

Signed-off-by: Matt Lord <[email protected]>

vitess-bot · 2024-12-27T01:41:29Z

codecov · 2024-12-27T02:02:22Z

Codecov Report

Attention: Patch coverage is 30.89172% with 217 lines in your changes missing coverage. Please review.

Project coverage is 67.70%. Comparing base (71ccd6d) to head (78ca3e0).
Report is 1 commits behind head on main.

Files with missing lines	Patch %	Lines
go/cmd/vtctldclient/command/schema.go	17.43%	90 Missing ⚠️
go/cmd/vtctldclient/command/permissions.go	8.51%	43 Missing ⚠️
go/vt/vtctl/grpcvtctldserver/server.go	63.80%	38 Missing ⚠️
go/cmd/vtctldclient/command/topology.go	14.28%	30 Missing ⚠️
go/vt/vtctl/grpcvtctldclient/client_gen.go	0.00%	10 Missing ⚠️
go/vt/vtctl/localvtctldclient/client_gen.go	0.00%	4 Missing ⚠️
go/cmd/vtctldclient/main.go	0.00%	2 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main   #17442      +/-   ##
==========================================
- Coverage   67.71%   67.70%   -0.02%     
==========================================
  Files        1584     1586       +2     
  Lines      254721   255059     +338     
==========================================
+ Hits       172473   172675     +202     
- Misses      82248    82384     +136

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

Signed-off-by: Matt Lord <[email protected]>

proto/vtctldata.proto

go/test/endtoend/vtgate/schema/schema_test.go

This reverts commit a091042. Signed-off-by: Matt Lord <[email protected]>

Signed-off-by: Matt Lord <[email protected]>

…cmds Signed-off-by: Matt Lord <[email protected]>

Signed-off-by: Matt Lord <[email protected]>

…cmds Signed-off-by: Matt Lord <[email protected]>

Signed-off-by: Matt Lord <[email protected]>

deepthi · 2025-01-17T20:04:33Z

go/cmd/vtctldclient/command/root.go

-		// Use internal vtctld server implementation.
-		// Register a nil grpc handler -- we will not use tmclient at all but
-		// a factory still needs to be registered.


Was this comment just incorrect?

It was correct. It is no longer. Now we do make some tmclient calls and register the grpc handler separately.

deepthi · 2025-01-17T20:05:21Z

go/cmd/vtctldclient/command/schema.go

+	// ValidateSchemaKeyspace makes a ValidateSchemaKeyspace gRPC call to a vtctld.
+	ValidateSchemaKeyspace = &cobra.Command{
+		Use:                   "ValidateSchemaKeyspace [--exclude-tables=<exclude_tables>] [--include-views] [--skip-no-primary] [--include-vschema] <keyspace>",
+		Short:                 "Validates that the schema on the primary tablet for the first shard matches the schema on all other tablets in the keyspace.",


Suggested change

Short: "Validates that the schema on the primary tablet for the first shard matches the schema on all other tablets in the keyspace.",

Short: "Validates that the schema on the primary tablet for the first shard matches the schema on all other shards in the keyspace.",

I copied the text from the legacy client, and the server code actually does compare against all tablets.

deepthi · 2025-01-17T20:06:53Z

go/cmd/vtctldclient/command/topology.go

@@ -36,12 +39,30 @@ var (
 		RunE:                  commandGetTopologyPath,
 	}

+	// WriteTopologyPath writes the contents of a local file to a path
+	// in the topology server.
+	WriteTopologyPath = &cobra.Command{


Is this a net new command?

It's replacing one:

❯ vtctlclient TopoCp -- --to_topo /tmp/foo.txt "/tmp" W0102 09:19:10.219407 42425 log.go:39] Failed to read in config : Config File "vtconfig" Not Found in "[/Users/matt/git/vitess]". This is optional, and can be ignored if you are not using config files. For a detailed explanation, see https://github.com/vitessio/vitess/blob/main/doc/viper/viper.md#config-files. ❯ vtctldclient --server=internal WriteTopologyPath "/tmp" /tmp/foo.txt

deepthi · 2025-01-17T20:08:07Z

go/flags/endtoend/vtctldclient.txt

  completion                  Generate the autocompletion script for the specified shell
  help                        Help about any command

 Flags:
-      --action_timeout duration                timeout to use for the command (default 1h0m0s)


What changed in these flags? I can't tell from the diff.

The tmclient related flags were added because of go/cmd/vtctldclient/plugin_grpctmclient.go. Which was needed for vtctldclient to be a full replacement for vtctl.

mattlord added 3 commits December 26, 2024 18:10

Add missing TopoCp replacement

b2c696d

Signed-off-by: Matt Lord <[email protected]>

Add CopySchemaShard

45dd233

Signed-off-by: Matt Lord <[email protected]>

Add ValidateSchemaShard

0e3a8e1

Signed-off-by: Matt Lord <[email protected]>

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 bot added this to the v22.0.0 milestone Dec 27, 2024

mattlord force-pushed the vtctldclient_missing_cmds branch 2 times, most recently from 9824c10 to ec59343 Compare December 27, 2024 12:41

Add missing permissions commands

851ccac

Signed-off-by: Matt Lord <[email protected]>

mattlord force-pushed the vtctldclient_missing_cmds branch from ec59343 to 851ccac Compare December 27, 2024 22:53

Fixups

05c4c1d

Signed-off-by: Matt Lord <[email protected]>

mattlord force-pushed the vtctldclient_missing_cmds branch from 8c5f3e9 to 05c4c1d Compare December 27, 2024 23:47

Remove CopySchemaShard

a091042

Signed-off-by: Matt Lord <[email protected]>

mattlord mentioned this pull request Dec 28, 2024

Move all e2e tests to vtctldclient #17441

Merged

5 tasks

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

dbussink reviewed Dec 30, 2024

View reviewed changes

proto/vtctldata.proto Show resolved Hide resolved

mattlord commented Dec 30, 2024

View reviewed changes

go/test/endtoend/vtgate/schema/schema_test.go Outdated Show resolved Hide resolved

mattlord force-pushed the vtctldclient_missing_cmds branch 2 times, most recently from 3018fa3 to 4465813 Compare January 1, 2025 21:13

mattlord added 2 commits January 1, 2025 18:40

Revert "Remove CopySchemaShard"

2ef4690

This reverts commit a091042. Signed-off-by: Matt Lord <[email protected]>

Start work on CopySchemaShard

f5fcd6c

Signed-off-by: Matt Lord <[email protected]>

mattlord force-pushed the vtctldclient_missing_cmds branch from c158a65 to e89ca17 Compare January 3, 2025 18:23

mattlord marked this pull request as ready for review January 3, 2025 18:49

mattlord requested review from deepthi, harshit-gangal, ajm188, notfelineit, rohit-nayak-ps, GuptaManan100, timvaillancourt, systay, frouioui and derekperkins as code owners January 3, 2025 18:49

mattlord removed request for dbussink, shlomi-noach, timvaillancourt, derekperkins, ajm188 and harshit-gangal January 8, 2025 14:08

Merge remote-tracking branch 'origin/main' into vtctldclient_missing_…

2de0bcf

…cmds Signed-off-by: Matt Lord <[email protected]>

mattlord requested review from shlomi-noach and dbussink January 11, 2025 21:59

mattlord added 3 commits January 16, 2025 12:27

Update vtctldclient help text

2e4cd37

Signed-off-by: Matt Lord <[email protected]>

Merge remote-tracking branch 'origin/main' into vtctldclient_missing_…

096b292

…cmds Signed-off-by: Matt Lord <[email protected]>

Add unit tests for permissions commands

60fca3a

Signed-off-by: Matt Lord <[email protected]>

mattlord force-pushed the vtctldclient_missing_cmds branch from 64a98e3 to f0d6c1e Compare January 17, 2025 17:56

Reorgnaize the permissions tests

1073206

Signed-off-by: Matt Lord <[email protected]>

mattlord force-pushed the vtctldclient_missing_cmds branch from f0d6c1e to 1073206 Compare January 17, 2025 17:58

mattlord added 2 commits January 17, 2025 13:04

Update copyright year on new files

afbeb6b

Signed-off-by: Matt Lord <[email protected]>

Fix TestRootWithInternalVtctld

78ca3e0

Signed-off-by: Matt Lord <[email protected]>

deepthi approved these changes Jan 17, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add vtctldclient missing cmds and remove remaining vtctl[client] usage in e2e tests #17442

Add vtctldclient missing cmds and remove remaining vtctl[client] usage in e2e tests #17442

mattlord commented Dec 27, 2024 •

edited

Loading

vitess-bot bot commented Dec 27, 2024

codecov bot commented Dec 27, 2024 •

edited

Loading

deepthi Jan 17, 2025

mattlord Jan 17, 2025

deepthi Jan 17, 2025

mattlord Jan 17, 2025

deepthi Jan 17, 2025

mattlord Jan 17, 2025

deepthi Jan 17, 2025 •

edited

Loading

mattlord Jan 17, 2025

	Short: "Validates that the schema on the primary tablet for the first shard matches the schema on all other tablets in the keyspace.",
	Short: "Validates that the schema on the primary tablet for the first shard matches the schema on all other shards in the keyspace.",

Add vtctldclient missing cmds and remove remaining vtctl[client] usage in e2e tests #17442

Are you sure you want to change the base?

Add vtctldclient missing cmds and remove remaining vtctl[client] usage in e2e tests #17442

Conversation

mattlord commented Dec 27, 2024 • edited Loading

Description

Command examples:

Related Issue(s)

Checklist

vitess-bot bot commented Dec 27, 2024

Review Checklist

General

Tests

Documentation

New flags

If a workflow is added or modified:

Backward compatibility

codecov bot commented Dec 27, 2024 • edited Loading

Codecov Report

deepthi Jan 17, 2025

Choose a reason for hiding this comment

mattlord Jan 17, 2025

Choose a reason for hiding this comment

deepthi Jan 17, 2025

Choose a reason for hiding this comment

mattlord Jan 17, 2025

Choose a reason for hiding this comment

deepthi Jan 17, 2025

Choose a reason for hiding this comment

mattlord Jan 17, 2025

Choose a reason for hiding this comment

deepthi Jan 17, 2025 • edited Loading

Choose a reason for hiding this comment

mattlord Jan 17, 2025

Choose a reason for hiding this comment

mattlord commented Dec 27, 2024 •

edited

Loading

codecov bot commented Dec 27, 2024 •

edited

Loading

deepthi Jan 17, 2025 •

edited

Loading