package config_test
import (
"errors"
"github.com/kardolus/chatgpt-cli/config"
"os"
"strings"
"testing"
"github.com/golang/mock/gomock"
. "github.com/onsi/gomega"
"github.com/sclevine/spec"
"github.com/sclevine/spec/report"
)
func TestUnitConfigManager(t *testing.T) {
spec.Run(t, "Config Manager", testConfig, spec.Report(report.Terminal{}))
}
func testConfig(t *testing.T, when spec.G, it spec.S) {
const (
defaultMaxTokens = 10
defaultContextWindow = 20
defaultName = "default-name"
defaultURL = "default-url"
defaultModel = "default-model"
defaultRole = "default-role"
defaultApiKey = "default-api-key"
defaultThread = "default-thread"
defaultCompletionsPath = "default-completions-path"
defaultModelsPath = "default-models-path"
defaultAuthHeader = "default-auth-header"
defaultAuthTokenPrefix = "default-auth-token-prefix"
defaultOmitHistory = false
defaultAutoCreateNewThread = false
defaultTrackTokenUsage = false
defaultSkipTLSVerify = false
defaultTemperature = 1.1
defaultTopP = 2.2
defaultFrequencyPenalty = 3.3
defaultPresencePenalty = 4.4
defaultCommandPrompt = "default-command-prompt"
defaultOutputPrompt = "default-output-prompt"
)
var (
mockCtrl *gomock.Controller
mockConfigStore *MockStore
defaultConfig config.Config
envPrefix string
)
it.Before(func() {
RegisterTestingT(t)
mockCtrl = gomock.NewController(t)
mockConfigStore = NewMockStore(mockCtrl)
defaultConfig = config.Config{
Name: defaultName,
APIKey: defaultApiKey,
Model: defaultModel,
MaxTokens: defaultMaxTokens,
ContextWindow: defaultContextWindow,
URL: defaultURL,
CompletionsPath: defaultCompletionsPath,
ModelsPath: defaultModelsPath,
AuthHeader: defaultAuthHeader,
AuthTokenPrefix: defaultAuthTokenPrefix,
OmitHistory: defaultOmitHistory,
Role: defaultRole,
Thread: defaultThread,
Temperature: defaultTemperature,
TopP: defaultTopP,
FrequencyPenalty: defaultFrequencyPenalty,
PresencePenalty: defaultPresencePenalty,
CommandPrompt: defaultCommandPrompt,
OutputPrompt: defaultOutputPrompt,
AutoCreateNewThread: defaultAutoCreateNewThread,
TrackTokenUsage: defaultTrackTokenUsage,
SkipTLSVerify: defaultSkipTLSVerify,
}
envPrefix = strings.ToUpper(defaultConfig.Name) + "_"
unsetEnvironmentVariables(envPrefix)
})
it.After(func() {
mockCtrl.Finish()
})
it("should use default values when no environment variables or user config are provided", func() {
mockConfigStore.EXPECT().ReadDefaults().Return(defaultConfig).Times(1)
mockConfigStore.EXPECT().Read().Return(config.Config{}, errors.New("no user config")).Times(1)
subject := config.NewManager(mockConfigStore).WithEnvironment()
Expect(subject.Config.MaxTokens).To(Equal(defaultMaxTokens))
Expect(subject.Config.ContextWindow).To(Equal(defaultContextWindow))
Expect(subject.Config.Name).To(Equal(defaultName))
Expect(subject.Config.Model).To(Equal(defaultModel))
Expect(subject.Config.URL).To(Equal(defaultURL))
Expect(subject.Config.CompletionsPath).To(Equal(defaultCompletionsPath))
Expect(subject.Config.ModelsPath).To(Equal(defaultModelsPath))
Expect(subject.Config.AuthHeader).To(Equal(defaultAuthHeader))
Expect(subject.Config.AuthTokenPrefix).To(Equal(defaultAuthTokenPrefix))
Expect(subject.Config.OmitHistory).To(Equal(defaultOmitHistory))
Expect(subject.Config.Role).To(Equal(defaultRole))
Expect(subject.Config.Thread).To(Equal(defaultThread))
Expect(subject.Config.Temperature).To(Equal(defaultTemperature))
Expect(subject.Config.TopP).To(Equal(defaultTopP))
Expect(subject.Config.FrequencyPenalty).To(Equal(defaultFrequencyPenalty))
Expect(subject.Config.PresencePenalty).To(Equal(defaultPresencePenalty))
Expect(subject.Config.CommandPrompt).To(Equal(defaultCommandPrompt))
Expect(subject.Config.OutputPrompt).To(Equal(defaultOutputPrompt))
Expect(subject.Config.AutoCreateNewThread).To(Equal(defaultAutoCreateNewThread))
Expect(subject.Config.TrackTokenUsage).To(Equal(defaultTrackTokenUsage))
Expect(subject.Config.SkipTLSVerify).To(Equal(defaultSkipTLSVerify))
})
it("should prioritize user-provided config over defaults", func() {
userConfig := config.Config{
Model: "user-model",
MaxTokens: 20,
ContextWindow: 30,
URL: "user-url",
CompletionsPath: "user-completions-path",
ModelsPath: "user-models-path",
AuthHeader: "user-auth-header",
AuthTokenPrefix: "user-auth-token-prefix",
OmitHistory: true,
Role: "user-role",
Thread: "user-thread",
Temperature: 2.5,
TopP: 3.5,
FrequencyPenalty: 4.5,
PresencePenalty: 5.5,
CommandPrompt: "user-command-prompt",
OutputPrompt: "user-output-prompt",
AutoCreateNewThread: true,
TrackTokenUsage: true,
SkipTLSVerify: true,
}
mockConfigStore.EXPECT().ReadDefaults().Return(defaultConfig).Times(1)
mockConfigStore.EXPECT().Read().Return(userConfig, nil).Times(1)
subject := config.NewManager(mockConfigStore).WithEnvironment()
Expect(subject.Config.Model).To(Equal("user-model"))
Expect(subject.Config.MaxTokens).To(Equal(20))
Expect(subject.Config.ContextWindow).To(Equal(30))
Expect(subject.Config.URL).To(Equal("user-url"))
Expect(subject.Config.CompletionsPath).To(Equal("user-completions-path"))
Expect(subject.Config.ModelsPath).To(Equal("user-models-path"))
Expect(subject.Config.AuthHeader).To(Equal("user-auth-header"))
Expect(subject.Config.AuthTokenPrefix).To(Equal("user-auth-token-prefix"))
Expect(subject.Config.OmitHistory).To(BeTrue())
Expect(subject.Config.AutoCreateNewThread).To(BeTrue())
Expect(subject.Config.TrackTokenUsage).To(BeTrue())
Expect(subject.Config.SkipTLSVerify).To(BeTrue())
Expect(subject.Config.Role).To(Equal("user-role"))
Expect(subject.Config.Thread).To(Equal("user-thread"))
Expect(subject.Config.Temperature).To(Equal(2.5))
Expect(subject.Config.TopP).To(Equal(3.5))
Expect(subject.Config.FrequencyPenalty).To(Equal(4.5))
Expect(subject.Config.PresencePenalty).To(Equal(5.5))
Expect(subject.Config.CommandPrompt).To(Equal("user-command-prompt"))
Expect(subject.Config.OutputPrompt).To(Equal("user-output-prompt"))
})
it("should prioritize environment variables over default config", func() {
Expect(os.Setenv(envPrefix+"API_KEY", "env-api-key")).To(Succeed())
Expect(os.Setenv(envPrefix+"MODEL", "env-model")).To(Succeed())
Expect(os.Setenv(envPrefix+"MAX_TOKENS", "15")).To(Succeed())
Expect(os.Setenv(envPrefix+"CONTEXT_WINDOW", "25")).To(Succeed())
Expect(os.Setenv(envPrefix+"URL", "env-url")).To(Succeed())
Expect(os.Setenv(envPrefix+"COMPLETIONS_PATH", "env-completions-path")).To(Succeed())
Expect(os.Setenv(envPrefix+"MODELS_PATH", "env-models-path")).To(Succeed())
Expect(os.Setenv(envPrefix+"AUTH_HEADER", "env-auth-header")).To(Succeed())
Expect(os.Setenv(envPrefix+"AUTH_TOKEN_PREFIX", "env-auth-token-prefix")).To(Succeed())
Expect(os.Setenv(envPrefix+"OMIT_HISTORY", "true")).To(Succeed())
Expect(os.Setenv(envPrefix+"AUTO_CREATE_NEW_THREAD", "true")).To(Succeed())
Expect(os.Setenv(envPrefix+"TRACK_TOKEN_USAGE", "true")).To(Succeed())
Expect(os.Setenv(envPrefix+"DEBUG", "true")).To(Succeed())
Expect(os.Setenv(envPrefix+"SKIP_TLS_VERIFY", "true")).To(Succeed())
Expect(os.Setenv(envPrefix+"ROLE", "env-role")).To(Succeed())
Expect(os.Setenv(envPrefix+"THREAD", "env-thread")).To(Succeed())
Expect(os.Setenv(envPrefix+"TEMPERATURE", "2.2")).To(Succeed())
Expect(os.Setenv(envPrefix+"TOP_P", "3.3")).To(Succeed())
Expect(os.Setenv(envPrefix+"FREQUENCY_PENALTY", "4.4")).To(Succeed())
Expect(os.Setenv(envPrefix+"PRESENCE_PENALTY", "5.5")).To(Succeed())
Expect(os.Setenv(envPrefix+"COMMAND_PROMPT", "env-command-prompt")).To(Succeed())
Expect(os.Setenv(envPrefix+"OUTPUT_PROMPT", "env-output-prompt")).To(Succeed())
mockConfigStore.EXPECT().ReadDefaults().Return(defaultConfig).Times(1)
mockConfigStore.EXPECT().Read().Return(config.Config{}, errors.New("config error")).Times(1)
subject := config.NewManager(mockConfigStore).WithEnvironment()
Expect(subject.Config.APIKey).To(Equal("env-api-key"))
Expect(subject.Config.Model).To(Equal("env-model"))
Expect(subject.Config.MaxTokens).To(Equal(15))
Expect(subject.Config.ContextWindow).To(Equal(25))
Expect(subject.Config.URL).To(Equal("env-url"))
Expect(subject.Config.CompletionsPath).To(Equal("env-completions-path"))
Expect(subject.Config.ModelsPath).To(Equal("env-models-path"))
Expect(subject.Config.AuthHeader).To(Equal("env-auth-header"))
Expect(subject.Config.AuthTokenPrefix).To(Equal("env-auth-token-prefix"))
Expect(subject.Config.OmitHistory).To(BeTrue())
Expect(subject.Config.AutoCreateNewThread).To(BeTrue())
Expect(subject.Config.TrackTokenUsage).To(BeTrue())
Expect(subject.Config.SkipTLSVerify).To(BeTrue())
Expect(subject.Config.Role).To(Equal("env-role"))
Expect(subject.Config.Thread).To(Equal("env-thread"))
Expect(subject.Config.Temperature).To(Equal(2.2))
Expect(subject.Config.TopP).To(Equal(3.3))
Expect(subject.Config.FrequencyPenalty).To(Equal(4.4))
Expect(subject.Config.PresencePenalty).To(Equal(5.5))
Expect(subject.Config.CommandPrompt).To(Equal("env-command-prompt"))
Expect(subject.Config.OutputPrompt).To(Equal("env-output-prompt"))
})
it("should prioritize environment variables over user-provided config", func() {
Expect(os.Setenv(envPrefix+"API_KEY", "env-api-key")).To(Succeed())
Expect(os.Setenv(envPrefix+"MODEL", "env-model")).To(Succeed())
Expect(os.Setenv(envPrefix+"MAX_TOKENS", "15")).To(Succeed())
Expect(os.Setenv(envPrefix+"CONTEXT_WINDOW", "25")).To(Succeed())
Expect(os.Setenv(envPrefix+"URL", "env-url")).To(Succeed())
Expect(os.Setenv(envPrefix+"COMPLETIONS_PATH", "env-completions-path")).To(Succeed())
Expect(os.Setenv(envPrefix+"MODELS_PATH", "env-models-path")).To(Succeed())
Expect(os.Setenv(envPrefix+"AUTH_HEADER", "env-auth-header")).To(Succeed())
Expect(os.Setenv(envPrefix+"AUTH_TOKEN_PREFIX", "env-auth-token-prefix")).To(Succeed())
Expect(os.Setenv(envPrefix+"OMIT_HISTORY", "true")).To(Succeed())
Expect(os.Setenv(envPrefix+"AUTO_CREATE_NEW_THREAD", "true")).To(Succeed())
Expect(os.Setenv(envPrefix+"TRACK_TOKEN_USAGE", "true")).To(Succeed())
Expect(os.Setenv(envPrefix+"SKIP_TLS_VERIFY", "true")).To(Succeed())
Expect(os.Setenv(envPrefix+"DEBUG", "false")).To(Succeed())
Expect(os.Setenv(envPrefix+"ROLE", "env-role")).To(Succeed())
Expect(os.Setenv(envPrefix+"THREAD", "env-thread")).To(Succeed())
Expect(os.Setenv(envPrefix+"TEMPERATURE", "2.2")).To(Succeed())
Expect(os.Setenv(envPrefix+"TOP_P", "3.3")).To(Succeed())
Expect(os.Setenv(envPrefix+"FREQUENCY_PENALTY", "4.4")).To(Succeed())
Expect(os.Setenv(envPrefix+"PRESENCE_PENALTY", "5.5")).To(Succeed())
Expect(os.Setenv(envPrefix+"COMMAND_PROMPT", "env-command-prompt")).To(Succeed())
Expect(os.Setenv(envPrefix+"OUTPUT_PROMPT", "env-output-prompt")).To(Succeed())
userConfig := config.Config{
APIKey: "user-api-key",
Model: "user-model",
MaxTokens: 20,
ContextWindow: 30,
URL: "user-url",
CompletionsPath: "user-completions-path",
ModelsPath: "user-models-path",
AuthHeader: "user-auth-header",
AuthTokenPrefix: "user-auth-token-prefix",
OmitHistory: false,
AutoCreateNewThread: false,
TrackTokenUsage: false,
SkipTLSVerify: false,
Role: "user-role",
Thread: "user-thread",
Temperature: 1.5,
TopP: 2.5,
FrequencyPenalty: 3.5,
PresencePenalty: 4.5,
CommandPrompt: "user-command-prompt",
OutputPrompt: "user-output-prompt",
}
mockConfigStore.EXPECT().ReadDefaults().Return(defaultConfig).Times(1)
mockConfigStore.EXPECT().Read().Return(userConfig, nil).Times(1)
subject := config.NewManager(mockConfigStore).WithEnvironment()
Expect(subject.Config.APIKey).To(Equal("env-api-key"))
Expect(subject.Config.Model).To(Equal("env-model"))
Expect(subject.Config.MaxTokens).To(Equal(15))
Expect(subject.Config.ContextWindow).To(Equal(25))
Expect(subject.Config.URL).To(Equal("env-url"))
Expect(subject.Config.CompletionsPath).To(Equal("env-completions-path"))
Expect(subject.Config.ModelsPath).To(Equal("env-models-path"))
Expect(subject.Config.AuthHeader).To(Equal("env-auth-header"))
Expect(subject.Config.AuthTokenPrefix).To(Equal("env-auth-token-prefix"))
Expect(subject.Config.OmitHistory).To(BeTrue())
Expect(subject.Config.AutoCreateNewThread).To(BeTrue())
Expect(subject.Config.TrackTokenUsage).To(BeTrue())
Expect(subject.Config.SkipTLSVerify).To(BeTrue())
Expect(subject.Config.Role).To(Equal("env-role"))
Expect(subject.Config.Thread).To(Equal("env-thread"))
Expect(subject.Config.Temperature).To(Equal(2.2))
Expect(subject.Config.TopP).To(Equal(3.3))
Expect(subject.Config.FrequencyPenalty).To(Equal(4.4))
Expect(subject.Config.PresencePenalty).To(Equal(5.5))
Expect(subject.Config.CommandPrompt).To(Equal("env-command-prompt"))
Expect(subject.Config.OutputPrompt).To(Equal("env-output-prompt"))
})
when("DeleteThread()", func() {
var subject *config.Manager
threadName := "non-active-thread"
it.Before(func() {
userConfig := config.Config{Thread: threadName}
mockConfigStore.EXPECT().ReadDefaults().Return(defaultConfig).Times(1)
mockConfigStore.EXPECT().Read().Return(userConfig, nil).Times(1)
subject = config.NewManager(mockConfigStore).WithEnvironment()
})
it("propagates the error from the config store", func() {
expectedMsg := "expected-error"
mockConfigStore.EXPECT().Delete(threadName).Return(errors.New(expectedMsg)).Times(1)
err := subject.DeleteThread(threadName)
Expect(err).To(HaveOccurred())
Expect(err).To(MatchError(expectedMsg))
})
it("completes successfully the config store throws no error", func() {
mockConfigStore.EXPECT().Delete(threadName).Return(nil).Times(1)
err := subject.DeleteThread(threadName)
Expect(err).NotTo(HaveOccurred())
})
})
when("ListThreads()", func() {
activeThread := "active-thread"
it.Before(func() {
userConfig := config.Config{Thread: activeThread}
mockConfigStore.EXPECT().ReadDefaults().Return(defaultConfig).Times(1)
mockConfigStore.EXPECT().Read().Return(userConfig, nil).Times(1)
})
it("throws an error when the List call fails", func() {
subject := config.NewManager(mockConfigStore).WithEnvironment()
errorInstance := errors.New("an error occurred")
mockConfigStore.EXPECT().List().Return(nil, errorInstance).Times(1)
_, err := subject.ListThreads()
Expect(err).To(HaveOccurred())
Expect(err).To(MatchError(errorInstance))
})
it("returns the expected threads", func() {
subject := config.NewManager(mockConfigStore).WithEnvironment()
threads := []string{"thread1.json", "thread2.json", activeThread + ".json"}
mockConfigStore.EXPECT().List().Return(threads, nil).Times(1)
result, err := subject.ListThreads()
Expect(err).NotTo(HaveOccurred())
Expect(result).To(HaveLen(3))
Expect(result[0]).NotTo(ContainSubstring("current"))
Expect(result[0]).NotTo(ContainSubstring("json"))
Expect(result[1]).NotTo(ContainSubstring("current"))
Expect(result[1]).NotTo(ContainSubstring("json"))
Expect(result[2]).To(ContainSubstring("current"))
Expect(result[2]).NotTo(ContainSubstring("json"))
})
})
when("ShowConfig()", func() {
it("returns the expected config", func() {
mockConfigStore.EXPECT().ReadDefaults().Return(defaultConfig).Times(1)
mockConfigStore.EXPECT().Read().Return(config.Config{
APIKey: "user-api-key",
}, nil).Times(1)
subject := config.NewManager(mockConfigStore).WithEnvironment()
result, err := subject.ShowConfig()
Expect(err).NotTo(HaveOccurred())
Expect(result).To(ContainSubstring("user-api-key"))
})
})
}
func unsetEnvironmentVariables(envPrefix string) {
variables := []string{
"API_KEY",
"MODEL",
"MAX_TOKENS",
"CONTEXT_WINDOW",
"URL",
"COMPLETIONS_PATH",
"MODELS_PATH",
"AUTH_HEADER",
"AUTH_TOKEN_PREFIX",
"OMIT_HISTORY",
"ROLE",
"THREAD",
"TEMPERATURE",
"TOP_P",
"FREQUENCY_PENALTY",
"PRESENCE_PENALTY",
"COMMAND_PROMPT",
"OUTPUT_PROMPT",
"AUTO_CREATE_NEW_THREAD",
"TRACK_TOKEN_USAGE",
"DEBUG",
"SKIP_TLS_VERIFY",
}
for _, variable := range variables {
Expect(os.Unsetenv(envPrefix + variable)).To(Succeed())
}
}
