refactor: unify Library and Package structs #6633

knqyf263 · 2024-05-06T07:18:35Z

Description

Previously, when go-dep-parser was a separate library, it defined a distinct Library struct to represent parsed packages. Trivy then converted this to the Package struct. However, since go-dep-parser has been merged into Trivy, there is no longer a need to define separate structs, and they can be unified. This eliminates the need for duplicate definitions of Relationship and other related elements. Additionally, the sorting methods for Package and Library were slightly different, but by using the same Package struct, these are now unified as well.

Furthermore, the internal terminology has been streamlined to consistently use "package" throughout the codebase. Previously, OS packages and language-specific packages were distinguished and referred to as "package" and "library" respectively. Going forward, both will be referred to as "package".

Related PRs

chore(deps): merge go-dep-parser into Trivy #6094

Checklist

I've read the guidelines for contributing to this repository.
I've followed the conventions in the PR title.
I've added tests that prove my fix is effective or that my feature works.
I've updated the documentation with the relevant information (if needed).
I've added usage information (if the PR introduces new options)
I've included a "before" and "after" example to the description (if the PR is a user interface change).

Signed-off-by: knqyf263 <knqyf263@gmail.com>

pkg/dependency/parser/c/conan/parse.go

pkg/dependency/parser/conda/environment/parse.go

pkg/dependency/parser/golang/sum/parse.go

pkg/dependency/parser/gradle/lockfile/parse_test.go

pkg/dependency/parser/hex/mix/parse_test.go

pkg/fanal/analyzer/language/php/composer/composer.go

pkg/fanal/analyzer/language/python/packaging/packaging.go

pkg/fanal/analyzer/language/python/poetry/poetry.go

pkg/fanal/applier/docker.go

DmitriyLewen · 2024-05-07T09:09:56Z

rpc/common/service.proto

@@ -27,7 +27,7 @@ message PackageInfo {
 message Application {
  string           type      = 1;
  string           file_path = 2;
-  repeated Package libraries = 3;
+  repeated Package packages  = 3;


IIRC it's better to use new number, even if we just rename the field.

Renaming should be ok as protobuf internally uses number, not name. I'll check it just in case.

Co-authored-by: DmitriyLewen <91113035+DmitriyLewen@users.noreply.github.com>

Signed-off-by: knqyf263 <knqyf263@gmail.com>

Co-authored-by: DmitriyLewen <91113035+DmitriyLewen@users.noreply.github.com>

Signed-off-by: knqyf263 <knqyf263@gmail.com>

knqyf263 · 2024-05-07T10:37:37Z

@DmitriyLewen I've addressed your comments.

DmitriyLewen

To save us time, I refactored some missing places:
2c73669
b2d35b1

Take a look, please.
If these changes are good for you - you can merge this PR.

knqyf263 · 2024-05-07T12:19:24Z

Thanks!

Signed-off-by: knqyf263 <knqyf263@gmail.com> Co-authored-by: DmitriyLewen <91113035+DmitriyLewen@users.noreply.github.com> Co-authored-by: DmitriyLewen <dmitriy.lewen@smartforce.io>

knqyf263 added 4 commits May 6, 2024 10:49

refactor: unifty Library and Package

9bb9014

Signed-off-by: knqyf263 <knqyf263@gmail.com>

refactor: replace Library with Package

9abf7ac

Signed-off-by: knqyf263 <knqyf263@gmail.com>

test(integration): fix golden

8704363

Signed-off-by: knqyf263 <knqyf263@gmail.com>

refactor: replace Libraries with Packages in Application

a19dbe8

Signed-off-by: knqyf263 <knqyf263@gmail.com>

knqyf263 self-assigned this May 6, 2024

knqyf263 added 2 commits May 6, 2024 11:55

refactor(rpc): replace Libraries with Packages

93c9c5a

Signed-off-by: knqyf263 <knqyf263@gmail.com>

test: sort packages

725e4fd

Signed-off-by: knqyf263 <knqyf263@gmail.com>

knqyf263 force-pushed the refactor/libraries branch from 3d9da72 to 725e4fd Compare May 6, 2024 07:55

knqyf263 marked this pull request as ready for review May 6, 2024 08:29

knqyf263 requested review from chen-keinan and DmitriyLewen as code owners May 6, 2024 08:29

DmitriyLewen reviewed May 7, 2024

View reviewed changes

knqyf263 and others added 18 commits May 7, 2024 13:59

refactor: replace lib with pkg

ff481eb

Co-authored-by: DmitriyLewen <91113035+DmitriyLewen@users.noreply.github.com>

refactor: replace lib with pkg

398aeaf

Co-authored-by: DmitriyLewen <91113035+DmitriyLewen@users.noreply.github.com>

refactor: replace lib with pkg

48cbd27

Co-authored-by: DmitriyLewen <91113035+DmitriyLewen@users.noreply.github.com>

refactor: replace lib with pkg

3718e95

Co-authored-by: DmitriyLewen <91113035+DmitriyLewen@users.noreply.github.com>

refactor(gradle): use sort.Sort

020e3b5

Signed-off-by: knqyf263 <knqyf263@gmail.com>

refactor: replace lib with pkg

4e33bc7

Co-authored-by: DmitriyLewen <91113035+DmitriyLewen@users.noreply.github.com>

refactor: replace lib with pkg

2468e08

Co-authored-by: DmitriyLewen <91113035+DmitriyLewen@users.noreply.github.com>

refactor: replace lib with pkg

84cf0be

Co-authored-by: DmitriyLewen <91113035+DmitriyLewen@users.noreply.github.com>

refactor: replace lib with pkg

05aa799

Co-authored-by: DmitriyLewen <91113035+DmitriyLewen@users.noreply.github.com>

refactor: replace lib with pkg

793c85d

Co-authored-by: DmitriyLewen <91113035+DmitriyLewen@users.noreply.github.com>

refactor: replace lib with pkg

964e98f

Co-authored-by: DmitriyLewen <91113035+DmitriyLewen@users.noreply.github.com>

refactor: replace lib with pkg

8598e4f

Co-authored-by: DmitriyLewen <91113035+DmitriyLewen@users.noreply.github.com>

refactor: replace lib with pkg

129fff0

Co-authored-by: DmitriyLewen <91113035+DmitriyLewen@users.noreply.github.com>

refactor: replace lib with pkg

9dcccd5

Co-authored-by: DmitriyLewen <91113035+DmitriyLewen@users.noreply.github.com>

refactor: replace lib with pkg

52cb6d1

Co-authored-by: DmitriyLewen <91113035+DmitriyLewen@users.noreply.github.com>

refactor: replace lib with pkg

bff98d2

Co-authored-by: DmitriyLewen <91113035+DmitriyLewen@users.noreply.github.com>

refactor: replace lib with pkg

d416271

Co-authored-by: DmitriyLewen <91113035+DmitriyLewen@users.noreply.github.com>

refactor: replace lib with pkg

4c3ddab

Co-authored-by: DmitriyLewen <91113035+DmitriyLewen@users.noreply.github.com>

knqyf263 and others added 9 commits May 7, 2024 14:05

refactor: replace lib with pkg

ce70874

Co-authored-by: DmitriyLewen <91113035+DmitriyLewen@users.noreply.github.com>

refactor: replace lib with pkg

82f95d3

Co-authored-by: DmitriyLewen <91113035+DmitriyLewen@users.noreply.github.com>

refactor: replace lib with pkg

b02d21f

Co-authored-by: DmitriyLewen <91113035+DmitriyLewen@users.noreply.github.com>

refactor: replace lib with pkg

e854249

Co-authored-by: DmitriyLewen <91113035+DmitriyLewen@users.noreply.github.com>

refactor(hex): use sort.Sort

07da4e2

Signed-off-by: knqyf263 <knqyf263@gmail.com>

refactor(pnpm): use sort.Sort

5f43652

Signed-off-by: knqyf263 <knqyf263@gmail.com>

refactor(npm): replace lib with pkg

d284d01

Signed-off-by: knqyf263 <knqyf263@gmail.com>

refactor(yarn): use sort.Sort

fee8c55

Signed-off-by: knqyf263 <knqyf263@gmail.com>

refactor: renaming

f83ca44

Signed-off-by: knqyf263 <knqyf263@gmail.com>

DmitriyLewen added 2 commits May 7, 2024 17:41

refactor: rename lib to pkg

2c73669

refactor: use sort.Sort instead of sort.Slice

b2d35b1

DmitriyLewen approved these changes May 7, 2024

View reviewed changes

knqyf263 enabled auto-merge May 7, 2024 12:19

knqyf263 added this pull request to the merge queue May 7, 2024

Merged via the queue into aquasecurity:main with commit 3eecfc6 May 7, 2024
12 checks passed

knqyf263 deleted the refactor/libraries branch May 7, 2024 12:49

nscuro mentioned this pull request May 20, 2024

TrivyAnalysisTaskIntegrationTest#test fails with Trivy v0.51.2 DependencyTrack/dependency-track#3737

Closed

2 tasks

DmitriyLewen mentioned this pull request Jun 13, 2024

fix(license): return license separation using separators ,, or, etc. #6916

Open

7 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

refactor: unify Library and Package structs #6633

refactor: unify Library and Package structs #6633

knqyf263 commented May 6, 2024

DmitriyLewen May 7, 2024

knqyf263 May 7, 2024

knqyf263 commented May 7, 2024

DmitriyLewen left a comment •

edited

knqyf263 commented May 7, 2024

refactor: unify Library and Package structs #6633

refactor: unify Library and Package structs #6633

Conversation

knqyf263 commented May 6, 2024

Description

Related PRs

Checklist

DmitriyLewen May 7, 2024

Choose a reason for hiding this comment

knqyf263 May 7, 2024

Choose a reason for hiding this comment

knqyf263 commented May 7, 2024

DmitriyLewen left a comment • edited

Choose a reason for hiding this comment

knqyf263 commented May 7, 2024

DmitriyLewen left a comment •

edited