mirror of
https://github.com/anchore/syft.git
synced 2026-03-29 21:23:24 +02:00
e38851143e
* chore: centralize temp files and prefer streaming IO Catalogers that create temp files ad-hoc can easily forget cleanup, leaking files on disk. Similarly, io.ReadAll is convenient but risks OOM on large or malicious inputs. Introduce internal/tmpdir to manage all cataloger temp storage under a single root directory with automatic cleanup. Prefer streaming parsers (bufio.Scanner, json/yaml.NewDecoder, io.LimitReader) over buffering entire inputs into memory. Add ruleguard rules to enforce both practices going forward. Signed-off-by: Will Murphy <willmurphyscode@users.noreply.github.com> * chore: go back to old release parsing Signed-off-by: Will Murphy <willmurphyscode@users.noreply.github.com> * simplify to limit reader in version check Signed-off-by: Will Murphy <willmurphyscode@users.noreply.github.com> * chore: regex change postponed Signed-off-by: Will Murphy <willmurphyscode@users.noreply.github.com> * simplify supplement release to limitreader Signed-off-by: Will Murphy <willmurphyscode@users.noreply.github.com> --------- Signed-off-by: Will Murphy <willmurphyscode@users.noreply.github.com>
72 lines
1.9 KiB
Go
72 lines
1.9 KiB
Go
package testutils
|
|
|
|
import (
|
|
"io"
|
|
"os"
|
|
"path"
|
|
"path/filepath"
|
|
"strings"
|
|
"testing"
|
|
)
|
|
|
|
const (
|
|
TestDataDir = "testdata"
|
|
GoldenFileDirName = "snapshot"
|
|
GoldenFileExt = ".golden"
|
|
GoldenFileDirPath = TestDataDir + string(filepath.Separator) + GoldenFileDirName
|
|
)
|
|
|
|
func GetGoldenFilePath(t *testing.T) string {
|
|
t.Helper()
|
|
// when using table-driven-tests, the `t.Name()` results in a string with slashes
|
|
// which makes it impossible to reference in a filesystem, producing a "No such file or directory"
|
|
filename := strings.ReplaceAll(t.Name(), "/", "_")
|
|
return path.Join(GoldenFileDirPath, filename+GoldenFileExt)
|
|
}
|
|
|
|
func UpdateGoldenFileContents(t *testing.T, contents []byte) {
|
|
t.Helper()
|
|
|
|
goldenFilePath := GetGoldenFilePath(t)
|
|
|
|
t.Log(dangerText("!!! UPDATING GOLDEN FILE !!!"), goldenFilePath)
|
|
|
|
err := os.WriteFile(goldenFilePath, contents, 0o600)
|
|
if err != nil {
|
|
t.Fatalf("could not update golden file (%s): %+v", goldenFilePath, err)
|
|
}
|
|
}
|
|
|
|
func GetGoldenFileContents(t *testing.T) []byte {
|
|
t.Helper()
|
|
|
|
goldenPath := GetGoldenFilePath(t)
|
|
if !fileOrDirExists(t, goldenPath) {
|
|
t.Fatalf("golden file does not exist: %s", goldenPath)
|
|
}
|
|
f, err := os.Open(goldenPath)
|
|
if err != nil {
|
|
t.Fatalf("could not open file (%s): %+v", goldenPath, err)
|
|
}
|
|
defer f.Close()
|
|
|
|
// suppress lint prohibiting ReadAll since golden files are source files in Syft's repository
|
|
// and not user provided artifacts.
|
|
bytes, err := io.ReadAll(f) //nolint:gocritic // golden files are trusted source files, not user artifacts
|
|
if err != nil {
|
|
t.Fatalf("could not read file (%s): %+v", goldenPath, err)
|
|
}
|
|
return bytes
|
|
}
|
|
|
|
func fileOrDirExists(t *testing.T, filename string) bool {
|
|
t.Helper()
|
|
_, err := os.Stat(filename)
|
|
return !os.IsNotExist(err)
|
|
}
|
|
|
|
// dangerText wraps text in ANSI escape codes for reverse red to make it highly visible.
|
|
func dangerText(s string) string {
|
|
return "\033[7;31m" + s + "\033[0m"
|
|
}
|