pkg/cli: resolve `--plugins`/`layout` value by semantic version #1536

estroz · 2020-05-30T01:41:29Z

Multiple plugins with the same name but different versions are now resolved correctly by resolvePluginsByKey(). For example, a config with layout: go/v2.0 and another with layout: go/v2.1 should both be resolvable by a particular CLI.

pkg/cli: resolve all matching plugins such that they can contain multiple plugins with the same name. As long as there is only one plugin type, ex. Init, per set of resolved plugins, no errors will occur.

pkg/cli/cli.go

pkg/cli/api.go

camilamacedo86

You are doing many changes. Its ONLY possible check and ensure that the plugin is working well with 2..N plugin versions implemented in the project when we have more than one version here which is ONLY done in the commit e38b06b from the PR #1498. Otherwise, we might be introducing new issues scenarios in this design/solution which is happening in this case. See:

Starting to generate projects with version 3-alpha
Generating project-v3
go: creating new go.mod: module sigs.k8s.io/kubebuilder/testdata/project-v3
initializing project-v3 ...
Error: unknown flag: --domain
2020/06/01 13:00:28 unknown flag: --domain
make[1]: *** [Makefile:63: generate-testdata] Error 1
make[1]: Leaving directory '/Users/camilamacedo/go/src/sigs.k8s.io/kubebuilder'
make: *** [Makefile:58: generate] Error 2

IMO we should move forward with #1498 and #1538 then, you would be able to work in improvements and cleanups as you wish and then, this scenario will be verified tested by the CI to avoid new issues be introduced as well. (kb working with more than one plugin version)

pkg/cli/cli_test.go

pkg/cli/plugins_test.go

containing multiple plugins of the same name (different versions) or same short name (different fully-qualified names). For example, when a CLI containing plugins "go.kubebuilder.io/v2.0" and "go.kubebuilder.io/v2.1" with a default of the latter is passed a either config with "layout: go/v2.0", a config with "layout: go/v2.1", or "--plugins go", it should resolve each successfully. pkg/cli: resolve default plugins first so that, if a key matches a default plugin, the correct plugin is always returned. If a user wants non-default behavior they must specify the exact plugin they want.

camilamacedo86 · 2020-06-03T18:06:19Z

pkg/cli/cli.go

@@ -218,22 +216,32 @@ func (c *cli) initialize() error {
 	// layout and --plugins values can be short (ex. "go/v2.0.0") or unversioned


Suggested change

// layout and --plugins values can be short (ex. "go/v2.0.0") or unversioned

// layout and --plugins values can be short (ex. "go/v2.0") or unversioned

We haven't yet removed patch versions yet, PR to come.

camilamacedo86 · 2020-06-03T18:20:13Z

pkg/cli/plugins_test.go

+
+	"sigs.k8s.io/kubebuilder/pkg/plugin"
+)
+


Coud we add here :

Suggested change

func TestPlugin(t *testing.T) {

RegisterFailHandler(Fail)

RunSpecs(t, "Plugin test")

}

The reason is that it makes easier we work with since we can run just this file.

This case is part of the greater CLI suite. I don't see a good reason to separate them right now.

camilamacedo86 · 2020-06-03T18:21:33Z

pkg/cli/plugins_test.go

+		By("resolving foo/v2.0")
+		resolvedPlugins, err = resolvePluginsByKey(plugins, "foo/v2.0")
+		Expect(err).NotTo(HaveOccurred())
+		Expect(makePluginKeySlice(resolvedPlugins...)).To(Equal([]string{"foo.kubebuilder.io/v2.0"}))


The following scenario is not working:

It("should return the correct version when just the name of the plugin is informed", func() { var ( plugins = makePluginsForKeys( "foo.example.com/v1.0", "foo.example.com/v2.0", ) resolvedPlugins []plugin.Base err error ) By("resolving foo.example.com") resolvedPlugins, err = resolvePluginsByKey(plugins, "foo.example.com") Expect(err).NotTo(HaveOccurred()) Expect(makePluginKeySlice(resolvedPlugins...)).To(Equal([]string{"foo.example.com/v2.0"})) })

should we not return the upper version in this case since we are allowing pass just the name?

This key would be ambiguous because there are multiple major versions for key foo.example.com. See this case.

Agreed that it would be a RFE

camilamacedo86 · 2020-06-03T18:23:30Z

pkg/cli/plugins_test.go

+		err             error
+	)
+
+	It("should resolve keys correctly", func() {


I think it would be easier to understand if we have 1 IT for scenario such as:

It("should work when the plugin informed exist", func() { By("resolving foo.example.com/v1.0") resolvedPlugins, err = resolvePluginsByKey(plugins, "foo.example.com/v1.0") Expect(err).NotTo(HaveOccurred()) Expect(makePluginKeySlice(resolvedPlugins...)).To(Equal([]string{"foo.example.com/v1.0"})) })

should work when just the name is informed

should work when short name is informed

etc ...

Using multiple By()'s within an It() is idiomatic, check out the docs.

I am not sure if here, it is so clear as the examples in the doc but ok.

camilamacedo86 · 2020-06-03T18:27:11Z

pkg/cli/plugins_test.go

+		_, err = resolvePluginsByKey(plugins, "foo")
+		Expect(err).To(MatchError(errAmbiguousPlugin{
+			key: "foo",
+			msg: `possible keys: ["foo.example.com/v1.0" "foo.kubebuilder.io/v1.0" "foo.kubebuilder.io/v2.0"]`,


IMO this scenario make is better covered with the currently duplicated issue for plugins.
I mean the plugin/v1.0.0 is duplicated in my POV is a more intuitive error for it.

The plugins known to the CLI are not duplicated, i.e. there is no duplicate key in plugins here. The user-defined key foo is ambiguous because it can match multiple known plugins.

camilamacedo86

/lgtm
/approve

k8s-ci-robot · 2020-06-03T18:59:56Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: camilamacedo86, estroz

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

~~OWNERS~~ [camilamacedo86]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

k8s-ci-robot added do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels May 30, 2020

k8s-ci-robot requested review from joelanford and mengqiy May 30, 2020 01:41

camilamacedo86 reviewed May 30, 2020

View reviewed changes

pkg/cli/cli.go Outdated Show resolved Hide resolved

estroz force-pushed the chore/change-version-semantics branch from 7b2a309 to eb9b0ee Compare May 30, 2020 18:03

k8s-ci-robot added size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. and removed size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels May 30, 2020

estroz force-pushed the chore/change-version-semantics branch 3 times, most recently from d008f68 to 74c039d Compare May 31, 2020 01:43

camilamacedo86 reviewed May 31, 2020

View reviewed changes

pkg/cli/api.go Outdated Show resolved Hide resolved

estroz force-pushed the chore/change-version-semantics branch 3 times, most recently from 9eada89 to a94b488 Compare May 31, 2020 18:07

estroz requested a review from camilamacedo86 May 31, 2020 18:09

estroz force-pushed the chore/change-version-semantics branch 2 times, most recently from 669b702 to 899d142 Compare May 31, 2020 21:43

estroz changed the title ~~[WIP] cli: change plugin name/version semantics~~ pkg/cli: resolve --plugins/layout value by semantic version May 31, 2020

k8s-ci-robot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label May 31, 2020

estroz force-pushed the chore/change-version-semantics branch from 899d142 to 7188ed1 Compare June 1, 2020 06:55

estroz mentioned this pull request Jun 1, 2020

pkg/cli: only allow one default plugin per project version #1542

Merged

camilamacedo86 requested changes Jun 1, 2020

View reviewed changes

pkg/cli/cli_test.go Show resolved Hide resolved

pkg/cli/plugins_test.go Outdated Show resolved Hide resolved

estroz force-pushed the chore/change-version-semantics branch from 7188ed1 to 4a5d821 Compare June 1, 2020 16:21

estroz mentioned this pull request Jun 1, 2020

docs: add/update CLI plugin docs #1539

Closed

k8s-ci-robot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Jun 2, 2020

estroz force-pushed the chore/change-version-semantics branch from 4a5d821 to 1afe32c Compare June 2, 2020 22:09

k8s-ci-robot removed the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Jun 2, 2020

estroz force-pushed the chore/change-version-semantics branch from 1afe32c to cb81777 Compare June 2, 2020 22:12

estroz requested a review from camilamacedo86 June 2, 2020 22:13

camilamacedo86 reviewed Jun 3, 2020

View reviewed changes

camilamacedo86 approved these changes Jun 3, 2020

View reviewed changes

k8s-ci-robot assigned camilamacedo86 Jun 3, 2020

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jun 3, 2020

k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Jun 3, 2020

k8s-ci-robot merged commit 1972f4c into kubernetes-sigs:master Jun 3, 2020

estroz deleted the chore/change-version-semantics branch June 3, 2020 19:06

estroz mentioned this pull request Jun 3, 2020

*: remove plugin minor/patch versions #1547

Merged

camilamacedo86 mentioned this pull request Feb 18, 2021

New Release - proposing 3.0.0 stable #2029

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

pkg/cli: resolve `--plugins`/`layout` value by semantic version #1536

pkg/cli: resolve `--plugins`/`layout` value by semantic version #1536

estroz commented May 30, 2020 •

edited

Loading

camilamacedo86 left a comment •

edited

Loading

camilamacedo86 Jun 3, 2020

estroz Jun 3, 2020

camilamacedo86 Jun 3, 2020

estroz Jun 3, 2020

camilamacedo86 Jun 3, 2020

estroz Jun 3, 2020

camilamacedo86 Jun 3, 2020

camilamacedo86 Jun 3, 2020 •

edited

Loading

estroz Jun 3, 2020

camilamacedo86 Jun 3, 2020

camilamacedo86 Jun 3, 2020

estroz Jun 3, 2020

camilamacedo86 left a comment

k8s-ci-robot commented Jun 3, 2020

		@@ -218,22 +216,32 @@ func (c *cli) initialize() error {
		// layout and --plugins values can be short (ex. "go/v2.0.0") or unversioned

+func TestPlugin(t *testing.T) {
+	RegisterFailHandler(Fail)
+	RunSpecs(t, "Plugin test")
+}

pkg/cli: resolve --plugins/layout value by semantic version #1536

pkg/cli: resolve --plugins/layout value by semantic version #1536

Conversation

estroz commented May 30, 2020 • edited Loading

camilamacedo86 left a comment • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

camilamacedo86 Jun 3, 2020 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

camilamacedo86 left a comment

Choose a reason for hiding this comment

k8s-ci-robot commented Jun 3, 2020

pkg/cli: resolve `--plugins`/`layout` value by semantic version #1536

pkg/cli: resolve `--plugins`/`layout` value by semantic version #1536

estroz commented May 30, 2020 •

edited

Loading

camilamacedo86 left a comment •

edited

Loading

camilamacedo86 Jun 3, 2020 •

edited

Loading