4c26bc9ecc
Two halves of v0.3 roadmap item 3-2. (1) `weknora auth refresh` — explicit token renewal: Reads the stored refresh_token, spends it via POST /api/v1/auth/refresh (OAuth refresh-token grant), and persists both new tokens. API-key contexts rejected with input.invalid_argument (no refresh semantic). NOTE: gh CLI has `gh auth refresh` but with different semantics — gh's variant is an OAuth scope expansion / re-prompt via the browser (verified against the gh manual). The two share a name but solve different problems; there's no direct gh parallel for refresh-token grant because gh's PAT/OAuth-app model doesn't expose a short-lived access_token + refresh_token pair to clients. Error mapping: - no current context → auth.unauthenticated - --name unknown → local.context_not_found - missing refresh in keyring → auth.token_expired (hint: re-login) - server Success=false → auth.token_expired - network → network.error Envelope omits the token values (would leak into agent transcripts). (2) AuthRetryTransport — transparent retry: Wraps the SDK http.Client. On a 401 from a non-/auth/* endpoint: - JWT context: read refresh token, hit /auth/refresh, persist new pair, replay original request with new bearer. - API-key context: pass through (no refresh semantic). - Non-replayable body (req.GetBody == nil): pass through. - /auth/login or /auth/refresh: pass through (no recursion). Concurrent 401s are singleflight-coalesced via sync.Mutex — 5 parallel calls trigger exactly 1 refresh. SDK additions (additive, non-breaking): - WithTransport(rt http.RoundTripper) ClientOption. - PathAuthLogin / PathAuthRefresh constants (cli/internal/cmdutil/authretry imports them so the CLI and SDK can't drift on path strings). Refactor surfaced by the post-commit reviewer round: - cmdutil.RefreshAndPersist(ctx, store, refresher, ctxName) — the load-refresh → call-SDK → persist-pair sequence was duplicated between the standalone `auth refresh` and the transport's refresh closure; collapsed to one canonical implementation. - refreshFn signature takes context.Context so Ctrl+C during a transparent refresh cancels. - AuthRetryTransport.CurrentToken() removed — never called. 8 + 8 + 8 unit tests cover happy path / refresh-fail / auth-endpoint skip / api-key passthrough / singleflight under concurrency / non- replayable-body fallback. Roadmap: 3-2.
221 lines
8.3 KiB
Go
221 lines
8.3 KiB
Go
package auth
|
|
|
|
import (
|
|
"context"
|
|
"encoding/json"
|
|
"errors"
|
|
"strings"
|
|
"testing"
|
|
|
|
"github.com/stretchr/testify/assert"
|
|
"github.com/stretchr/testify/require"
|
|
|
|
"github.com/Tencent/WeKnora/cli/internal/cmdutil"
|
|
"github.com/Tencent/WeKnora/cli/internal/config"
|
|
"github.com/Tencent/WeKnora/cli/internal/format"
|
|
"github.com/Tencent/WeKnora/cli/internal/iostreams"
|
|
"github.com/Tencent/WeKnora/cli/internal/prompt"
|
|
"github.com/Tencent/WeKnora/cli/internal/secrets"
|
|
"github.com/Tencent/WeKnora/cli/internal/testutil"
|
|
sdk "github.com/Tencent/WeKnora/client"
|
|
)
|
|
|
|
// fakeRefreshService scripts a RefreshToken response.
|
|
type fakeRefreshService struct {
|
|
resp *sdk.RefreshTokenResponse
|
|
err error
|
|
gotTok string
|
|
}
|
|
|
|
func (f *fakeRefreshService) RefreshToken(_ context.Context, refreshToken string) (*sdk.RefreshTokenResponse, error) {
|
|
f.gotTok = refreshToken
|
|
return f.resp, f.err
|
|
}
|
|
|
|
// stubSvc returns a closure conforming to the refresherFor signature; it
|
|
// ignores host since the fake doesn't talk to the network.
|
|
func stubSvc(s cmdutil.Refresher) func(string) cmdutil.Refresher {
|
|
return func(string) cmdutil.Refresher { return s }
|
|
}
|
|
|
|
func newRefreshFactory(t *testing.T, cfg *config.Config, store *secrets.MemStore) *cmdutil.Factory {
|
|
t.Helper()
|
|
testutil.XDGTempDir(t)
|
|
require.NoError(t, config.Save(cfg))
|
|
return &cmdutil.Factory{
|
|
Config: func() (*config.Config, error) { return config.Load() },
|
|
Client: func() (*sdk.Client, error) { panic("client") },
|
|
Prompter: func() prompt.Prompter { return prompt.AgentPrompter{} },
|
|
Secrets: func() (secrets.Store, error) { return store, nil },
|
|
}
|
|
}
|
|
|
|
func TestRefresh_Happy(t *testing.T) {
|
|
iostreams.SetForTest(t)
|
|
store := secrets.NewMemStore()
|
|
require.NoError(t, store.Set("prod", "access", "old-access"))
|
|
require.NoError(t, store.Set("prod", "refresh", "old-refresh"))
|
|
|
|
cfg := &config.Config{
|
|
CurrentContext: "prod",
|
|
Contexts: map[string]config.Context{
|
|
"prod": {
|
|
Host: "https://kb.example.com",
|
|
TokenRef: "mem://prod/access",
|
|
RefreshRef: "mem://prod/refresh",
|
|
User: "alice@example.com",
|
|
},
|
|
},
|
|
}
|
|
f := newRefreshFactory(t, cfg, store)
|
|
svc := &fakeRefreshService{resp: &sdk.RefreshTokenResponse{
|
|
Success: true,
|
|
AccessToken: "new-access",
|
|
RefreshToken: "new-refresh",
|
|
}}
|
|
require.NoError(t, runRefresh(context.Background(), &RefreshOptions{}, f, stubSvc(svc)))
|
|
|
|
assert.Equal(t, "old-refresh", svc.gotTok, "must pass stored refresh token to SDK")
|
|
gotAccess, _ := store.Get("prod", "access")
|
|
gotRefresh, _ := store.Get("prod", "refresh")
|
|
assert.Equal(t, "new-access", gotAccess)
|
|
assert.Equal(t, "new-refresh", gotRefresh)
|
|
}
|
|
|
|
func TestRefresh_NamedContext(t *testing.T) {
|
|
iostreams.SetForTest(t)
|
|
store := secrets.NewMemStore()
|
|
require.NoError(t, store.Set("staging", "refresh", "stg-refresh"))
|
|
|
|
cfg := &config.Config{
|
|
CurrentContext: "prod",
|
|
Contexts: map[string]config.Context{
|
|
"prod": {Host: "https://prod", TokenRef: "mem://prod/access", RefreshRef: "mem://prod/refresh"},
|
|
"staging": {Host: "https://stg", TokenRef: "mem://staging/access", RefreshRef: "mem://staging/refresh"},
|
|
},
|
|
}
|
|
f := newRefreshFactory(t, cfg, store)
|
|
svc := &fakeRefreshService{resp: &sdk.RefreshTokenResponse{
|
|
Success: true, AccessToken: "new-stg-access", RefreshToken: "new-stg-refresh",
|
|
}}
|
|
require.NoError(t, runRefresh(context.Background(), &RefreshOptions{Name: "staging"}, f, stubSvc(svc)))
|
|
|
|
assert.Equal(t, "stg-refresh", svc.gotTok, "--name=staging must refresh the staging context, not current")
|
|
// current is untouched
|
|
if v, _ := store.Get("prod", "access"); v != "" {
|
|
t.Errorf("prod must not have been touched, got %q", v)
|
|
}
|
|
}
|
|
|
|
func TestRefresh_NoCurrentContext(t *testing.T) {
|
|
iostreams.SetForTest(t)
|
|
f := newRefreshFactory(t, &config.Config{}, secrets.NewMemStore())
|
|
err := runRefresh(context.Background(), &RefreshOptions{}, f, stubSvc(&fakeRefreshService{}))
|
|
require.Error(t, err)
|
|
var typed *cmdutil.Error
|
|
require.ErrorAs(t, err, &typed)
|
|
assert.Equal(t, cmdutil.CodeAuthUnauthenticated, typed.Code)
|
|
}
|
|
|
|
func TestRefresh_APIKeyContext(t *testing.T) {
|
|
iostreams.SetForTest(t)
|
|
store := secrets.NewMemStore()
|
|
require.NoError(t, store.Set("ci", "api_key", "sk-123"))
|
|
cfg := &config.Config{
|
|
CurrentContext: "ci",
|
|
Contexts: map[string]config.Context{"ci": {Host: "https://kb", APIKeyRef: "mem://ci/api_key"}},
|
|
}
|
|
f := newRefreshFactory(t, cfg, store)
|
|
err := runRefresh(context.Background(), &RefreshOptions{}, f, stubSvc(&fakeRefreshService{}))
|
|
require.Error(t, err)
|
|
var typed *cmdutil.Error
|
|
require.ErrorAs(t, err, &typed)
|
|
assert.Equal(t, cmdutil.CodeInputInvalidArgument, typed.Code)
|
|
assert.Contains(t, typed.Hint, "api-key", "hint should explain api-key contexts cannot be refreshed")
|
|
}
|
|
|
|
func TestRefresh_NoRefreshTokenStored(t *testing.T) {
|
|
iostreams.SetForTest(t)
|
|
cfg := &config.Config{
|
|
CurrentContext: "prod",
|
|
Contexts: map[string]config.Context{
|
|
"prod": {Host: "https://kb", TokenRef: "mem://prod/access", RefreshRef: "mem://prod/refresh"},
|
|
},
|
|
}
|
|
// MemStore is empty — RefreshRef points to a slot that doesn't exist.
|
|
f := newRefreshFactory(t, cfg, secrets.NewMemStore())
|
|
err := runRefresh(context.Background(), &RefreshOptions{}, f, stubSvc(&fakeRefreshService{}))
|
|
require.Error(t, err)
|
|
var typed *cmdutil.Error
|
|
require.ErrorAs(t, err, &typed)
|
|
assert.Equal(t, cmdutil.CodeAuthTokenExpired, typed.Code)
|
|
assert.Contains(t, typed.Hint, "auth login")
|
|
}
|
|
|
|
func TestRefresh_ServerRefused(t *testing.T) {
|
|
iostreams.SetForTest(t)
|
|
store := secrets.NewMemStore()
|
|
require.NoError(t, store.Set("prod", "refresh", "stale-refresh"))
|
|
cfg := &config.Config{
|
|
CurrentContext: "prod",
|
|
Contexts: map[string]config.Context{"prod": {Host: "https://kb", TokenRef: "mem://prod/access", RefreshRef: "mem://prod/refresh"}},
|
|
}
|
|
f := newRefreshFactory(t, cfg, store)
|
|
svc := &fakeRefreshService{resp: &sdk.RefreshTokenResponse{Success: false, Message: "refresh token expired"}}
|
|
err := runRefresh(context.Background(), &RefreshOptions{}, f, stubSvc(svc))
|
|
require.Error(t, err)
|
|
var typed *cmdutil.Error
|
|
require.ErrorAs(t, err, &typed)
|
|
assert.Equal(t, cmdutil.CodeAuthTokenExpired, typed.Code)
|
|
assert.Contains(t, typed.Hint, "auth login")
|
|
// stored access must NOT have been overwritten with empty
|
|
if v, _ := store.Get("prod", "access"); v == "" {
|
|
// Was never set in this test, that's fine — main thing is no panic.
|
|
_ = v
|
|
}
|
|
}
|
|
|
|
func TestRefresh_TransportError(t *testing.T) {
|
|
iostreams.SetForTest(t)
|
|
store := secrets.NewMemStore()
|
|
require.NoError(t, store.Set("prod", "refresh", "ok-refresh"))
|
|
cfg := &config.Config{
|
|
CurrentContext: "prod",
|
|
Contexts: map[string]config.Context{"prod": {Host: "https://kb", TokenRef: "mem://prod/access", RefreshRef: "mem://prod/refresh"}},
|
|
}
|
|
f := newRefreshFactory(t, cfg, store)
|
|
svc := &fakeRefreshService{err: errors.New("connection reset")}
|
|
err := runRefresh(context.Background(), &RefreshOptions{}, f, stubSvc(svc))
|
|
require.Error(t, err)
|
|
var typed *cmdutil.Error
|
|
require.ErrorAs(t, err, &typed)
|
|
// network/transport classified as network.error (mirrors auth login's
|
|
// CodeAuthBadCredential mapping pattern; here we keep network errors
|
|
// distinct since auth/refresh treats them as retryable).
|
|
assert.Equal(t, cmdutil.CodeNetworkError, typed.Code)
|
|
}
|
|
|
|
func TestRefresh_JSONOutput(t *testing.T) {
|
|
out, _ := iostreams.SetForTest(t)
|
|
store := secrets.NewMemStore()
|
|
require.NoError(t, store.Set("prod", "refresh", "ok-refresh"))
|
|
cfg := &config.Config{
|
|
CurrentContext: "prod",
|
|
Contexts: map[string]config.Context{"prod": {Host: "https://kb", TokenRef: "mem://prod/access", RefreshRef: "mem://prod/refresh"}},
|
|
}
|
|
f := newRefreshFactory(t, cfg, store)
|
|
svc := &fakeRefreshService{resp: &sdk.RefreshTokenResponse{Success: true, AccessToken: "a", RefreshToken: "r"}}
|
|
require.NoError(t, runRefresh(context.Background(), &RefreshOptions{JSONOut: true}, f, stubSvc(svc)))
|
|
|
|
var env format.Envelope
|
|
require.NoError(t, json.Unmarshal(out.Bytes(), &env))
|
|
assert.True(t, env.OK)
|
|
// payload should not leak the actual token values.
|
|
body := out.String()
|
|
assert.NotContains(t, body, "ok-refresh", "envelope must not leak refresh token")
|
|
assert.NotContains(t, body, "\"a\"", "envelope must not leak the new access token")
|
|
assert.NotContains(t, body, "\"r\"", "envelope must not leak the new refresh token")
|
|
// must mention the context name so agents can confirm what was refreshed
|
|
assert.True(t, strings.Contains(body, "prod"), "envelope should reference the refreshed context")
|
|
}
|