Files
skillshare/internal/audit/policy.go
T
Willie 0d59f15db4 refactor(cli): deduplicate JSON output helpers and fix ResolvePolicy semantics
- Extract writeJSONResult() to replace 5 identical write+silent-error trailers
- Replace local isRepoDirty() with existing git.IsDirty() (8 call sites)
- Use defer for suppressUIToDevnull restore instead of manual calls at each
  return site in install.go and update.go (prevents stdout leak on new paths)
- Fix ResolvePolicy always filling EnabledAnalyzers, which broke the
  nil-means-all contract for ForPolicy; add EffectiveAnalyzers() for display
- Simplify collectOutputJSON double map allocation
- Remove unnecessary string conversion in writeJSONError
2026-03-06 02:15:36 +08:00

117 lines
2.7 KiB
Go

package audit
// Profile is a preset shorthand for audit policy settings.
type Profile string
const (
ProfileDefault Profile = "default"
ProfileStrict Profile = "strict"
ProfilePermissive Profile = "permissive"
)
// DedupeMode controls how duplicate findings are handled.
type DedupeMode string
const (
DedupeLegacy DedupeMode = "legacy"
DedupeGlobal DedupeMode = "global"
)
// Policy holds resolved audit policy settings.
type Policy struct {
Profile Profile
Threshold string
DedupeMode DedupeMode
EnabledAnalyzers []string // nil = all enabled (default)
}
// PolicyInputs carries raw inputs from CLI flags and config for resolution.
type PolicyInputs struct {
Profile string // CLI --profile
Threshold string // CLI --threshold (already normalized)
Dedupe string // CLI --dedupe
ConfigProfile string
ConfigThreshold string
ConfigDedupe string
EnabledAnalyzers []string // CLI --analyzer (repeatable)
ConfigAnalyzers []string // config.yaml audit.enabled_analyzers
}
var profilePresets = map[Profile]struct {
Threshold string
DedupeMode DedupeMode
}{
ProfileDefault: {SeverityCritical, DedupeGlobal},
ProfileStrict: {SeverityHigh, DedupeGlobal},
ProfilePermissive: {SeverityCritical, DedupeLegacy},
}
func ResolvePolicy(in PolicyInputs) Policy {
profile := resolveProfile(in.Profile, in.ConfigProfile)
preset := profilePresets[profile]
threshold := coalesce(in.Threshold, in.ConfigThreshold)
if threshold == "" {
threshold = preset.Threshold
}
dedupe := resolveDedupeMode(coalesce(in.Dedupe, in.ConfigDedupe))
if dedupe == "" {
dedupe = preset.DedupeMode
}
analyzers := in.EnabledAnalyzers
if len(analyzers) == 0 {
analyzers = in.ConfigAnalyzers
}
// Keep nil when no explicit filter — nil means "all enabled" for ForPolicy.
return Policy{
Profile: profile,
Threshold: threshold,
DedupeMode: dedupe,
EnabledAnalyzers: analyzers,
}
}
// EffectiveAnalyzers returns the active analyzer IDs.
// If EnabledAnalyzers is nil (meaning "all"), it returns the full built-in set.
func (p Policy) EffectiveAnalyzers() []string {
if len(p.EnabledAnalyzers) > 0 {
return p.EnabledAnalyzers
}
return DefaultRegistry().IDs()
}
func resolveProfile(cli, cfg string) Profile {
raw := coalesce(cli, cfg)
switch Profile(raw) {
case ProfileDefault, ProfileStrict, ProfilePermissive:
return Profile(raw)
default:
return ProfileDefault
}
}
func resolveDedupeMode(raw string) DedupeMode {
switch DedupeMode(raw) {
case DedupeLegacy, DedupeGlobal:
return DedupeMode(raw)
case "":
return ""
default:
return DedupeLegacy
}
}
func coalesce(values ...string) string {
for _, v := range values {
if v != "" {
return v
}
}
return ""
}