Compare commits

..

1 Commits

Author SHA1 Message Date
Ahmet Alp Balkan
840a9cf003 docs: simplify installation instructions into a single table
Replace repetitive per-package-manager sections with a compact table.
Move completion scripts into a collapsible <details> section.
Simplify manual install to point to the Releases page.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
2026-03-08 17:58:17 -07:00
11 changed files with 62 additions and 91 deletions

View File

@@ -52,14 +52,6 @@ func (op InteractiveSwitchOp) Run(_, stderr io.Writer) error {
return fmt.Errorf("kubeconfig error: %w", err) 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")
}
cmd := exec.Command("fzf", "--ansi", "--no-preview") cmd := exec.Command("fzf", "--ansi", "--no-preview")
var out bytes.Buffer var out bytes.Buffer
cmd.Stdin = os.Stdin cmd.Stdin = os.Stdin

View File

@@ -24,11 +24,11 @@ import (
) )
func kubectxPrevCtxFile() (string, error) { func kubectxPrevCtxFile() (string, error) {
dir := cmdutil.CacheDir() home := cmdutil.HomeDir()
if dir == "" { if home == "" {
return "", errors.New("HOME or USERPROFILE environment variable not set") 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 // readLastContext returns the saved previous context

View File

@@ -73,7 +73,6 @@ func Test_writeLastContext(t *testing.T) {
func Test_kubectxFilePath(t *testing.T) { func Test_kubectxFilePath(t *testing.T) {
t.Setenv("HOME", filepath.FromSlash("/foo/bar")) t.Setenv("HOME", filepath.FromSlash("/foo/bar"))
t.Setenv("XDG_CACHE_HOME", "")
expected := filepath.Join(filepath.FromSlash("/foo/bar"), ".kube", "kubectx") expected := filepath.Join(filepath.FromSlash("/foo/bar"), ".kube", "kubectx")
v, err := kubectxPrevCtxFile() 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) { func Test_kubectxFilePath_error(t *testing.T) {
t.Setenv("HOME", "") t.Setenv("HOME", "")
t.Setenv("USERPROFILE", "") t.Setenv("USERPROFILE", "")

View File

@@ -46,14 +46,6 @@ func (op InteractiveSwitchOp) Run(_, stderr io.Writer) error {
return fmt.Errorf("kubeconfig error: %w", err) 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")
}
cmd := exec.Command("fzf", "--ansi", "--no-preview") cmd := exec.Command("fzf", "--ansi", "--no-preview")
var out bytes.Buffer var out bytes.Buffer
cmd.Stdin = os.Stdin cmd.Stdin = os.Stdin

View File

@@ -24,7 +24,7 @@ import (
"github.com/ahmetb/kubectx/internal/cmdutil" "github.com/ahmetb/kubectx/internal/cmdutil"
) )
var defaultDir = filepath.Join(cmdutil.CacheDir(), "kubens") var defaultDir = filepath.Join(cmdutil.HomeDir(), ".kube", "kubens")
type NSFile struct { type NSFile struct {
dir string dir string

View File

@@ -18,6 +18,8 @@ import (
"runtime" "runtime"
"strings" "strings"
"testing" "testing"
"github.com/ahmetb/kubectx/internal/testutil"
) )
func TestNSFile(t *testing.T) { func TestNSFile(t *testing.T) {
@@ -48,7 +50,7 @@ func TestNSFile(t *testing.T) {
} }
func TestNSFile_path_windows(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() fp := NewNSFile("a:b:c").path()
if expected := "a__b__c"; !strings.HasSuffix(fp, expected) { 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.Fatalf("isWindows() returned true for %s", runtime.GOOS)
} }
t.Setenv("_FORCE_GOOS", "windows") defer testutil.WithEnvVar("_FORCE_GOOS", "windows")()
if !isWindows() { if !isWindows() {
t.Fatalf("isWindows() failed to detect windows with env override.") t.Fatalf("isWindows() failed to detect windows with env override.")
} }

View File

@@ -17,7 +17,6 @@ package cmdutil
import ( import (
"errors" "errors"
"os" "os"
"path/filepath"
) )
func HomeDir() string { func HomeDir() string {
@@ -28,19 +27,6 @@ func HomeDir() string {
return home 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. // IsNotFoundErr determines if the underlying error is os.IsNotExist.
func IsNotFoundErr(err error) bool { func IsNotFoundErr(err error) bool {
for e := err; e != nil; e = errors.Unwrap(e) { for e := err; e != nil; e = errors.Unwrap(e) {

View File

@@ -15,8 +15,9 @@
package cmdutil package cmdutil
import ( import (
"path/filepath"
"testing" "testing"
"github.com/ahmetb/kubectx/internal/testutil"
) )
func Test_homeDir(t *testing.T) { func Test_homeDir(t *testing.T) {
@@ -62,40 +63,18 @@ func Test_homeDir(t *testing.T) {
for _, c := range cases { for _, c := range cases {
t.Run(c.name, func(tt *testing.T) { t.Run(c.name, func(tt *testing.T) {
var unsets []func()
for _, e := range c.envs { for _, e := range c.envs {
tt.Setenv(e.k, e.v) unsets = append(unsets, testutil.WithEnvVar(e.k, e.v))
} }
got := HomeDir() got := HomeDir()
if got != c.want { if got != c.want {
t.Errorf("expected:%q got:%q", c.want, got) 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)
}
})
}

View File

@@ -15,16 +15,17 @@
package kubeconfig package kubeconfig
import ( import (
"github.com/ahmetb/kubectx/internal/cmdutil"
"os" "os"
"path/filepath" "path/filepath"
"strings" "strings"
"testing" "testing"
"github.com/ahmetb/kubectx/internal/cmdutil" "github.com/ahmetb/kubectx/internal/testutil"
) )
func Test_kubeconfigPath(t *testing.T) { 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") expected := filepath.FromSlash("/x/y/z/.kube/config")
got, err := kubeconfigPath() got, err := kubeconfigPath()
@@ -37,9 +38,9 @@ func Test_kubeconfigPath(t *testing.T) {
} }
func Test_kubeconfigPath_noEnvVars(t *testing.T) { func Test_kubeconfigPath_noEnvVars(t *testing.T) {
t.Setenv("XDG_CACHE_HOME", "") defer testutil.WithEnvVar("XDG_CACHE_HOME", "")()
t.Setenv("HOME", "") defer testutil.WithEnvVar("HOME", "")()
t.Setenv("USERPROFILE", "") defer testutil.WithEnvVar("USERPROFILE", "")()
_, err := kubeconfigPath() _, err := kubeconfigPath()
if err == nil { if err == nil {
@@ -48,7 +49,7 @@ func Test_kubeconfigPath_noEnvVars(t *testing.T) {
} }
func Test_kubeconfigPath_envOvveride(t *testing.T) { func Test_kubeconfigPath_envOvveride(t *testing.T) {
t.Setenv("KUBECONFIG", "foo") defer testutil.WithEnvVar("KUBECONFIG", "foo")()
v, err := kubeconfigPath() v, err := kubeconfigPath()
if err != nil { if err != nil {
@@ -61,7 +62,7 @@ func Test_kubeconfigPath_envOvveride(t *testing.T) {
func Test_kubeconfigPath_envOvverideDoesNotSupportPathSeparator(t *testing.T) { func Test_kubeconfigPath_envOvverideDoesNotSupportPathSeparator(t *testing.T) {
path := strings.Join([]string{"file1", "file2"}, string(os.PathListSeparator)) path := strings.Join([]string{"file1", "file2"}, string(os.PathListSeparator))
t.Setenv("KUBECONFIG", path) defer testutil.WithEnvVar("KUBECONFIG", path)()
_, err := kubeconfigPath() _, err := kubeconfigPath()
if err == nil { if err == nil {
@@ -70,7 +71,7 @@ func Test_kubeconfigPath_envOvverideDoesNotSupportPathSeparator(t *testing.T) {
} }
func TestStandardKubeconfigLoader_returnsNotFoundErr(t *testing.T) { func TestStandardKubeconfigLoader_returnsNotFoundErr(t *testing.T) {
t.Setenv("KUBECONFIG", "foo") defer testutil.WithEnvVar("KUBECONFIG", "foo")()
kc := new(Kubeconfig).WithLoader(DefaultLoader) kc := new(Kubeconfig).WithLoader(DefaultLoader)
err := kc.Parse() err := kc.Parse()
if err == nil { if err == nil {

View File

@@ -18,6 +18,8 @@ import (
"testing" "testing"
"github.com/google/go-cmp/cmp" "github.com/google/go-cmp/cmp"
"github.com/ahmetb/kubectx/internal/testutil"
) )
var ( var (
@@ -25,8 +27,8 @@ var (
) )
func Test_useColors_forceColors(t *testing.T) { func Test_useColors_forceColors(t *testing.T) {
t.Setenv("_KUBECTX_FORCE_COLOR", "1") defer testutil.WithEnvVar("_KUBECTX_FORCE_COLOR", "1")()
t.Setenv("NO_COLOR", "1") defer testutil.WithEnvVar("NO_COLOR", "1")()
if v := useColors(); !cmp.Equal(v, &tr) { if v := useColors(); !cmp.Equal(v, &tr) {
t.Fatalf("expected useColors() = true; got = %v", v) 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) { 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) { if v := useColors(); !cmp.Equal(v, &fa) {
t.Fatalf("expected useColors() = false; got = %v", v) 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) { func Test_useColors_default(t *testing.T) {
t.Setenv("NO_COLOR", "") defer testutil.WithEnvVar("NO_COLOR", "")()
t.Setenv("_KUBECTX_FORCE_COLOR", "") defer testutil.WithEnvVar("_KUBECTX_FORCE_COLOR", "")()
if v := useColors(); v != nil { if v := useColors(); v != nil {
t.Fatalf("expected useColors() = nil; got=%v", *v) t.Fatalf("expected useColors() = nil; got=%v", *v)

View 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)
}
}
}