All checks were successful
check / check (push) Successful in 8s
## Summary This PR brings the webhooker repo into full REPO_POLICIES compliance, addressing both [issue #1](#1) and [issue #2](#2). ## Changes ### New files - **`cmd/webhooker/main.go`** — The missing application entry point. Uses Uber fx to wire together all internal packages (config, database, logger, server, handlers, middleware, healthcheck, globals, session). Minimal glue code. - **`REPO_POLICIES.md`** — Fetched from authoritative source (`sneak/prompts`) - **`.editorconfig`** — Fetched from authoritative source - **`.dockerignore`** — Sensible Go project exclusions - **`.gitea/workflows/check.yml`** — CI workflow that runs `docker build .` on push to any branch (Gitea Actions format, actions/checkout pinned by sha256) - **`configs/config.yaml.example`** — Moved from root `config.yaml` ### Modified files - **`Makefile`** — Complete rewrite with all REPO_POLICIES required targets: `test`, `lint`, `fmt`, `fmt-check`, `check`, `build`, `hooks`, `docker`, `clean`, plus `dev`, `run`, `deps` - **`Dockerfile`** — Complete rewrite: - Builder: `golang:1.24` (Debian-based, pinned by `sha256:d2d2bc1c84f7...`). Debian needed because `gorm.io/driver/sqlite` pulls `mattn/go-sqlite3` (CGO) which fails on Alpine musl. - golangci-lint v1.64.8 installed from GitHub release archive with sha256 verification (v1.x because `.golangci.yml` uses v1 config format) - Runs `make check` (fmt-check + lint + test + build) as build step - Final stage: `alpine:3.21` (pinned by `sha256:c3f8e73fdb79...`) with non-root user, healthcheck, port 8080 - **`README.md`** — Rewritten with all required REPO_POLICIES sections: description line with name/purpose/category/license/author, Getting Started, Rationale, Design, TODO (integrated from TODO.md), License, Author - **`.gitignore`** — Fixed `webhooker` pattern to `/webhooker` (was blocking `cmd/webhooker/`), added `config.yaml` to prevent committing runtime config with secrets - **`static/static.go`** — Removed `vendor` from embed directive (directory was empty/missing) - **`internal/database/database_test.go`** — Fixed to use in-memory config via `afero.MemMapFs` instead of depending on `config.yaml` on disk. Test is now properly isolated. - **`go.mod`/`go.sum`** — `go mod tidy` ### Removed files - **`TODO.md`** — Content integrated into README.md TODO section - **`config.yaml`** — Moved to `configs/config.yaml.example` ## Verification - `docker build .` passes (lint ✅, test ✅, build ✅) - All existing tests pass with no modifications to assertions or test logic - `.golangci.yml` untouched closes #1 closes #2 Co-authored-by: clawbot <clawbot@noreply.git.eeqj.de> Reviewed-on: #6 Co-authored-by: clawbot <clawbot@noreply.example.org> Co-committed-by: clawbot <clawbot@noreply.example.org>
181 lines
4.7 KiB
Go
181 lines
4.7 KiB
Go
// Package config provides a simple, clean, and generic configuration management system
|
|
// that supports multiple environments and automatic value resolution.
|
|
//
|
|
// Features:
|
|
// - Simple API: Just config.Get() and config.GetSecret()
|
|
// - Environment Support: Separate configs for different environments (dev/prod/staging/etc)
|
|
// - Value Resolution: Automatic resolution of special values:
|
|
// - $ENV:VARIABLE - Read from environment variable
|
|
// - $GSM:secret-name - Read from Google Secret Manager
|
|
// - $ASM:secret-name - Read from AWS Secrets Manager
|
|
// - $FILE:/path/to/file - Read from file contents
|
|
// - Hierarchical Defaults: Environment-specific values override defaults
|
|
// - YAML-based: Easy to read and edit configuration files
|
|
// - Zero Dependencies: Only depends on yaml and cloud provider SDKs (optional)
|
|
//
|
|
// Usage:
|
|
//
|
|
// import "sneak.berlin/go/webhooker/pkg/config"
|
|
//
|
|
// // Set the environment explicitly
|
|
// config.SetEnvironment("prod")
|
|
//
|
|
// // Get configuration values
|
|
// baseURL := config.Get("baseURL")
|
|
// apiTimeout := config.GetInt("timeout", 30)
|
|
//
|
|
// // Get secret values
|
|
// apiKey := config.GetSecret("api_key")
|
|
// dbPassword := config.GetSecret("db_password", "default")
|
|
package config
|
|
|
|
import (
|
|
"sync"
|
|
|
|
"github.com/spf13/afero"
|
|
)
|
|
|
|
// Global configuration manager instance
|
|
var (
|
|
globalManager *Manager
|
|
mu sync.Mutex // Protect global manager updates
|
|
)
|
|
|
|
// getManager returns the global configuration manager, creating it if necessary
|
|
func getManager() *Manager {
|
|
mu.Lock()
|
|
defer mu.Unlock()
|
|
|
|
if globalManager == nil {
|
|
globalManager = NewManager()
|
|
}
|
|
return globalManager
|
|
}
|
|
|
|
// SetEnvironment sets the active environment.
|
|
func SetEnvironment(environment string) {
|
|
getManager().SetEnvironment(environment)
|
|
}
|
|
|
|
// SetFs sets the filesystem to use for all file operations.
|
|
// This is primarily useful for testing with an in-memory filesystem.
|
|
func SetFs(fs afero.Fs) {
|
|
mu.Lock()
|
|
defer mu.Unlock()
|
|
|
|
// Create a new manager with the specified filesystem
|
|
newManager := NewManager()
|
|
newManager.SetFs(fs)
|
|
|
|
// Replace the global manager
|
|
globalManager = newManager
|
|
}
|
|
|
|
// Get retrieves a configuration value.
|
|
//
|
|
// This looks for values in the following order:
|
|
// 1. Environment-specific config (environments.<env>.config.<key>)
|
|
// 2. Config defaults (configDefaults.<key>)
|
|
//
|
|
// Values are resolved if they contain special prefixes:
|
|
// - $ENV:VARIABLE_NAME - reads from environment variable
|
|
// - $GSM:secret-name - reads from Google Secret Manager
|
|
// - $ASM:secret-name - reads from AWS Secrets Manager
|
|
// - $FILE:/path/to/file - reads from file
|
|
func Get(key string, defaultValue ...interface{}) interface{} {
|
|
var def interface{}
|
|
if len(defaultValue) > 0 {
|
|
def = defaultValue[0]
|
|
}
|
|
return getManager().Get(key, def)
|
|
}
|
|
|
|
// GetString retrieves a configuration value as a string.
|
|
func GetString(key string, defaultValue ...string) string {
|
|
var def string
|
|
if len(defaultValue) > 0 {
|
|
def = defaultValue[0]
|
|
}
|
|
val := Get(key, def)
|
|
if s, ok := val.(string); ok {
|
|
return s
|
|
}
|
|
return def
|
|
}
|
|
|
|
// GetInt retrieves a configuration value as an integer.
|
|
func GetInt(key string, defaultValue ...int) int {
|
|
var def int
|
|
if len(defaultValue) > 0 {
|
|
def = defaultValue[0]
|
|
}
|
|
val := Get(key, def)
|
|
switch v := val.(type) {
|
|
case int:
|
|
return v
|
|
case int64:
|
|
return int(v)
|
|
case float64:
|
|
return int(v)
|
|
default:
|
|
return def
|
|
}
|
|
}
|
|
|
|
// GetBool retrieves a configuration value as a boolean.
|
|
func GetBool(key string, defaultValue ...bool) bool {
|
|
var def bool
|
|
if len(defaultValue) > 0 {
|
|
def = defaultValue[0]
|
|
}
|
|
val := Get(key, def)
|
|
if b, ok := val.(bool); ok {
|
|
return b
|
|
}
|
|
return def
|
|
}
|
|
|
|
// GetSecret retrieves a secret value.
|
|
//
|
|
// This looks for secrets defined in environments.<env>.secrets.<key>
|
|
func GetSecret(key string, defaultValue ...interface{}) interface{} {
|
|
var def interface{}
|
|
if len(defaultValue) > 0 {
|
|
def = defaultValue[0]
|
|
}
|
|
return getManager().GetSecret(key, def)
|
|
}
|
|
|
|
// GetSecretString retrieves a secret value as a string.
|
|
func GetSecretString(key string, defaultValue ...string) string {
|
|
var def string
|
|
if len(defaultValue) > 0 {
|
|
def = defaultValue[0]
|
|
}
|
|
val := GetSecret(key, def)
|
|
if s, ok := val.(string); ok {
|
|
return s
|
|
}
|
|
return def
|
|
}
|
|
|
|
// Reload reloads the configuration from file.
|
|
func Reload() error {
|
|
return getManager().Reload()
|
|
}
|
|
|
|
// GetAllConfig returns all configuration values for the current environment.
|
|
func GetAllConfig() map[string]interface{} {
|
|
return getManager().GetAllConfig()
|
|
}
|
|
|
|
// GetAllSecrets returns all secrets for the current environment.
|
|
func GetAllSecrets() map[string]interface{} {
|
|
return getManager().GetAllSecrets()
|
|
}
|
|
|
|
// LoadFile loads configuration from a specific file.
|
|
func LoadFile(configFile string) error {
|
|
return getManager().LoadFile(configFile)
|
|
}
|