Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

refactor(vex): improve SBOM reference handling with project standards #8457

Merged
merged 2 commits into from
Mar 3, 2025

Conversation

knqyf263
Copy link
Collaborator

Overview

This PR refactors the SBOM reference handling code to better align with project conventions.

Description

The changes focus on improving the code structure and readability in the VEX SBOM reference implementation:

  • Added context-based logging for improved traceability and debugging
  • Utilized lo.FilterMap for more concise and functional URL parsing
  • Simplified error handling and logging patterns
  • Improved code structure with cleaner function signatures and return patterns
  • Enhanced test readability by using table-driven tests with clear test cases
  • Refactored external VEX document retrieval with table-driven tests for better test coverage and maintainability

These changes maintain the same functionality while making the code more maintainable and consistent with the project's coding standards.

PRs

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).

- Refactor external VEX document retrieval with table-driven tests
- Add context logging for better traceability
- Use lo.FilterMap for more concise URL parsing
- Simplify error handling and logging
@knqyf263 knqyf263 self-assigned this Feb 27, 2025
- Replace `require.NoError()` with explicit error handling in test server
- Add more descriptive error messages for file opening and copying failures
- Reorder imports in sbomref.go for consistency
@knqyf263 knqyf263 marked this pull request as ready for review March 3, 2025 12:41
@knqyf263 knqyf263 requested a review from DmitriyLewen March 3, 2025 12:41
Copy link
Contributor

@DmitriyLewen DmitriyLewen left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@DmitriyLewen DmitriyLewen added this pull request to the merge queue Mar 3, 2025
Merged via the queue into aquasecurity:main with commit 1f85b27 Mar 3, 2025
12 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants