refactor: patch with context #732
Conversation
Signed-off-by: Miaha Cybersec <MiahaCybersec@gmail.com>
Signed-off-by: Miaha Cybersec <MiahaCybersec@gmail.com>
Signed-off-by: Miaha Cybersec <MiahaCybersec@gmail.com>
Signed-off-by: Miaha Cybersec <MiahaCybersec@gmail.com>
Signed-off-by: Miaha Cybersec <MiahaCybersec@gmail.com>
Signed-off-by: Miaha Cybersec <MiahaCybersec@gmail.com>
Signed-off-by: Miaha Cybersec <MiahaCybersec@gmail.com>
MiahaCybersec
requested review from
jeremyrickard,
sozercan and
ashnamehrotra
as code owners
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #732 +/- ##
==========================================
+ Coverage 47.46% 49.35% +1.88%
==========================================
Files 18 18
Lines 1677 1702 +25
==========================================
+ Hits 796 840 +44
+ Misses 826 805 -21
- Partials 55 57 +2 ☔ View full report in Codecov by Sentry. |
Signed-off-by: Miaha Cybersec <MiahaCybersec@gmail.com>
There was a problem hiding this comment.
@MiahaCybersec I have submitted some review comments on the tests and code.
This is good work that will make it easier for the Copa project to on-board new contributors, well done!
My requested changes are largely around improving the story telling around how copa works which will benefit both early adopting end-users and new contributors.
I have one question on the TrivyOpts and why that include non-trivy related fields (there's a bk client in there)
The most important thing to do with work like this is to test it extensively and ensure that no behaviour has changed as a result of the submitted changes.
| @@ -291,3 +298,228 @@ func TestGetOSVersion(t *testing.T) { | |||
| }) | |||
| } | |||
| } | |||
|
|
|||
| func TestGeneratePatchedTag(t *testing.T) { | |||
There was a problem hiding this comment.
I like this test!
It is easy to understand from having worked with you this.
That test names could be even more explicit so as to differentiate between two types of tag that we are considering here in this test.
We have two tags
- The user-supplied tag which leaves a breadcrumb indicating that the image was patched by copa
- The imagename tag which appears at the end of the image
If you use ImageTag and UserSuppliedTag in the test names a new contributor (or a curious end-user) would more easily understand this test.
There was a problem hiding this comment.
In the test case we are only supplying a user patched tag, which can either be empty "", or supplied "example-supplied-tag". The differentiation is done within the function itself, not the parameters being passed in.
This is why for some of the test cases, an empty string is passed in but the expected result contains defaultPatchedTagSuffix
…tion Extracted BuildKit client configurations from TrivyOpts into a new BkClient struct. Updated related functions and tests to accommodate this change, improving modularity and readability. Signed-off-by: Miaha Cybersec <MiahaCybersec@gmail.com>
Renamed the `TrivyOpts` struct to `ScannerOpts` to better reflect its purpose. Added an explicit channel parameter `ch` for error handling throughout the functions to improve code clarity and maintainability. Added new test cases to cover scenarios with digest-referenced Docker images. Signed-off-by: Miaha Cybersec <MiahaCybersec@gmail.com>
Signed-off-by: Miaha <143584635+MiahaCybersec@users.noreply.github.com>
|
LGTM, will wait to merge. @MiahaCybersec @RobertKielty and I discussed adding canary testing before merging large changes. |
|
Changing PR to draft until it gets further review 👍 |
Closes #723