Refactor to remove duplicated code, reflect some review comments

aquasecurity · Jun 3, 2024 · 39c24d0 · 39c24d0
1 parent da71578
commit 39c24d0
Show file tree

Hide file tree

Showing 53 changed files with 144 additions and 749 deletions.
diff --git a/go.mod b/go.mod
@@ -135,7 +135,6 @@ require (
  github.com/alecthomas/chroma v0.10.0
  github.com/antchfx/htmlquery v1.3.0
  github.com/apparentlymart/go-cidr v1.1.0
- github.com/aquasecurity/go-dep-parser v0.0.0-20240213093706-423cd04548a5
  github.com/aws/smithy-go v1.20.2
  github.com/hashicorp/go-uuid v1.0.3
  github.com/hashicorp/go-version v1.6.0

diff --git a/go.sum b/go.sum
@@ -752,8 +752,6 @@ github.com/apparentlymart/go-textseg/v15 v15.0.0 h1:uYvfpb3DyLSCGWnctWKGj857c6ew
 github.com/apparentlymart/go-textseg/v15 v15.0.0/go.mod h1:K8XmNZdhEBkdlyDdvbmmsvpAG721bKi0joRfFdHIWJ4=
 github.com/aquasecurity/bolt-fixtures v0.0.0-20200903104109-d34e7f983986 h1:2a30xLN2sUZcMXl50hg+PJCIDdJgIvIbVcKqLJ/ZrtM=
 github.com/aquasecurity/bolt-fixtures v0.0.0-20200903104109-d34e7f983986/go.mod h1:NT+jyeCzXk6vXR5MTkdn4z64TgGfE5HMLC8qfj5unl8=
-github.com/aquasecurity/go-dep-parser v0.0.0-20240213093706-423cd04548a5 h1:VhlDpfiVYpjCJt+tL2IpJV/T0OkAAKM545yMP4Hlsl0=
-github.com/aquasecurity/go-dep-parser v0.0.0-20240213093706-423cd04548a5/go.mod h1:6sh6f0Ixlt+oIMEPGxJyDOmzB03tK2v2rsAlc/9q12g=
 github.com/aquasecurity/go-gem-version v0.0.0-20201115065557-8eed6fe000ce h1:QgBRgJvtEOBtUXilDb1MLi1p1MWoyFDXAu5DEUl5nwM=
 github.com/aquasecurity/go-gem-version v0.0.0-20201115065557-8eed6fe000ce/go.mod h1:HXgVzOPvXhVGLJs4ZKO817idqr/xhwsTcj17CLYY74s=
 github.com/aquasecurity/go-mock-aws v0.0.0-20240523055201-a4152219967f h1:NRq3oUfkheKgoYPjNUApUtClKaBRcc6KzdcBHqZPrAM=

diff --git a/pkg/dependency/parser/nodejs/binary/exe.go → ...ependency/parser/executable/executable.go b/pkg/dependency/parser/nodejs/binary/exe.go → ...ependency/parser/executable/executable.go
@@ -1,6 +1,6 @@
 // Ported from https://github.com/golang/go/blob/e9c96835971044aa4ace37c7787de231bbde05d9/src/cmd/go/internal/version/exe.go
 
-package binary
+package executable
 
 import (
  "bytes"
@@ -11,7 +11,7 @@ import (
 )
 
 // An exe is a generic interface to an OS executable (ELF, Mach-O, PE, XCOFF).
-type exe interface {
+type Exe interface {
  // ReadData reads and returns up to size byte starting at virtual address addr.
  ReadData(addr, size uint64) ([]byte, error)
 
@@ -20,7 +20,7 @@ type exe interface {
 }
 
 // openExe opens file and returns it as an exe.
-func openExe(r io.Reader) (exe, error) {
+func OpenExe(r io.Reader) (Exe, error) {
  b, err := ioutil.ReadAll(r)
  if err != nil {
  return nil, err

diff --git a/pkg/dependency/parser/nodejs/binary/parse.go → ...endency/parser/executable/nodejs/parse.go b/pkg/dependency/parser/nodejs/binary/parse.go → ...endency/parser/executable/nodejs/parse.go
@@ -1,6 +1,6 @@
 // Ported from https://github.com/golang/go/blob/e9c96835971044aa4ace37c7787de231bbde05d9/src/cmd/go/internal/version/version.go
 
-package binary
+package nodejsparser
 
 import (
  "bytes"
@@ -9,6 +9,7 @@ import (
 
  "github.com/aquasecurity/trivy/pkg/dependency"
  "github.com/aquasecurity/trivy/pkg/dependency/types"
+ exe "github.com/aquasecurity/trivy/pkg/dependency/parser/executable"
  ftypes "github.com/aquasecurity/trivy/pkg/fanal/types"
  xio "github.com/aquasecurity/trivy/pkg/x/io"
 )
@@ -25,7 +26,7 @@ func NewParser() types.Parser {
 
 // Parse scans file to try to report the NodeJS version.
 func (p *Parser) Parse(r xio.ReadSeekerAt) ([]types.Library, []types.Dependency, error) {
- x, err := openExe(r)
+ x, err := exe.OpenExe(r)
  if err != nil {
  return nil, nil, ErrUnrecognizedExe
  }
@@ -37,7 +38,7 @@ func (p *Parser) Parse(r xio.ReadSeekerAt) ([]types.Library, []types.Dependency,
 
  var libs []types.Library
  libs = append(libs, types.Library{
- ID: packageID(mod, vers),
+ ID: dependency.ID(ftypes.NodeJsExecutable, mod, vers),
  Name: mod,
  Version: vers,
  })
@@ -46,7 +47,7 @@ func (p *Parser) Parse(r xio.ReadSeekerAt) ([]types.Library, []types.Dependency,
 }
 
 // findVers finds and returns the NodeJS version in the executable x.
-func findVers(x exe) (vers, mod string) {
+func findVers(x exe.Exe) (vers, mod string) {
  text, size := x.DataStart()
  data, err := x.ReadData(text, size)
  if err != nil {
@@ -67,7 +68,3 @@ func findVers(x exe) (vers, mod string) {
 
  return "node", vers
 }
-
-func packageID(name, version string) string {
- return dependency.ID(ftypes.NodeJsGeneric, name, version)
-}
diff --git a/...ndency/parser/nodejs/binary/parse_test.go → ...cy/parser/executable/nodejs/parse_test.go b/...ndency/parser/nodejs/binary/parse_test.go → ...cy/parser/executable/nodejs/parse_test.go
@@ -1,4 +1,4 @@
-package binary
+package nodejsparser
 
 import (
  "os"
@@ -43,7 +43,7 @@ func TestParse(t *testing.T) {
  got, _, err := parser.Parse(f)
  if tt.wantErr != "" {
  require.NotNil(t, err)
- assert.Contains(t, err.Error(), tt.wantErr)
+ require.ErrorContains(t, err, tt.wantErr)
  return
  }
 

diff --git a/...dency/parser/nodejs/binary/testdata/dummy → ...y/parser/executable/nodejs/testdata/dummy b/...dency/parser/nodejs/binary/testdata/dummy → ...y/parser/executable/nodejs/testdata/dummy
diff --git a/...parser/nodejs/binary/testdata/node.12.elf → ...er/executable/nodejs/testdata/node.12.elf b/...parser/nodejs/binary/testdata/node.12.elf → ...er/executable/nodejs/testdata/node.12.elf
diff --git a/pkg/dependency/parser/php/binary/parse.go → ...dependency/parser/executable/php/parse.go b/pkg/dependency/parser/php/binary/parse.go → ...dependency/parser/executable/php/parse.go
@@ -1,6 +1,6 @@
 // Ported from https://github.com/golang/go/blob/e9c96835971044aa4ace37c7787de231bbde05d9/src/cmd/go/internal/version/version.go
 
-package binary
+package phpparser
 
 import (
  "bytes"
@@ -9,6 +9,7 @@ import (
 
  "github.com/aquasecurity/trivy/pkg/dependency"
  "github.com/aquasecurity/trivy/pkg/dependency/types"
+ exe "github.com/aquasecurity/trivy/pkg/dependency/parser/executable"
  ftypes "github.com/aquasecurity/trivy/pkg/fanal/types"
  xio "github.com/aquasecurity/trivy/pkg/x/io"
 )
@@ -26,7 +27,7 @@ func NewParser() types.Parser {
 
 // Parse scans file to try to report the Python version.
 func (p *Parser) Parse(r xio.ReadSeekerAt) ([]types.Library, []types.Dependency, error) {
- x, err := openExe(r)
+ x, err := exe.OpenExe(r)
  if err != nil {
  return nil, nil, ErrUnrecognizedExe
  }
@@ -38,7 +39,7 @@ func (p *Parser) Parse(r xio.ReadSeekerAt) ([]types.Library, []types.Dependency,
 
  var libs []types.Library
  libs = append(libs, types.Library{
- ID: packageID(name, vers),
+ ID: dependency.ID(ftypes.PhpExecutable, name, vers),
  Name: name,
  Version: vers,
  })
@@ -47,7 +48,7 @@ func (p *Parser) Parse(r xio.ReadSeekerAt) ([]types.Library, []types.Dependency,
 }
 
 // findVers finds and returns the PHP version in the executable x.
-func findVers(x exe) (vers, mod string) {
+func findVers(x exe.Exe) (vers, mod string) {
  text, size := x.DataStart()
  data, err := x.ReadData(text, size)
  if err != nil {
@@ -68,7 +69,3 @@ func findVers(x exe) (vers, mod string) {
 
  return "php", vers
 }
-
-func packageID(name, version string) string {
- return dependency.ID(ftypes.PhpGeneric, name, version)
-}
diff --git a/...ependency/parser/php/binary/parse_test.go → ...dency/parser/executable/php/parse_test.go b/...ependency/parser/php/binary/parse_test.go → ...dency/parser/executable/php/parse_test.go
@@ -1,4 +1,4 @@
-package binary
+package phpparser
 
 import (
  "os"
@@ -43,7 +43,7 @@ func TestParse(t *testing.T) {
  got, _, err := parser.Parse(f)
  if tt.wantErr != "" {
  require.NotNil(t, err)
- assert.Contains(t, err.Error(), tt.wantErr)
+ require.ErrorContains(t, err, tt.wantErr)
  return
  }
 

diff --git a/...pendency/parser/php/binary/testdata/dummy → ...ency/parser/executable/php/testdata/dummy b/...pendency/parser/php/binary/testdata/dummy → ...ency/parser/executable/php/testdata/dummy
diff --git a/...ndency/parser/php/binary/testdata/php.elf → ...cy/parser/executable/php/testdata/php.elf b/...ndency/parser/php/binary/testdata/php.elf → ...cy/parser/executable/php/testdata/php.elf
diff --git a/...ndency/parser/python/binary/parse_test.go → ...cy/parser/executable/python/parse_test.go b/...ndency/parser/python/binary/parse_test.go → ...cy/parser/executable/python/parse_test.go
@@ -1,4 +1,4 @@
-package binary
+package pythonparser
 
 import (
  "os"
@@ -65,7 +65,7 @@ func TestParse(t *testing.T) {
  got, _, err := parser.Parse(f)
  if tt.wantErr != "" {
  require.NotNil(t, err)
- assert.Contains(t, err.Error(), tt.wantErr)
+ require.ErrorContains(t, err, tt.wantErr)
  return
  }
 

diff --git a/pkg/dependency/parser/python/binary/parse.go → ...ndency/parser/executable/python/parser.go b/pkg/dependency/parser/python/binary/parse.go → ...ndency/parser/executable/python/parser.go
@@ -1,6 +1,6 @@
 // Ported from https://github.com/golang/go/blob/e9c96835971044aa4ace37c7787de231bbde05d9/src/cmd/go/internal/version/version.go
 
-package binary
+package pythonparser
 
 import (
  "bytes"
@@ -9,6 +9,7 @@ import (
 
  "github.com/aquasecurity/trivy/pkg/dependency"
  "github.com/aquasecurity/trivy/pkg/dependency/types"
+ exe "github.com/aquasecurity/trivy/pkg/dependency/parser/executable"
  ftypes "github.com/aquasecurity/trivy/pkg/fanal/types"
  xio "github.com/aquasecurity/trivy/pkg/x/io"
 )
@@ -26,7 +27,7 @@ func NewParser() types.Parser {
 
 // Parse scans file to try to report the Python version.
 func (p *Parser) Parse(r xio.ReadSeekerAt) ([]types.Library, []types.Dependency, error) {
- x, err := openExe(r)
+ x, err := exe.OpenExe(r)
  if err != nil {
  return nil, nil, ErrUnrecognizedExe
  }
@@ -38,7 +39,7 @@ func (p *Parser) Parse(r xio.ReadSeekerAt) ([]types.Library, []types.Dependency,
 
  var libs []types.Library
  libs = append(libs, types.Library{
- ID: packageID(name, vers),
+ ID: dependency.ID(ftypes.PythonExecutable, name, vers),
  Name: name,
  Version: vers,
  })
@@ -47,7 +48,7 @@ func (p *Parser) Parse(r xio.ReadSeekerAt) ([]types.Library, []types.Dependency,
 }
 
 // findVers finds and returns the Python version in the executable x.
-func findVers(x exe) (mod, vers string) {
+func findVers(x exe.Exe) (mod, vers string) {
  text, size := x.DataStart()
  data, err := x.ReadData(text, size)
  if err != nil {
@@ -69,7 +70,3 @@ func findVers(x exe) (mod, vers string) {
 
  return "python", vers
 }
-
-func packageID(name, version string) string {
- return dependency.ID(ftypes.PythonGeneric, name, version)
-}
diff --git a/...dency/parser/python/binary/testdata/dummy → ...y/parser/executable/python/testdata/dummy b/...dency/parser/python/binary/testdata/dummy → ...y/parser/executable/python/testdata/dummy
diff --git a/...rser/python/binary/testdata/python2.7.elf → .../executable/python/testdata/python2.7.elf b/...rser/python/binary/testdata/python2.7.elf → .../executable/python/testdata/python2.7.elf
diff --git a/...ser/python/binary/testdata/python3.10.elf → ...executable/python/testdata/python3.10.elf b/...ser/python/binary/testdata/python3.10.elf → ...executable/python/testdata/python3.10.elf
diff --git a/...rser/python/binary/testdata/python3.9.elf → .../executable/python/testdata/python3.9.elf b/...rser/python/binary/testdata/python3.9.elf → .../executable/python/testdata/python3.9.elf
diff --git a/pkg/dependency/parser/php/binary/exe.go b/pkg/dependency/parser/php/binary/exe.go