Files
pmg/config/cooldown_skip_test.go
T
61230fbcd7 feat(cooldown): add dependency_cooldown.skip list (per-control exemption) (#328)
Let dependency cooldown respect an explicit skip list so first-party /
internal packages that must be installed the moment they are published
(e.g. to sanity-test a freshly released version) are not held back by the
cooldown window.

Per review, this is a per-control skip list — NOT a second definition of
"trusted package". There remains a single top-level `trusted_packages`
(which waives malware analysis); `dependency_cooldown.skip` waives ONLY
the cooldown wait, so a fast-tracked package is still malware-scanned.

Matching:
- a PURL without a version skips cooldown for all versions of the package
  (package-level) — the metadata passes through unmodified;
- a PURL with a version skips cooldown for that version only — that
  version is preserved during stripping while other recent versions are
  still held.

- config: DependencyCooldownConfig.Skip + CooldownSkip()/CooldownSkipInfo.
- npm/pypi interceptors: bypass on package-level skip; thread per-version
  exemptions into the cooldown stripper so pinned versions survive.
- docs + config template; unit tests for the matcher (package/version
  level, precedence, mismatches) and the skip-vs-trusted independence.

Signed-off-by: dmdhrumilmistry <56185972+dmdhrumilmistry@users.noreply.github.com>
Co-authored-by: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
2026-06-15 19:44:55 +05:30

159 lines
5.3 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 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}}
_ = preprocessTrustedPackages(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"))
}
// TestCooldownSkipAndTrustedPackagesAreIndependent verifies the cooldown skip
// list and the top-level trusted_packages do not leak into each other: a
// cooldown-skipped package is NOT trusted for malware analysis, and a
// malware-trusted package is NOT cooldown-skipped.
func TestCooldownSkipAndTrustedPackagesAreIndependent(t *testing.T) {
cfg := &Config{
TrustedPackages: []TrustedPackage{
{Purl: "pkg:npm/malware-trusted", Reason: "waives analysis only"},
},
DependencyCooldown: DependencyCooldownConfig{
Skip: []TrustedPackage{
{Purl: "pkg:npm/cooldown-skipped", Reason: "waives cooldown only"},
},
},
}
_ = preprocessTrustedPackages(cfg)
cooldownSkipped := &packagev1.PackageVersion{
Package: &packagev1.Package{Name: "cooldown-skipped", Ecosystem: packagev1.Ecosystem_ECOSYSTEM_NPM},
Version: "1.0.0",
}
malwareTrusted := &packagev1.PackageVersion{
Package: &packagev1.Package{Name: "malware-trusted", Ecosystem: packagev1.Ecosystem_ECOSYSTEM_NPM},
Version: "1.0.0",
}
// Cooldown-skipped package is still malware-analyzed (not in trusted_packages).
assert.False(t, isTrustedPackageVersion(cfg.TrustedPackages, cooldownSkipped),
"cooldown-skipped package must NOT waive malware analysis")
assert.True(t, cooldownSkip(cfg.DependencyCooldown.Skip, packagev1.Ecosystem_ECOSYSTEM_NPM, "cooldown-skipped").SkipAll,
"cooldown-skipped package must skip the cooldown window")
// Malware-trusted package is still subject to cooldown (not in the skip list).
assert.True(t, isTrustedPackageVersion(cfg.TrustedPackages, malwareTrusted),
"malware-trusted package must waive malware analysis")
skip := cooldownSkip(cfg.DependencyCooldown.Skip, packagev1.Ecosystem_ECOSYSTEM_NPM, "malware-trusted")
assert.False(t, skip.SkipAll, "malware-trusted package must NOT skip cooldown")
assert.Nil(t, skip.Versions)
}