Skip to content

Modern Docker Management, Designed for Everyone

refactor(cli): store auth config in a seperate auth.json file (#4379)

Kyle Mendell517cd55c3b4c
diff --git a/cli/go.mod b/cli/go.mod
index 4e99e5649..390ce55c7 100644
--- a/cli/go.mod
+++ b/cli/go.mod
@@ -16,6 +16,7 @@ require (
github.com/creack/pty v1.1.24
github.com/docker/go-units v0.5.0
github.com/getarcaneapp/arcane/types/v2 v2.14.0
+ github.com/gofrs/flock v0.13.1
github.com/mattn/go-runewidth v0.0.31
github.com/muesli/cancelreader v0.2.2
github.com/samber/hot v0.13.1
diff --git a/cli/go.sum b/cli/go.sum
index e7f146250..0b0365ce8 100644
--- a/cli/go.sum
+++ b/cli/go.sum
@@ -70,6 +70,8 @@ github.com/go-logr/stdr v1.2.2 h1:hSWxHoqTgW2S2qGc0LTAI563KZ5YKYRhT3MFKZMbjag=
github.com/go-logr/stdr v1.2.2/go.mod h1:mMo/vtBO5dYbehREoey6XUKy/eSumjCCveDpRre4VKE=
github.com/go-viper/mapstructure/v2 v2.5.0 h1:vM5IJoUAy3d7zRSVtIwQgBj7BiWtMPfmPEgAXnvj1Ro=
github.com/go-viper/mapstructure/v2 v2.5.0/go.mod h1:oJDH3BJKyqBA2TXFhDsKDGDTlndYOZ6rGS0BRZIxGhM=
+github.com/gofrs/flock v0.13.1 h1:jjREztyBeSKBZYAC+mgc1laB+xsgy4kYMf3FbKF2UBo=
+github.com/gofrs/flock v0.13.1/go.mod h1:sf4BFiHwnvgxa25DlQoDqXQnwRMEOwqxRq37P6MzzmE=
github.com/golang/groupcache v0.0.0-20210331224755-41bb18bfe9da/go.mod h1:cIg4eruTrX1D+g88fzRXU5OdNfaM+9IcxsU14FzY7Hc=
github.com/golang/groupcache v0.0.0-20241129210726-2c02b8208cf8 h1:f+oWsMOmNPc8JmEHVZIycC7hBoQxHH9pNKQORJNozsQ=
github.com/golang/groupcache v0.0.0-20241129210726-2c02b8208cf8/go.mod h1:wcDNUvekVysuuOpQKo3191zZyTpiI6se1N1ULghS0sw=
diff --git a/cli/internal/client/client.go b/cli/internal/client/client.go
index 92026f272..b3cebc1ae 100644
--- a/cli/internal/client/client.go
+++ b/cli/internal/client/client.go
@@ -456,7 +456,7 @@ func (c *Client) refreshAccessToken(ctx context.Context) error {
cfg.JWTToken = result.Data.Token
cfg.APIKey = ""
cfg.RefreshToken = newRefresh
- if saveErr := config.Save(cfg); saveErr != nil {
+ if saveErr := config.SaveTokens(ctx, cfg); saveErr != nil {
return fmt.Errorf("failed to save refreshed token: %w", saveErr)
}
diff --git a/cli/internal/config/config.go b/cli/internal/config/config.go
index d51bc7f66..43e809857 100644
--- a/cli/internal/config/config.go
+++ b/cli/internal/config/config.go
@@ -1,7 +1,10 @@
-// Package config loads and persists CLI configuration in ~/.config/arcanecli.yml.
+// Package config loads and persists CLI configuration in ~/.config/arcanecli.yml and session tokens in ~/.arcanecli/auth.json.
package config
import (
+ "context"
+ "encoding/json/jsontext"
+ "encoding/json/v2"
"errors"
"fmt"
"os"
@@ -9,10 +12,12 @@ import (
"strings"
"time"
+ "github.com/gofrs/flock"
"github.com/samber/hot"
"go.getarcane.app/acfs/atomic"
"go.yaml.in/yaml/v4"
+ "github.com/getarcaneapp/arcane/cli/v2/internal/output"
"github.com/getarcaneapp/arcane/cli/v2/internal/types"
)
@@ -29,6 +34,12 @@ const (
defaultPaginationInitLimit = 20
)
+// authTokens are the session tokens saved for one server.
+type authTokens struct {
+ AccessToken string `json:"accessToken,omitempty"`
+ RefreshToken string `json:"refreshToken,omitempty"`
+}
+
var customConfigPath string
var configCache = hot.NewHotCache[string, *types.Config](hot.LRU, 4).
@@ -103,18 +114,30 @@ func Load() (*types.Config, error) {
return cfg, nil
}
+ cfg := DefaultConfig()
data, err := os.ReadFile(path)
- if err != nil {
- if os.IsNotExist(err) {
- def := DefaultConfig()
- configCache.Set(path, def)
- return def, nil
+ switch {
+ case err == nil:
+ if parseErr := yaml.Unmarshal(data, cfg); parseErr != nil {
+ return nil, fmt.Errorf("failed to parse config file: %w", parseErr)
}
+ case !os.IsNotExist(err):
return nil, fmt.Errorf("failed to read config file: %w", err)
}
- cfg := DefaultConfig()
- if parseErr := yaml.Unmarshal(data, cfg); parseErr != nil {
- return nil, fmt.Errorf("failed to parse config file: %w", parseErr)
+ // API key configs ignore saved sessions so they keep authenticating as the key.
+ if cfg.APIKey == "" {
+ auth, authErr := loadAuth()
+ tokens, saved := auth[authKey(cfg.ServerURL)]
+ switch {
+ case authErr != nil:
+ output.Warning("Ignoring saved sessions: %v", authErr)
+ case saved:
+ cfg.JWTToken, cfg.RefreshToken = tokens.AccessToken, tokens.RefreshToken
+ case cfg.JWTToken != "" || cfg.RefreshToken != "":
+ // TODO(v3): remove the jwt_token and refresh_token config fallback.
+ output.Warning("jwt_token and refresh_token in %s are deprecated and stop working in v3. "+
+ "Run `arcane-cli auth refresh` to move the session to ~/.arcanecli/auth.json.", path)
+ }
}
normalized := cfg.Clone()
if normalized.Pagination.Resources == nil {
@@ -126,8 +149,11 @@ func Load() (*types.Config, error) {
return normalized, nil
}
-// Save writes configuration with mode 0600, creating its directory when needed.
-func Save(c *types.Config) error {
+// Save writes settings with mode 0600 without changing saved sessions.
+func Save(ctx context.Context, c *types.Config) error {
+ if err := ctx.Err(); err != nil {
+ return err
+ }
path, err := ConfigPath()
if err != nil {
return err
@@ -146,15 +172,38 @@ func Save(c *types.Config) error {
}
}
+ cfg.JWTToken, cfg.RefreshToken = "", ""
+ // Preserve existing legacy credentials on settings saves; explicit token saves remove them.
+ if c != nil && c.APIKey == "" && (c.JWTToken != "" || c.RefreshToken != "") {
+ data, readErr := os.ReadFile(path)
+ if readErr != nil && !os.IsNotExist(readErr) {
+ return fmt.Errorf("failed to read config file: %w", readErr)
+ }
+ if readErr == nil {
+ legacy := DefaultConfig()
+ if parseErr := yaml.Unmarshal(data, legacy); parseErr != nil {
+ return fmt.Errorf("failed to parse config file: %w", parseErr)
+ }
+ if authKey(legacy.ServerURL) == authKey(cfg.ServerURL) {
+ cfg.JWTToken, cfg.RefreshToken = legacy.JWTToken, legacy.RefreshToken
+ }
+ }
+ }
if writeErr := writeConfig(path, cfg, false); writeErr != nil {
return writeErr
}
- configCache.Set(path, cfg)
+ invalidateCache()
return nil
}
+// ClearTokens removes the current server's saved session and clears tokens from the active config.
+func ClearTokens(ctx context.Context, cfg *types.Config) error {
+ cfg.JWTToken, cfg.RefreshToken = "", ""
+ return SaveTokens(ctx, cfg)
+}
+
// InitDefaultFile creates a template with credential placeholders and returns false if the file already exists.
func InitDefaultFile() (bool, error) {
path, err := ConfigPath()
@@ -185,7 +234,7 @@ func InitDefaultFile() (bool, error) {
return false, fmt.Errorf("failed to encode config template: %w", encodeErr)
}
// Show empty authentication fields even though normal saves omit them.
- for _, key := range []string{"api_key", "jwt_token", "refresh_token", "federated_audience"} {
+ for _, key := range []string{"api_key", "federated_audience"} {
template.Content = append(template.Content,
&yaml.Node{Kind: yaml.ScalarNode, Tag: "!!str", Value: key},
&yaml.Node{Kind: yaml.ScalarNode, Tag: "!!str", Value: ""},
@@ -236,24 +285,162 @@ func writeConfig(path string, cfg any, exclusive bool) (err error) {
return nil
}
+// AuthPath returns the session token file, ~/.arcanecli/auth.json.
+func AuthPath() (string, error) {
+ home, err := os.UserHomeDir()
+ if err != nil {
+ return "", fmt.Errorf("failed to get home directory: %w", err)
+ }
+ return filepath.Join(home, ".arcanecli", "auth.json"), nil
+}
+
+// SwitchServer points cfg at serverURL and loads that server's saved session without changing auth.json.
+func SwitchServer(ctx context.Context, cfg *types.Config, serverURL string) error {
+ if err := ctx.Err(); err != nil {
+ return err
+ }
+ if authKey(serverURL) == authKey(cfg.ServerURL) {
+ cfg.ServerURL = serverURL
+ return nil
+ }
+ cfg.ServerURL, cfg.JWTToken, cfg.RefreshToken = serverURL, "", ""
+ if cfg.APIKey != "" {
+ return nil
+ }
+ auth, err := loadAuth()
+ if err != nil {
+ return err
+ }
+ tokens := auth[authKey(serverURL)]
+ cfg.JWTToken, cfg.RefreshToken = tokens.AccessToken, tokens.RefreshToken
+ return nil
+}
+
+func authKey(serverURL string) string {
+ return strings.TrimRight(strings.TrimSpace(serverURL), "/")
+}
+
+func loadAuth() (map[string]authTokens, error) {
+ path, err := AuthPath()
+ if err != nil {
+ return nil, err
+ }
+ auth := make(map[string]authTokens)
+ data, err := os.ReadFile(path)
+ if os.IsNotExist(err) {
+ return auth, nil
+ }
+ if err != nil {
+ return nil, fmt.Errorf("failed to read auth file: %w", err)
+ }
+ if unmarshalErr := json.Unmarshal(data, &auth); unmarshalErr != nil {
+ return nil, fmt.Errorf("failed to parse auth file %s: %w (run `arcane-cli config backup --auth` to set it aside)", path, unmarshalErr)
+ }
+ if auth == nil {
+ auth = make(map[string]authTokens)
+ }
+ return auth, nil
+}
+
+// lockAuth serializes auth.json updates across CLI processes.
+func lockAuth(ctx context.Context) (func() error, error) {
+ path, err := AuthPath()
+ if err != nil {
+ return nil, err
+ }
+ if mkdirErr := os.MkdirAll(filepath.Dir(path), 0o700); mkdirErr != nil {
+ return nil, fmt.Errorf("failed to create auth directory: %w", mkdirErr)
+ }
+ lock := flock.New(path + ".lock")
+ if _, lockErr := lock.TryLockContext(ctx, 100*time.Millisecond); lockErr != nil {
+ return nil, fmt.Errorf("failed to lock auth file: %w", lockErr)
+ }
+ return func() error {
+ if unlockErr := lock.Unlock(); unlockErr != nil {
+ return fmt.Errorf("failed to unlock auth file: %w", unlockErr)
+ }
+ return nil
+ }, nil
+}
+
+// SaveTokens explicitly stores or removes the current server's session before saving its settings.
+func SaveTokens(ctx context.Context, cfg *types.Config) (err error) {
+ unlock, err := lockAuth(ctx)
+ if err != nil {
+ return err
+ }
+ defer func() { err = errors.Join(err, unlock()) }()
+ auth, err := loadAuth()
+ if err != nil {
+ return err
+ }
+ key := authKey(cfg.ServerURL)
+ tokens := authTokens{AccessToken: cfg.JWTToken, RefreshToken: cfg.RefreshToken}
+ if auth[key] != tokens {
+ if tokens == (authTokens{}) {
+ delete(auth, key)
+ } else {
+ auth[key] = tokens
+ }
+ path, pathErr := AuthPath()
+ if pathErr != nil {
+ return pathErr
+ }
+ if len(auth) == 0 {
+ if removeErr := os.Remove(path); removeErr != nil && !os.IsNotExist(removeErr) {
+ return fmt.Errorf("failed to remove auth file: %w", removeErr)
+ }
+ } else {
+ data, marshalErr := json.Marshal(auth, jsontext.WithIndent(" "))
+ if marshalErr != nil {
+ return fmt.Errorf("failed to marshal auth file: %w", marshalErr)
+ }
+ if writeErr := atomic.WriteFile(path, append(data, '\n'), 0o600); writeErr != nil {
+ return fmt.Errorf("failed to write auth file: %w", writeErr)
+ }
+ }
+ }
+ settings := cfg.Clone()
+ settings.JWTToken, settings.RefreshToken = "", ""
+ return Save(ctx, settings)
+}
+
// BackupFile moves the active config to .bak, returning moved=false when no config exists.
func BackupFile() (backupPath string, moved bool, err error) {
path, err := ConfigPath()
if err != nil {
return "", false, err
}
+ return moveToBackup(path, "config")
+}
+
+// BackupAuthFile moves auth.json to .bak so a damaged file stops blocking saves.
+func BackupAuthFile(ctx context.Context) (backupPath string, moved bool, err error) {
+ path, err := AuthPath()
+ if err != nil {
+ return "", false, err
+ }
+ unlock, err := lockAuth(ctx)
+ if err != nil {
+ return "", false, err
+ }
+ defer func() { err = errors.Join(err, unlock()) }()
+ return moveToBackup(path, "auth")
+}
+
+func moveToBackup(path, kind string) (backupPath string, moved bool, err error) {
backupPath = path + ".bak"
info, err := os.Stat(path)
switch {
case err == nil:
if info.IsDir() {
- return "", false, fmt.Errorf("config path is a directory: %s", path)
+ return "", false, fmt.Errorf("%s path is a directory: %s", kind, path)
}
case os.IsNotExist(err):
return backupPath, false, nil
default:
- return "", false, fmt.Errorf("failed to stat config path: %w", err)
+ return "", false, fmt.Errorf("failed to stat %s path: %w", kind, err)
}
if existingBackup, backupErr := os.Stat(backupPath); backupErr == nil {
@@ -269,7 +456,7 @@ func BackupFile() (backupPath string, moved bool, err error) {
}
if backupConfigErr := os.Rename(path, backupPath); backupConfigErr != nil {
- return "", false, fmt.Errorf("failed to move config to backup: %w", backupConfigErr)
+ return "", false, fmt.Errorf("failed to move %s file to backup: %w", kind, backupConfigErr)
}
invalidateCache()
diff --git a/cli/internal/config/config_test.go b/cli/internal/config/config_test.go
index 32cb0c432..7afbddcbc 100644
--- a/cli/internal/config/config_test.go
+++ b/cli/internal/config/config_test.go
@@ -1,9 +1,11 @@
package config
import (
+ "context"
"os"
"path/filepath"
"testing"
+ "time"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
@@ -15,6 +17,9 @@ import (
func setTempConfigPath(t *testing.T) string {
t.Helper()
+ home := t.TempDir()
+ t.Setenv("HOME", home)
+ t.Setenv("USERPROFILE", home)
path := filepath.Join(t.TempDir(), "arcanecli.yml")
{
err := SetConfigPath(path)
@@ -75,8 +80,6 @@ func TestSaveAndLoadRoundTripPagination(t *testing.T) {
cfg := DefaultConfig()
cfg.Previews.AllEnvironments = true
cfg.APIKey = "k_test"
- cfg.JWTToken = "jwt_test"
- cfg.RefreshToken = "refresh_test"
cfg.FederatedAudience = "audience_test"
cfg.CLIUpdateChannel = "next"
cfg.SetDefaultLimit(42)
@@ -87,7 +90,7 @@ func TestSaveAndLoadRoundTripPagination(t *testing.T) {
cfg.Pagination.Resources["volumes"] = types.PaginationResourceConfig{Limit: -1}
{
- err := Save(cfg)
+ err := Save(t.Context(), cfg)
require.NoError(t, err,
"Save() failed: %v", err)
}
@@ -158,8 +161,6 @@ func TestSaveAndLoadRoundTripPagination(t *testing.T) {
"CLIUpdateChannel=%q, want next", loaded.CLIUpdateChannel)
require.True(t, loaded.Previews.AllEnvironments)
require.Equal(t, "k_test", loaded.APIKey)
- require.Equal(t, "jwt_test", loaded.JWTToken)
- require.Equal(t, "refresh_test", loaded.RefreshToken)
require.Equal(t, "audience_test", loaded.FederatedAudience)
require.Equal(t, 8, loaded.LimitFor("gitops-syncs"))
loaded.SetResourceLimit("images", 101)
@@ -168,7 +169,7 @@ func TestSaveAndLoadRoundTripPagination(t *testing.T) {
require.Equal(t, 17, reloaded.LimitFor("images"))
require.NoError(t, os.Chmod(path, 0o644))
- require.NoError(t, Save(&types.Config{
+ require.NoError(t, Save(t.Context(), &types.Config{
ServerURL: "https://short.test",
Pagination: types.PaginationConfig{Default: types.PaginationResourceConfig{Limit: -1}},
}))
@@ -336,7 +337,7 @@ func TestInitDefaultFileCreatesTemplate(t *testing.T) {
require.Contains(t, text, "previews:\n allEnvironments: false")
var values map[string]any
require.NoError(t, yaml.Unmarshal(raw, &values))
- for _, key := range []string{"api_key", "jwt_token", "refresh_token", "federated_audience"} {
+ for _, key := range []string{"api_key", "federated_audience"} {
require.Contains(t, values, key)
require.Empty(t, values[key])
}
@@ -351,8 +352,6 @@ func TestInitDefaultFileCreatesTemplate(t *testing.T) {
requiredKeys := []string{
"server_url:",
"api_key:",
- "jwt_token:",
- "refresh_token:",
"default_environment:",
"log_level:",
"pagination:",
@@ -512,3 +511,138 @@ func TestBackupFileRotatesExistingBak(t *testing.T) {
require.NotEmpty(t, rotated,
"expected rotated backup matching %q", backupPath+".*")
}
+
+func TestAuthTokens(t *testing.T) {
+ path := setTempConfigPath(t)
+ require.NoError(t, os.WriteFile(path, []byte("server_url: https://a.test\njwt_token: legacy_jwt\nrefresh_token: legacy_refresh\n"), 0o600))
+
+ legacy, err := Load()
+ require.NoError(t, err)
+ require.Equal(t, "legacy_jwt", legacy.JWTToken)
+
+ legacy.DefaultEnvironment = "1"
+ require.NoError(t, Save(t.Context(), legacy))
+ loadedLegacy, err := Load()
+ require.NoError(t, err)
+ require.Equal(t, "legacy_jwt", loadedLegacy.JWTToken)
+ require.Equal(t, "legacy_refresh", loadedLegacy.RefreshToken)
+
+ require.NoError(t, SaveTokens(t.Context(), legacy))
+ require.NoError(t, SwitchServer(t.Context(), legacy, "https://b.test/"))
+ require.Empty(t, legacy.JWTToken)
+ require.NoError(t, Save(t.Context(), legacy))
+ raw, err := os.ReadFile(path)
+ require.NoError(t, err)
+ require.NotContains(t, string(raw), "legacy_")
+
+ authPath, err := AuthPath()
+ require.NoError(t, err)
+ info, err := os.Stat(authPath)
+ require.NoError(t, err)
+ require.Equal(t, os.FileMode(0o600), info.Mode().Perm())
+
+ legacy.JWTToken, legacy.RefreshToken = "b_jwt", "b_refresh"
+ require.NoError(t, SaveTokens(t.Context(), legacy))
+ require.NoError(t, SwitchServer(t.Context(), legacy, "https://a.test"))
+ require.Equal(t, "legacy_jwt", legacy.JWTToken)
+ require.Equal(t, "legacy_refresh", legacy.RefreshToken)
+
+ apiKeyConfig := &types.Config{ServerURL: "https://a.test", APIKey: "arc_key"}
+ require.NoError(t, Save(t.Context(), apiKeyConfig))
+ invalidateCache()
+ loaded, err := Load()
+ require.NoError(t, err)
+ require.Equal(t, "arc_key", loaded.APIKey)
+ require.Empty(t, loaded.JWTToken)
+ auth, err := loadAuth()
+ require.NoError(t, err)
+ require.Len(t, auth, 2)
+
+ stale := legacy.Clone()
+ refreshed := legacy.Clone()
+ refreshed.JWTToken, refreshed.RefreshToken = "refreshed_jwt", "refreshed_refresh"
+ require.NoError(t, SaveTokens(t.Context(), refreshed))
+ waitingPath := path + ".waiting"
+ require.NoError(t, SetConfigPath(waitingPath))
+ stale.DefaultEnvironment = "2"
+ require.NoError(t, Save(t.Context(), stale))
+ auth, err = loadAuth()
+ require.NoError(t, err)
+ require.Equal(t, "refreshed_jwt", auth["https://a.test"].AccessToken)
+ require.Equal(t, "refreshed_refresh", auth["https://a.test"].RefreshToken)
+ loaded, err = Load()
+ require.NoError(t, err)
+ require.Equal(t, "refreshed_jwt", loaded.JWTToken)
+ require.Equal(t, "2", loaded.DefaultEnvironment)
+
+ require.NoError(t, SetConfigPath(path))
+ require.NoError(t, ClearTokens(t.Context(), apiKeyConfig))
+ require.Equal(t, "arc_key", apiKeyConfig.APIKey)
+ require.NoError(t, SetConfigPath(waitingPath))
+ require.NoError(t, Save(t.Context(), stale))
+ loaded, err = Load()
+ require.NoError(t, err)
+ require.Empty(t, loaded.JWTToken)
+ require.Empty(t, loaded.RefreshToken)
+ auth, err = loadAuth()
+ require.NoError(t, err)
+ require.NotContains(t, auth, "https://a.test")
+ require.Equal(t, "b_jwt", auth["https://b.test"].AccessToken)
+ require.NoError(t, os.WriteFile(path+".session", []byte("server_url: https://a.test\n"), 0o600))
+ require.NoError(t, SetConfigPath(path+".session"))
+ loaded, err = Load()
+ require.NoError(t, err)
+ require.Empty(t, loaded.JWTToken)
+ require.Empty(t, loaded.RefreshToken)
+ require.NoError(t, SetConfigPath(path))
+
+ for _, serverURL := range []string{"https://a.test", "https://b.test"} {
+ require.NoError(t, ClearTokens(t.Context(), &types.Config{ServerURL: serverURL}))
+ }
+ _, statErr := os.Stat(authPath)
+ require.ErrorIs(t, statErr, os.ErrNotExist)
+
+ require.NoError(t, os.MkdirAll(filepath.Dir(authPath), 0o700))
+ require.NoError(t, os.WriteFile(authPath, []byte("null"), 0o600))
+ require.NoError(t, SaveTokens(t.Context(), &types.Config{ServerURL: "https://a.test", JWTToken: "jwt"}))
+
+ require.NoError(t, os.WriteFile(authPath, []byte("{broken"), 0o600))
+ require.NoError(t, Save(t.Context(), stale))
+ require.ErrorContains(t, SaveTokens(t.Context(), &types.Config{ServerURL: "https://a.test", JWTToken: "jwt"}), "config backup --auth")
+ backupPath, moved, err := BackupAuthFile(t.Context())
+ require.NoError(t, err)
+ require.True(t, moved)
+ require.FileExists(t, backupPath)
+ require.NoError(t, SaveTokens(t.Context(), &types.Config{ServerURL: "https://a.test", JWTToken: "jwt"}))
+
+ before, err := os.ReadFile(authPath)
+ require.NoError(t, err)
+ unlock, err := lockAuth(t.Context())
+ require.NoError(t, err)
+ defer func() { assert.NoError(t, unlock()) }()
+ require.NoError(t, Save(t.Context(), stale))
+ require.NoError(t, SwitchServer(t.Context(), stale, "https://b.test"))
+ for _, operation := range []struct {
+ name string
+ run func(context.Context) error
+ }{
+ {name: "save", run: func(ctx context.Context) error {
+ return SaveTokens(ctx, &types.Config{ServerURL: "https://a.test", JWTToken: "changed"})
+ }},
+ {name: "backup", run: func(ctx context.Context) error {
+ _, _, backupErr := BackupAuthFile(ctx)
+ return backupErr
+ }},
+ {name: "clear tokens", run: func(ctx context.Context) error {
+ return ClearTokens(ctx, &types.Config{ServerURL: "https://a.test", APIKey: "arc_key"})
+ }},
+ } {
+ ctx, cancel := context.WithTimeout(t.Context(), 50*time.Millisecond)
+ operationErr := operation.run(ctx)
+ cancel()
+ require.ErrorIs(t, operationErr, context.DeadlineExceeded, operation.name)
+ }
+ after, err := os.ReadFile(authPath)
+ require.NoError(t, err)
+ require.Equal(t, before, after)
+}
diff --git a/cli/internal/testutil/cli.go b/cli/internal/testutil/cli.go
index e8d284077..6cdf5241c 100644
--- a/cli/internal/testutil/cli.go
+++ b/cli/internal/testutil/cli.go
@@ -22,6 +22,9 @@ func WriteConfig(t *testing.T, serverURL string, preview ...bool) string {
t.Helper()
tempDir := t.TempDir()
+ // Keep commands away from the developer's ~/.arcanecli/auth.json.
+ t.Setenv("HOME", tempDir)
+ t.Setenv("USERPROFILE", tempDir)
configPath := filepath.Join(tempDir, "arcanecli.yml")
configContent := strings.Join([]string{
"server_url: " + serverURL,
diff --git a/cli/internal/types/config.go b/cli/internal/types/config.go
index 6808a836c..e3d227c1e 100644
--- a/cli/internal/types/config.go
+++ b/cli/internal/types/config.go
@@ -89,9 +89,10 @@ type Config struct {
ServerURL string `yaml:"server_url"`
// APIKey is the API key for authentication (sent as X-API-KEY)
APIKey string `yaml:"api_key,omitempty"`
- // JWTToken is the JWT access token for authentication (sent as Authorization: Bearer)
+ // JWTToken is the access token sent as Authorization: Bearer. It is saved in auth.json;
+ // the config file key is only read as a fallback until v3.
JWTToken string `yaml:"jwt_token,omitempty"`
- // RefreshToken is the refresh token for obtaining new access tokens
+ // RefreshToken obtains new access tokens. Saved and read like JWTToken.
RefreshToken string `yaml:"refresh_token,omitempty"`
// Previews contains optional CLI preview features.
Previews PreviewsConfig `yaml:"previews"`
diff --git a/cli/pkg/admin/federatedcredentials/cmd.go b/cli/pkg/admin/federatedcredentials/cmd.go
index 07607aa66..5a915e203 100644
--- a/cli/pkg/admin/federatedcredentials/cmd.go
+++ b/cli/pkg/admin/federatedcredentials/cmd.go
@@ -134,7 +134,8 @@ func newCreateCmd() *cobra.Command {
Path: types.FederatedCredentials(),
FailureMessage: "failed to create federated credential",
Body: federated.CreateFederatedCredential{
- Name: opts.name,
+ Name: opts.name,
+ // TODO(v3): drop the deprecated flag handling.
Enabled: !opts.disabled,
IssuerURL: opts.issuerURL,
Audiences: opts.audiences,
@@ -198,6 +199,7 @@ func newUpdateCmd() *cobra.Command {
Args: cobra.ExactArgs(1),
SilenceUsage: true,
PreRunE: func(cmd *cobra.Command, _ []string) error {
+ // TODO(v3): drop the deprecated flag handling.
return cmdutil.ExclusiveFlags(cmd, "enabled", "disabled")
},
RunE: func(cmd *cobra.Command, args []string) error {
@@ -223,8 +225,9 @@ func newUpdateCmd() *cobra.Command {
Path: types.FederatedCredential(args[0]),
FailureMessage: "failed to update federated credential",
Body: federated.UpdateFederatedCredential{
- Name: kit.Ternary(cmd.Flags().Changed("name"), &opts.name, nil),
- Description: kit.Ternary(cmd.Flags().Changed("description"), &opts.description, nil),
+ Name: kit.Ternary(cmd.Flags().Changed("name"), &opts.name, nil),
+ Description: kit.Ternary(cmd.Flags().Changed("description"), &opts.description, nil),
+ // TODO(v3): drop the deprecated flag handling.
Enabled: kit.Ternary(cmd.Flags().Changed("enabled") || cmd.Flags().Changed("disabled"), new(opts.enabled && !opts.disabled), nil),
IssuerURL: kit.Ternary(cmd.Flags().Changed("issuer-url"), &opts.issuerURL, nil),
Audiences: kit.Ternary(cmd.Flags().Changed("audience"), opts.audiences, nil),
@@ -248,6 +251,7 @@ func newUpdateCmd() *cobra.Command {
command.Flags().StringVar(&opts.description, "description", "", "New description")
command.Flags().BoolVar(&opts.enabled, "enabled", false, "Enable the trust rule")
command.Flags().BoolVar(&opts.disabled, "disabled", false, "Disable the trust rule")
+ // TODO(v3): remove the deprecated --disabled flag.
_ = command.Flags().MarkDeprecated("disabled", "use --enabled=false")
command.Flags().StringVar(&opts.issuerURL, "issuer-url", "", "New issuer URL")
command.Flags().StringArrayVar(&opts.audiences, "audience", nil, "Replace allowed audiences (repeatable)")
diff --git a/cli/pkg/admin/notifications/cmd.go b/cli/pkg/admin/notifications/cmd.go
index 71c86d01a..10ee921fc 100644
--- a/cli/pkg/admin/notifications/cmd.go
+++ b/cli/pkg/admin/notifications/cmd.go
@@ -147,6 +147,7 @@ func newSettingsSetCmd() *cobra.Command {
if cmd.Flags().Changed("enabled") {
req.Enabled = opts.enabled
}
+ // TODO(v3): drop the deprecated flag handling.
if cmd.Flags().Changed("provider-config") || cmd.Flags().Changed("config") {
configFlag := "--config"
if cmd.Flags().Changed("provider-config") {
@@ -197,6 +198,7 @@ func newSettingsSetCmd() *cobra.Command {
command.Flags().BoolVar(&opts.enabled, "enabled", false, "Enable the provider")
command.Flags().StringVar(&opts.config, "provider-config", "", "Provider configuration as a JSON object")
command.Flags().StringVar(&opts.config, "config", "", "Provider configuration as a JSON object")
+ // TODO(v3): remove the deprecated --config flag.
_ = command.Flags().MarkDeprecated("config", "use --provider-config")
command.Flags().StringVar(&opts.file, "file", "", "Path to a JSON file with provider, enabled, and config fields")
return command
diff --git a/cli/pkg/auth/cmd.go b/cli/pkg/auth/cmd.go
index eaccb64bb..03f4e5c6c 100644
--- a/cli/pkg/auth/cmd.go
+++ b/cli/pkg/auth/cmd.go
@@ -103,13 +103,13 @@ func newLoginCmd() *cobra.Command {
cfg.JWTToken = tokenResult.Token
cfg.RefreshToken = tokenResult.RefreshToken
cfg.APIKey = ""
- if saveErr := config.Save(cfg); saveErr != nil {
+ if saveErr := config.SaveTokens(cmd.Context(), cfg); saveErr != nil {
return fmt.Errorf("failed to save token: %w", saveErr)
}
output.Success("Login successful")
- path, _ := config.ConfigPath()
- output.KeyValue("JWT token saved to config", path)
+ path, _ := config.AuthPath()
+ output.KeyValue("Session saved to", path)
return nil
},
}
@@ -137,9 +137,7 @@ func newLogoutCmd() *cobra.Command {
if err != nil {
return fmt.Errorf("failed to load config: %w", err)
}
- cfg.JWTToken = ""
- cfg.RefreshToken = ""
- if saveErr := config.Save(cfg); saveErr != nil {
+ if saveErr := config.ClearTokens(cmd.Context(), cfg); saveErr != nil {
return fmt.Errorf("failed to clear token: %w", saveErr)
}
@@ -268,12 +266,12 @@ func newRefreshCmd() *cobra.Command {
cfg.JWTToken = data.Token
cfg.APIKey = ""
cfg.RefreshToken = cmp.Or(data.RefreshToken, cfg.RefreshToken)
- if saveErr := config.Save(cfg); saveErr != nil {
+ if saveErr := config.SaveTokens(cmd.Context(), cfg); saveErr != nil {
return fmt.Errorf("failed to save token: %w", saveErr)
}
output.Success("Token refreshed successfully")
- path, _ := config.ConfigPath()
- output.KeyValue("New JWT token saved to config", path)
+ path, _ := config.AuthPath()
+ output.KeyValue("Session saved to", path)
return nil
},
})
diff --git a/cli/pkg/auth/federated.go b/cli/pkg/auth/federated.go
index 57e5a31a0..193bff34c 100644
--- a/cli/pkg/auth/federated.go
+++ b/cli/pkg/auth/federated.go
@@ -95,7 +95,7 @@ GitHub Actions example:
cfg.JWTToken = tokenResp.AccessToken
cfg.APIKey = ""
cfg.RefreshToken = ""
- if saveErr := config.Save(cfg); saveErr != nil {
+ if saveErr := config.SaveTokens(cmd.Context(), cfg); saveErr != nil {
return fmt.Errorf("failed to save federated token: %w", saveErr)
}
}
@@ -127,8 +127,8 @@ GitHub Actions example:
output.KeyValue("Token source", tokenSource)
output.KeyValue("Expires at", expiresAt.Format(time.RFC3339))
if opts.persist {
- path, _ := config.ConfigPath()
- output.KeyValue("JWT token saved to config", path)
+ path, _ := config.AuthPath()
+ output.KeyValue("Session saved to", path)
} else {
output.Info("Use --export, --json, or --persist to consume the token.")
}
diff --git a/cli/pkg/backups/cmd.go b/cli/pkg/backups/cmd.go
index 8ca986161..572fb914d 100644
--- a/cli/pkg/backups/cmd.go
+++ b/cli/pkg/backups/cmd.go
@@ -422,14 +422,17 @@ Alternatively, --file replaces all policies from a raw JSON payload.`,
cmd.Flags().BoolVar(&opts.local, "local", false, "Store backups in the local repository")
cmd.Flags().BoolVar(&opts.s3, "s3", false, "Store backups in the S3 destination")
cmd.Flags().StringVar(&opts.s3Destination, "s3-destination", "", "S3 destination name or ID (implies --s3)")
+ // TODO(v3): remove the deprecated --disabled flag.
_ = cmd.Flags().MarkDeprecated("disabled", "use --enabled=false")
cmd.PreRunE = func(cmd *cobra.Command, _ []string) error {
+ // TODO(v3): drop the deprecated flag handling.
if conflictErr := cmdutil.ExclusiveFlags(cmd, "enabled", "disabled"); conflictErr != nil {
return conflictErr
}
if !cmd.Flags().Changed("file") {
return nil
}
+ // TODO(v3): drop the deprecated flag handling.
for _, name := range []string{"policy-id", "enabled", "disabled", "schedule", "retention", "local", "s3", "s3-destination"} {
if cmd.Flags().Changed(name) {
return fmt.Errorf("--file cannot be combined with --%s", name)
@@ -645,6 +648,7 @@ func (opts policiesUpdateOptions) request(cmd *cobra.Command, c *client.Client)
}
target := &req.Policies[targetIndex]
+ // TODO(v3): drop the deprecated flag handling.
if cmd.Flags().Changed("enabled") || cmd.Flags().Changed("disabled") {
target.Enabled = opts.enabled && !opts.disabled
}
diff --git a/cli/pkg/config/cmd.go b/cli/pkg/config/cmd.go
index 5f426e0db..c453158de 100644
--- a/cli/pkg/config/cmd.go
+++ b/cli/pkg/config/cmd.go
@@ -2,10 +2,12 @@ package config
import (
"cmp"
+ "context"
"errors"
"fmt"
"io"
"net/http"
+ "path/filepath"
"slices"
"sort"
"strconv"
@@ -51,15 +53,23 @@ func newConfigShowCmd() *cobra.Command {
}
output.Header("CLI configuration")
output.KeyValue("Config file", path)
+ authPath, authPathErr := config.AuthPath()
+ if authPathErr != nil {
+ authPath = fmt.Sprintf("(unavailable: %v)", authPathErr)
+ }
+ output.KeyValue("Auth file", authPath)
output.KeyValue("Server URL", cmp.Or(cfg.ServerURL, "(not set)"))
output.KeyValue("API key", maskAPIKey(cfg.APIKey))
- output.KeyValue("JWT token", maskAPIKey(cfg.JWTToken))
- output.KeyValue("Refresh token", maskAPIKey(cfg.RefreshToken))
output.KeyValue("Environment", cmp.Or(cfg.DefaultEnvironment, "0 (local)"))
output.KeyValue("Federated audience", cmp.Or(cfg.FederatedAudience, "(not set)"))
output.KeyValue("Log level", cmp.Or(cfg.LogLevel, "info (default)"))
output.KeyValue("Update channel", cmp.Or(cfg.CLIUpdateChannel, "(auto)"))
output.KeyValue("Pagination limit", kit.Ternary(cfg.Pagination.Default.Limit > 0, strconv.Itoa(cfg.Pagination.Default.Limit), "(not set)"))
+ if cfg.JWTToken != "" || cfg.RefreshToken != "" {
+ output.Header("Session")
+ output.KeyValue("Access token", maskAPIKey(cfg.JWTToken))
+ output.KeyValue("Refresh token", maskAPIKey(cfg.RefreshToken))
+ }
output.Header("Previews")
output.KeyValue("allEnvironments", strconv.FormatBool(cfg.Previews.AllEnvironments))
output.Header("Pagination resources")
@@ -141,10 +151,7 @@ Legacy flag syntax (flags shown below) is still supported:
if cmdutil.JSONOutputEnabled(cmd) {
w = io.Discard
}
- if setErr := applyConfigSetArgs(cfg, args, w); setErr != nil {
- return setErr
- }
-
+ var flagArgs []string
updatedKeys := make([]string, 0, len(args)/2)
for i := 0; i < len(args); i += 2 {
updatedKeys = append(updatedKeys, args[i])
@@ -158,9 +165,7 @@ Legacy flag syntax (flags shown below) is still supported:
{"log-level", opts.logLevel},
} {
if flag.value != "" {
- if setErr := applyConfigSetArg(cfg, flag.key, flag.value, w); setErr != nil {
- return setErr
- }
+ flagArgs = append(flagArgs, flag.key, flag.value)
updatedKeys = append(updatedKeys, flag.key)
}
}
@@ -168,19 +173,19 @@ Legacy flag syntax (flags shown below) is still supported:
if opts.defaultLimit < 0 {
return errors.New("--default-limit must be >= 0")
}
- if setErr := applyConfigSetArg(cfg, "default-limit", strconv.Itoa(opts.defaultLimit), w); setErr != nil {
- return setErr
- }
+ flagArgs = append(flagArgs, "default-limit", strconv.Itoa(opts.defaultLimit))
updatedKeys = append(updatedKeys, "default-limit")
}
for _, pair := range opts.resourceLimits {
- if setErr := applyConfigSetArg(cfg, "resource-limit", pair, w); setErr != nil {
- return setErr
- }
+ flagArgs = append(flagArgs, "resource-limit", pair)
resource, _, _ := strings.Cut(pair, "=")
updatedKeys = append(updatedKeys, "pagination.resources."+types.NormalizePaginatedResource(resource)+".limit")
}
+ if setErr := applyConfigSetArgs(cmd.Context(), cfg, args, flagArgs, w); setErr != nil {
+ return setErr
+ }
+
if len(args) == 0 && len(opts.resourceLimits) == 0 && !cmd.Flags().Changed("default-limit") &&
cmp.Or(opts.serverURL, opts.apiKey, opts.jwtToken, opts.environment, opts.federatedAudience, opts.logLevel) == "" {
return errors.New("no configuration values provided. Use `arcane config set <key> <value>` (e.g. `arcane config set server-url " +
@@ -188,7 +193,14 @@ Legacy flag syntax (flags shown below) is still supported:
"--default-limit, --resource-limit)")
}
- if saveErr := config.Save(cfg); saveErr != nil {
+ save := config.Save
+ if cfg.APIKey == "" && slices.ContainsFunc(updatedKeys, func(key string) bool {
+ normalized := strings.ReplaceAll(strings.ToLower(strings.TrimSpace(key)), " ", "")
+ return slices.Contains([]string{"jwt-token", "jwt", "jwt_token"}, normalized)
+ }) {
+ save = config.SaveTokens
+ }
+ if saveErr := save(cmd.Context(), cfg); saveErr != nil {
return fmt.Errorf("failed to save config: %w", saveErr)
}
@@ -328,23 +340,35 @@ If the config file already exists, this command is a no-op and does not overwrit
}
func newConfigBackupCmd() *cobra.Command {
- return &cobra.Command{
+ var opts struct{ auth bool }
+ cmd := &cobra.Command{
Use: "backup",
Short: "Move the current config file to a .bak backup",
Args: cobra.NoArgs,
SilenceUsage: true,
Long: `Move the active config file to <config-path>.bak.
-This removes the original config file from its previous path.`,
+This removes the original config file from its previous path.
+With --auth, move ~/.arcanecli/auth.json instead, for example when it is damaged.`,
RunE: func(cmd *cobra.Command, args []string) error {
- path, err := config.ConfigPath()
+ pathFn := config.ConfigPath
+ if opts.auth {
+ pathFn = config.AuthPath
+ }
+ path, err := pathFn()
if err != nil {
return err
}
- backupPath, moved, err := config.BackupFile()
+ var backupPath string
+ var moved bool
+ if opts.auth {
+ backupPath, moved, err = config.BackupAuthFile(cmd.Context())
+ } else {
+ backupPath, moved, err = config.BackupFile()
+ }
if err != nil {
- return fmt.Errorf("failed to backup config: %w", err)
+ return fmt.Errorf("failed to backup %s: %w", filepath.Base(path), err)
}
if cmdutil.JSONOutputEnabled(cmd) {
return cmdutil.PrintJSON(struct {
@@ -353,15 +377,17 @@ This removes the original config file from its previous path.`,
}{Path: cmp.Or(backupPath, path), Moved: moved})
}
if !moved {
- _, _ = fmt.Fprintf(output.Stdout(), "No config file found at %s (no changes made)\n", path)
+ _, _ = fmt.Fprintf(output.Stdout(), "No file found at %s (no changes made)\n", path)
return nil
}
- _, _ = fmt.Fprintf(output.Stdout(), "Backed up config to %s\n", backupPath)
- _, _ = fmt.Fprintf(output.Stdout(), "Removed original config at %s\n", path)
+ _, _ = fmt.Fprintf(output.Stdout(), "Backed up %s to %s\n", filepath.Base(path), backupPath)
+ _, _ = fmt.Fprintf(output.Stdout(), "Removed original at %s\n", path)
return nil
},
}
+ cmd.Flags().BoolVar(&opts.auth, "auth", false, "Back up the saved sessions file instead of the config")
+ return cmd
}
func maskAPIKey(key string) string {
@@ -374,23 +400,33 @@ func maskAPIKey(key string) string {
return key[:4] + "..." + key[len(key)-4:]
}
-func applyConfigSetArgs(cfg *types.Config, args []string, w io.Writer) error {
+func applyConfigSetArgs(ctx context.Context, cfg *types.Config, args, flags []string, w io.Writer) error {
if len(args)%2 != 0 {
return fmt.Errorf("expected key/value pairs, got odd number of arguments (%d). Example: `arcane config set server-url http://localhost:3552`", len(args))
}
- for i := 0; i < len(args); i += 2 {
- if err := applyConfigSetArg(cfg, args[i], args[i+1], w); err != nil {
- return err
+ args = append(slices.Clone(args), flags...)
+ // Switch servers before credential keys so tokens attach to the final server regardless of order.
+ for _, serverFirst := range []bool{true, false} {
+ for i := 0; i < len(args); i += 2 {
+ key := strings.ReplaceAll(strings.ToLower(strings.TrimSpace(args[i])), " ", "")
+ if slices.Contains([]string{"server-url", "server", "serverurl", "server_url"}, key) != serverFirst {
+ continue
+ }
+ if err := applyConfigSetArg(ctx, cfg, args[i], args[i+1], w); err != nil {
+ return err
+ }
}
}
return nil
}
-func applyConfigSetArg(cfg *types.Config, key, value string, w io.Writer) error {
+func applyConfigSetArg(ctx context.Context, cfg *types.Config, key, value string, w io.Writer) error {
normalized := strings.ReplaceAll(strings.ToLower(strings.TrimSpace(key)), " ", "")
switch normalized {
case "server-url", "server", "serverurl", "server_url":
- cfg.ServerURL = value
+ if err := config.SwitchServer(ctx, cfg, value); err != nil {
+ return err
+ }
_, _ = fmt.Fprintf(w, "Set server_url = %s\n", value)
return nil
case "api-key", "apikey", "api_key":
diff --git a/cli/pkg/config/cmd_test.go b/cli/pkg/config/cmd_test.go
index 20cdf047a..6647519da 100644
--- a/cli/pkg/config/cmd_test.go
+++ b/cli/pkg/config/cmd_test.go
@@ -2,24 +2,29 @@ package config
import (
"io"
+ "path/filepath"
"testing"
"github.com/stretchr/testify/require"
+ "github.com/getarcaneapp/arcane/cli/v2/internal/config"
"github.com/getarcaneapp/arcane/cli/v2/internal/types"
)
func TestApplyConfigSetArgs(t *testing.T) {
+ home := t.TempDir()
+ t.Setenv("HOME", home)
+ t.Setenv("USERPROFILE", home)
cfg := &types.Config{}
- err := applyConfigSetArgs(cfg, []string{
+ err := applyConfigSetArgs(t.Context(), cfg, []string{
"server-url", "http://localhost:3552",
"api-key", "arc_test_12345678",
"previews.allEnvironments", "true",
"default-limit", "25",
"pagination.resources.images.limit", "100",
"resource-limit.volumes", "40",
- }, io.Discard)
+ }, nil, io.Discard)
require.NoError(t, err,
"applyConfigSetArgs() error = %v", err)
@@ -35,7 +40,7 @@ func TestApplyConfigSetArgs(t *testing.T) {
require.True(t, cfg.Previews.AllEnvironments)
for _, value := range []string{"false", "true", "invalid"} {
- setErr := applyConfigSetArg(cfg, "previews.allEnvironments", value, io.Discard)
+ setErr := applyConfigSetArg(t.Context(), cfg, "previews.allEnvironments", value, io.Discard)
if value == "invalid" {
require.Error(t, setErr)
continue
@@ -57,11 +62,35 @@ func TestApplyConfigSetArgs(t *testing.T) {
require.Equal(t, 40, got,
"LimitFor(volumes) = %d, want 40", got)
}
+
+ path := filepath.Join(home, "config.yml")
+ require.NoError(t, config.SetConfigPath(path))
+ t.Cleanup(func() { require.NoError(t, config.SetConfigPath("")) })
+ for _, args := range [][]string{
+ {"jwt-token", "new_token", "server-url", "https://b.test"},
+ {"server-url", "https://b.test", "jwt-token", "new_token"},
+ {"jwt-token", "new_token", "--server-url", "https://b.test"},
+ {"server-url", "https://b.test", "--jwt-token", "new_token"},
+ {"jwt-token", "new_token", "server-url", "https://c.test", "--server-url", "https://b.test"},
+ } {
+ require.NoError(t, config.SaveTokens(t.Context(), &types.Config{ServerURL: "https://b.test", JWTToken: "saved_b"}))
+ require.NoError(t, config.SaveTokens(t.Context(), &types.Config{ServerURL: "https://a.test", JWTToken: "saved_a"}))
+ cmd := newConfigSetCmd()
+ cmd.SetArgs(args)
+ require.NoError(t, cmd.ExecuteContext(t.Context()))
+ require.NoError(t, config.SetConfigPath(path))
+ loaded, loadErr := config.Load()
+ require.NoError(t, loadErr)
+ require.Equal(t, "https://b.test", loaded.ServerURL)
+ require.Equal(t, "new_token", loaded.JWTToken)
+ require.NoError(t, config.SwitchServer(t.Context(), loaded, "https://a.test"))
+ require.Equal(t, "saved_a", loaded.JWTToken)
+ }
}
func TestApplyConfigSetArgs_OddArgs(t *testing.T) {
cfg := &types.Config{}
- err := applyConfigSetArgs(cfg, []string{"server-url", "http://localhost:3552", "api-key"}, io.Discard)
+ err := applyConfigSetArgs(t.Context(), cfg, []string{"server-url", "http://localhost:3552", "api-key"}, nil, io.Discard)
require.Error(t, err,
"expected error for odd key/value args, got nil")
@@ -69,7 +98,7 @@ func TestApplyConfigSetArgs_OddArgs(t *testing.T) {
func TestApplyConfigSetArg_UnknownKey(t *testing.T) {
cfg := &types.Config{}
- err := applyConfigSetArg(cfg, "not-a-real-key", "value", io.Discard)
+ err := applyConfigSetArg(t.Context(), cfg, "not-a-real-key", "value", io.Discard)
require.Error(t, err,
"expected unknown key error, got nil")
@@ -80,7 +109,7 @@ func TestApplyConfigSetArg_UnknownKey(t *testing.T) {
func TestApplyConfigSetArg_ResourceLimitPair(t *testing.T) {
cfg := &types.Config{}
- err := applyConfigSetArg(cfg, "resource-limit", "containers=55", io.Discard)
+ err := applyConfigSetArg(t.Context(), cfg, "resource-limit", "containers=55", io.Discard)
require.NoError(t, err,
"applyConfigSetArg() error = %v", err)
diff --git a/cli/pkg/containers/cmd.go b/cli/pkg/containers/cmd.go
index 4f097fa54..7f7509beb 100644
--- a/cli/pkg/containers/cmd.go
+++ b/cli/pkg/containers/cmd.go
@@ -489,6 +489,7 @@ func newCreateCmd() *cobra.Command {
command.Flags().StringVar(&opts.image, "image", "", "Docker image")
command.Flags().StringArrayVarP(&opts.env, "env-var", "e", nil, "Environment variable (KEY=VALUE)")
command.Flags().Var(command.Flags().Lookup("env-var").Value, "env", "Environment variable (KEY=VALUE)")
+ // TODO(v3): remove the deprecated --env flag.
_ = command.Flags().MarkDeprecated("env", "use --env-var or -e")
command.Flags().StringArrayVarP(&opts.port, "port", "p", nil, "Port mapping (HOST:CONTAINER)")
command.Flags().StringArrayVarP(&opts.volume, "volume", "v", nil, "Volume mount (SRC:DST)")
@@ -566,6 +567,7 @@ func (opts *createOptions) request(cmd *cobra.Command) (container.Create, error)
if cmd.Flags().Changed("image") {
req.Image = opts.image
}
+ // TODO(v3): drop the deprecated flag handling.
if cmd.Flags().Changed("env-var") || cmd.Flags().Changed("env") {
req.Env = opts.env
}
diff --git a/cli/pkg/environments/cmd.go b/cli/pkg/environments/cmd.go
index 2d6b3c817..4b3e0b790 100644
--- a/cli/pkg/environments/cmd.go
+++ b/cli/pkg/environments/cmd.go
@@ -227,7 +227,7 @@ func newSwitchCmd() *cobra.Command {
}
cfg.DefaultEnvironment = selected.ID
- if saveErr := config.Save(cfg); saveErr != nil {
+ if saveErr := config.Save(cmd.Context(), cfg); saveErr != nil {
return fmt.Errorf("failed to save config: %w", saveErr)
}
@@ -254,6 +254,7 @@ func newUpdateCmd() *cobra.Command {
Args: cobra.ExactArgs(1),
SilenceUsage: true,
PreRunE: func(cmd *cobra.Command, _ []string) error {
+ // TODO(v3): drop the deprecated flag handling.
return cmdutil.ExclusiveFlags(cmd, "enabled", "disabled")
},
RunE: func(cmd *cobra.Command, args []string) error {
@@ -262,10 +263,12 @@ func newUpdateCmd() *cobra.Command {
return err
}
+ // TODO(v3): drop the deprecated flag handling.
enabled := cmd.Flags().Changed("enabled") && opts.enabled || cmd.Flags().Changed("disabled") && !opts.disabled
req := environment.Update{
- Name: kit.Ternary(cmd.Flags().Changed("name"), &opts.name, nil),
- ApiUrl: kit.Ternary(cmd.Flags().Changed("api-url"), &opts.apiUrl, nil),
+ Name: kit.Ternary(cmd.Flags().Changed("name"), &opts.name, nil),
+ ApiUrl: kit.Ternary(cmd.Flags().Changed("api-url"), &opts.apiUrl, nil),
+ // TODO(v3): drop the deprecated flag handling.
Enabled: kit.Ternary(cmd.Flags().Changed("enabled") || cmd.Flags().Changed("disabled"), &enabled, nil),
}
@@ -289,6 +292,7 @@ func newUpdateCmd() *cobra.Command {
command.Flags().StringVar(&opts.apiUrl, "api-url", "", "API URL")
command.Flags().BoolVar(&opts.enabled, "enabled", false, "Enable environment")
command.Flags().BoolVar(&opts.disabled, "disabled", false, "Disable environment")
+ // TODO(v3): remove the deprecated --disabled flag.
_ = command.Flags().MarkDeprecated("disabled", "use --enabled=false")
return command
}
@@ -309,6 +313,7 @@ func newCreateCmd() *cobra.Command {
Args: cobra.NoArgs,
SilenceUsage: true,
PreRunE: func(cmd *cobra.Command, _ []string) error {
+ // TODO(v3): drop the deprecated flag handling.
return cmdutil.ExclusiveFlags(cmd, "enabled", "disabled")
},
RunE: func(cmd *cobra.Command, args []string) error {
@@ -323,7 +328,8 @@ func newCreateCmd() *cobra.Command {
AccessToken: kit.Ternary(cmd.Flags().Changed("access-token"), &opts.accessToken, nil),
UseApiKey: kit.Ternary(cmd.Flags().Changed("use-api-key"), &opts.useApiKey, nil),
IsEdge: kit.Ternary(cmd.Flags().Changed("edge"), &opts.edge, nil),
- Enabled: kit.Ternary(cmd.Flags().Changed("enabled") || cmd.Flags().Changed("disabled"), new(opts.enabled && !opts.disabled), nil),
+ // TODO(v3): drop the deprecated flag handling.
+ Enabled: kit.Ternary(cmd.Flags().Changed("enabled") || cmd.Flags().Changed("disabled"), new(opts.enabled && !opts.disabled), nil),
}
return cmdutil.Run(cmd, c, cmdutil.Spec[environment.Environment]{
@@ -353,6 +359,7 @@ func newCreateCmd() *cobra.Command {
command.Flags().BoolVar(&opts.edge, "edge", false, "Create as an edge environment")
command.Flags().BoolVar(&opts.enabled, "enabled", true, "Enable environment")
command.Flags().BoolVar(&opts.disabled, "disabled", false, "Create environment in disabled state")
+ // TODO(v3): remove the deprecated --disabled flag.
_ = command.Flags().MarkDeprecated("disabled", "use --enabled=false")
_ = command.MarkFlagRequired("api-url")
return command
diff --git a/cli/pkg/registries/cmd.go b/cli/pkg/registries/cmd.go
index a399acdfe..08255b82c 100644
--- a/cli/pkg/registries/cmd.go
+++ b/cli/pkg/registries/cmd.go
@@ -163,12 +163,13 @@ func newCreateCmd() *cobra.Command {
}
req := containerregistry.CreateContainerRegistryRequest{
- URL: opts.url,
- RegistryType: opts.registryType,
- Username: opts.username,
- Token: opts.token,
- Description: &opts.description,
- Insecure: &opts.insecure,
+ URL: opts.url,
+ RegistryType: opts.registryType,
+ Username: opts.username,
+ Token: opts.token,
+ Description: &opts.description,
+ Insecure: &opts.insecure,
+ // TODO(v3): drop the deprecated flag handling.
Enabled: new(opts.enabled && !opts.disabled),
AWSAccessKeyID: opts.awsKeyID,
AWSSecretAccessKey: opts.awsSecret,
@@ -205,7 +206,9 @@ func newCreateCmd() *cobra.Command {
cmd.Flags().StringVar(&opts.awsKeyID, "aws-access-key-id", "", "AWS Access Key ID (ECR only; omit both keys to use the host's IAM role)")
cmd.Flags().StringVar(&opts.awsSecret, "aws-secret-access-key", "", "AWS Secret Access Key (ECR only; omit both keys to use the host's IAM role)")
cmd.Flags().StringVar(&opts.awsRegion, "aws-region", "", "AWS region (ECR only)")
+ // TODO(v3): remove the deprecated --disabled flag.
_ = cmd.Flags().MarkDeprecated("disabled", "use --enabled=false")
+ // TODO(v3): drop the deprecated flag handling.
cmd.PreRunE = func(cmd *cobra.Command, _ []string) error { return cmdutil.ExclusiveFlags(cmd, "enabled", "disabled") }
_ = cmd.MarkFlagRequired("url")
return cmd
@@ -234,11 +237,13 @@ func newUpdateCmd() *cobra.Command {
URL: kit.Ternary(cmd.Flags().Changed("url"), &opts.url, nil),
Username: kit.Ternary(cmd.Flags().Changed("username"), &opts.username, nil),
Token: kit.Ternary(cmd.Flags().Changed("password"), &opts.password, nil),
+ // TODO(v3): drop the deprecated flag handling.
Enabled: kit.Ternary(cmd.Flags().Changed("enabled") || cmd.Flags().Changed("disabled"),
new(cmd.Flags().Changed("enabled") && opts.enabled || cmd.Flags().Changed("disabled") && !opts.disabled), nil),
}
if req.URL == nil && req.Username == nil && req.Token == nil && req.Enabled == nil {
+ // TODO(v3): drop the deprecated flag handling.
return errors.New("no updates provided; use --url, --username, --password, --enabled, or --disabled")
}
@@ -259,7 +264,9 @@ func newUpdateCmd() *cobra.Command {
cmd.Flags().StringVar(&opts.password, "password", "", "Password")
cmd.Flags().BoolVar(&opts.enabled, "enabled", false, "Enable registry")
cmd.Flags().BoolVar(&opts.disabled, "disabled", false, "Disable registry")
+ // TODO(v3): remove the deprecated --disabled flag.
_ = cmd.Flags().MarkDeprecated("disabled", "use --enabled=false")
+ // TODO(v3): drop the deprecated flag handling.
cmd.PreRunE = func(cmd *cobra.Command, _ []string) error { return cmdutil.ExclusiveFlags(cmd, "enabled", "disabled") }
return cmd
}
diff --git a/cli/pkg/selfupdate/cmd.go b/cli/pkg/selfupdate/cmd.go
index beb0c24c7..5a5fe5ca2 100644
--- a/cli/pkg/selfupdate/cmd.go
+++ b/cli/pkg/selfupdate/cmd.go
@@ -122,7 +122,7 @@ func (opts cliUpdateOptions) setCLIUpdateChannelAndRun(cmd *cobra.Command, chann
return fmt.Errorf("failed to load config: %w", err)
}
cfg.CLIUpdateChannel = channel
- if saveErr := config.Save(cfg); saveErr != nil {
+ if saveErr := config.Save(cmd.Context(), cfg); saveErr != nil {
return fmt.Errorf("failed to save config: %w", saveErr)
}
diff --git a/cli/pkg/templates/cmd.go b/cli/pkg/templates/cmd.go
index 28f7f36e9..bc4512e1a 100644
--- a/cli/pkg/templates/cmd.go
+++ b/cli/pkg/templates/cmd.go
@@ -714,6 +714,7 @@ func newDownloadCmd() *cobra.Command {
if err != nil {
return fmt.Errorf("failed to download template: %w", err)
}
+ // TODO(v3): drop the deprecated flag handling.
jsonMode := cmdutil.JSONOutputEnabled(cmd) || opts.legacyOutput == "json"
outputFile := cmp.Or(opts.outputFile, kit.Ternary(slices.Contains([]string{"text", "json"}, opts.legacyOutput), "", opts.legacyOutput))
if jsonMode && outputFile == "" {
@@ -749,6 +750,7 @@ func newDownloadCmd() *cobra.Command {
}
cmd.Flags().StringVarP(&opts.outputFile, "output-file", "o", "", "Output file path")
cmd.Flags().StringVar(&opts.legacyOutput, "output", "", "Output file path")
+ // TODO(v3): remove the deprecated --output flag.
_ = cmd.Flags().MarkDeprecated("output", "use --output-file or -o")
return cmd
}
@@ -840,6 +842,7 @@ func newRegistriesUpdateCmd() *cobra.Command {
Name: kit.Ternary(cmd.Flags().Changed("name"), opts.name, current.Name),
URL: kit.Ternary(cmd.Flags().Changed("url"), opts.url, current.URL),
Description: kit.Ternary(cmd.Flags().Changed("description"), opts.desc, current.Description),
+ // TODO(v3): drop the deprecated flag handling.
Enabled: cmd.Flags().Changed("enabled") && opts.enabled ||
cmd.Flags().Changed("disabled") && !opts.disabled ||
!cmd.Flags().Changed("enabled") && !cmd.Flags().Changed("disabled") && current.Enabled,
@@ -865,7 +868,9 @@ func newRegistriesUpdateCmd() *cobra.Command {
cmd.Flags().StringVar(&opts.desc, "description", "", "Registry description")
cmd.Flags().BoolVar(&opts.enabled, "enabled", false, "Enable registry")
cmd.Flags().BoolVar(&opts.disabled, "disabled", false, "Disable registry")
+ // TODO(v3): remove the deprecated --disabled flag.
_ = cmd.Flags().MarkDeprecated("disabled", "use --enabled=false")
+ // TODO(v3): drop the deprecated flag handling.
cmd.PreRunE = func(cmd *cobra.Command, _ []string) error { return cmdutil.ExclusiveFlags(cmd, "enabled", "disabled") }
return cmd
}