Guest24897
/
DockerCLI
mirror of https://github.com/docker/cli.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
DockerCLI/e2e/cli-plugins/testdata/docker-help-helloworld.golden

18 lines
479 B
Plaintext
Raw Normal View History

Integrate CLI plugins with `docker help «foo»` Signed-off-by: Ian Campbell <ijc@docker.com>
2018-12-11 09:52:59 -05:00
Replace tab with spaces in usage output All output of the usage / --help output uses spaces, and having a tab in the output can be somewhat cumbersome (e.g. our YAML docs generator doesn't like them, and copy/pasing the output in iTerm produces a warning). This patch changes the output to use two spaces instead. Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-10-02 09:41:17 -04:00
Usage: docker helloworld [OPTIONS] COMMAND
Integrate CLI plugins with `docker help «foo»` Signed-off-by: Ian Campbell <ijc@docker.com>
2018-12-11 09:52:59 -05:00
A basic Hello World plugin for tests
Ignore unknown arguments on the top-level command. This allows passing argument to plugins, otherwise they are caught by the parse loop, since cobra does not know about each plugin at this stage (to avoid having to always scan for all plugins) this means that e.g. `docker plugin --foo` would accumulate `plugin` as an arg to the `docker` command, then choke on the unknown `--foo`. This allows unknown global args only, unknown arguments on subcommands (e.g. `docker ps --foo`) are still correctly caught. Add an e2e test covering this case. Signed-off-by: Ian Campbell <ijc@docker.com>
2019-01-17 08:38:38 -05:00
Options:
Add e2e tests for plugin vs global argument issues These won't pass right now due to https://github.com/docker/cli/issues/1699 ("Plugins can't re-use the same flags as cli global flags") and the change in 935d47bbe967 ("Ignore unknown arguments on the top-level command."), but the intention is to fix them now. Signed-off-by: Ian Campbell <ijc@docker.com>
2019-03-01 11:03:14 -05:00
-c, --context string Is it Christmas?
-D, --debug Enable debug
e2e/cli-plugins: explicitly check that PersistentPreRunE works I regressed this in d4ced2ef77fc ("allow plugins to have argument which match a top-level flag.") by unconditionally overwriting any `PersistentRunE` that the user may have supplied. We need to ensure two things: 1. That the user can use `PersistentRunE` (or `PersistentRun`) for their own purposes. 2. That our initialisation always runs, even if the user has used `PersistentRun*`, since that will shadow the root. To do this add a `PersistentRunE` to the helloworld plugin which logs (covers 1 above) and then use it when calling the `apiversion` subcommand (which covers 2 since that uses the client) Signed-off-by: Ian Campbell <ijc@docker.com>
2019-03-13 13:50:51 -04:00
--pre-run Log from prerun hook
Add e2e tests for plugin vs global argument issues These won't pass right now due to https://github.com/docker/cli/issues/1699 ("Plugins can't re-use the same flags as cli global flags") and the change in 935d47bbe967 ("Ignore unknown arguments on the top-level command."), but the intention is to fix them now. Signed-off-by: Ian Campbell <ijc@docker.com>
2019-03-01 11:03:14 -05:00
--who string Who are we addressing?
Ignore unknown arguments on the top-level command. This allows passing argument to plugins, otherwise they are caught by the parse loop, since cobra does not know about each plugin at this stage (to avoid having to always scan for all plugins) this means that e.g. `docker plugin --foo` would accumulate `plugin` as an arg to the `docker` command, then choke on the unknown `--foo`. This allows unknown global args only, unknown arguments on subcommands (e.g. `docker ps --foo`) are still correctly caught. Add an e2e test covering this case. Signed-off-by: Ian Campbell <ijc@docker.com>
2019-01-17 08:38:38 -05:00
Integrate CLI plugins with `docker help «foo»` Signed-off-by: Ian Campbell <ijc@docker.com>
2018-12-11 09:52:59 -05:00
Commands:
Allow plugins to make use of the cobra `PersistentPreRun` hooks. Previously a plugin which used these hooks would overwrite the top-level plugin command's use of this hook, resulting in the dockerCli object not being fully initialised. Provide a function which plugins can use to chain to the required behaviour. This required some fairly ugly arrangements to preserve state (which was previously in-scope in `newPluginCOmmand`) to be used by the new function. Signed-off-by: Ian Campbell <ijc@docker.com>
2018-12-17 10:55:38 -05:00
apiversion Print the API version of the server
Fix issue where plugin command error exit code is printed out Signed-off-by: Corey Quon <corey.quon@docker.com>
2019-02-22 12:49:44 -05:00
exitstatus2 Exit with status 2
Integrate CLI plugins with `docker help «foo»` Signed-off-by: Ian Campbell <ijc@docker.com>
2018-12-11 09:52:59 -05:00
goodbye Say Goodbye instead of Hello
Run 'docker helloworld COMMAND --help' for more information on a command.