forked from anchore/syft
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
ignore minor parsing error when reading dpkg status files (anchore#786)
* ignore minor parsing error when reading dpkg status files helps with anchore#733 Question: should we add a smarter parser to guess approximate installed-size value? Signed-off-by: Jonas Galvão Xavier <[email protected]> * add datasize lib to help dpkg parsing added unit tests to expand coverage of dpkg parsing Signed-off-by: Jonas Galvão Xavier <[email protected]> * drop parse error added unit tests to handleNewKeyValue Signed-off-by: Jonas Galvão Xavier <[email protected]> * don't return parsing errors from dpkg Signed-off-by: Jonas Galvão Xavier <[email protected]> * go mod tidy Signed-off-by: Jonas Galvão Xavier <[email protected]> * test higher level functions Signed-off-by: Jonas Galvão Xavier <[email protected]> * return parsing err to let cataloger handle it Signed-off-by: Jonas Galvão Xavier <[email protected]> * feedback changes Signed-off-by: Jonas Galvão Xavier <[email protected]> * ignore key parsing error log warning with relevant context Signed-off-by: Jonas Galvão Xavier <[email protected]> * go mod tidy Signed-off-by: Jonas Galvão Xavier <[email protected]> * add context info to log lines simpler error assertion Signed-off-by: Jonas Galvão Xavier <[email protected]> * use error.As to assert error in chain Signed-off-by: Jonas Galvão Xavier <[email protected]>
- Loading branch information
Showing
6 changed files
with
197 additions
and
16 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -2,10 +2,15 @@ package deb | |
|
|
||
| import ( | ||
| "bufio" | ||
| "errors" | ||
| "fmt" | ||
| "os" | ||
| "path/filepath" | ||
| "strings" | ||
| "testing" | ||
|
|
||
| "github.com/anchore/syft/syft/file" | ||
| "github.com/stretchr/testify/assert" | ||
|
|
||
| "github.com/anchore/syft/syft/pkg" | ||
| "github.com/go-test/deep" | ||
|
|
@@ -20,11 +25,13 @@ func compareEntries(t *testing.T, left, right pkg.DpkgMetadata) { | |
|
|
||
| func TestSinglePackage(t *testing.T) { | ||
| tests := []struct { | ||
| name string | ||
| expected pkg.DpkgMetadata | ||
| name string | ||
| expected pkg.DpkgMetadata | ||
| fixturePath string | ||
| }{ | ||
| { | ||
| name: "Test Single Package", | ||
| name: "Test Single Package", | ||
| fixturePath: filepath.Join("test-fixtures", "status", "single"), | ||
| expected: pkg.DpkgMetadata{ | ||
| Package: "apt", | ||
| Source: "apt-dev", | ||
|
|
@@ -68,11 +75,22 @@ func TestSinglePackage(t *testing.T) { | |
| }, | ||
| }, | ||
| }, | ||
| } | ||
| { | ||
| name: "parse storage notation", | ||
| fixturePath: filepath.Join("test-fixtures", "status", "installed-size-4KB"), | ||
| expected: pkg.DpkgMetadata{ | ||
| Package: "apt", | ||
| Source: "apt-dev", | ||
| Version: "1.8.2", | ||
| Architecture: "amd64", | ||
| InstalledSize: 4000, | ||
| Maintainer: "APT Development Team <[email protected]>", | ||
| }, | ||
| }} | ||
|
|
||
| for _, test := range tests { | ||
| t.Run(test.name, func(t *testing.T) { | ||
| file, err := os.Open("test-fixtures/status/single") | ||
| file, err := os.Open(test.fixturePath) | ||
| if err != nil { | ||
| t.Fatal("Unable to read test_fixtures/single: ", err) | ||
| } | ||
|
|
@@ -204,7 +222,6 @@ func TestMultiplePackages(t *testing.T) { | |
| } | ||
|
|
||
| func TestSourceVersionExtract(t *testing.T) { | ||
|
|
||
| tests := []struct { | ||
| name string | ||
| input string | ||
|
|
@@ -242,3 +259,135 @@ func TestSourceVersionExtract(t *testing.T) { | |
| }) | ||
| } | ||
| } | ||
|
|
||
| func assertAs(expected error) assert.ErrorAssertionFunc { | ||
| return func(t assert.TestingT, err error, i ...interface{}) bool { | ||
| return assert.ErrorAs(t, err, &expected) | ||
| } | ||
| } | ||
|
|
||
| func Test_parseDpkgStatus(t *testing.T) { | ||
| tests := []struct { | ||
| name string | ||
| input string | ||
| want []pkg.Package | ||
| wantErr assert.ErrorAssertionFunc | ||
| }{ | ||
| { | ||
| name: "no more packages", | ||
| input: `Package: apt`, | ||
| wantErr: assert.NoError, | ||
| }, | ||
| { | ||
| name: "duplicated key", | ||
| input: `Package: apt | ||
| Package: apt-get | ||
| `, | ||
| wantErr: assertAs(errors.New("duplicate key discovered: Package")), | ||
| }, | ||
| { | ||
| name: "no match for continuation", | ||
| input: ` Package: apt | ||
| `, | ||
| wantErr: assertAs(errors.New("no match for continuation: line: ' Package: apt'")), | ||
| }, | ||
| { | ||
| name: "find keys", | ||
| input: `Package: apt | ||
| Status: install ok installed | ||
| Installed-Size: 10kib | ||
| `, | ||
| want: []pkg.Package{ | ||
| { | ||
| Name: "apt", | ||
| Type: "deb", | ||
| MetadataType: "DpkgMetadata", | ||
| Metadata: pkg.DpkgMetadata{ | ||
| Package: "apt", | ||
| InstalledSize: 10240, | ||
| Files: []pkg.DpkgFileRecord{}, | ||
| }, | ||
| }, | ||
| }, | ||
| wantErr: assert.NoError, | ||
| }, | ||
| } | ||
|
|
||
| for _, tt := range tests { | ||
| t.Run(tt.name, func(t *testing.T) { | ||
| r := bufio.NewReader(strings.NewReader(tt.input)) | ||
| got, err := parseDpkgStatus(r) | ||
| tt.wantErr(t, err, fmt.Sprintf("parseDpkgStatus")) | ||
| assert.Equal(t, tt.want, got) | ||
| }) | ||
| } | ||
| } | ||
|
|
||
| func Test_handleNewKeyValue(t *testing.T) { | ||
| tests := []struct { | ||
| name string | ||
| line string | ||
| wantKey string | ||
| wantVal interface{} | ||
| wantErr assert.ErrorAssertionFunc | ||
| }{ | ||
| { | ||
| name: "cannot parse field", | ||
| line: "blabla", | ||
| wantErr: assertAs(errors.New("cannot parse field from line: 'blabla'")), | ||
| }, | ||
| { | ||
| name: "parse field", | ||
| line: "key: val", | ||
| wantKey: "key", | ||
| wantVal: "val", | ||
| wantErr: assert.NoError, | ||
| }, | ||
| { | ||
| name: "parse installed size", | ||
| line: "InstalledSize: 128", | ||
| wantKey: "InstalledSize", | ||
| wantVal: 128, | ||
| wantErr: assert.NoError, | ||
| }, | ||
| { | ||
| name: "parse installed kib size", | ||
| line: "InstalledSize: 1kib", | ||
| wantKey: "InstalledSize", | ||
| wantVal: 1024, | ||
| wantErr: assert.NoError, | ||
| }, | ||
| { | ||
| name: "parse installed kb size", | ||
| line: "InstalledSize: 1kb", | ||
| wantKey: "InstalledSize", | ||
| wantVal: 1000, | ||
| wantErr: assert.NoError, | ||
| }, | ||
| { | ||
| name: "parse installed-size mb", | ||
| line: "Installed-Size: 1 mb", | ||
| wantKey: "InstalledSize", | ||
| wantVal: 1000000, | ||
| wantErr: assert.NoError, | ||
| }, | ||
| { | ||
| name: "fail parsing installed-size", | ||
| line: "Installed-Size: 1bla", | ||
| wantKey: "", | ||
| wantErr: assertAs(fmt.Errorf("unhandled size name: %s", "bla")), | ||
| }, | ||
| } | ||
| for _, tt := range tests { | ||
| t.Run(tt.name, func(t *testing.T) { | ||
| gotKey, gotVal, err := handleNewKeyValue(tt.line) | ||
| tt.wantErr(t, err, fmt.Sprintf("handleNewKeyValue(%v)", tt.line)) | ||
|
|
||
| assert.Equalf(t, tt.wantKey, gotKey, "handleNewKeyValue(%v)", tt.line) | ||
| assert.Equalf(t, tt.wantVal, gotVal, "handleNewKeyValue(%v)", tt.line) | ||
| }) | ||
| } | ||
| } | ||
31 changes: 31 additions & 0 deletions
31
syft/pkg/cataloger/deb/test-fixtures/status/installed-size-4KB
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,31 @@ | ||
| Package: apt | ||
| Status: install ok installed | ||
| Priority: required | ||
| Section: admin | ||
| Installed-Size: 4KB | ||
| Maintainer: APT Development Team <[email protected]> | ||
| Architecture: amd64 | ||
| Version: 1.8.2 | ||
| Source: apt-dev | ||
| Replaces: apt-transport-https (<< 1.5~alpha4~), apt-utils (<< 1.3~exp2~) | ||
| Provides: apt-transport-https (= 1.8.2) | ||
| Depends: adduser, gpgv | gpgv2 | gpgv1, debian-archive-keyring, libapt-pkg5.0 (>= 1.7.0~alpha3~), libc6 (>= 2.15), libgcc1 (>= 1:3.0), libgnutls30 (>= 3.6.6), libseccomp2 (>= 1.0.1), libstdc++6 (>= 5.2) | ||
| Recommends: ca-certificates | ||
| Suggests: apt-doc, aptitude | synaptic | wajig, dpkg-dev (>= 1.17.2), gnupg | gnupg2 | gnupg1, powermgmt-base | ||
| Breaks: apt-transport-https (<< 1.5~alpha4~), apt-utils (<< 1.3~exp2~), aptitude (<< 0.8.10) | ||
| Conffiles: | ||
| Description: commandline package manager | ||
| This package provides commandline tools for searching and | ||
| managing as well as querying information about packages | ||
| as a low-level access to all features of the libapt-pkg library. | ||
| . | ||
| These include: | ||
| * apt-get for retrieval of packages and information about them | ||
| from authenticated sources and for installation, upgrade and | ||
| removal of packages together with their dependencies | ||
| * apt-cache for querying available information about installed | ||
| as well as installable packages | ||
| * apt-cdrom to use removable media as a source for packages | ||
| * apt-config as an interface to the configuration settings | ||
| * apt-key as an interface to manage authentication keys | ||
|
|