test: add unit tests for pkg/config package

backend/pkg/config/config_test.go

@@ -0,0 +1,268 @@
+package config
+
+import (
+	"os"
+	"path/filepath"
+	"testing"
+
+	"github.com/google/uuid"
+	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/require"
+)
+
+// clearConfigEnv clears all environment variables referenced by Config struct tags
+// so that tests are hermetic and not affected by ambient environment.
+func clearConfigEnv(t *testing.T) {
+	t.Helper()
+
+	envVars := []string{
+		"DATABASE_URL", "DEBUG", "DATA_DIR", "ASK_USER", "INSTALLATION_ID", "LICENSE_KEY",
+		"DOCKER_INSIDE", "DOCKER_NET_ADMIN", "DOCKER_SOCKET", "DOCKER_NETWORK",
+		"DOCKER_PUBLIC_IP", "DOCKER_WORK_DIR", "DOCKER_DEFAULT_IMAGE", "DOCKER_DEFAULT_IMAGE_FOR_PENTEST",
+		"SERVER_PORT", "SERVER_HOST", "SERVER_USE_SSL", "SERVER_SSL_KEY", "SERVER_SSL_CRT",
+		"STATIC_URL", "STATIC_DIR", "CORS_ORIGINS", "COOKIE_SIGNING_SALT",
+		"SCRAPER_PUBLIC_URL", "SCRAPER_PRIVATE_URL",
+		"OPEN_AI_KEY", "OPEN_AI_SERVER_URL",
+		"ANTHROPIC_API_KEY", "ANTHROPIC_SERVER_URL",
+		"EMBEDDING_URL", "EMBEDDING_KEY", "EMBEDDING_MODEL",
+		"EMBEDDING_STRIP_NEW_LINES", "EMBEDDING_BATCH_SIZE", "EMBEDDING_PROVIDER",
+		"SUMMARIZER_PRESERVE_LAST", "SUMMARIZER_USE_QA", "SUMMARIZER_SUM_MSG_HUMAN_IN_QA",
+		"SUMMARIZER_LAST_SEC_BYTES", "SUMMARIZER_MAX_BP_BYTES",
+		"SUMMARIZER_MAX_QA_SECTIONS", "SUMMARIZER_MAX_QA_BYTES", "SUMMARIZER_KEEP_QA_SECTIONS",
+		"LLM_SERVER_URL", "LLM_SERVER_KEY", "LLM_SERVER_MODEL", "LLM_SERVER_PROVIDER",
+		"LLM_SERVER_CONFIG_PATH", "LLM_SERVER_LEGACY_REASONING", "LLM_SERVER_PRESERVE_REASONING",
+		"OLLAMA_SERVER_URL", "OLLAMA_SERVER_API_KEY", "OLLAMA_SERVER_MODEL",
+		"OLLAMA_SERVER_CONFIG_PATH", "OLLAMA_SERVER_PULL_MODELS_TIMEOUT",
+		"OLLAMA_SERVER_PULL_MODELS_ENABLED", "OLLAMA_SERVER_LOAD_MODELS_ENABLED",
+		"GEMINI_API_KEY", "GEMINI_SERVER_URL",
+		"BEDROCK_REGION", "BEDROCK_DEFAULT_AUTH", "BEDROCK_BEARER_TOKEN",
+		"BEDROCK_ACCESS_KEY_ID", "BEDROCK_SECRET_ACCESS_KEY", "BEDROCK_SESSION_TOKEN", "BEDROCK_SERVER_URL",
+		"DEEPSEEK_API_KEY", "DEEPSEEK_SERVER_URL", "DEEPSEEK_PROVIDER",
+		"GLM_API_KEY", "GLM_SERVER_URL", "GLM_PROVIDER",
+		"KIMI_API_KEY", "KIMI_SERVER_URL", "KIMI_PROVIDER",
+		"QWEN_API_KEY", "QWEN_SERVER_URL", "QWEN_PROVIDER",
+		"DUCKDUCKGO_ENABLED", "DUCKDUCKGO_REGION", "DUCKDUCKGO_SAFESEARCH", "DUCKDUCKGO_TIME_RANGE",
+		"SPLOITUS_ENABLED",
+		"GOOGLE_API_KEY", "GOOGLE_CX_KEY", "GOOGLE_LR_KEY",
+		"OAUTH_GOOGLE_CLIENT_ID", "OAUTH_GOOGLE_CLIENT_SECRET",
+		"OAUTH_GITHUB_CLIENT_ID", "OAUTH_GITHUB_CLIENT_SECRET",
+		"PUBLIC_URL", "TRAVERSAAL_API_KEY", "TAVILY_API_KEY",
+		"PERPLEXITY_API_KEY", "PERPLEXITY_MODEL", "PERPLEXITY_CONTEXT_SIZE",
+		"SEARXNG_URL", "SEARXNG_CATEGORIES", "SEARXNG_LANGUAGE",
+		"SEARXNG_SAFESEARCH", "SEARXNG_TIME_RANGE", "SEARXNG_TIMEOUT",
+		"ASSISTANT_USE_AGENTS", "ASSISTANT_SUMMARIZER_PRESERVE_LAST",
+		"ASSISTANT_SUMMARIZER_LAST_SEC_BYTES", "ASSISTANT_SUMMARIZER_MAX_BP_BYTES",
+		"ASSISTANT_SUMMARIZER_MAX_QA_SECTIONS", "ASSISTANT_SUMMARIZER_MAX_QA_BYTES",
+		"ASSISTANT_SUMMARIZER_KEEP_QA_SECTIONS",
+		"PROXY_URL", "EXTERNAL_SSL_CA_PATH", "EXTERNAL_SSL_INSECURE",
+		"OTEL_HOST", "LANGFUSE_BASE_URL", "LANGFUSE_PROJECT_ID", "LANGFUSE_PUBLIC_KEY", "LANGFUSE_SECRET_KEY",
+		"GRAPHITI_ENABLED", "GRAPHITI_TIMEOUT", "GRAPHITI_URL",
+	}
+	for _, v := range envVars {
+		t.Setenv(v, "")
+	}
+}
+
+func TestNewConfig_Defaults(t *testing.T) {
+	clearConfigEnv(t)
+	t.Chdir(t.TempDir())
+
+	config, err := NewConfig()
+	require.NoError(t, err)
+	require.NotNil(t, config)
+
+	assert.Equal(t, 8080, config.ServerPort)
+	assert.Equal(t, "0.0.0.0", config.ServerHost)
+	assert.Equal(t, false, config.Debug)
+	assert.Equal(t, "./data", config.DataDir)
+	assert.Equal(t, false, config.ServerUseSSL)
+	assert.Equal(t, "openai", config.EmbeddingProvider)
+	assert.Equal(t, 512, config.EmbeddingBatchSize)
+	assert.Equal(t, true, config.EmbeddingStripNewLines)
+	assert.Equal(t, true, config.DuckDuckGoEnabled)
+	assert.Equal(t, "debian:latest", config.DockerDefaultImage)
+	assert.Equal(t, "vxcontrol/kali-linux", config.DockerDefaultImageForPentest)
+}
+
+func TestNewConfig_EnvOverride(t *testing.T) {
+	clearConfigEnv(t)
+	t.Chdir(t.TempDir())
+
+	t.Setenv("SERVER_PORT", "9090")
+	t.Setenv("SERVER_HOST", "127.0.0.1")
+	t.Setenv("DEBUG", "true")
+
+	config, err := NewConfig()
+	require.NoError(t, err)
+	require.NotNil(t, config)
+
+	assert.Equal(t, 9090, config.ServerPort)
+	assert.Equal(t, "127.0.0.1", config.ServerHost)
+	assert.Equal(t, true, config.Debug)
+}
+
+func TestNewConfig_ProviderDefaults(t *testing.T) {
+	clearConfigEnv(t)
+	t.Chdir(t.TempDir())
+
+	config, err := NewConfig()
+	require.NoError(t, err)
+
+	assert.Equal(t, "https://api.openai.com/v1", config.OpenAIServerURL)
+	assert.Equal(t, "https://api.anthropic.com/v1", config.AnthropicServerURL)
+	assert.Equal(t, "https://generativelanguage.googleapis.com", config.GeminiServerURL)
+	assert.Equal(t, "us-east-1", config.BedrockRegion)
+	assert.Equal(t, "https://api.deepseek.com", config.DeepSeekServerURL)
+	assert.Equal(t, "https://api.z.ai/api/paas/v4", config.GLMServerURL)
+	assert.Equal(t, "https://api.moonshot.ai/v1", config.KimiServerURL)
+	assert.Equal(t, "https://dashscope-us.aliyuncs.com/compatible-mode/v1", config.QwenServerURL)
+}
+
+func TestNewConfig_StaticURL(t *testing.T) {
+	clearConfigEnv(t)
+	t.Chdir(t.TempDir())
+
+	t.Setenv("STATIC_URL", "https://example.com/static")
+
+	config, err := NewConfig()
+	require.NoError(t, err)
+	require.NotNil(t, config.StaticURL)
+
+	assert.Equal(t, "https", config.StaticURL.Scheme)
+	assert.Equal(t, "example.com", config.StaticURL.Host)
+	assert.Equal(t, "/static", config.StaticURL.Path)
+}
+
+func TestNewConfig_StaticURL_Empty(t *testing.T) {
+	clearConfigEnv(t)
+	t.Chdir(t.TempDir())
+
+	config, err := NewConfig()
+	require.NoError(t, err)
+	assert.Nil(t, config.StaticURL)
+}
+
+func TestNewConfig_SummarizerDefaults(t *testing.T) {
+	clearConfigEnv(t)
+	t.Chdir(t.TempDir())
+
+	config, err := NewConfig()
+	require.NoError(t, err)
+
+	assert.Equal(t, true, config.SummarizerPreserveLast)
+	assert.Equal(t, true, config.SummarizerUseQA)
+	assert.Equal(t, false, config.SummarizerSumHumanInQA)
+	assert.Equal(t, 51200, config.SummarizerLastSecBytes)
+	assert.Equal(t, 16384, config.SummarizerMaxBPBytes)
+	assert.Equal(t, 10, config.SummarizerMaxQASections)
+	assert.Equal(t, 65536, config.SummarizerMaxQABytes)
+	assert.Equal(t, 1, config.SummarizerKeepQASections)
+}
+
+func TestNewConfig_SearchEngineDefaults(t *testing.T) {
+	clearConfigEnv(t)
+	t.Chdir(t.TempDir())
+
+	config, err := NewConfig()
+	require.NoError(t, err)
+
+	assert.Equal(t, "sonar", config.PerplexityModel)
+	assert.Equal(t, "low", config.PerplexityContextSize)
+	assert.Equal(t, "general", config.SearxngCategories)
+	assert.Equal(t, "0", config.SearxngSafeSearch)
+	assert.Equal(t, "lang_en", config.GoogleLRKey)
+}
+
+func TestEnsureInstallationID_GeneratesNewUUID(t *testing.T) {
+	tmpDir := t.TempDir()
+	config := &Config{
+		DataDir: tmpDir,
+	}
+
+	ensureInstallationID(config)
+
+	assert.NotEmpty(t, config.InstallationID)
+	assert.NoError(t, uuid.Validate(config.InstallationID))
+
+	// verify file was written
+	data, err := os.ReadFile(filepath.Join(tmpDir, "installation_id"))
+	require.NoError(t, err)
+	assert.Equal(t, config.InstallationID, string(data))
+}
+
+func TestEnsureInstallationID_ReadsExistingFile(t *testing.T) {
+	tmpDir := t.TempDir()
+	existingID := uuid.New().String()
+	err := os.WriteFile(filepath.Join(tmpDir, "installation_id"), []byte(existingID), 0644)
+	require.NoError(t, err)
+
+	config := &Config{
+		DataDir: tmpDir,
+	}
+
+	ensureInstallationID(config)
+
+	assert.Equal(t, existingID, config.InstallationID)
+}
+
+func TestEnsureInstallationID_KeepsValidEnvValue(t *testing.T) {
+	envID := uuid.New().String()
+	config := &Config{
+		InstallationID: envID,
+		DataDir:        t.TempDir(),
+	}
+
+	ensureInstallationID(config)
+
+	assert.Equal(t, envID, config.InstallationID)
+}
+
+func TestEnsureInstallationID_ReplacesInvalidEnvValue(t *testing.T) {
+	tmpDir := t.TempDir()
+	config := &Config{
+		InstallationID: "not-a-valid-uuid",
+		DataDir:        tmpDir,
+	}
+
+	ensureInstallationID(config)
+
+	assert.NotEqual(t, "not-a-valid-uuid", config.InstallationID)
+	assert.NoError(t, uuid.Validate(config.InstallationID))
+}
+
+func TestEnsureInstallationID_ReplacesInvalidFileContent(t *testing.T) {
+	tmpDir := t.TempDir()
+	err := os.WriteFile(filepath.Join(tmpDir, "installation_id"), []byte("garbage"), 0644)
+	require.NoError(t, err)
+
+	config := &Config{
+		DataDir: tmpDir,
+	}
+
+	ensureInstallationID(config)
+
+	assert.NotEqual(t, "garbage", config.InstallationID)
+	assert.NoError(t, uuid.Validate(config.InstallationID))
+}
+
+func TestNewConfig_CorsOrigins(t *testing.T) {
+	clearConfigEnv(t)
+	t.Chdir(t.TempDir())
+
+	config, err := NewConfig()
+	require.NoError(t, err)
+
+	assert.Equal(t, []string{"*"}, config.CorsOrigins)
+}
+
+func TestNewConfig_OllamaDefaults(t *testing.T) {
+	clearConfigEnv(t)
+	t.Chdir(t.TempDir())
+
+	config, err := NewConfig()
+	require.NoError(t, err)
+
+	assert.Equal(t, 600, config.OllamaServerPullModelsTimeout)
+	assert.Equal(t, false, config.OllamaServerPullModelsEnabled)
+	assert.Equal(t, false, config.OllamaServerLoadModelsEnabled)
+}