[WIP] cli-plugins: look for plugins in experimental folder when experimental is enabled #1902

tiborvass · 2019-05-22T23:48:24Z

This is an alternative to #1898

Related to docker/docker-ce-packaging#332

This patch expands the cli plugin search paths by adding -experimental to each,
only if the CLI has experimental mode enabled.

To test that experimental plugins do not work by default:

$ ln -s plugins-linux-amd64 build/plugins-linux-amd64-experimental
$ vim ~/.config/docker.json # add $(pwd)/build/plugins-linux-amd64 to "cliPluginsExtraDirs"
$ make plugins
$ make binary
$ docker helloworld

To show it enabled:

DOCKER_CLI_EXPERIMENTAL=enabled docker helloworld

Signed-off-by: Tibor Vass tibor@docker.com

codecov-io · 2019-05-23T01:02:26Z

Codecov Report

Merging #1902 into master will decrease coverage by 0.02%.
The diff coverage is 32.35%.

@@            Coverage Diff             @@
##           master    #1902      +/-   ##
==========================================
- Coverage   56.75%   56.73%   -0.03%     
==========================================
  Files         309      309              
  Lines       21680    21701      +21     
==========================================
+ Hits        12305    12311       +6     
- Misses       8476     8489      +13     
- Partials      899      901       +2

andrewhsu

LGTM

ijc · 2019-05-23T08:58:35Z

cli-plugins/manager/manager.go

+		dirs := make([]string, len(pluginDirs), len(pluginDirs)*2)
+		copy(dirs, pluginDirs)
+		for _, dir := range dirs {
+			pluginDirs = append(pluginDirs, dir+"-experimental")


This puts all experimental paths after all non-experimental paths, rather than interleving them, is that as intended?

IOW this is:

~/.docker/cli-plugins /usr/local/lib/docker/cli-plugins /usr/lib/docker/cli-plugins ~/.docker/cli-plugins-experimental /usr/local/lib/docker/cli-plugins-experimental /usr/lib/docker/cli-plugins-experimental

and not

~/.docker/cli-plugins ~/.docker/cli-plugins-experimental /usr/local/lib/docker/cli-plugins /usr/local/lib/docker/cli-plugins-experimental /usr/lib/docker/cli-plugins /usr/lib/docker/cli-plugins-experimental

I think it's deliberate but just wanted to check that the implications had been considered i.e. As a user I cannot now install an experimental update to something shipped in /usr/lib/docker/cli-plugins in my home dir.

Was thinking about this; if someone installs both an "experimental" and "stable" version of a plugin; which one should take precedence?

it should be precisely the first enabled plugin found in the search path, which is why the above distinction on the ordering might matter.

With the current layout I think there is no way to install an experimental version "over" an non-experimental one, other than by pretending it is non-experimental

We could do either, I thought this was not only easier to implement, but also made more sense. But happy to change it.

ijc · 2019-05-23T09:01:56Z

cli-plugins/manager/candidate_test.go

 		}
+		t.Run(tc.name, func(t *testing.T) {
+			fmt.Println("toto", tc.c.Experimental())


left over deubg?

cli-plugins/manager/candidate_test.go

ijc

Code looks ok, I left some minor comments/nits.

I think the stuff about e2e testing from #1902 (comment) applies to this variant applies here too but you were going to do that in a follow up so that's fine.

thaJeztah · 2019-05-23T09:11:24Z

I renamed this "WIP" for now; as there might be things to discuss w.r.t. Docker Desktop integration and some other concerns; lets do so on #1897

…l is enabled This patch expands the cli plugin search paths by adding `-experimental` to each, only if the CLI has experimental mode enabled. To test that experimental plugins do not work by default: ``` $ ln -s plugins-linux-amd64 build/plugins-linux-amd64-experimental $ vim ~/.config/docker.json # add $(pwd)/build/plugins-linux-amd64 to "cliPluginsExtraDirs" $ make plugins $ make binary $ docker helloworld ``` To show it enabled: ``` DOCKER_CLI_EXPERIMENTAL=enabled docker helloworld ``` Signed-off-by: Tibor Vass <tibor@docker.com>

Signed-off-by: Tibor Vass <tibor@docker.com>

tiborvass · 2019-05-23T13:11:21Z

@ijc Updated with fixes.

tiborvass · 2019-05-23T13:24:07Z

I can't retrigger validate, but validate passed locally for me.

thaJeztah · 2019-05-23T13:33:53Z

restarted CI (you can restart after connecting GitHub in the user-settings in CircleCI)

thaJeztah · 2019-05-23T19:25:59Z

closing as #1898 was merged

tiborvass · 2019-05-23T20:50:35Z

I'm reopening because I thought this was still desired.

ijc · 2019-05-24T08:54:23Z

I'm reopening because I thought this was still desired.

Yeah, I was about to say I don't think the two approaches need to be mutually exclusive...

thaJeztah · 2021-07-20T18:05:52Z

Closing this one as #2774 enabled experimental features by default, and #2773 deprecated the associated options

GordonTheTurtle added the status/0-triage label May 22, 2019

tiborvass mentioned this pull request May 23, 2019

[WIP] Support for experimental plugins in packaging docker/docker-ce-packaging#332

Closed

tiborvass force-pushed the plugin_experimental2 branch from 849209a to ca44e4b Compare May 23, 2019 01:02

tiborvass mentioned this pull request May 23, 2019

cli-plugins: add concept of experimental plugin, only enabled in experimental mode #1898

Merged

andrewhsu approved these changes May 23, 2019

View reviewed changes

ijc reviewed May 23, 2019

View reviewed changes

cli-plugins/manager/candidate_test.go Show resolved Hide resolved

ijc reviewed May 23, 2019

View reviewed changes

thaJeztah changed the title ~~cli-plugins: look for plugins in experimental folder when experimental is enabled~~ [WIP] cli-plugins: look for plugins in experimental folder when experimental is enabled May 23, 2019

Tibor Vass added 2 commits May 23, 2019 13:00

cli-plugins: add test names for easier debugging

e39aa2d

Signed-off-by: Tibor Vass <tibor@docker.com>

tiborvass force-pushed the plugin_experimental2 branch from ca44e4b to e39aa2d Compare May 23, 2019 13:11

tonistiigi approved these changes May 23, 2019

View reviewed changes

thaJeztah closed this May 23, 2019

tiborvass reopened this May 23, 2019

hc0503 approved these changes Nov 6, 2020

View reviewed changes

thaJeztah closed this Jul 20, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[WIP] cli-plugins: look for plugins in experimental folder when experimental is enabled #1902

[WIP] cli-plugins: look for plugins in experimental folder when experimental is enabled #1902

tiborvass commented May 22, 2019 •

edited

Loading

codecov-io commented May 23, 2019 •

edited

Loading

andrewhsu left a comment

ijc May 23, 2019

thaJeztah May 23, 2019

ijc May 23, 2019

tiborvass May 23, 2019

ijc May 23, 2019

ijc left a comment

thaJeztah commented May 23, 2019

tiborvass commented May 23, 2019

tiborvass commented May 23, 2019

thaJeztah commented May 23, 2019

thaJeztah commented May 23, 2019

tiborvass commented May 23, 2019

ijc commented May 24, 2019

thaJeztah commented Jul 20, 2021

[WIP] cli-plugins: look for plugins in experimental folder when experimental is enabled #1902

[WIP] cli-plugins: look for plugins in experimental folder when experimental is enabled #1902

Conversation

tiborvass commented May 22, 2019 • edited Loading

codecov-io commented May 23, 2019 • edited Loading

Codecov Report

andrewhsu left a comment

Choose a reason for hiding this comment

ijc May 23, 2019

Choose a reason for hiding this comment

thaJeztah May 23, 2019

Choose a reason for hiding this comment

ijc May 23, 2019

Choose a reason for hiding this comment

tiborvass May 23, 2019

Choose a reason for hiding this comment

ijc May 23, 2019

Choose a reason for hiding this comment

ijc left a comment

Choose a reason for hiding this comment

thaJeztah commented May 23, 2019

tiborvass commented May 23, 2019

tiborvass commented May 23, 2019

thaJeztah commented May 23, 2019

thaJeztah commented May 23, 2019

tiborvass commented May 23, 2019

ijc commented May 24, 2019

thaJeztah commented Jul 20, 2021

tiborvass commented May 22, 2019 •

edited

Loading

codecov-io commented May 23, 2019 •

edited

Loading