mirror of
https://github.com/router-for-me/CLIProxyAPI.git
synced 2026-06-13 10:12:50 +08:00
- Implemented command-line flag registration and execution for plugins with priority-based conflict resolution. - Enabled plugin-owned command-line flag execution and persistence of plugin-auth data. - Added new `Host` methods to support command-line capabilities, including flag normalization, validation, and execution state management. - Introduced unit tests to ensure coverage for command-line plugin functionality, including auth data persistence. - Updated configs to normalize plugins during initialization.
318 lines
11 KiB
Go
318 lines
11 KiB
Go
package pluginhost
|
|
|
|
import (
|
|
"context"
|
|
"encoding/json"
|
|
"os"
|
|
"path/filepath"
|
|
"testing"
|
|
"time"
|
|
|
|
"github.com/router-for-me/CLIProxyAPI/v7/internal/config"
|
|
"github.com/router-for-me/CLIProxyAPI/v7/sdk/pluginapi"
|
|
)
|
|
|
|
func TestAuthProviderDiscovery(t *testing.T) {
|
|
host := newHostWithRecords(
|
|
capabilityRecord{
|
|
id: "high",
|
|
priority: 20,
|
|
plugin: pluginapi.Plugin{Capabilities: pluginapi.Capabilities{
|
|
AuthProvider: fakeAuthProvider{identifier: " High-Provider "},
|
|
}},
|
|
},
|
|
capabilityRecord{
|
|
id: "low",
|
|
priority: 10,
|
|
plugin: pluginapi.Plugin{Capabilities: pluginapi.Capabilities{
|
|
AuthProvider: fakeAuthProvider{identifier: "low-provider"},
|
|
}},
|
|
},
|
|
capabilityRecord{
|
|
id: "missing-auth-provider",
|
|
plugin: pluginapi.Plugin{Capabilities: pluginapi.Capabilities{
|
|
ModelRegistrar: staticModelRegistrar("provider", "model"),
|
|
}},
|
|
},
|
|
)
|
|
|
|
identifiers := host.AuthProviderIdentifiers()
|
|
if len(identifiers) != 2 || identifiers[0] != "high-provider" || identifiers[1] != "low-provider" {
|
|
t.Fatalf("AuthProviderIdentifiers() = %#v, want sorted normalized providers", identifiers)
|
|
}
|
|
if !host.HasAuthProvider(" HIGH-PROVIDER ") {
|
|
t.Fatal("HasAuthProvider(high-provider) = false, want true")
|
|
}
|
|
if host.HasAuthProvider("missing-provider") {
|
|
t.Fatal("HasAuthProvider(missing-provider) = true, want false")
|
|
}
|
|
}
|
|
|
|
func TestParseAuthDefaultsProviderFromRequest(t *testing.T) {
|
|
host := newHostWithRecords(capabilityRecord{
|
|
id: "auth-plugin",
|
|
plugin: pluginapi.Plugin{
|
|
Capabilities: pluginapi.Capabilities{
|
|
AuthProvider: fakeAuthProvider{
|
|
identifier: "plugin-provider",
|
|
parseAuth: func(ctx context.Context, req pluginapi.AuthParseRequest) (pluginapi.AuthParseResponse, error) {
|
|
return pluginapi.AuthParseResponse{
|
|
Handled: true,
|
|
Auth: pluginapi.AuthData{
|
|
ID: "auth-1",
|
|
},
|
|
}, nil
|
|
},
|
|
},
|
|
},
|
|
},
|
|
})
|
|
|
|
auth, handled, errParse := host.ParseAuth(context.Background(), pluginapi.AuthParseRequest{Provider: "plugin-provider"})
|
|
if errParse != nil {
|
|
t.Fatalf("ParseAuth() error = %v", errParse)
|
|
}
|
|
if !handled || auth == nil {
|
|
t.Fatalf("ParseAuth() handled=%t auth=%#v, want parsed auth", handled, auth)
|
|
}
|
|
if auth.Provider != "plugin-provider" || auth.Metadata["type"] != "plugin-provider" {
|
|
t.Fatalf("ParseAuth() auth = %#v, want plugin-provider defaults", auth)
|
|
}
|
|
}
|
|
|
|
func TestParseAuthDefaultsProviderFromAuthProviderIdentifier(t *testing.T) {
|
|
seenProvider := ""
|
|
host := newHostWithRecords(capabilityRecord{
|
|
id: "auth-plugin",
|
|
plugin: pluginapi.Plugin{
|
|
Capabilities: pluginapi.Capabilities{
|
|
AuthProvider: fakeAuthProvider{
|
|
identifier: "Plugin-Provider",
|
|
parseAuth: func(ctx context.Context, req pluginapi.AuthParseRequest) (pluginapi.AuthParseResponse, error) {
|
|
seenProvider = req.Provider
|
|
return pluginapi.AuthParseResponse{
|
|
Handled: true,
|
|
Auth: pluginapi.AuthData{
|
|
ID: "auth-1",
|
|
},
|
|
}, nil
|
|
},
|
|
},
|
|
},
|
|
},
|
|
})
|
|
|
|
auth, handled, errParse := host.ParseAuth(context.Background(), pluginapi.AuthParseRequest{})
|
|
if errParse != nil {
|
|
t.Fatalf("ParseAuth() error = %v", errParse)
|
|
}
|
|
if !handled || auth == nil {
|
|
t.Fatalf("ParseAuth() handled=%t auth=%#v, want parsed auth", handled, auth)
|
|
}
|
|
if seenProvider != "plugin-provider" {
|
|
t.Fatalf("plugin parse request provider = %q, want plugin-provider", seenProvider)
|
|
}
|
|
if auth.Provider != "plugin-provider" || auth.Metadata["type"] != "plugin-provider" {
|
|
t.Fatalf("ParseAuth() auth = %#v, want identifier provider fallback", auth)
|
|
}
|
|
}
|
|
|
|
func TestStartLoginPassesProviderBaseURLHostAndHTTPClient(t *testing.T) {
|
|
authDir := t.TempDir()
|
|
expiresAt := time.Now().Add(time.Minute).UTC()
|
|
called := false
|
|
host := newHostWithRecords(capabilityRecord{
|
|
id: "auth-plugin",
|
|
plugin: pluginapi.Plugin{
|
|
Capabilities: pluginapi.Capabilities{
|
|
AuthProvider: fakeAuthProvider{
|
|
identifier: "plugin-provider",
|
|
startLogin: func(ctx context.Context, req pluginapi.AuthLoginStartRequest) (pluginapi.AuthLoginStartResponse, error) {
|
|
called = true
|
|
if req.Provider != "plugin-provider" || req.BaseURL != "http://localhost:8080/login" {
|
|
t.Fatalf("StartLogin request = %#v, want provider/baseURL", req)
|
|
}
|
|
if req.Host.AuthDir != authDir || req.Host.ProxyURL != "http://proxy.local" || !req.Host.ForceModelPrefix {
|
|
t.Fatalf("StartLogin host = %#v, want configured summary", req.Host)
|
|
}
|
|
if req.HTTPClient == nil {
|
|
t.Fatal("StartLogin HTTPClient = nil, want host HTTP bridge")
|
|
}
|
|
return pluginapi.AuthLoginStartResponse{
|
|
Provider: req.Provider,
|
|
URL: "http://provider/login",
|
|
State: "state-1",
|
|
ExpiresAt: expiresAt,
|
|
}, nil
|
|
},
|
|
},
|
|
},
|
|
},
|
|
})
|
|
host.runtimeConfig = &config.Config{
|
|
SDKConfig: config.SDKConfig{
|
|
ProxyURL: "http://proxy.local",
|
|
ForceModelPrefix: true,
|
|
},
|
|
AuthDir: authDir,
|
|
}
|
|
|
|
resp, handled, errStart := host.StartLogin(context.Background(), " Plugin-Provider ", "http://localhost:8080/login")
|
|
if errStart != nil {
|
|
t.Fatalf("StartLogin() error = %v", errStart)
|
|
}
|
|
if !handled || !called {
|
|
t.Fatalf("StartLogin() handled=%t called=%t, want handled call", handled, called)
|
|
}
|
|
if resp.Provider != "plugin-provider" || resp.URL != "http://provider/login" || resp.State != "state-1" || !resp.ExpiresAt.Equal(expiresAt) {
|
|
t.Fatalf("StartLogin() response = %#v, want plugin response", resp)
|
|
}
|
|
}
|
|
|
|
func TestPollLoginPassesProviderStateHostAndHTTPClient(t *testing.T) {
|
|
authDir := t.TempDir()
|
|
called := false
|
|
host := newHostWithRecords(capabilityRecord{
|
|
id: "auth-plugin",
|
|
plugin: pluginapi.Plugin{
|
|
Capabilities: pluginapi.Capabilities{
|
|
AuthProvider: fakeAuthProvider{
|
|
identifier: "plugin-provider",
|
|
pollLogin: func(ctx context.Context, req pluginapi.AuthLoginPollRequest) (pluginapi.AuthLoginPollResponse, error) {
|
|
called = true
|
|
if req.Provider != "plugin-provider" || req.State != "state-1" {
|
|
t.Fatalf("PollLogin request = %#v, want provider/state", req)
|
|
}
|
|
if req.Host.AuthDir != authDir || req.Host.ProxyURL != "http://proxy.local" || !req.Host.ForceModelPrefix {
|
|
t.Fatalf("PollLogin host = %#v, want configured summary", req.Host)
|
|
}
|
|
if req.HTTPClient == nil {
|
|
t.Fatal("PollLogin HTTPClient = nil, want host HTTP bridge")
|
|
}
|
|
return pluginapi.AuthLoginPollResponse{
|
|
Status: pluginapi.AuthLoginStatusSuccess,
|
|
Message: "done",
|
|
Auth: pluginapi.AuthData{
|
|
Provider: "plugin-provider",
|
|
ID: "auth-1",
|
|
},
|
|
}, nil
|
|
},
|
|
},
|
|
},
|
|
},
|
|
})
|
|
host.runtimeConfig = &config.Config{
|
|
SDKConfig: config.SDKConfig{
|
|
ProxyURL: "http://proxy.local",
|
|
ForceModelPrefix: true,
|
|
},
|
|
AuthDir: authDir,
|
|
}
|
|
|
|
resp, handled, errPoll := host.PollLogin(context.Background(), " Plugin-Provider ", " state-1 ")
|
|
if errPoll != nil {
|
|
t.Fatalf("PollLogin() error = %v", errPoll)
|
|
}
|
|
if !handled || !called {
|
|
t.Fatalf("PollLogin() handled=%t called=%t, want handled call", handled, called)
|
|
}
|
|
if resp.Status != pluginapi.AuthLoginStatusSuccess || resp.Message != "done" || resp.Auth.ID != "auth-1" {
|
|
t.Fatalf("PollLogin() response = %#v, want plugin response", resp)
|
|
}
|
|
}
|
|
|
|
func TestHostAuthDataToCoreAuthRejectsMissingProviderAndUsesAuthDir(t *testing.T) {
|
|
authDir := t.TempDir()
|
|
host := New()
|
|
host.runtimeConfig = &config.Config{AuthDir: authDir}
|
|
path := filepath.Join(authDir, "nested", "auth.json")
|
|
|
|
if auth := host.AuthDataToCoreAuth(pluginapi.AuthData{ID: "auth-1"}, path, "auth.json"); auth != nil {
|
|
t.Fatalf("AuthDataToCoreAuth() = %#v, want nil for missing provider", auth)
|
|
}
|
|
auth := host.AuthDataToCoreAuth(pluginapi.AuthData{Provider: "Plugin-Provider"}, path, "")
|
|
if auth == nil {
|
|
t.Fatal("AuthDataToCoreAuth() = nil, want auth")
|
|
}
|
|
if auth.Provider != "plugin-provider" || auth.ID != "nested/auth.json" {
|
|
t.Fatalf("AuthDataToCoreAuth() auth = %#v, want normalized provider and relative ID", auth)
|
|
}
|
|
if auth.Metadata["type"] != "plugin-provider" || auth.Attributes["path"] != path || auth.Attributes["source"] != path {
|
|
t.Fatalf("AuthDataToCoreAuth() metadata=%#v attributes=%#v, want path/source/type", auth.Metadata, auth.Attributes)
|
|
}
|
|
}
|
|
|
|
func TestPluginTokenStorageMergesRawMetadataAndProviderType(t *testing.T) {
|
|
storage := &pluginTokenStorage{
|
|
provider: "plugin-provider",
|
|
rawJSON: []byte(`{"old":"value","type":"old-provider"}`),
|
|
}
|
|
storage.SetMetadata(map[string]any{
|
|
"new": "value",
|
|
"old": "override",
|
|
})
|
|
|
|
raw := storage.RawJSON()
|
|
var decoded map[string]any
|
|
if errUnmarshal := json.Unmarshal(raw, &decoded); errUnmarshal != nil {
|
|
t.Fatalf("RawJSON() decode error = %v", errUnmarshal)
|
|
}
|
|
if decoded["old"] != "override" || decoded["new"] != "value" || decoded["type"] != "plugin-provider" {
|
|
t.Fatalf("RawJSON() decoded = %#v, want merged metadata and provider type", decoded)
|
|
}
|
|
|
|
path := filepath.Join(t.TempDir(), "auth.json")
|
|
if errSave := storage.SaveTokenToFile(path); errSave != nil {
|
|
t.Fatalf("SaveTokenToFile() error = %v", errSave)
|
|
}
|
|
saved, errReadFile := os.ReadFile(path)
|
|
if errReadFile != nil {
|
|
t.Fatalf("ReadFile(saved token) error = %v", errReadFile)
|
|
}
|
|
decoded = nil
|
|
if errUnmarshal := json.Unmarshal(saved, &decoded); errUnmarshal != nil {
|
|
t.Fatalf("saved token decode error = %v", errUnmarshal)
|
|
}
|
|
if decoded["old"] != "override" || decoded["new"] != "value" || decoded["type"] != "plugin-provider" {
|
|
t.Fatalf("saved token decoded = %#v, want merged metadata and provider type", decoded)
|
|
}
|
|
}
|
|
|
|
func TestPluginTokenStorageSkipsUnchangedFile(t *testing.T) {
|
|
path := filepath.Join(t.TempDir(), "auth.json")
|
|
if errWriteFile := os.WriteFile(path, []byte(`{"disabled":false,"token":"secret","type":"plugin-provider"}`), 0o600); errWriteFile != nil {
|
|
t.Fatalf("WriteFile() error = %v", errWriteFile)
|
|
}
|
|
before, errStatBefore := os.Stat(path)
|
|
if errStatBefore != nil {
|
|
t.Fatalf("Stat(before) error = %v", errStatBefore)
|
|
}
|
|
storage := &pluginTokenStorage{
|
|
provider: "plugin-provider",
|
|
rawJSON: []byte(`{"token":"secret"}`),
|
|
}
|
|
storage.SetMetadata(map[string]any{"disabled": false})
|
|
|
|
if errSave := storage.SaveTokenToFile(path); errSave != nil {
|
|
t.Fatalf("SaveTokenToFile() error = %v", errSave)
|
|
}
|
|
after, errStatAfter := os.Stat(path)
|
|
if errStatAfter != nil {
|
|
t.Fatalf("Stat(after) error = %v", errStatAfter)
|
|
}
|
|
if !os.SameFile(before, after) {
|
|
t.Fatal("SaveTokenToFile() replaced unchanged auth file, want write skipped")
|
|
}
|
|
}
|
|
|
|
func TestPluginTokenStorageRejectsEmptyPayload(t *testing.T) {
|
|
storage := &pluginTokenStorage{}
|
|
if raw := storage.RawJSON(); raw != nil {
|
|
t.Fatalf("RawJSON() = %q, want nil for empty payload", raw)
|
|
}
|
|
if errSave := storage.SaveTokenToFile(filepath.Join(t.TempDir(), "auth.json")); errSave == nil {
|
|
t.Fatal("SaveTokenToFile() error = nil, want empty payload error")
|
|
}
|
|
}
|