swap format readseekers for readers (#2515)

Signed-off-by: Alex Goodman <wagoodman@users.noreply.github.com>
This commit is contained in:
Alex Goodman
2024-01-23 16:44:57 -05:00
committed by GitHub
parent 8e39ca6dfc
commit 0fe13888d5
10 changed files with 188 additions and 43 deletions
+10 -2
View File
@@ -5,6 +5,8 @@ import (
"io"
"github.com/CycloneDX/cyclonedx-go"
"github.com/anchore/syft/syft/format/internal/stream"
)
type Decoder struct {
@@ -17,14 +19,20 @@ func NewDecoder(format cyclonedx.BOMFileFormat) Decoder {
}
}
func (d Decoder) Decode(reader io.ReadSeeker) (*cyclonedx.BOM, error) {
func (d Decoder) Decode(r io.Reader) (*cyclonedx.BOM, error) {
reader, err := stream.SeekableReader(r)
if err != nil {
return nil, err
}
doc := &cyclonedx.BOM{
Components: &[]cyclonedx.Component{},
}
if _, err := reader.Seek(0, io.SeekStart); err != nil {
return nil, fmt.Errorf("unable to seek to start of CycloneDX SBOM: %w", err)
}
err := cyclonedx.NewBOMDecoder(reader, d.format).Decode(doc)
err = cyclonedx.NewBOMDecoder(reader, d.format).Decode(doc)
if err != nil {
return nil, err
}
@@ -0,0 +1,24 @@
package stream
import (
"bytes"
"fmt"
"io"
)
func SeekableReader(reader io.Reader) (io.ReadSeeker, error) {
if reader == nil {
return nil, fmt.Errorf("no bytes provided")
}
if r, ok := reader.(io.ReadSeeker); ok {
return r, nil
}
content, err := io.ReadAll(reader)
if err != nil {
return nil, err
}
return bytes.NewReader(content), nil
}
@@ -0,0 +1,101 @@
package stream
import (
"bytes"
"io"
"reflect"
"testing"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
)
func TestSeekableReader(t *testing.T) {
tests := []struct {
name string
input io.Reader
assert func(io.Reader, io.ReadSeeker)
wantErr require.ErrorAssertionFunc
}{
{
name: "nil reader",
input: nil,
wantErr: require.Error,
},
{
name: "empty reader",
input: bytes.NewBuffer([]byte{}), // does not implement io.Seeker (but does implement io.Reader)
assert: func(input io.Reader, got io.ReadSeeker) {
impl, ok := got.(*bytes.Reader) // implements bytes.Reader
require.True(t, ok)
_, err := impl.Seek(0, io.SeekStart)
require.NoError(t, err)
content, err := io.ReadAll(impl)
require.NoError(t, err)
require.Equal(t, []byte{}, content)
},
},
{
name: "empty read seeker",
input: bytes.NewReader([]byte{}), // implements io.ReadSeeker
assert: func(input io.Reader, got io.ReadSeeker) {
impl, ok := got.(*bytes.Reader)
require.True(t, ok)
_, err := impl.Seek(0, io.SeekStart)
require.NoError(t, err)
content, err := io.ReadAll(impl)
require.NoError(t, err)
require.Equal(t, []byte{}, content)
// assert this is the same read seeker (reflect tt.input pointer is the same as the impl pointer
inputImpl, ok := input.(*bytes.Reader)
require.True(t, ok)
assert.Equal(t, reflect.ValueOf(inputImpl).Pointer(), reflect.ValueOf(impl).Pointer())
},
},
{
name: "non-empty read seeker",
input: bytes.NewReader([]byte("hello world!")), // implements io.ReadSeeker
assert: func(input io.Reader, got io.ReadSeeker) {
impl, ok := got.(*bytes.Reader)
require.True(t, ok)
_, err := impl.Seek(0, io.SeekStart)
require.NoError(t, err)
content, err := io.ReadAll(impl)
require.NoError(t, err)
require.Equal(t, []byte("hello world!"), content)
// assert this is the same read seeker (reflect tt.input pointer is the same as the impl pointer
inputImpl, ok := input.(*bytes.Reader)
require.True(t, ok)
assert.Equal(t, reflect.ValueOf(inputImpl).Pointer(), reflect.ValueOf(impl).Pointer())
},
},
{
name: "non-empty reader",
input: bytes.NewBufferString("hello world!"), // does not implement io.Seeker (but does implement io.Reader)
assert: func(input io.Reader, got io.ReadSeeker) {
impl, ok := got.(*bytes.Reader)
require.True(t, ok)
_, err := impl.Seek(0, io.SeekStart)
require.NoError(t, err)
content, err := io.ReadAll(impl)
require.NoError(t, err)
require.Equal(t, []byte("hello world!"), content)
},
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
if tt.wantErr == nil {
tt.wantErr = require.NoError
}
got, err := SeekableReader(tt.input)
tt.wantErr(t, err)
if err != nil {
return
}
tt.assert(tt.input, got)
})
}
}