Extend plugin mapping to command-level remapping #177

vuil · 2024-04-16T23:56:41Z

What this PR does / why we need it

Replaces InvokedAs field in the PluginDescriptor with a list of CommandMapEntry's that can provide additional mapping details. In particular it can specify a destination command path of the Tanzu CLI to map to a specific non root command path in the plugin.

Adds support for capturing the invocation "context" by consuming environment variables that are expected to be set by the Tanzu CLI when invoking a command that is being mapped.

Information in this context allows the plugin to construct proper Help information, and learn if the its command being invoked is done via a command-level mapping or not.

Updates the usage to provides better output when help is invoked on a command-level mapping.

Some additional handling added to propagate aliases and description of a mapped subcommand.

    The aliases and description of a remapped subcommand CommandMapEntry
    should default to the Aliases and Short values of the Command in the
    plugin. Hence, the 'info' command will interrogate the plugin command
    tree for these values unless they are already explicitly specified in
    the CommandMapEntry.

Which issue(s) this PR fixes

Fixes #

Describe testing done for PR

Updated unit tests
Build sample plugins with command-level map and verified that the command's Aliases and Short description are propagated into the elevate Tanzu CLI commands.

Release note

Extend plugin mapping to command-level remapping. Introduce CommandMapEntry which replaces InvokedAs in PluginDescriptor.

Additional information

Special notes for your reviewer

anujc25

Looks good 👍 . Just a few really minor comments.

plugin/types.go

marckhouzam

Very nice. I like the clear way for a plugin to indicate any mapping. I also like that there can be multiple mappings and from sub-commands. Very powerful.

We'll need some release notes for this nice change.

This is pretty complex stuff to think about so I'm not quite done but here are minor comments to start.

plugin/types.go

plugin/plugin_test.go

marckhouzam · 2024-04-19T15:00:13Z

plugin/usage.go

+		return cmd.UseLine()
+	}
+
+	// TODO(vuil) look into still incorporating relevant parts of UseLine into output


note so we don't forget this as a follow-up

Fixed in #180

plugin/invoke_context.go

marckhouzam · 2024-04-19T15:44:57Z

plugin/usage.go

The aliases need some tweaks in the help. Specifically, if a plugin sub-command is mapped to a different name. For example, I mapped tanzu builder cli to tanzu mycli but then the alias is incorrect:

$ tz mycli -h Build CLIs Usage: tanzu mycli tanzu kubernetes mycli tanzu mycli [command] tanzu kubernetes mycli [command] Aliases: cli, c [...] $ tz cli -h [x] : unknown command "cli" for "tanzu" Did you mean this? mycli

Thanks, the issue is with still assuming the name of the plugin is always a valid alias entry (the first item int the alias list), which is no longer true for a mapped command. I will address it in a followup.

Fixed in #180

plugin/usage.go

plugin/info.go

marckhouzam

Once the missing quote x2 is fixed (see comments) and that CI passes, this LGTM.

Nice job @vuil, this is some powerful stuff!

Replaces InvokedAs field in the PluginDescriptor with a list of CommandMapEntry's that can provide additional mapping details. In particular it can specify a destination command path of the Tanzu CLI to map to a specific non root command path in the plugin. Adds support for capturing the invocation "context" by consuming environment variables that are expected to be set by the Tanzu CLI. Information in this context allows the plugin to construct proper Help information, and learn if the its command being invoked is done via a command-level mapping or not. Updates the usage to provides better output when help is invoked on a command-level mapping.

The aliases and description of a remapped subcommand CommandMapEntry should default to the Aliases and Short values of the Command in the plugin. Hence, the 'info' command will interrogate the plugin command tree for these values unless they are already explicitly specified in the CommandMapEntry.

- and some typos, linter warnings Signed-off-by: Vui Lam <[email protected]>

vuil requested a review from a team as a code owner April 16, 2024 23:56

vmwclabot added the cla-not-required label Apr 16, 2024

vuil changed the title ~~Remap commandmap autoaliasdesc~~ Autopopulate aliases and description of command-level map entries Apr 16, 2024

vuil changed the title ~~Autopopulate aliases and description of command-level map entries~~ WIP: Autopopulate aliases and description of command-level map entries Apr 16, 2024

vuil changed the title ~~WIP: Autopopulate aliases and description of command-level map entries~~ Autopopulate aliases and description of command-level map entries Apr 17, 2024

vuil changed the title ~~Autopopulate aliases and description of command-level map entries~~ Extend plugin mapping to command-level remapping Apr 17, 2024

vuil mentioned this pull request Apr 17, 2024

Extend plugin mapping to command-level remapping (older) #176

Closed

marckhouzam mentioned this pull request Apr 19, 2024

Perform a catalog initialization if needed vmware-tanzu/tanzu-cli#738

Merged

anujc25 reviewed Apr 19, 2024

View reviewed changes

plugin/types.go Outdated Show resolved Hide resolved

plugin/types.go Show resolved Hide resolved

vuil commented Apr 19, 2024

View reviewed changes

plugin/types.go Show resolved Hide resolved

vuil force-pushed the remap_commandmap_autoaliasdesc branch from ee0eb15 to 34eeb73 Compare April 19, 2024 15:42

marckhouzam reviewed Apr 19, 2024

View reviewed changes

plugin/usage.go Show resolved Hide resolved

vuil force-pushed the remap_commandmap_autoaliasdesc branch from 34eeb73 to 63e97b6 Compare April 19, 2024 19:52

marckhouzam reviewed Apr 19, 2024

View reviewed changes

plugin/usage.go Outdated Show resolved Hide resolved

marckhouzam reviewed Apr 19, 2024

View reviewed changes

plugin/usage.go Outdated Show resolved Hide resolved

marckhouzam reviewed Apr 19, 2024

View reviewed changes

plugin/info.go Show resolved Hide resolved

marckhouzam approved these changes Apr 19, 2024

View reviewed changes

vuil force-pushed the remap_commandmap_autoaliasdesc branch from 63e97b6 to da4a99a Compare April 19, 2024 21:05

vuil added 4 commits April 19, 2024 14:11

Add Aliases to CommandMapEntry

efd5a91

Fix usage footer generation of mapped command

c8b12e5

- and some typos, linter warnings Signed-off-by: Vui Lam <[email protected]>

vuil force-pushed the remap_commandmap_autoaliasdesc branch from da4a99a to c8b12e5 Compare April 19, 2024 21:11

vuil merged commit 8822322 into vmware-tanzu:main Apr 19, 2024

marckhouzam added this to the v1.3.0 milestone Apr 20, 2024

Extend plugin mapping to command-level remapping #177

Extend plugin mapping to command-level remapping #177

Uh oh!

Conversation

vuil commented Apr 16, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What this PR does / why we need it

Which issue(s) this PR fixes

Describe testing done for PR

Release note

Additional information

Special notes for your reviewer

Uh oh!

anujc25 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

marckhouzam left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

marckhouzam Apr 19, 2024

Choose a reason for hiding this comment

Uh oh!

marckhouzam Apr 25, 2024

Choose a reason for hiding this comment

Uh oh!

Uh oh!

marckhouzam Apr 19, 2024

Choose a reason for hiding this comment

Uh oh!

vuil Apr 19, 2024

Choose a reason for hiding this comment

Uh oh!

marckhouzam Apr 25, 2024

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

marckhouzam left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

vuil commented Apr 16, 2024 •

edited

Loading