Deprecation Notice breaks (atleast zsh) completion #3473
Labels
kind/bug
Categorizes issue or PR as related to a bug.
Comments
|
From my (admittedly very cursory) understanding of both kubebuilder's and cobra's source this stems from the fact that the deprecation notice is always printed, regardless of subcommand Line 116 in 3a3d1d9 But instead we should not print it if the subcommand is either
, or https://github.com/spf13/cobra/blob/dcb405a9399ed307eaa0e50f5cb1c290c8979dd4/completions.go#L32 I'll see if I can whip up a PR for this and include the latter two as constants from the dependency rather than magic strings |
|
Please, feel free to push a PR to sorted it out. |
BronzeDeer
added a commit
to BronzeDeer/kubebuilder
that referenced
this issue
Jun 21, 2023
Fixes kubernetes-sigs#3473 Currently, when initializing in a project with deprecated plugins the kubebuilder cli will immediately output a deprecation notice to stdout before even parsing the command. While this is acceptable and even desirable for interactive usage of the cli, it will "randomly" (i.e. dependent on $PWD and not on the command) break automated usage of the kubebuilder output. This, again is fine if kubebuilder makes no guarantees of stable machine readable output, but this does not hold for the completion sub commands which are only ever parsed by machines: The output of "kubebuilder completion <shell>" must always only output the exact script generated by cobra and the cobra internal commands __complete and __completeNoDesc must only only return an exact list of completion options. In deprecated projects this will break shell completion if the shell is started in the directory and if the completion script is correctly initialized, all completion options will be polluted by the massive deprecation notice. This commit instead changes the deprecation notice to output to stderr (while maintaining the return code of the actual command). This fixes the completion usecase which only reads in stdout, and should not break existing integrations, unless there exist scripts which use the length of stderr to check for errors rather than the return code of the call.
BronzeDeer
added a commit
to BronzeDeer/kubebuilder
that referenced
this issue
Jun 21, 2023
Fixes kubernetes-sigs#3473 Currently, when initializing in a project with deprecated plugins the kubebuilder cli will immediately output a deprecation notice to stdout before even parsing the command. While this is acceptable and even desirable for interactive usage of the cli, it will "randomly" (i.e. dependent on $PWD and not on the command) break automated usage of the kubebuilder output. This, again is fine if kubebuilder makes no guarantees of stable machine readable output, but this does not hold for the completion sub commands which are only ever parsed by machines: The output of "kubebuilder completion <shell>" must always only output the exact script generated by cobra and the cobra internal commands __complete and __completeNoDesc must only only return an exact list of completion options. In deprecated projects this will break shell completion if the shell is started in the directory and if the completion script is correctly initialized, all completion options will be polluted by the massive deprecation notice. This commit instead changes the deprecation notice to output to stderr (while maintaining the return code of the actual command). This fixes the completion usecase which only reads in stdout, and should not break existing integrations, unless there exist scripts which use the length of stderr to check for errors rather than the return code of the call. Signed-off-by: Joel Pepper <pepper@bronze-deer.de>
|
FYI $ source <(kubebuilder completion bash)
-bash: /dev/fd/63: line 1: syntax error near unexpected token `('
-bash: /dev/fd/63: line 1: `[Deprecation Notice] This version is deprecated.The `go/v3` cannot scaffold projects using kustomize versions v4x+ and cannot fully support Kubernetes 1.25+.It is recommended to upgrade your project to the latest versions available (go/v4).Please, check the migration guide to learn how to upgrade your project' |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
What broke? What's expected?
When generating the completion script or accessing auto complete functionality while inside a directory with a deprecated project the deprecation notice is generated on standard out and therefore interfers with the normal evaluation. Since the deprecation notice is not valid script syntax the completion script cannot be evaluated and even if loaded correctly, the deprecation notice will intermingle with the correct suggestions in deprecated paths
The error occurs if the completion script is sourced at shell-init and the shell is launched in a deprecated project (for example when opening a terminal from an IDE while working on such a project. A mitigation (cd / &&) can be used to always make the completion initialize cleanly (assuming the user didn't check out a deprecated project into root), this wholly unexpected and not a pattern that users ever need to follow with similar projects, where
source <($BIN completion $SHELL)works cleanly. Furthermore there seems to be no mitigation for the completion results, requiring a fix in the cli itselfReproducing this issue
KubeBuilder (CLI) Version
Version: main.version{KubeBuilderVersion:"3.10.0", KubernetesVendor:"1.26.1", GitCommit:"0fa57405d4a892efceec3c5a902f634277e30732", BuildDate:"2023-04-15T08:10:35Z", GoOs:"linux", GoArch:"amd64"}
PROJECT version
3
Plugin versions
Other versions
Extra Labels
No response
The text was updated successfully, but these errors were encountered: