Skip to content
New issue

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

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

Already on GitHub? # to your account

chore: code cleanup #1865

Merged
merged 8 commits into from
Jun 5, 2023
Merged
Show file tree
Hide file tree
Changes from 7 commits
Commits
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
6 changes: 3 additions & 3 deletions internal/file/tar_file_traversal.go
Original file line number Diff line number Diff line change
Expand Up @@ -32,12 +32,12 @@ func ExtractGlobsFromTarToUniqueTempFile(archivePath, dir string, globs ...strin
}

// we have a file we want to extract....
tempfilePrefix := filepath.Base(filepath.Clean(file.Name())) + "-"
tempFile, err := os.CreateTemp(dir, tempfilePrefix)
tempFilePrefix := filepath.Base(filepath.Clean(file.Name())) + "-"
tempFile, err := os.CreateTemp(dir, tempFilePrefix)
if err != nil {
return fmt.Errorf("unable to create temp file: %w", err)
}
// we shouldn't try and keep the tempfile open as the returned result may have several files, which takes up
// we shouldn't try and keep the tempFile open as the returned result may have several files, which takes up
// resources (leading to "too many open files"). Instead we'll return a file opener to the caller which
// provides a ReadCloser. It is up to the caller to handle closing the file explicitly.
defer tempFile.Close()
Expand Down
25 changes: 2 additions & 23 deletions internal/file/zip_file_helpers_test.go
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
package file

import (
"io/ioutil"
"os"
"os/exec"
"path"
Expand Down Expand Up @@ -73,31 +72,11 @@ func assertNoError(t testing.TB, fn func() error) func() {
func setupZipFileTest(t testing.TB, sourceDirPath string, zip64 bool) string {
t.Helper()

archivePrefix, err := ioutil.TempFile("", "syft-ziputil-archive-TEST-")
if err != nil {
t.Fatalf("unable to create tempfile: %+v", err)
}

t.Cleanup(
assertNoError(t,
func() error {
return os.Remove(archivePrefix.Name())
},
),
)

destinationArchiveFilePath := archivePrefix.Name() + ".zip"
archivePrefix := path.Join(t.TempDir(), "syft-ziputil-archive-TEST-")
destinationArchiveFilePath := archivePrefix + ".zip"
t.Logf("archive path: %s", destinationArchiveFilePath)
createZipArchive(t, sourceDirPath, destinationArchiveFilePath, zip64)

t.Cleanup(
assertNoError(t,
func() error {
return os.Remove(destinationArchiveFilePath)
},
),
)

cwd, err := os.Getwd()
if err != nil {
t.Fatalf("unable to get cwd: %+v", err)
Expand Down
28 changes: 5 additions & 23 deletions internal/file/zip_file_traversal_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,6 @@ import (
"errors"
"fmt"
"io"
"io/ioutil"
"os"
"path"
"path/filepath"
Expand Down Expand Up @@ -49,13 +48,7 @@ func TestUnzipToDir(t *testing.T) {
sourceDirPath := path.Join(goldenRootDir, "zip-source")
archiveFilePath := setupZipFileTest(t, sourceDirPath, false)

unzipDestinationDir, err := ioutil.TempDir("", "syft-ziputil-contents-TEST-")
t.Cleanup(assertNoError(t, func() error {
return os.RemoveAll(unzipDestinationDir)
}))
if err != nil {
t.Fatalf("unable to create tempdir: %+v", err)
}
unzipDestinationDir := t.TempDir()

t.Logf("content path: %s", unzipDestinationDir)

Expand Down Expand Up @@ -170,7 +163,7 @@ func prependZipSourceFixtureWithString(tb testing.TB, value string) func(tb test
archivePath := prepZipSourceFixture(t)

// create a temp file
tmpFile, err := ioutil.TempFile("", "syft-ziputil-prependZipSourceFixtureWithString-")
tmpFile, err := os.CreateTemp(tb.TempDir(), "syft-ziputil-prependZipSourceFixtureWithString-")
if err != nil {
t.Fatalf("unable to create tempfile: %+v", err)
}
Expand Down Expand Up @@ -209,25 +202,14 @@ func prependZipSourceFixtureWithString(tb testing.TB, value string) func(tb test

func prepZipSourceFixture(t testing.TB) string {
t.Helper()
archivePrefix, err := ioutil.TempFile("", "syft-ziputil-prepZipSourceFixture-")
if err != nil {
t.Fatalf("unable to create tempfile: %+v", err)
}

t.Cleanup(func() {
assert.NoError(t, os.Remove(archivePrefix.Name()))
})
archivePrefix := path.Join(t.TempDir(), "syft-ziputil-prepZipSourceFixture-")

// the zip utility will add ".zip" to the end of the given name
archivePath := archivePrefix.Name() + ".zip"

t.Cleanup(func() {
assert.NoError(t, os.Remove(archivePath))
})
archivePath := archivePrefix + ".zip"

t.Logf("archive path: %s", archivePath)

createZipArchive(t, "zip-source", archivePrefix.Name(), false)
createZipArchive(t, "zip-source", archivePrefix, false)

return archivePath
}
Expand Down
8 changes: 4 additions & 4 deletions syft/cpe/cpe_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ package cpe
import (
"encoding/json"
"fmt"
"io/ioutil"
"os"
"strings"
"testing"

Expand Down Expand Up @@ -80,12 +80,12 @@ func Test_normalizeCpeField(t *testing.T) {
}

func Test_CPEParser(t *testing.T) {
testCases := []struct {
var testCases []struct {
CPEString string `json:"cpe-string"`
CPEUrl string `json:"cpe-url"`
WFN CPE `json:"wfn"`
}{}
out, err := ioutil.ReadFile("test-fixtures/cpe-data.json")
}
out, err := os.ReadFile("test-fixtures/cpe-data.json")
require.NoError(t, err)
require.NoError(t, json.Unmarshal(out, &testCases))

Expand Down
4 changes: 2 additions & 2 deletions syft/linux/identify_release_test.go
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
package linux

import (
"io/ioutil"
"io"
"os"
"testing"

Expand Down Expand Up @@ -539,7 +539,7 @@ func retrieveFixtureContentsAsString(fixturePath string, t *testing.T) string {
}
defer fixture.Close()

b, err := ioutil.ReadAll(fixture)
b, err := io.ReadAll(fixture)
if err != nil {
t.Fatalf("unable to read fixture file: %+v", err)
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,6 @@ import (
"compress/gzip"
"encoding/binary"
"io"
"io/ioutil"
"os"
"path"
"testing"
Expand Down Expand Up @@ -36,7 +35,7 @@ func TestParseNativeImage(t *testing.T) {
t.Run(test.fixture, func(t *testing.T) {
f, err := os.Open("test-fixtures/java-builds/packages/" + test.fixture)
assert.NoError(t, err)
readerCloser := io.ReadCloser(ioutil.NopCloser(f))
readerCloser := io.NopCloser(f)
reader, err := unionreader.GetUnionReader(readerCloser)
assert.NoError(t, err)
parsed := false
Expand Down Expand Up @@ -107,7 +106,7 @@ func TestParseNativeImageSbom(t *testing.T) {
for _, test := range tests {
t.Run(path.Base(test.fixture), func(t *testing.T) {
// Create a buffer to resemble a compressed SBOM in a native image.
sbom, err := ioutil.ReadFile(test.fixture)
sbom, err := os.ReadFile(test.fixture)
assert.NoError(t, err)
var b bytes.Buffer
writebytes := bufio.NewWriter(&b)
Expand Down
10 changes: 1 addition & 9 deletions syft/source/source_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -898,7 +898,7 @@ func createArchive(t testing.TB, sourceDirPath, destinationArchivePath string, l
func setupArchiveTest(t testing.TB, sourceDirPath string, layer2 bool) string {
t.Helper()

archivePrefix, err := os.CreateTemp("", "syft-archive-TEST-")
archivePrefix, err := os.CreateTemp(t.TempDir(), "syft-archive-TEST-")
require.NoError(t, err)

t.Cleanup(
spiffcs marked this conversation as resolved.
Show resolved Hide resolved
Expand All @@ -913,14 +913,6 @@ func setupArchiveTest(t testing.TB, sourceDirPath string, layer2 bool) string {
t.Logf("archive path: %s", destinationArchiveFilePath)
createArchive(t, sourceDirPath, destinationArchiveFilePath, layer2)

t.Cleanup(
assertNoError(t,
func() error {
return os.Remove(destinationArchiveFilePath)
},
),
)

cwd, err := os.Getwd()
require.NoError(t, err)

Expand Down
4 changes: 1 addition & 3 deletions test/cli/cyclonedx_valid_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -44,9 +44,7 @@ func TestValidCycloneDX(t *testing.T) {
args := []string{
test.subcommand, fixtureRef, "-q",
}
for _, a := range test.args {
args = append(args, a)
}
args = append(args, test.args...)

cmd, stdout, stderr := runSyft(t, nil, args...)
for _, traitFn := range test.assertions {
Expand Down
4 changes: 1 addition & 3 deletions test/cli/json_schema_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -57,9 +57,7 @@ func TestJSONSchema(t *testing.T) {
args := []string{
test.subcommand, fixtureRef, "-q",
}
for _, a := range test.args {
args = append(args, a)
}
args = append(args, test.args...)

_, stdout, stderr := runSyft(t, nil, args...)

Expand Down
4 changes: 1 addition & 3 deletions test/cli/spdx_json_schema_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -50,9 +50,7 @@ func TestSPDXJSONSchema(t *testing.T) {
args := []string{
test.subcommand, fixtureRef, "-q",
}
for _, a := range test.args {
args = append(args, a)
}
args = append(args, test.args...)

_, stdout, _ := runSyft(t, nil, args...)

Expand Down
3 changes: 1 addition & 2 deletions test/integration/encode_decode_cycle_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@ package integration

import (
"bytes"
"fmt"
"regexp"
"testing"

Expand Down Expand Up @@ -64,7 +63,7 @@ func TestEncodeDecodeEncodeCycleComparison(t *testing.T) {
}

for _, test := range tests {
t.Run(fmt.Sprintf("%s", test.formatOption), func(t *testing.T) {
t.Run(string(test.formatOption), func(t *testing.T) {
for _, image := range images {
originalSBOM, _ := catalogFixtureImage(t, image, source.SquashedScope, nil)

Expand Down