Files
pmg/config/cooldown_skip_test.go
Sahil BansalandGitHub 2d938ea381 feat: advisory message appended to block output (#362)
* docs(specs): add custom block messages and package blocklist spec

* docs(specs): add custom block messages and package blocklist implementation plan

* feat(config): add blocked_packages list and custom block messages

* feat(audit): add package_blocklist_blocked event and blocklist model

* feat(proxy): block blocklisted packages in the policy gate before analysis

* feat(guard): block blocklisted packages before trust skip and analysis

* feat(ui): render blocklist blocks and custom messages, fix silent-mode block output

* feat(proxy): append custom messages to malware and go-cooldown block bodies

* test(proxye2e): cover blocklist enforcement and custom block messages

* docs(specs): remove spec and plan documents

* refactor: drop guard-flow blocklist enforcement and trim docs

Guard mode is being deprecated; the blocklist is enforced in proxy mode
only. Remove the trusted_packages mirroring references outside the docs.

* refactor(config): consolidate blocklist and block message under top-level block section

Replace dependency_cooldown.message, malware.message and blocked_packages
with a single block section: block.message is appended to every block
output regardless of which control blocked, and block.packages is the
package blocklist.

* fix(ui): render block.message as info note with clean spacing

* fix(ui): indent wrapped continuation lines in block reasons and messages

* update config template

* refactor(config): replace block section with top-level advisory_message

Remove the package blocklist (will be implemented as part of policies in
the future) and replace block.message with an optional top-level
advisory_message appended to every block output.

* chore(config): move advisory_message near top-level scalar configs in template
2026-07-09 17:49:00 +05:30

165 lines
5.2 KiB
Go

package config
import (
"testing"
packagev1 "buf.build/gen/go/safedep/api/protocolbuffers/go/safedep/messages/package/v1"
"github.com/stretchr/testify/assert"
)
func setGlobalForTest(t *testing.T, cfg *Config) {
t.Helper()
prev := globalConfig
globalConfig = &RuntimeConfig{Config: *cfg}
t.Cleanup(func() { globalConfig = prev })
}
func TestIsTrustedPackageRef(t *testing.T) {
cfg := &Config{TrustedPackages: []TrustedPackage{
{Purl: "pkg:npm/all-versions"},
{Purl: "pkg:npm/pinned@1.0.0"},
}}
_ = preprocessPackageRefs(cfg)
setGlobalForTest(t, cfg)
assert.True(t, IsTrustedPackageRef(packagev1.Ecosystem_ECOSYSTEM_NPM, "all-versions", "9.9.9"))
assert.True(t, IsTrustedPackageRef(packagev1.Ecosystem_ECOSYSTEM_NPM, "pinned", "1.0.0"))
assert.False(t, IsTrustedPackageRef(packagev1.Ecosystem_ECOSYSTEM_NPM, "pinned", "2.0.0"))
assert.False(t, IsTrustedPackageRef(packagev1.Ecosystem_ECOSYSTEM_NPM, "other", "1.0.0"))
}
func TestIsTrustedPackageAllVersions(t *testing.T) {
cfg := &Config{TrustedPackages: []TrustedPackage{
{Purl: "pkg:npm/all-versions"},
{Purl: "pkg:npm/pinned@1.0.0"},
}}
_ = preprocessPackageRefs(cfg)
setGlobalForTest(t, cfg)
assert.True(t, IsTrustedPackageAllVersions(packagev1.Ecosystem_ECOSYSTEM_NPM, "all-versions"))
assert.False(t, IsTrustedPackageAllVersions(packagev1.Ecosystem_ECOSYSTEM_NPM, "pinned"))
assert.False(t, IsTrustedPackageAllVersions(packagev1.Ecosystem_ECOSYSTEM_NPM, "absent"))
}
func TestCooldownSkip(t *testing.T) {
tests := []struct {
name string
skip []TrustedPackage
ecosystem packagev1.Ecosystem
pkgName string
wantSkipAll bool
wantVers map[string]bool
}{
{
name: "empty skip list",
skip: []TrustedPackage{},
ecosystem: packagev1.Ecosystem_ECOSYSTEM_NPM,
pkgName: "internal-sdk",
},
{
name: "empty package name",
skip: []TrustedPackage{{Purl: "pkg:npm/internal-sdk"}},
ecosystem: packagev1.Ecosystem_ECOSYSTEM_NPM,
pkgName: "",
},
{
name: "version-less entry skips all versions",
skip: []TrustedPackage{{Purl: "pkg:npm/internal-sdk", Reason: "first-party"}},
ecosystem: packagev1.Ecosystem_ECOSYSTEM_NPM,
pkgName: "internal-sdk",
wantSkipAll: true,
},
{
name: "version-pinned entry skips only that version",
skip: []TrustedPackage{{Purl: "pkg:npm/internal-sdk@1.2.3", Reason: "first-party"}},
ecosystem: packagev1.Ecosystem_ECOSYSTEM_NPM,
pkgName: "internal-sdk",
wantVers: map[string]bool{"1.2.3": true},
},
{
name: "multiple version-pinned entries",
skip: []TrustedPackage{
{Purl: "pkg:npm/internal-sdk@1.2.3"},
{Purl: "pkg:npm/internal-sdk@1.3.0"},
},
ecosystem: packagev1.Ecosystem_ECOSYSTEM_NPM,
pkgName: "internal-sdk",
wantVers: map[string]bool{"1.2.3": true, "1.3.0": true},
},
{
name: "version-less wins over version-pinned for same package",
skip: []TrustedPackage{
{Purl: "pkg:npm/internal-sdk@1.2.3"},
{Purl: "pkg:npm/internal-sdk"},
},
ecosystem: packagev1.Ecosystem_ECOSYSTEM_NPM,
pkgName: "internal-sdk",
wantSkipAll: true,
},
{
name: "name mismatch",
skip: []TrustedPackage{{Purl: "pkg:npm/internal-sdk"}},
ecosystem: packagev1.Ecosystem_ECOSYSTEM_NPM,
pkgName: "express",
},
{
name: "ecosystem mismatch",
skip: []TrustedPackage{{Purl: "pkg:pypi/internal-tool"}},
ecosystem: packagev1.Ecosystem_ECOSYSTEM_NPM,
pkgName: "internal-tool",
},
{
name: "pypi version-less entry",
skip: []TrustedPackage{{Purl: "pkg:pypi/internal-tool"}},
ecosystem: packagev1.Ecosystem_ECOSYSTEM_PYPI,
pkgName: "internal-tool",
wantSkipAll: true,
},
{
name: "invalid purl skipped, valid match still found",
skip: []TrustedPackage{
{Purl: "invalid-purl"},
{Purl: "pkg:npm/internal-sdk"},
},
ecosystem: packagev1.Ecosystem_ECOSYSTEM_NPM,
pkgName: "internal-sdk",
wantSkipAll: true,
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
cfg := &Config{DependencyCooldown: DependencyCooldownConfig{Skip: tt.skip}}
_ = preprocessPackageRefs(cfg)
got := cooldownSkip(cfg.DependencyCooldown.Skip, tt.ecosystem, tt.pkgName)
assert.Equal(t, tt.wantSkipAll, got.SkipAll)
assert.Equal(t, tt.wantVers, got.Versions)
})
}
}
func TestCooldownSkipInfo_ExemptsVersion(t *testing.T) {
skipAll := CooldownSkipInfo{SkipAll: true}
assert.True(t, skipAll.ExemptsVersion("9.9.9"), "skip-all exempts any version")
pinned := CooldownSkipInfo{Versions: map[string]bool{"1.2.3": true}}
assert.True(t, pinned.ExemptsVersion("1.2.3"))
assert.False(t, pinned.ExemptsVersion("1.2.4"))
none := CooldownSkipInfo{}
assert.False(t, none.ExemptsVersion("1.0.0"))
}
func TestCooldownSkipIsSkipListOnly(t *testing.T) {
cfg := &Config{
TrustedPackages: []TrustedPackage{{Purl: "pkg:npm/trusted-only"}},
DependencyCooldown: DependencyCooldownConfig{Skip: []TrustedPackage{{Purl: "pkg:npm/cooldown-only"}}},
}
_ = preprocessPackageRefs(cfg)
setGlobalForTest(t, cfg)
assert.False(t, CooldownSkip(packagev1.Ecosystem_ECOSYSTEM_NPM, "trusted-only").SkipAll, "trusted_packages must not leak into CooldownSkip")
assert.True(t, CooldownSkip(packagev1.Ecosystem_ECOSYSTEM_NPM, "cooldown-only").SkipAll)
}