Skip to content

test: format cassette bodies as pretty json #2393

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

Merged
another-rex merged 2 commits into from
Dec 5, 2025
Merged

test: format cassette bodies as pretty json #2393

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
01203cc
test: format request body in cassettes
G-Rath Dec 4, 2025
87dd406
test: reformat all cassettes
G-Rath Dec 4, 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
32 changes: 5 additions & 27 deletions cmd/osv-scanner/internal/testcmd/vcr.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@ package testcmd
import (
"bytes"
"cmp"
"encoding/json"
"io"
"net/http"
"os"
Expand Down Expand Up @@ -103,11 +102,7 @@ func InsertCassette(t *testing.T) *http.Client {

delete(i.Request.Headers, "User-Agent")

body, err := normalizeBody([]byte(i.Request.Body))
if err != nil {
return err
}
i.Request.Body = string(body)
i.Request.Body = string(pretty.Pretty([]byte(i.Request.Body)))
i.Request.ContentLength = int64(len(i.Request.Body))

// use a static duration since we don't care about replicating latency
Expand Down Expand Up @@ -208,13 +203,10 @@ func matchBody(r *http.Request, i cassette.Request) bool {

r.Body = io.NopCloser(bytes.NewBuffer(buffer.Bytes()))

body2, err := normalizeBody(buffer.Bytes())
if err != nil {
// This file will only run in tests, and this should be very unlikely
panic(err)
}

if !bytes.Equal(body2, []byte(i.Body)) {
if !bytes.Equal(
pretty.PrettyOptions(buffer.Bytes(), &pretty.Options{SortKeys: true}),
pretty.PrettyOptions([]byte(i.Body), &pretty.Options{SortKeys: true}),
Copy link
Collaborator

@another-rex another-rex Dec 5, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this should actually be a cmp compare of the parsed output, rather than formatting both JSONs and doing a byte compare.

Copy link
Collaborator Author

@G-Rath G-Rath Dec 5, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

could be, but what do you think of landing this as-is? just cause of its size and I've got a few other tweaks I'm planning to make which I do at the same time as moving to cmp (namely, I'm pretty sure we don't need to be touching some of the headers)

Copy link
Collaborator

@another-rex another-rex Dec 5, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sure

Copy link
Collaborator Author

@G-Rath G-Rath Dec 5, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

so actually, I'm not sure if that is possible because parsing the output requires us to know the structure right? and currently this is generic - it so happens we're using it only for the bulkquery endpoint, but its implemented with the idea that it can be used for anything...

) {
return false
}
} else if len(i.Body) != 0 {
Expand All @@ -223,17 +215,3 @@ func matchBody(r *http.Request, i cassette.Request) bool {

return true
}

func normalizeBody(body []byte) ([]byte, error) {
var intermediate any
if err := json.Unmarshal(body, &intermediate); err != nil {
return nil, err
}

buffer2, err := json.Marshal(intermediate)
if err != nil {
return nil, err
}

return buffer2, nil
}
113 changes: 111 additions & 2 deletions cmd/osv-scanner/scan/image/testdata/cassettes/TestCommand_Docker.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,118 @@ interactions:
proto: HTTP/1.1
proto_major: 1
proto_minor: 1
content_length: 1232
content_length: 2036
host: api.osv.dev
body: '{"queries":[{"package":{"ecosystem":"Alpine:v3.18","name":"alpine-baselayout"},"version":"3.4.3-r1"},{"package":{"ecosystem":"Alpine:v3.18","name":"alpine-baselayout"},"version":"3.4.3-r1"},{"package":{"ecosystem":"Alpine:v3.18","name":"alpine-keys"},"version":"2.4-r1"},{"package":{"ecosystem":"Alpine:v3.18","name":"apk-tools"},"version":"2.14.4-r0"},{"package":{"ecosystem":"Alpine:v3.18","name":"busybox"},"version":"1.36.1-r7"},{"package":{"ecosystem":"Alpine:v3.18","name":"busybox"},"version":"1.36.1-r7"},{"package":{"ecosystem":"Alpine:v3.18","name":"ca-certificates"},"version":"20240226-r0"},{"package":{"ecosystem":"Alpine:v3.18","name":"libc-dev"},"version":"0.7.2-r5"},{"package":{"ecosystem":"Alpine:v3.18","name":"openssl"},"version":"3.1.7-r0"},{"package":{"ecosystem":"Alpine:v3.18","name":"openssl"},"version":"3.1.7-r0"},{"package":{"ecosystem":"Alpine:v3.18","name":"musl"},"version":"1.2.4-r2"},{"package":{"ecosystem":"Alpine:v3.18","name":"musl"},"version":"1.2.4-r2"},{"package":{"ecosystem":"Alpine:v3.18","name":"pax-utils"},"version":"1.3.7-r1"},{"package":{"ecosystem":"Alpine:v3.18","name":"busybox"},"version":"1.36.1-r7"},{"package":{"ecosystem":"Alpine:v3.18","name":"zlib"},"version":"1.2.13-r1"}]}'
body: |
{
"queries": [
{
"package": {
"ecosystem": "Alpine:v3.18",
"name": "alpine-baselayout"
},
"version": "3.4.3-r1"
},
{
"package": {
"ecosystem": "Alpine:v3.18",
"name": "alpine-baselayout"
},
"version": "3.4.3-r1"
},
{
"package": {
"ecosystem": "Alpine:v3.18",
"name": "alpine-keys"
},
"version": "2.4-r1"
},
{
"package": {
"ecosystem": "Alpine:v3.18",
"name": "apk-tools"
},
"version": "2.14.4-r0"
},
{
"package": {
"ecosystem": "Alpine:v3.18",
"name": "busybox"
},
"version": "1.36.1-r7"
},
{
"package": {
"ecosystem": "Alpine:v3.18",
"name": "busybox"
},
"version": "1.36.1-r7"
},
{
"package": {
"ecosystem": "Alpine:v3.18",
"name": "ca-certificates"
},
"version": "20240226-r0"
},
{
"package": {
"ecosystem": "Alpine:v3.18",
"name": "libc-dev"
},
"version": "0.7.2-r5"
},
{
"package": {
"ecosystem": "Alpine:v3.18",
"name": "openssl"
},
"version": "3.1.7-r0"
},
{
"package": {
"ecosystem": "Alpine:v3.18",
"name": "openssl"
},
"version": "3.1.7-r0"
},
{
"package": {
"ecosystem": "Alpine:v3.18",
"name": "musl"
},
"version": "1.2.4-r2"
},
{
"package": {
"ecosystem": "Alpine:v3.18",
"name": "musl"
},
"version": "1.2.4-r2"
},
{
"package": {
"ecosystem": "Alpine:v3.18",
"name": "pax-utils"
},
"version": "1.3.7-r1"
},
{
"package": {
"ecosystem": "Alpine:v3.18",
"name": "busybox"
},
"version": "1.36.1-r7"
},
{
"package": {
"ecosystem": "Alpine:v3.18",
"name": "zlib"
},
"version": "1.2.13-r1"
}
]
}
headers:
Content-Type:
- application/json
Expand Down
106 changes: 104 additions & 2 deletions cmd/osv-scanner/scan/image/testdata/cassettes/TestCommand_HtmlFile.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,111 @@ interactions:
proto: HTTP/1.1
proto_major: 1
proto_minor: 1
content_length: 1156
content_length: 1907
host: api.osv.dev
body: '{"queries":[{"package":{"ecosystem":"Alpine:v3.18","name":"alpine-baselayout"},"version":"3.1.2-r0"},{"package":{"ecosystem":"Alpine:v3.18","name":"alpine-keys"},"version":"2.1-r2"},{"package":{"ecosystem":"Alpine:v3.18","name":"apk-tools"},"version":"2.10.6-r0"},{"package":{"ecosystem":"Alpine:v3.18","name":"busybox"},"version":"1.30.1-r5"},{"package":{"ecosystem":"Alpine:v3.18","name":"ca-certificates"},"version":"20191127-r2"},{"package":{"ecosystem":"Alpine:v3.18","name":"libc-dev"},"version":"0.7.1-r0"},{"package":{"ecosystem":"Alpine:v3.18","name":"openssl"},"version":"1.1.1k-r0"},{"package":{"ecosystem":"Alpine:v3.18","name":"openssl"},"version":"1.1.1k-r0"},{"package":{"ecosystem":"Alpine:v3.18","name":"libtls-standalone"},"version":"2.9.1-r0"},{"package":{"ecosystem":"Alpine:v3.18","name":"musl"},"version":"1.1.22-r4"},{"package":{"ecosystem":"Alpine:v3.18","name":"musl"},"version":"1.1.22-r4"},{"package":{"ecosystem":"Alpine:v3.18","name":"pax-utils"},"version":"1.2.3-r0"},{"package":{"ecosystem":"Alpine:v3.18","name":"busybox"},"version":"1.30.1-r5"},{"package":{"ecosystem":"Alpine:v3.18","name":"zlib"},"version":"1.2.11-r1"}]}'
body: |
{
"queries": [
{
"package": {
"ecosystem": "Alpine:v3.18",
"name": "alpine-baselayout"
},
"version": "3.1.2-r0"
},
{
"package": {
"ecosystem": "Alpine:v3.18",
"name": "alpine-keys"
},
"version": "2.1-r2"
},
{
"package": {
"ecosystem": "Alpine:v3.18",
"name": "apk-tools"
},
"version": "2.10.6-r0"
},
{
"package": {
"ecosystem": "Alpine:v3.18",
"name": "busybox"
},
"version": "1.30.1-r5"
},
{
"package": {
"ecosystem": "Alpine:v3.18",
"name": "ca-certificates"
},
"version": "20191127-r2"
},
{
"package": {
"ecosystem": "Alpine:v3.18",
"name": "libc-dev"
},
"version": "0.7.1-r0"
},
{
"package": {
"ecosystem": "Alpine:v3.18",
"name": "openssl"
},
"version": "1.1.1k-r0"
},
{
"package": {
"ecosystem": "Alpine:v3.18",
"name": "openssl"
},
"version": "1.1.1k-r0"
},
{
"package": {
"ecosystem": "Alpine:v3.18",
"name": "libtls-standalone"
},
"version": "2.9.1-r0"
},
{
"package": {
"ecosystem": "Alpine:v3.18",
"name": "musl"
},
"version": "1.1.22-r4"
},
{
"package": {
"ecosystem": "Alpine:v3.18",
"name": "musl"
},
"version": "1.1.22-r4"
},
{
"package": {
"ecosystem": "Alpine:v3.18",
"name": "pax-utils"
},
"version": "1.2.3-r0"
},
{
"package": {
"ecosystem": "Alpine:v3.18",
"name": "busybox"
},
"version": "1.30.1-r5"
},
{
"package": {
"ecosystem": "Alpine:v3.18",
"name": "zlib"
},
"version": "1.2.11-r1"
}
]
}
headers:
Content-Type:
- application/json
Expand Down
Loading