* feat: implement centralized configuration service using viper This commit introduces a centralized configuration service in `pkg/config` to reduce code duplication and provide a unified way to manage configuration across the project. Key changes: - Refactored `pkg/config` to use `github.com/spf13/viper` as the backend. - Implemented `core.Config` interface with support for layered resolution (defaults, files, environment variables). - Added `LoadFile` to support merging multiple configuration files, with automatic type detection for YAML and .env files. - Migrated `pkg/agentic`, `pkg/devops`, `pkg/build`, and `pkg/release` to use the new centralized service. - Added `mapstructure` tags to configuration structs to support viper unmarshaling. - Added comprehensive tests for the new configuration service features. This addresses the recommendations from the Architecture & Design Pattern Audit. * feat: implement centralized configuration service and address security alerts - Introduced centralized configuration service in `pkg/config` using `viper`. - Migrated major packages (`agentic`, `devops`, `build`, `release`) to the new service. - Resolved merge conflicts with `dev` branch. - Addressed CodeQL security alert by making UniFi TLS verification configurable. - Fixed `go.mod` to ensure it is tidy and consistent with direct dependencies. - Updated UniFi CLI to support TLS verification configuration.
169 lines
5 KiB
Go
169 lines
5 KiB
Go
// Package build provides project type detection and cross-compilation for the Core build system.
|
|
// This file handles configuration loading from .core/build.yaml files.
|
|
package build
|
|
|
|
import (
|
|
"fmt"
|
|
"path/filepath"
|
|
|
|
"github.com/host-uk/core/pkg/build/signing"
|
|
"github.com/host-uk/core/pkg/config"
|
|
"github.com/host-uk/core/pkg/io"
|
|
)
|
|
|
|
// ConfigFileName is the name of the build configuration file.
|
|
const ConfigFileName = "build.yaml"
|
|
|
|
// ConfigDir is the directory where build configuration is stored.
|
|
const ConfigDir = ".core"
|
|
|
|
// BuildConfig holds the complete build configuration loaded from .core/build.yaml.
|
|
// This is distinct from Config which holds runtime build parameters.
|
|
type BuildConfig struct {
|
|
// Version is the config file format version.
|
|
Version int `yaml:"version" mapstructure:"version"`
|
|
// Project contains project metadata.
|
|
Project Project `yaml:"project" mapstructure:"project"`
|
|
// Build contains build settings.
|
|
Build Build `yaml:"build" mapstructure:"build"`
|
|
// Targets defines the build targets.
|
|
Targets []TargetConfig `yaml:"targets" mapstructure:"targets"`
|
|
// Sign contains code signing configuration.
|
|
Sign signing.SignConfig `yaml:"sign,omitempty" mapstructure:"sign,omitempty"`
|
|
}
|
|
|
|
// Project holds project metadata.
|
|
type Project struct {
|
|
// Name is the project name.
|
|
Name string `yaml:"name" mapstructure:"name"`
|
|
// Description is a brief description of the project.
|
|
Description string `yaml:"description" mapstructure:"description"`
|
|
// Main is the path to the main package (e.g., ./cmd/core).
|
|
Main string `yaml:"main" mapstructure:"main"`
|
|
// Binary is the output binary name.
|
|
Binary string `yaml:"binary" mapstructure:"binary"`
|
|
}
|
|
|
|
// Build holds build-time settings.
|
|
type Build struct {
|
|
// CGO enables CGO for the build.
|
|
CGO bool `yaml:"cgo" mapstructure:"cgo"`
|
|
// Flags are additional build flags (e.g., ["-trimpath"]).
|
|
Flags []string `yaml:"flags" mapstructure:"flags"`
|
|
// LDFlags are linker flags (e.g., ["-s", "-w"]).
|
|
LDFlags []string `yaml:"ldflags" mapstructure:"ldflags"`
|
|
// Env are additional environment variables.
|
|
Env []string `yaml:"env" mapstructure:"env"`
|
|
}
|
|
|
|
// TargetConfig defines a build target in the config file.
|
|
// This is separate from Target to allow for additional config-specific fields.
|
|
type TargetConfig struct {
|
|
// OS is the target operating system (e.g., "linux", "darwin", "windows").
|
|
OS string `yaml:"os" mapstructure:"os"`
|
|
// Arch is the target architecture (e.g., "amd64", "arm64").
|
|
Arch string `yaml:"arch" mapstructure:"arch"`
|
|
}
|
|
|
|
// LoadConfig loads build configuration from the .core/build.yaml file in the given directory.
|
|
// If the config file does not exist, it returns DefaultConfig().
|
|
// Returns an error if the file exists but cannot be parsed.
|
|
func LoadConfig(fs io.Medium, dir string) (*BuildConfig, error) {
|
|
configPath := filepath.Join(dir, ConfigDir, ConfigFileName)
|
|
|
|
if !fs.Exists(configPath) {
|
|
return DefaultConfig(), nil
|
|
}
|
|
|
|
// Use centralized config service
|
|
c, err := config.New(config.WithMedium(fs), config.WithPath(configPath))
|
|
if err != nil {
|
|
return nil, fmt.Errorf("build.LoadConfig: %w", err)
|
|
}
|
|
|
|
cfg := DefaultConfig()
|
|
if err := c.Get("", cfg); err != nil {
|
|
return nil, fmt.Errorf("build.LoadConfig: %w", err)
|
|
}
|
|
|
|
// Apply defaults for any missing fields (centralized Get might not fill everything)
|
|
applyDefaults(cfg)
|
|
|
|
return cfg, nil
|
|
}
|
|
|
|
// DefaultConfig returns sensible defaults for Go projects.
|
|
func DefaultConfig() *BuildConfig {
|
|
return &BuildConfig{
|
|
Version: 1,
|
|
Project: Project{
|
|
Name: "",
|
|
Main: ".",
|
|
Binary: "",
|
|
},
|
|
Build: Build{
|
|
CGO: false,
|
|
Flags: []string{"-trimpath"},
|
|
LDFlags: []string{"-s", "-w"},
|
|
Env: []string{},
|
|
},
|
|
Targets: []TargetConfig{
|
|
{OS: "linux", Arch: "amd64"},
|
|
{OS: "linux", Arch: "arm64"},
|
|
{OS: "darwin", Arch: "arm64"},
|
|
{OS: "windows", Arch: "amd64"},
|
|
},
|
|
Sign: signing.DefaultSignConfig(),
|
|
}
|
|
}
|
|
|
|
// applyDefaults fills in default values for any empty fields in the config.
|
|
func applyDefaults(cfg *BuildConfig) {
|
|
defaults := DefaultConfig()
|
|
|
|
if cfg.Version == 0 {
|
|
cfg.Version = defaults.Version
|
|
}
|
|
|
|
if cfg.Project.Main == "" {
|
|
cfg.Project.Main = defaults.Project.Main
|
|
}
|
|
|
|
if cfg.Build.Flags == nil {
|
|
cfg.Build.Flags = defaults.Build.Flags
|
|
}
|
|
|
|
if cfg.Build.LDFlags == nil {
|
|
cfg.Build.LDFlags = defaults.Build.LDFlags
|
|
}
|
|
|
|
if cfg.Build.Env == nil {
|
|
cfg.Build.Env = defaults.Build.Env
|
|
}
|
|
|
|
if len(cfg.Targets) == 0 {
|
|
cfg.Targets = defaults.Targets
|
|
}
|
|
|
|
// Expand environment variables in sign config
|
|
cfg.Sign.ExpandEnv()
|
|
}
|
|
|
|
// ConfigPath returns the path to the build config file for a given directory.
|
|
func ConfigPath(dir string) string {
|
|
return filepath.Join(dir, ConfigDir, ConfigFileName)
|
|
}
|
|
|
|
// ConfigExists checks if a build config file exists in the given directory.
|
|
func ConfigExists(fs io.Medium, dir string) bool {
|
|
return fs.IsFile(ConfigPath(dir))
|
|
}
|
|
|
|
// ToTargets converts TargetConfig slice to Target slice for use with builders.
|
|
func (cfg *BuildConfig) ToTargets() []Target {
|
|
targets := make([]Target, len(cfg.Targets))
|
|
for i, t := range cfg.Targets {
|
|
targets[i] = Target(t)
|
|
}
|
|
return targets
|
|
}
|