mirror of
https://github.com/ahmetb/kubectx.git
synced 2026-03-10 16:02:14 +00:00
Compare commits
1 Commits
master
...
abalkan/up
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
090ddfe542 |
172
README.md
172
README.md
@@ -72,23 +72,139 @@ names anymore.
|
||||
|
||||
## Installation
|
||||
|
||||
| Package manager | Command |
|
||||
|---|---|
|
||||
| [Homebrew](https://brew.sh/) (macOS & Linux) | `brew install kubectx` |
|
||||
| [MacPorts](https://www.macports.org) (macOS) | `sudo port install kubectx` |
|
||||
| apt (Debian/Ubuntu) | `sudo apt install kubectx` |
|
||||
| pacman (Arch Linux) | `sudo pacman -S kubectx` |
|
||||
| [Chocolatey](https://chocolatey.org/) (Windows) | `choco install kubens kubectx` |
|
||||
| [Scoop](https://scoop.sh/) (Windows) | `scoop bucket add main && scoop install main/kubens main/kubectx` |
|
||||
| [winget](https://learn.microsoft.com/en-us/windows/package-manager/) (Windows) | `winget install --id ahmetb.kubectx && winget install --id ahmetb.kubens` |
|
||||
| [Krew](https://github.com/kubernetes-sigs/krew/) (kubectl plugin) | `kubectl krew install ctx && kubectl krew install ns` |
|
||||
Stable versions of `kubectx` and `kubens` are small bash scripts that you
|
||||
can find in this repository.
|
||||
|
||||
Alternatively, download binaries from the [**Releases page →**](https://github.com/ahmetb/kubectx/releases) and add them to somewhere in your `PATH`.
|
||||
Starting with v0.9.0, `kubectx` and `kubens` **are now rewritten in Go**. They
|
||||
should work the same way (and we'll keep the bash-based implementations around)
|
||||
but the new features will be added to the new Go programs. Please help us test
|
||||
this new Go implementation by downloading the binaries from the [**Releases page
|
||||
→**](https://github.com/ahmetb/kubectx/releases)
|
||||
|
||||
<details>
|
||||
<summary>Shell completion scripts</summary>
|
||||
**Installation options:**
|
||||
|
||||
#### zsh (with [antibody](https://getantibody.github.io))
|
||||
- [as kubectl plugins (macOS & Linux)](#kubectl-plugins-macos-and-linux)
|
||||
- [with Homebrew (macOS & Linux)](#homebrew-macos-and-linux)
|
||||
- [with MacPorts (macOS)](#macports-macos)
|
||||
- [with apt (Debian)](#apt-debian)
|
||||
- [with pacman (Arch Linux)](#pacman-arch-linux)
|
||||
- [with Chocolatey (Windows)](#windows-installation-using-chocolatey)
|
||||
- [Windows Installation (using Scoop)](#windows-installation-using-scoop)
|
||||
- [with winget (Windows)](#windows-installation-using-winget)
|
||||
- [manually (macOS & Linux)](#manual-installation-macos-and-linux)
|
||||
|
||||
If you like to add context/namespace information to your shell prompt (`$PS1`),
|
||||
you can try out [kube-ps1].
|
||||
|
||||
[kube-ps1]: https://github.com/jonmosco/kube-ps1
|
||||
|
||||
### Kubectl Plugins (macOS and Linux)
|
||||
|
||||
You can install and use the [Krew](https://github.com/kubernetes-sigs/krew/) kubectl
|
||||
plugin manager to get `kubectx` and `kubens`.
|
||||
|
||||
**Note:** This will not install the shell completion scripts. If you want them,
|
||||
*choose another installation method
|
||||
or install the scripts [manually](#manual-installation-macos-and-linux).
|
||||
|
||||
```sh
|
||||
kubectl krew install ctx
|
||||
kubectl krew install ns
|
||||
```
|
||||
|
||||
After installing, the tools will be available as `kubectl ctx` and `kubectl ns`.
|
||||
|
||||
### Homebrew (macOS and Linux)
|
||||
|
||||
If you use [Homebrew](https://brew.sh/) you can install like this:
|
||||
|
||||
```sh
|
||||
brew install kubectx
|
||||
```
|
||||
|
||||
This command will set up bash/zsh/fish completion scripts automatically. Make sure you [configure your shell](https://docs.brew.sh/Shell-Completion) to load completions for installed Homebrew formulas.
|
||||
|
||||
|
||||
### MacPorts (macOS)
|
||||
|
||||
If you use [MacPorts](https://www.macports.org) you can install like this:
|
||||
|
||||
```sh
|
||||
sudo port install kubectx
|
||||
```
|
||||
|
||||
### apt (Debian)
|
||||
|
||||
``` bash
|
||||
sudo apt install kubectx
|
||||
```
|
||||
Newer versions might be available on repos like
|
||||
[Debian Buster (testing)](https://packages.debian.org/buster/kubectx),
|
||||
[Sid (unstable)](https://packages.debian.org/sid/kubectx)
|
||||
(_if you are unfamiliar with the Debian release process and how to enable
|
||||
testing/unstable repos, check out the
|
||||
[Debian Wiki](https://wiki.debian.org/DebianReleases)_):
|
||||
|
||||
|
||||
### pacman (Arch Linux)
|
||||
|
||||
Available as official Arch Linux package. Install it via:
|
||||
|
||||
```bash
|
||||
sudo pacman -S kubectx
|
||||
```
|
||||
|
||||
### Windows Installation (using Chocolatey)
|
||||
|
||||
Available as packages on [Chocolatey](https://chocolatey.org/why-chocolatey)
|
||||
```pwsh
|
||||
choco install kubens kubectx
|
||||
```
|
||||
|
||||
### Windows Installation (using Scoop)
|
||||
|
||||
Available as packages on [Scoop](https://scoop.sh/)
|
||||
```pwsh
|
||||
scoop bucket add main
|
||||
scoop install main/kubens main/kubectx
|
||||
```
|
||||
|
||||
### Windows Installation (using winget)
|
||||
|
||||
Available as packages on [winget](https://learn.microsoft.com/en-us/windows/package-manager/)
|
||||
```pwsh
|
||||
winget install --id ahmetb.kubectx
|
||||
winget install --id ahmetb.kubens
|
||||
```
|
||||
|
||||
### Manual Installation (macOS and Linux)
|
||||
|
||||
Since `kubectx` and `kubens` are written in Bash, you should be able to install
|
||||
them to any POSIX environment that has Bash installed.
|
||||
|
||||
- Download the `kubectx`, and `kubens` scripts.
|
||||
- Either:
|
||||
- save them all to somewhere in your `PATH`,
|
||||
- or save them to a directory, then create symlinks to `kubectx`/`kubens` from
|
||||
somewhere in your `PATH`, like `/usr/local/bin`
|
||||
- Make `kubectx` and `kubens` executable (`chmod +x ...`)
|
||||
|
||||
Example installation steps:
|
||||
|
||||
``` bash
|
||||
sudo git clone https://github.com/ahmetb/kubectx /opt/kubectx
|
||||
sudo ln -s /opt/kubectx/kubectx /usr/local/bin/kubectx
|
||||
sudo ln -s /opt/kubectx/kubens /usr/local/bin/kubens
|
||||
```
|
||||
|
||||
If you also want to have shell completions, pick an installation method for the
|
||||
[completion scripts](completion/) that fits your system best: [`zsh` with
|
||||
`antibody`](#completion-scripts-for-zsh-with-antibody), [plain
|
||||
`zsh`](#completion-scripts-for-plain-zsh),
|
||||
[`bash`](#completion-scripts-for-bash) or
|
||||
[`fish`](#completion-scripts-for-fish).
|
||||
|
||||
#### Completion scripts for `zsh` with [antibody](https://getantibody.github.io)
|
||||
|
||||
Add this line to your [Plugins File](https://getantibody.github.io/usage/) (e.g.
|
||||
`~/.zsh_plugins.txt`):
|
||||
@@ -101,9 +217,9 @@ Depending on your setup, you might or might not need to call `compinit` or
|
||||
`autoload -U compinit && compinit` in your `~/.zshrc` after you load the Plugins
|
||||
file. If you use [oh-my-zsh](https://github.com/ohmyzsh/ohmyzsh), load the
|
||||
completions before you load `oh-my-zsh` because `oh-my-zsh` will call
|
||||
`compinit`.
|
||||
`compinit`.
|
||||
|
||||
#### zsh (plain)
|
||||
#### Completion scripts for plain `zsh`
|
||||
|
||||
The completion scripts have to be in a path that belongs to `$fpath`. Either
|
||||
link or copy them to an existing folder.
|
||||
@@ -128,7 +244,7 @@ depending on the `$fpath` of your zsh installation.
|
||||
|
||||
In case of errors, calling `compaudit` might help.
|
||||
|
||||
#### bash
|
||||
#### Completion scripts for `bash`
|
||||
|
||||
```bash
|
||||
git clone https://github.com/ahmetb/kubectx.git ~/.kubectx
|
||||
@@ -143,7 +259,7 @@ export PATH=~/.kubectx:\$PATH
|
||||
EOF
|
||||
```
|
||||
|
||||
#### fish
|
||||
#### Completion scripts for `fish`
|
||||
|
||||
```fish
|
||||
mkdir -p ~/.config/fish/completions
|
||||
@@ -151,12 +267,6 @@ ln -s /opt/kubectx/completion/kubectx.fish ~/.config/fish/completions/
|
||||
ln -s /opt/kubectx/completion/kubens.fish ~/.config/fish/completions/
|
||||
```
|
||||
|
||||
</details>
|
||||
|
||||
> [!NOTE]
|
||||
> Tip: Show context/namespace in your shell prompt with [oh-my-posh](https://ohmyposh.dev/) or
|
||||
> simply with [kube-ps1](https://github.com/jonmosco/kube-ps1).
|
||||
|
||||
-----
|
||||
|
||||
### Interactive mode
|
||||
@@ -167,12 +277,12 @@ with fuzzy searching, you just need to [install
|
||||
|
||||

|
||||
|
||||
Caveats:
|
||||
- If you have `fzf` installed, but want to opt out of using this feature, set the
|
||||
environment variable `KUBECTX_IGNORE_FZF=1`.
|
||||
- If you want to keep `fzf` interactive mode but need the default behavior of the
|
||||
command, you can do it by piping the output to another command (e.g. `kubectx |
|
||||
cat `).
|
||||
If you have `fzf` installed, but want to opt out of using this feature, set the
|
||||
environment variable `KUBECTX_IGNORE_FZF=1`.
|
||||
|
||||
If you want to keep `fzf` interactive mode but need the default behavior of the
|
||||
command, you can do it by piping the output to another command (e.g. `kubectx |
|
||||
cat `).
|
||||
|
||||
-----
|
||||
|
||||
@@ -196,7 +306,7 @@ Colors in the output can be disabled by setting the
|
||||
If you liked `kubectx`, you may like my
|
||||
[`kubectl-aliases`](https://github.com/ahmetb/kubectl-aliases) project, too. I
|
||||
recommend pairing kubectx and kubens with [fzf](#interactive-mode) and
|
||||
[kube-ps1](https://github.com/jonmosco/kube-ps1).
|
||||
[kube-ps1].
|
||||
|
||||
#### Stargazers over time
|
||||
|
||||
|
||||
@@ -35,14 +35,12 @@ func (_op CurrentOp) Run(stdout, _ io.Writer) error {
|
||||
return fmt.Errorf("kubeconfig error: %w", err)
|
||||
}
|
||||
|
||||
v, err := kc.GetCurrentContext()
|
||||
if err != nil {
|
||||
return fmt.Errorf("failed to get current context: %w", err)
|
||||
}
|
||||
v := kc.GetCurrentContext()
|
||||
if v == "" {
|
||||
return errors.New("current-context is not set")
|
||||
}
|
||||
if _, err := fmt.Fprintln(stdout, v); err != nil {
|
||||
_, err := fmt.Fprintln(stdout, v)
|
||||
if err != nil {
|
||||
return fmt.Errorf("write error: %w", err)
|
||||
}
|
||||
return nil
|
||||
|
||||
@@ -44,7 +44,7 @@ func (op DeleteOp) Run(_, stderr io.Writer) error {
|
||||
selfName())
|
||||
}
|
||||
|
||||
_ = printer.Success(stderr, `Deleted context %s.`, printer.SuccessColor.Sprint(deletedName))
|
||||
printer.Success(stderr, `Deleted context %s.`, printer.SuccessColor.Sprint(deletedName))
|
||||
}
|
||||
return nil
|
||||
}
|
||||
@@ -58,10 +58,7 @@ func deleteContext(name string) (deleteName string, wasActiveContext bool, err e
|
||||
return deleteName, false, fmt.Errorf("kubeconfig error: %w", err)
|
||||
}
|
||||
|
||||
cur, err := kc.GetCurrentContext()
|
||||
if err != nil {
|
||||
return deleteName, false, fmt.Errorf("failed to get current context: %w", err)
|
||||
}
|
||||
cur := kc.GetCurrentContext()
|
||||
// resolve "." to a real name
|
||||
if name == "." {
|
||||
if cur == "" {
|
||||
@@ -71,11 +68,7 @@ func deleteContext(name string) (deleteName string, wasActiveContext bool, err e
|
||||
name = cur
|
||||
}
|
||||
|
||||
exists, err := kc.ContextExists(name)
|
||||
if err != nil {
|
||||
return name, false, fmt.Errorf("failed to check context: %w", err)
|
||||
}
|
||||
if !exists {
|
||||
if !kc.ContextExists(name) {
|
||||
return name, false, errors.New("context does not exist")
|
||||
}
|
||||
|
||||
|
||||
@@ -43,7 +43,6 @@ func (op InteractiveSwitchOp) Run(_, stderr io.Writer) error {
|
||||
}
|
||||
// parse kubeconfig just to see if it can be loaded
|
||||
kc := new(kubeconfig.Kubeconfig).WithLoader(kubeconfig.DefaultLoader)
|
||||
defer kc.Close()
|
||||
if err := kc.Parse(); err != nil {
|
||||
if cmdutil.IsNotFoundErr(err) {
|
||||
printer.Warning(stderr, "kubeconfig file not found")
|
||||
@@ -51,14 +50,7 @@ func (op InteractiveSwitchOp) Run(_, stderr io.Writer) error {
|
||||
}
|
||||
return fmt.Errorf("kubeconfig error: %w", err)
|
||||
}
|
||||
|
||||
ctxNames, err := kc.ContextNames()
|
||||
if err != nil {
|
||||
return fmt.Errorf("failed to get context names: %w", err)
|
||||
}
|
||||
if len(ctxNames) == 0 {
|
||||
return errors.New("no contexts found in the kubeconfig file")
|
||||
}
|
||||
kc.Close()
|
||||
|
||||
cmd := exec.Command("fzf", "--ansi", "--no-preview")
|
||||
var out bytes.Buffer
|
||||
@@ -83,7 +75,7 @@ func (op InteractiveSwitchOp) Run(_, stderr io.Writer) error {
|
||||
if err != nil {
|
||||
return fmt.Errorf("failed to switch context: %w", err)
|
||||
}
|
||||
_ = printer.Success(stderr, "Switched to context \"%s\".", printer.SuccessColor.Sprint(name))
|
||||
printer.Success(stderr, "Switched to context \"%s\".", printer.SuccessColor.Sprint(name))
|
||||
return nil
|
||||
}
|
||||
|
||||
@@ -93,7 +85,6 @@ func (op InteractiveDeleteOp) Run(_, stderr io.Writer) error {
|
||||
}
|
||||
// parse kubeconfig just to see if it can be loaded
|
||||
kc := new(kubeconfig.Kubeconfig).WithLoader(kubeconfig.DefaultLoader)
|
||||
defer kc.Close()
|
||||
if err := kc.Parse(); err != nil {
|
||||
if cmdutil.IsNotFoundErr(err) {
|
||||
printer.Warning(stderr, "kubeconfig file not found")
|
||||
@@ -101,12 +92,9 @@ func (op InteractiveDeleteOp) Run(_, stderr io.Writer) error {
|
||||
}
|
||||
return fmt.Errorf("kubeconfig error: %w", err)
|
||||
}
|
||||
kc.Close()
|
||||
|
||||
ctxNames, err := kc.ContextNames()
|
||||
if err != nil {
|
||||
return fmt.Errorf("failed to get context names: %w", err)
|
||||
}
|
||||
if len(ctxNames) == 0 {
|
||||
if len(kc.ContextNames()) == 0 {
|
||||
return errors.New("no contexts found in config")
|
||||
}
|
||||
|
||||
@@ -141,7 +129,7 @@ func (op InteractiveDeleteOp) Run(_, stderr io.Writer) error {
|
||||
selfName())
|
||||
}
|
||||
|
||||
_ = printer.Success(stderr, `Deleted context %s.`, printer.SuccessColor.Sprint(name))
|
||||
printer.Success(stderr, `Deleted context %s.`, printer.SuccessColor.Sprint(name))
|
||||
|
||||
return nil
|
||||
}
|
||||
|
||||
@@ -19,6 +19,6 @@ func checkIsolatedMode() error {
|
||||
return fmt.Errorf("you are in a locked single-context shell, use 'exit' to leave")
|
||||
}
|
||||
|
||||
cur, _ := kc.GetCurrentContext()
|
||||
cur := kc.GetCurrentContext()
|
||||
return fmt.Errorf("you are in a locked single-context shell (\"%s\"), use 'exit' to leave", cur)
|
||||
}
|
||||
|
||||
@@ -42,16 +42,10 @@ func (_ ListOp) Run(stdout, stderr io.Writer) error {
|
||||
return fmt.Errorf("kubeconfig error: %w", err)
|
||||
}
|
||||
|
||||
ctxs, err := kc.ContextNames()
|
||||
if err != nil {
|
||||
return fmt.Errorf("failed to get context names: %w", err)
|
||||
}
|
||||
ctxs := kc.ContextNames()
|
||||
natsort.Sort(ctxs)
|
||||
|
||||
cur, err := kc.GetCurrentContext()
|
||||
if err != nil {
|
||||
return fmt.Errorf("failed to get current context: %w", err)
|
||||
}
|
||||
cur := kc.GetCurrentContext()
|
||||
for _, c := range ctxs {
|
||||
s := c
|
||||
if c == cur {
|
||||
|
||||
@@ -52,27 +52,16 @@ func (op RenameOp) Run(_, stderr io.Writer) error {
|
||||
return fmt.Errorf("kubeconfig error: %w", err)
|
||||
}
|
||||
|
||||
cur, err := kc.GetCurrentContext()
|
||||
if err != nil {
|
||||
return fmt.Errorf("failed to get current context: %w", err)
|
||||
}
|
||||
cur := kc.GetCurrentContext()
|
||||
if op.Old == "." {
|
||||
op.Old = cur
|
||||
}
|
||||
|
||||
oldExists, err := kc.ContextExists(op.Old)
|
||||
if err != nil {
|
||||
return fmt.Errorf("failed to check context: %w", err)
|
||||
}
|
||||
if !oldExists {
|
||||
if !kc.ContextExists(op.Old) {
|
||||
return fmt.Errorf("context \"%s\" not found, can't rename it", op.Old)
|
||||
}
|
||||
|
||||
newExists, err := kc.ContextExists(op.New)
|
||||
if err != nil {
|
||||
return fmt.Errorf("failed to check context: %w", err)
|
||||
}
|
||||
if newExists {
|
||||
if kc.ContextExists(op.New) {
|
||||
printer.Warning(stderr, "context \"%s\" exists, overwriting it.", op.New)
|
||||
if err := kc.DeleteContextEntry(op.New); err != nil {
|
||||
return fmt.Errorf("failed to delete new context to overwrite it: %w", err)
|
||||
@@ -90,7 +79,7 @@ func (op RenameOp) Run(_, stderr io.Writer) error {
|
||||
if err := kc.Save(); err != nil {
|
||||
return fmt.Errorf("failed to save modified kubeconfig: %w", err)
|
||||
}
|
||||
_ = printer.Success(stderr, "Context %s renamed to %s.",
|
||||
printer.Success(stderr, "Context %s renamed to %s.",
|
||||
printer.SuccessColor.Sprint(op.Old),
|
||||
printer.SuccessColor.Sprint(op.New))
|
||||
return nil
|
||||
|
||||
@@ -35,17 +35,10 @@ func (op ShellOp) Run(_, stderr io.Writer) error {
|
||||
if err := kc.Parse(); err != nil {
|
||||
return fmt.Errorf("kubeconfig error: %w", err)
|
||||
}
|
||||
exists, err := kc.ContextExists(op.Target)
|
||||
if err != nil {
|
||||
return fmt.Errorf("failed to check context: %w", err)
|
||||
}
|
||||
if !exists {
|
||||
if !kc.ContextExists(op.Target) {
|
||||
return fmt.Errorf("no context exists with the name: \"%s\"", op.Target)
|
||||
}
|
||||
previousCtx, err := kc.GetCurrentContext()
|
||||
if err != nil {
|
||||
return fmt.Errorf("failed to get current context: %w", err)
|
||||
}
|
||||
previousCtx := kc.GetCurrentContext()
|
||||
|
||||
// Extract minimal kubeconfig using kubectl
|
||||
data, err := extractMinimalKubeconfig(kubectlPath, op.Target)
|
||||
|
||||
@@ -24,11 +24,11 @@ import (
|
||||
)
|
||||
|
||||
func kubectxPrevCtxFile() (string, error) {
|
||||
dir := cmdutil.CacheDir()
|
||||
if dir == "" {
|
||||
home := cmdutil.HomeDir()
|
||||
if home == "" {
|
||||
return "", errors.New("HOME or USERPROFILE environment variable not set")
|
||||
}
|
||||
return filepath.Join(dir, "kubectx"), nil
|
||||
return filepath.Join(home, ".kube", "kubectx"), nil
|
||||
}
|
||||
|
||||
// readLastContext returns the saved previous context
|
||||
|
||||
@@ -73,7 +73,6 @@ func Test_writeLastContext(t *testing.T) {
|
||||
|
||||
func Test_kubectxFilePath(t *testing.T) {
|
||||
t.Setenv("HOME", filepath.FromSlash("/foo/bar"))
|
||||
t.Setenv("XDG_CACHE_HOME", "")
|
||||
|
||||
expected := filepath.Join(filepath.FromSlash("/foo/bar"), ".kube", "kubectx")
|
||||
v, err := kubectxPrevCtxFile()
|
||||
@@ -85,19 +84,6 @@ func Test_kubectxFilePath(t *testing.T) {
|
||||
}
|
||||
}
|
||||
|
||||
func Test_kubectxFilePath_xdgCacheHome(t *testing.T) {
|
||||
t.Setenv("XDG_CACHE_HOME", filepath.FromSlash("/tmp/xdg-cache"))
|
||||
|
||||
expected := filepath.Join(filepath.FromSlash("/tmp/xdg-cache"), "kubectx")
|
||||
v, err := kubectxPrevCtxFile()
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
if v != expected {
|
||||
t.Fatalf("expected=\"%s\" got=\"%s\"", expected, v)
|
||||
}
|
||||
}
|
||||
|
||||
func Test_kubectxFilePath_error(t *testing.T) {
|
||||
t.Setenv("HOME", "")
|
||||
t.Setenv("USERPROFILE", "")
|
||||
|
||||
@@ -61,15 +61,8 @@ func switchContext(name string) (string, error) {
|
||||
return "", fmt.Errorf("kubeconfig error: %w", err)
|
||||
}
|
||||
|
||||
prev, err := kc.GetCurrentContext()
|
||||
if err != nil {
|
||||
return "", fmt.Errorf("failed to get current context: %w", err)
|
||||
}
|
||||
exists, err := kc.ContextExists(name)
|
||||
if err != nil {
|
||||
return "", fmt.Errorf("failed to check context: %w", err)
|
||||
}
|
||||
if !exists {
|
||||
prev := kc.GetCurrentContext()
|
||||
if !kc.ContextExists(name) {
|
||||
return "", fmt.Errorf("no context exists with the name: \"%s\"", name)
|
||||
}
|
||||
if err := kc.ModifyCurrentContext(name); err != nil {
|
||||
|
||||
@@ -31,10 +31,7 @@ func (c CurrentOp) Run(stdout, _ io.Writer) error {
|
||||
return fmt.Errorf("kubeconfig error: %w", err)
|
||||
}
|
||||
|
||||
ctx, err := kc.GetCurrentContext()
|
||||
if err != nil {
|
||||
return fmt.Errorf("failed to get current context: %w", err)
|
||||
}
|
||||
ctx := kc.GetCurrentContext()
|
||||
if ctx == "" {
|
||||
return errors.New("current-context is not set")
|
||||
}
|
||||
|
||||
@@ -37,7 +37,6 @@ type InteractiveSwitchOp struct {
|
||||
func (op InteractiveSwitchOp) Run(_, stderr io.Writer) error {
|
||||
// parse kubeconfig just to see if it can be loaded
|
||||
kc := new(kubeconfig.Kubeconfig).WithLoader(kubeconfig.DefaultLoader)
|
||||
defer kc.Close()
|
||||
if err := kc.Parse(); err != nil {
|
||||
if cmdutil.IsNotFoundErr(err) {
|
||||
printer.Warning(stderr, "kubeconfig file not found")
|
||||
@@ -45,14 +44,7 @@ func (op InteractiveSwitchOp) Run(_, stderr io.Writer) error {
|
||||
}
|
||||
return fmt.Errorf("kubeconfig error: %w", err)
|
||||
}
|
||||
|
||||
ctxNames, err := kc.ContextNames()
|
||||
if err != nil {
|
||||
return fmt.Errorf("failed to get context names: %w", err)
|
||||
}
|
||||
if len(ctxNames) == 0 {
|
||||
return errors.New("no contexts found in the kubeconfig file")
|
||||
}
|
||||
defer kc.Close()
|
||||
|
||||
cmd := exec.Command("fzf", "--ansi", "--no-preview")
|
||||
var out bytes.Buffer
|
||||
@@ -77,6 +69,6 @@ func (op InteractiveSwitchOp) Run(_, stderr io.Writer) error {
|
||||
if err != nil {
|
||||
return fmt.Errorf("failed to switch namespace: %w", err)
|
||||
}
|
||||
_ = printer.Success(stderr, "Active namespace is \"%s\".", printer.SuccessColor.Sprint(name))
|
||||
printer.Success(stderr, "Active namespace is \"%s\".", printer.SuccessColor.Sprint(name))
|
||||
return nil
|
||||
}
|
||||
|
||||
@@ -20,7 +20,6 @@ import (
|
||||
"fmt"
|
||||
"io"
|
||||
"os"
|
||||
"slices"
|
||||
|
||||
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
|
||||
"k8s.io/client-go/kubernetes"
|
||||
@@ -40,10 +39,7 @@ func (op ListOp) Run(stdout, stderr io.Writer) error {
|
||||
return fmt.Errorf("kubeconfig error: %w", err)
|
||||
}
|
||||
|
||||
ctx, err := kc.GetCurrentContext()
|
||||
if err != nil {
|
||||
return fmt.Errorf("failed to get current context: %w", err)
|
||||
}
|
||||
ctx := kc.GetCurrentContext()
|
||||
if ctx == "" {
|
||||
return errors.New("current-context is not set")
|
||||
}
|
||||
@@ -90,7 +86,6 @@ func queryNamespaces(kc *kubeconfig.Kubeconfig) ([]string, error) {
|
||||
return nil, fmt.Errorf("failed to list namespaces from k8s API: %w", err)
|
||||
}
|
||||
next = list.Continue
|
||||
out = slices.Grow(out, len(list.Items))
|
||||
for _, it := range list.Items {
|
||||
out = append(out, it.Name)
|
||||
}
|
||||
|
||||
@@ -24,7 +24,7 @@ import (
|
||||
"github.com/ahmetb/kubectx/internal/cmdutil"
|
||||
)
|
||||
|
||||
var defaultDir = filepath.Join(cmdutil.CacheDir(), "kubens")
|
||||
var defaultDir = filepath.Join(cmdutil.HomeDir(), ".kube", "kubens")
|
||||
|
||||
type NSFile struct {
|
||||
dir string
|
||||
|
||||
@@ -18,6 +18,8 @@ import (
|
||||
"runtime"
|
||||
"strings"
|
||||
"testing"
|
||||
|
||||
"github.com/ahmetb/kubectx/internal/testutil"
|
||||
)
|
||||
|
||||
func TestNSFile(t *testing.T) {
|
||||
@@ -48,7 +50,7 @@ func TestNSFile(t *testing.T) {
|
||||
}
|
||||
|
||||
func TestNSFile_path_windows(t *testing.T) {
|
||||
t.Setenv("_FORCE_GOOS", "windows")
|
||||
defer testutil.WithEnvVar("_FORCE_GOOS", "windows")()
|
||||
fp := NewNSFile("a:b:c").path()
|
||||
|
||||
if expected := "a__b__c"; !strings.HasSuffix(fp, expected) {
|
||||
@@ -66,7 +68,7 @@ func Test_isWindows(t *testing.T) {
|
||||
t.Fatalf("isWindows() returned true for %s", runtime.GOOS)
|
||||
}
|
||||
|
||||
t.Setenv("_FORCE_GOOS", "windows")
|
||||
defer testutil.WithEnvVar("_FORCE_GOOS", "windows")()
|
||||
if !isWindows() {
|
||||
t.Fatalf("isWindows() failed to detect windows with env override.")
|
||||
}
|
||||
|
||||
@@ -49,10 +49,7 @@ func (s SwitchOp) Run(_, stderr io.Writer) error {
|
||||
}
|
||||
|
||||
func switchNamespace(kc *kubeconfig.Kubeconfig, ns string, force bool) (string, error) {
|
||||
ctx, err := kc.GetCurrentContext()
|
||||
if err != nil {
|
||||
return "", fmt.Errorf("failed to get current context: %w", err)
|
||||
}
|
||||
ctx := kc.GetCurrentContext()
|
||||
if ctx == "" {
|
||||
return "", errors.New("current-context is not set")
|
||||
}
|
||||
|
||||
@@ -42,10 +42,7 @@ func (_ UnsetOp) Run(_, stderr io.Writer) error {
|
||||
}
|
||||
|
||||
func clearNamespace(kc *kubeconfig.Kubeconfig) (string, error) {
|
||||
ctx, err := kc.GetCurrentContext()
|
||||
if err != nil {
|
||||
return "", fmt.Errorf("failed to get current context: %w", err)
|
||||
}
|
||||
ctx := kc.GetCurrentContext()
|
||||
ns := "default"
|
||||
if ctx == "" {
|
||||
return "", errors.New("current-context is not set")
|
||||
|
||||
@@ -17,7 +17,6 @@ package cmdutil
|
||||
import (
|
||||
"errors"
|
||||
"os"
|
||||
"path/filepath"
|
||||
)
|
||||
|
||||
func HomeDir() string {
|
||||
@@ -28,19 +27,6 @@ func HomeDir() string {
|
||||
return home
|
||||
}
|
||||
|
||||
// CacheDir returns XDG_CACHE_HOME if set, otherwise $HOME/.kube,
|
||||
// matching the bash scripts' behavior: ${XDG_CACHE_HOME:-$HOME/.kube}.
|
||||
func CacheDir() string {
|
||||
if xdg := os.Getenv("XDG_CACHE_HOME"); xdg != "" {
|
||||
return xdg
|
||||
}
|
||||
home := HomeDir()
|
||||
if home == "" {
|
||||
return ""
|
||||
}
|
||||
return filepath.Join(home, ".kube")
|
||||
}
|
||||
|
||||
// IsNotFoundErr determines if the underlying error is os.IsNotExist.
|
||||
func IsNotFoundErr(err error) bool {
|
||||
for e := err; e != nil; e = errors.Unwrap(e) {
|
||||
|
||||
@@ -15,8 +15,9 @@
|
||||
package cmdutil
|
||||
|
||||
import (
|
||||
"path/filepath"
|
||||
"testing"
|
||||
|
||||
"github.com/ahmetb/kubectx/internal/testutil"
|
||||
)
|
||||
|
||||
func Test_homeDir(t *testing.T) {
|
||||
@@ -62,40 +63,18 @@ func Test_homeDir(t *testing.T) {
|
||||
|
||||
for _, c := range cases {
|
||||
t.Run(c.name, func(tt *testing.T) {
|
||||
var unsets []func()
|
||||
for _, e := range c.envs {
|
||||
tt.Setenv(e.k, e.v)
|
||||
unsets = append(unsets, testutil.WithEnvVar(e.k, e.v))
|
||||
}
|
||||
|
||||
got := HomeDir()
|
||||
if got != c.want {
|
||||
t.Errorf("expected:%q got:%q", c.want, got)
|
||||
}
|
||||
for _, u := range unsets {
|
||||
u()
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
func TestCacheDir(t *testing.T) {
|
||||
t.Run("XDG_CACHE_HOME set", func(t *testing.T) {
|
||||
t.Setenv("XDG_CACHE_HOME", "/tmp/xdg-cache")
|
||||
t.Setenv("HOME", "/home/user")
|
||||
if got := CacheDir(); got != "/tmp/xdg-cache" {
|
||||
t.Errorf("expected:%q got:%q", "/tmp/xdg-cache", got)
|
||||
}
|
||||
})
|
||||
t.Run("XDG_CACHE_HOME unset, falls back to HOME/.kube", func(t *testing.T) {
|
||||
t.Setenv("XDG_CACHE_HOME", "")
|
||||
t.Setenv("HOME", "/home/user")
|
||||
want := filepath.Join("/home/user", ".kube")
|
||||
if got := CacheDir(); got != want {
|
||||
t.Errorf("expected:%q got:%q", want, got)
|
||||
}
|
||||
})
|
||||
t.Run("neither set", func(t *testing.T) {
|
||||
t.Setenv("XDG_CACHE_HOME", "")
|
||||
t.Setenv("HOME", "")
|
||||
t.Setenv("USERPROFILE", "")
|
||||
if got := CacheDir(); got != "" {
|
||||
t.Errorf("expected:%q got:%q", "", got)
|
||||
}
|
||||
})
|
||||
}
|
||||
|
||||
@@ -50,25 +50,18 @@ func (k *Kubeconfig) contextNode(name string) (*yaml.RNode, error) {
|
||||
return context, nil
|
||||
}
|
||||
|
||||
func (k *Kubeconfig) ContextNames() ([]string, error) {
|
||||
func (k *Kubeconfig) ContextNames() []string {
|
||||
contexts, err := k.config.Pipe(yaml.Get("contexts"))
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("failed to get contexts: %w", err)
|
||||
}
|
||||
if contexts == nil {
|
||||
return nil, nil
|
||||
return nil
|
||||
}
|
||||
names, err := contexts.ElementValues("name")
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("failed to get context names: %w", err)
|
||||
return nil
|
||||
}
|
||||
return names, nil
|
||||
return names
|
||||
}
|
||||
|
||||
func (k *Kubeconfig) ContextExists(name string) (bool, error) {
|
||||
names, err := k.ContextNames()
|
||||
if err != nil {
|
||||
return false, err
|
||||
}
|
||||
return slices.Contains(names, name), nil
|
||||
func (k *Kubeconfig) ContextExists(name string) bool {
|
||||
return slices.Contains(k.ContextNames(), name)
|
||||
}
|
||||
|
||||
@@ -33,10 +33,7 @@ func TestKubeconfig_ContextNames(t *testing.T) {
|
||||
t.Fatal(err)
|
||||
}
|
||||
|
||||
ctx, err := kc.ContextNames()
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
ctx := kc.ContextNames()
|
||||
expected := []string{"abc", "def", "ghi"}
|
||||
if diff := cmp.Diff(expected, ctx); diff != "" {
|
||||
t.Fatalf("%s", diff)
|
||||
@@ -49,10 +46,7 @@ func TestKubeconfig_ContextNames_noContextsEntry(t *testing.T) {
|
||||
if err := kc.Parse(); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
ctx, err := kc.ContextNames()
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
ctx := kc.ContextNames()
|
||||
var expected []string = nil
|
||||
if diff := cmp.Diff(expected, ctx); diff != "" {
|
||||
t.Fatalf("%s", diff)
|
||||
@@ -65,9 +59,10 @@ func TestKubeconfig_ContextNames_nonArrayContextsEntry(t *testing.T) {
|
||||
if err := kc.Parse(); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
_, err := kc.ContextNames()
|
||||
if err == nil {
|
||||
t.Fatal("expected error for non-array contexts entry")
|
||||
ctx := kc.ContextNames()
|
||||
var expected []string = nil
|
||||
if diff := cmp.Diff(expected, ctx); diff != "" {
|
||||
t.Fatalf("%s", diff)
|
||||
}
|
||||
}
|
||||
|
||||
@@ -82,15 +77,13 @@ func TestKubeconfig_CheckContextExists(t *testing.T) {
|
||||
t.Fatal(err)
|
||||
}
|
||||
|
||||
if exists, err := kc.ContextExists("c1"); err != nil || !exists {
|
||||
if !kc.ContextExists("c1") {
|
||||
t.Fatal("c1 actually exists; reported false")
|
||||
}
|
||||
if exists, err := kc.ContextExists("c2"); err != nil || !exists {
|
||||
if !kc.ContextExists("c2") {
|
||||
t.Fatal("c2 actually exists; reported false")
|
||||
}
|
||||
if exists, err := kc.ContextExists("c3"); err != nil {
|
||||
t.Fatal(err)
|
||||
} else if exists {
|
||||
if kc.ContextExists("c3") {
|
||||
t.Fatal("c3 does not exist; but reported true")
|
||||
}
|
||||
}
|
||||
|
||||
@@ -15,19 +15,17 @@
|
||||
package kubeconfig
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
|
||||
"sigs.k8s.io/kustomize/kyaml/yaml"
|
||||
)
|
||||
|
||||
// GetCurrentContext returns "current-context" value in given
|
||||
// kubeconfig object Node, or returns ("", nil) if not found.
|
||||
func (k *Kubeconfig) GetCurrentContext() (string, error) {
|
||||
// kubeconfig object Node, or returns "" if not found.
|
||||
func (k *Kubeconfig) GetCurrentContext() string {
|
||||
v, err := k.config.Pipe(yaml.Get("current-context"))
|
||||
if err != nil {
|
||||
return "", fmt.Errorf("failed to read current-context: %w", err)
|
||||
return ""
|
||||
}
|
||||
return yaml.GetValue(v), nil
|
||||
return yaml.GetValue(v)
|
||||
}
|
||||
|
||||
func (k *Kubeconfig) UnsetCurrentContext() error {
|
||||
|
||||
@@ -26,10 +26,7 @@ func TestKubeconfig_GetCurrentContext(t *testing.T) {
|
||||
if err := kc.Parse(); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
v, err := kc.GetCurrentContext()
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
v := kc.GetCurrentContext()
|
||||
|
||||
expected := "foo"
|
||||
if v != expected {
|
||||
@@ -43,10 +40,7 @@ func TestKubeconfig_GetCurrentContext_missingField(t *testing.T) {
|
||||
if err := kc.Parse(); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
v, err := kc.GetCurrentContext()
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
v := kc.GetCurrentContext()
|
||||
|
||||
expected := ""
|
||||
if v != expected {
|
||||
|
||||
@@ -87,8 +87,5 @@ func (k *Kubeconfig) Save() error {
|
||||
}
|
||||
enc := yaml.NewEncoder(k.f)
|
||||
enc.SetIndent(0)
|
||||
if err := enc.Encode(k.config.YNode()); err != nil {
|
||||
return err
|
||||
}
|
||||
return enc.Close()
|
||||
return enc.Encode(k.config.YNode())
|
||||
}
|
||||
|
||||
@@ -15,16 +15,17 @@
|
||||
package kubeconfig
|
||||
|
||||
import (
|
||||
"github.com/ahmetb/kubectx/internal/cmdutil"
|
||||
"os"
|
||||
"path/filepath"
|
||||
"strings"
|
||||
"testing"
|
||||
|
||||
"github.com/ahmetb/kubectx/internal/cmdutil"
|
||||
"github.com/ahmetb/kubectx/internal/testutil"
|
||||
)
|
||||
|
||||
func Test_kubeconfigPath(t *testing.T) {
|
||||
t.Setenv("HOME", "/x/y/z")
|
||||
defer testutil.WithEnvVar("HOME", "/x/y/z")()
|
||||
|
||||
expected := filepath.FromSlash("/x/y/z/.kube/config")
|
||||
got, err := kubeconfigPath()
|
||||
@@ -37,9 +38,9 @@ func Test_kubeconfigPath(t *testing.T) {
|
||||
}
|
||||
|
||||
func Test_kubeconfigPath_noEnvVars(t *testing.T) {
|
||||
t.Setenv("XDG_CACHE_HOME", "")
|
||||
t.Setenv("HOME", "")
|
||||
t.Setenv("USERPROFILE", "")
|
||||
defer testutil.WithEnvVar("XDG_CACHE_HOME", "")()
|
||||
defer testutil.WithEnvVar("HOME", "")()
|
||||
defer testutil.WithEnvVar("USERPROFILE", "")()
|
||||
|
||||
_, err := kubeconfigPath()
|
||||
if err == nil {
|
||||
@@ -48,7 +49,7 @@ func Test_kubeconfigPath_noEnvVars(t *testing.T) {
|
||||
}
|
||||
|
||||
func Test_kubeconfigPath_envOvveride(t *testing.T) {
|
||||
t.Setenv("KUBECONFIG", "foo")
|
||||
defer testutil.WithEnvVar("KUBECONFIG", "foo")()
|
||||
|
||||
v, err := kubeconfigPath()
|
||||
if err != nil {
|
||||
@@ -61,7 +62,7 @@ func Test_kubeconfigPath_envOvveride(t *testing.T) {
|
||||
|
||||
func Test_kubeconfigPath_envOvverideDoesNotSupportPathSeparator(t *testing.T) {
|
||||
path := strings.Join([]string{"file1", "file2"}, string(os.PathListSeparator))
|
||||
t.Setenv("KUBECONFIG", path)
|
||||
defer testutil.WithEnvVar("KUBECONFIG", path)()
|
||||
|
||||
_, err := kubeconfigPath()
|
||||
if err == nil {
|
||||
@@ -70,7 +71,7 @@ func Test_kubeconfigPath_envOvverideDoesNotSupportPathSeparator(t *testing.T) {
|
||||
}
|
||||
|
||||
func TestStandardKubeconfigLoader_returnsNotFoundErr(t *testing.T) {
|
||||
t.Setenv("KUBECONFIG", "foo")
|
||||
defer testutil.WithEnvVar("KUBECONFIG", "foo")()
|
||||
kc := new(Kubeconfig).WithLoader(DefaultLoader)
|
||||
err := kc.Parse()
|
||||
if err == nil {
|
||||
|
||||
@@ -18,6 +18,8 @@ import (
|
||||
"testing"
|
||||
|
||||
"github.com/google/go-cmp/cmp"
|
||||
|
||||
"github.com/ahmetb/kubectx/internal/testutil"
|
||||
)
|
||||
|
||||
var (
|
||||
@@ -25,8 +27,8 @@ var (
|
||||
)
|
||||
|
||||
func Test_useColors_forceColors(t *testing.T) {
|
||||
t.Setenv("_KUBECTX_FORCE_COLOR", "1")
|
||||
t.Setenv("NO_COLOR", "1")
|
||||
defer testutil.WithEnvVar("_KUBECTX_FORCE_COLOR", "1")()
|
||||
defer testutil.WithEnvVar("NO_COLOR", "1")()
|
||||
|
||||
if v := useColors(); !cmp.Equal(v, &tr) {
|
||||
t.Fatalf("expected useColors() = true; got = %v", v)
|
||||
@@ -34,7 +36,7 @@ func Test_useColors_forceColors(t *testing.T) {
|
||||
}
|
||||
|
||||
func Test_useColors_disableColors(t *testing.T) {
|
||||
t.Setenv("NO_COLOR", "1")
|
||||
defer testutil.WithEnvVar("NO_COLOR", "1")()
|
||||
|
||||
if v := useColors(); !cmp.Equal(v, &fa) {
|
||||
t.Fatalf("expected useColors() = false; got = %v", v)
|
||||
@@ -42,8 +44,8 @@ func Test_useColors_disableColors(t *testing.T) {
|
||||
}
|
||||
|
||||
func Test_useColors_default(t *testing.T) {
|
||||
t.Setenv("NO_COLOR", "")
|
||||
t.Setenv("_KUBECTX_FORCE_COLOR", "")
|
||||
defer testutil.WithEnvVar("NO_COLOR", "")()
|
||||
defer testutil.WithEnvVar("_KUBECTX_FORCE_COLOR", "")()
|
||||
|
||||
if v := useColors(); v != nil {
|
||||
t.Fatalf("expected useColors() = nil; got=%v", *v)
|
||||
|
||||
31
internal/testutil/testutil.go
Normal file
31
internal/testutil/testutil.go
Normal file
@@ -0,0 +1,31 @@
|
||||
// Copyright 2021 Google LLC
|
||||
//
|
||||
// Licensed under the Apache License, Version 2.0 (the "License");
|
||||
// you may not use this file except in compliance with the License.
|
||||
// You may obtain a copy of the License at
|
||||
//
|
||||
// http://www.apache.org/licenses/LICENSE-2.0
|
||||
//
|
||||
// Unless required by applicable law or agreed to in writing, software
|
||||
// distributed under the License is distributed on an "AS IS" BASIS,
|
||||
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
// See the License for the specific language governing permissions and
|
||||
// limitations under the License.
|
||||
|
||||
package testutil
|
||||
|
||||
import "os"
|
||||
|
||||
// WithEnvVar sets an env var temporarily. Call its return value
|
||||
// in defer to restore original value in env (if exists).
|
||||
func WithEnvVar(key, value string) func() {
|
||||
orig, ok := os.LookupEnv(key)
|
||||
os.Setenv(key, value)
|
||||
return func() {
|
||||
if ok {
|
||||
os.Setenv(key, orig)
|
||||
} else {
|
||||
os.Unsetenv(key)
|
||||
}
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user