Skip to content

test: introduce a special "cherry-picking" mock server for providing local databases #1603

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 8 commits into
base: main
Choose a base branch
from
Draft

test: introduce a special "cherry-picking" mock server for providing local databases #1603

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
c0a3868
refactor: make db remote host a public variable
G-Rath Feb 6, 2025
e389614
test: use a proxy cache to serve local databases
G-Rath Feb 7, 2025
86d5852
test: introduce "cherry-pick" database
G-Rath Feb 7, 2025
f167190
test: fetch osvs in parallel
G-Rath Feb 7, 2025
9a5b952
chore: don't cherry-picking databases for ecosystems starting with a …
G-Rath Feb 9, 2025
127bd59
test: implicitly cherry-pick aliases and other related OSVs
G-Rath Feb 10, 2025
3bd68ec
test: add a cache
G-Rath Feb 11, 2025
e4259f9
chore: log when the test server serves a database
G-Rath Feb 11, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion cmd/osv-scanner/fix/command.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -323,7 +323,7 @@ func action(ctx *cli.Context, stdout, stderr io.Writer) error {
// Something's very wrong if we hit this
panic("unhandled resolve.Ecosystem: " + system.String())
}
if err := matcher.LoadEcosystem(ctx.Context, ecosystem.Parsed{Ecosystem: eco}); err != nil {
if _, err := matcher.LoadEcosystem(ctx.Context, ecosystem.Parsed{Ecosystem: eco}); err != nil {
return err
}

Expand Down
226 changes: 226 additions & 0 deletions cmd/osv-scanner/scan/source/testmain_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@
"github.com/google/osv-scanner/v2/cmd/osv-scanner/internal/cmd"
"github.com/google/osv-scanner/v2/cmd/osv-scanner/internal/testcmd"
"github.com/google/osv-scanner/v2/cmd/osv-scanner/scan/source"
"github.com/google/osv-scanner/v2/internal/clients/clientimpl/localmatcher"
"github.com/google/osv-scanner/v2/internal/testdb"
"github.com/google/osv-scanner/v2/internal/testlogger"
"github.com/google/osv-scanner/v2/internal/testutility"
)
Expand All @@ -24,6 +26,230 @@
panic(err)
}

// localmatcher.ZippedDBRemoteHost = testdb.NewZipDBCacheServer().URL
localmatcher.ZippedDBRemoteHost = testdb.NewZipDBCherryPickServer(map[string][]string{
"RubyGems": {},

Check failure on line 31 in cmd/osv-scanner/scan/source/testmain_test.go

View workflow job for this annotation

GitHub Actions / golangci-lint 

File is not properly formatted (gofmt)
"Alpine": {
"CVE-2016-9840",
"CVE-2016-9841",
"CVE-2016-9842",
"CVE-2016-9843",
"CVE-2018-25032",
"CVE-2022-37434",
"CVE-2025-26519",
},
"Packagist": {},
"Debian": {
"CVE-2018-0501",
"CVE-2019-3462",
"DSA-4808-1",
"DSA-4685-1",
"CVE-2022-3715",
"CVE-2016-2781",
"CVE-2024-0684",
"DLA-3482-1",
"DSA-5147-1",
"DLA-3022-1",
"DSA-4535-1",
"CVE-2019-5188",
"CVE-2022-1304",
"DLA-3910-1",
"DSA-5122-1",
"CVE-2017-0379",
"CVE-2017-7526",
"CVE-2018-0495",
"CVE-2019-13627",
"CVE-2021-33560",
"CVE-2021-40528",
"CVE-2024-2236",
"CVE-2017-10790",
"CVE-2018-6003",
"CVE-2021-46848",
"DLA-3263-1",
"CVE-2016-3709",
"CVE-2016-9318",
"CVE-2017-0663",
"CVE-2017-15412",
"CVE-2017-16931",
"CVE-2017-16932",
"CVE-2017-18258",
"CVE-2017-5130",
"CVE-2017-7375",
"CVE-2017-7376",
"CVE-2017-8872",
"CVE-2017-9047",
"CVE-2017-9048",
"CVE-2017-9049",
"CVE-2017-9050",
"CVE-2018-14404",
"CVE-2018-14567",
"CVE-2019-19956",
"CVE-2019-20388",
"CVE-2020-7595",
"CVE-2021-3516",
"CVE-2021-3517",
"CVE-2021-3518",
"CVE-2021-3537",
"CVE-2021-3541",
"CVE-2022-2309",
"CVE-2022-23308",
"DSA-5142-1",
"DSA-5271-1",
"CVE-2022-49043",
"DSA-5391-1",
"CVE-2024-25062",
"DLA-3012-1",
"DLA-3172-1",
"DLA-3405-1",
"DLA-3878-1",
"CVE-2018-0732",
"CVE-2018-0734",
"CVE-2018-0735",
"CVE-2018-5407",
"CVE-2019-1543",
"DSA-4539-1",
"CVE-2019-1549",
"DSA-4855-1",
"DSA-4661-1",
"DSA-4807-1",
"DSA-4875-1",
"CVE-2021-3450",
"DSA-4963-1",
"DSA-5103-1",
"DSA-5139-1",
"DSA-5169-1",
"DSA-5343-1",
"CVE-2022-2274",
"CVE-2022-3358",
"CVE-2022-3602",
"CVE-2022-3786",
"CVE-2022-3996",
"CVE-2022-4203",
"CVE-2023-0216",
"CVE-2023-0217",
"CVE-2023-0401",
"DSA-5417-1",
"CVE-2023-1255",
"CVE-2023-2975",
"CVE-2023-3446",
"CVE-2023-3817",
"DSA-5532-1",
"CVE-2023-5678",
"CVE-2023-6129",
"CVE-2023-6237",
"CVE-2024-0727",
"CVE-2024-13176",
"CVE-2024-2511",
"CVE-2024-4603",
"CVE-2024-4741",
"CVE-2024-5535",
"DSA-5764-1",
"CVE-2024-9143",
"DLA-3008-1",
"DLA-3325-1",
"DLA-3449-1",
"DLA-3530-1",
"DLA-3942-1",
"DLA-3942-2",
"DSA-4539-3",
"CVE-2017-12837",
"CVE-2017-12883",
"CVE-2018-12015",
"CVE-2018-18311",
"CVE-2018-18312",
"CVE-2018-18313",
"CVE-2018-18314",
"CVE-2018-6797",
"CVE-2018-6798",
"CVE-2018-6913",
"CVE-2020-10543",
"CVE-2020-10878",
"CVE-2020-12723",
"CVE-2020-16156",
"CVE-2021-36770",
"CVE-2023-31484",
"CVE-2023-47038",
"DLA-3926-1",
"DLA-3072-1",
"DLA-3189-1",
"DLA-3316-1",
"DLA-3422-1",
"DLA-3600-1",
"DLA-3651-1",
"DLA-3764-1",
"DSA-5135-1",
"CVE-2017-17512",
"CVE-2018-20482",
"CVE-2023-39804",
"DLA-3755-1",
"DLA-3051-1",
"DLA-3134-1",
"DLA-3161-1",
"DLA-3366-1",
"DLA-3412-1",
"DLA-3684-1",
"DLA-3788-1",
"DLA-3972-1",
"DLA-4016-1",
"CVE-2016-2779",
"DSA-5055-1",
"DSA-5650-1",
"DLA-3782-1",
"DSA-5123-1",
"CVE-2024-3094",
"CVE-2011-3374",
"CVE-2019-18276",
"CVE-2017-18018",
"CVE-2018-6829",
"CVE-2018-1000654",
"CVE-2020-24977",
"CVE-2024-34459",
"CVE-2011-4116",
"CVE-2022-48522",
"CVE-2023-31486",
"CVE-2005-2541",
"CVE-2019-9923",
"CVE-2021-20193",
"CVE-2022-48303",
"CVE-2018-7738",
"CVE-2022-0563",
"CVE-2024-12797",
"CVE-2024-56171",
"CVE-2025-24928",
"CVE-2025-27113",
"CVE-2025-32414",
"CVE-2025-32415",
"DLA-4061-1",
"DLA-4085-1",
"DLA-4105-1",
"DLA-4146-1",
"DSA-5863-1",
"DSA-5895-1",
"DSA-5902-1",
},
"Go": {
"GO-2022-0452",
"GHSA-f3fp-gc8g-vw66",
"GO-2023-1683",
"GHSA-g2j6-57v7-gm8c",
"GO-2024-3110",
"GHSA-jfvp-7x6p-h2pv",
"GO-2023-1682",
"GHSA-m8cg-xc2p-r3fc",
"GO-2022-0274",
"GHSA-v95c-p5hm-xq8f",
"GO-2023-1627",
"GHSA-vpvm-3wq2-2wvm",
"GO-2024-2491",
"GHSA-xr7r-f8xq-vfvv",
"GO-2022-0493",
"GHSA-p782-xgp4-8hr8",
},
"Maven": {},
"npm": {"GHSA-whgm-jr23-g3j9"},
"OSS-Fuzz": {},
}).URL

slog.SetDefault(slog.New(testlogger.New()))
testcmd.CommandsUnderTest = []cmd.CommandBuilder{source.Command}
m.Run()
Expand Down
15 changes: 9 additions & 6 deletions internal/clients/clientimpl/localmatcher/localmatcher.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,8 @@ import (
"github.com/ossf/osv-schema/bindings/go/osvschema"
)

const zippedDBRemoteHost = "https://osv-vulnerabilities.storage.googleapis.com"
var ZippedDBRemoteHost = "https://osv-vulnerabilities.storage.googleapis.com"

const envKeyLocalDBCacheDirectory = "OSV_SCANNER_LOCAL_DB_CACHE_DIRECTORY"

// LocalMatcher implements the VulnerabilityMatcher interface by downloading the osv export zip files,
Expand All @@ -27,6 +28,8 @@ type LocalMatcher struct {
failedDBs map[osvschema.Ecosystem]error
// userAgent sets the user agent requests for db zips are made with
userAgent string

zippedDBRemoteHost string
}

func NewLocalMatcher(localDBPath string, userAgent string, downloadDB bool) (*LocalMatcher, error) {
Expand All @@ -41,6 +44,8 @@ func NewLocalMatcher(localDBPath string, userAgent string, downloadDB bool) (*Lo
downloadDB: downloadDB,
userAgent: userAgent,
failedDBs: make(map[osvschema.Ecosystem]error),

zippedDBRemoteHost: ZippedDBRemoteHost,
}, nil
}

Expand Down Expand Up @@ -81,10 +86,8 @@ func (matcher *LocalMatcher) MatchVulnerabilities(ctx context.Context, invs []*e

// LoadEcosystem tries to preload the ecosystem into the cache, and returns an error if the ecosystem
// cannot be loaded.
func (matcher *LocalMatcher) LoadEcosystem(ctx context.Context, ecosystem ecosystem.Parsed) error {
_, err := matcher.loadDBFromCache(ctx, ecosystem)

return err
func (matcher *LocalMatcher) LoadEcosystem(ctx context.Context, ecosystem ecosystem.Parsed) (*ZipDB, error) {
return matcher.loadDBFromCache(ctx, ecosystem)
}

func (matcher *LocalMatcher) loadDBFromCache(ctx context.Context, ecosystem ecosystem.Parsed) (*ZipDB, error) {
Expand All @@ -96,7 +99,7 @@ func (matcher *LocalMatcher) loadDBFromCache(ctx context.Context, ecosystem ecos
return nil, matcher.failedDBs[ecosystem.Ecosystem]
}

db, err := NewZippedDB(ctx, matcher.dbBasePath, string(ecosystem.Ecosystem), fmt.Sprintf("%s/%s/all.zip", zippedDBRemoteHost, ecosystem.Ecosystem), matcher.userAgent, !matcher.downloadDB)
db, err := NewZippedDB(ctx, matcher.dbBasePath, string(ecosystem.Ecosystem), fmt.Sprintf("%s/%s/all.zip", matcher.zippedDBRemoteHost, ecosystem.Ecosystem), matcher.userAgent, !matcher.downloadDB)

if err != nil {
matcher.failedDBs[ecosystem.Ecosystem] = err
Expand Down
Loading
Loading