Enhancement request: Trigger `populate_purldb` pipeline in ScanCode.io on SBOM import
メンテナーはふだん 1 日以内に返信
まだ誰も着手していません。
評価
- 難易度
- 5/5
- 見積もり時間
- 1週間以上
- 初心者へのやさしさ
- 25/100
調査の方向性
まず、SBOM インポートのエントリポイントと、名前付きの load_sbom および populate_purldb パイプラインを追跡します。最初に ScanCode.io の依存関係の問題 #1644 を確認してください。次に、web/API オプション、PurlDB の完了、Improve Packages from PurlDB、およびその後のスキャンフローを整理します。設定されたインポートが、ScanCode.io で手動作業を行わずにこれらの手順を完了できれば完了です。
索引モデルが issue の本文から書いたものです。
説明
Is your enhancement request related to a problem? Please describe.
Currently DejaCode has trouble getting all necessary information for scanning package that have been imported from SBOMs. Most often not enough information are present to deduce the download URL. For references, see issues such as:
- https://github.com/aboutcode-org/dejacode/issues/121
- https://github.com/aboutcode-org/dejacode/issues/258
- https://github.com/aboutcode-org/dejacode/issues/256
The issue stems from the fact the translation from PURL to URL is not always directly possible and may thus not be supported by purl2url and/or DejaCode is not using purl2url in all situations (it is used when manually adding a package but seemingly not when importing through SBOM). For example more elaborate logic is needed for Maven to determine what file needs to be downloaded, which may not be immediately clear from the PURL as the file could have a variety of potential file extensions. This issue can be addressed by using DejaCode, ScanCode.io, and PurlDB, where PurlDB is pulling the metadata of the package, which can then be used to enhance the package information in DejaCode.
Currently the step of gathering metadata for an SBOM requires manually creating an additional pipeline in ScanCode.io to run populate_purldb for the imported SBOM. My suggestion would be to offer an additional option for the SBOM import so that DejaCode triggers this pipeline automatically after running load_sbom. In a completely perfect solution, DejaCode would also allow to run "Improve Package from PurlDB" automatically, once PurlDB has concluded the gathering of metadata. This is needed to assign the download URLs to the package, otherwise the scanning of packages cannot be started
Note: For this to work, ScanCode.io first has to fix the bug in https://github.com/aboutcode-org/scancode.io/issues/1644 where populate_purldb fails if any dependencies are listed in the SBOM. This currently requires to manually edit the SBOM file and remove the dependencies array in the JSON file.
What are the benefits of the requested enhancement?
- Users can import SBOM and have packages analyzed straight from DejaCode, without requiring additional manual steps or access to ScanCode.io
- Allows fully automated CI/CD integration, where a product is created, SBOM uploads, metadata gathered and then all packages get scanned
Describe the solution you would like
- Extend the project that is being created in ScanCode.io by a
populate_purldbpipeline after theload_sbompipeline - Run "Improve Packages from PurlDB" once the PurlDB has gather the metadata (unclear if this is technically possible)
- Once the metadata has been added to the packages continue with scanning the packages
- Provide options in the web view and API to configure if these two options should be enabled for an SBOM import
Additional notes
This feature together with the fix for ScanCode.io would greatly help to integrate this an automated CI workflow.
- 主要言語
- Python
- スター
- 52
- フォーク
- 30
- 平均マージ
- 4時間 57分
- マージ済み PR(30日)
- 21
環境構築
- Dockerfile または Docker Compose ファイルあり
- プルリクエストのテンプレートあり
- コントリビューションガイドを読む
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
aboutcode-org/dejacode のほかの issue
-
DOC: Document workflow between ScanCode.io and DejaCode対応中かも @tdruez が 1 日前に担当しました。 オープンdocumentation
難易度 3/5 1〜2日 初心者へのやさしさ 55/100
aboutcode-org/dejacode#606 · コメント 2 件 ·
メンテナーはふだん 1 日以内に返信
-
難易度 4/5 3〜5日 初心者へのやさしさ 45/100
aboutcode-org/dejacode#603 ·
メンテナーはふだん 1 日以内に返信
-
design needed enhancement
難易度 3/5 1〜2日 初心者へのやさしさ 62/100
aboutcode-org/dejacode#561 · コメント 3 件 ·
メンテナーはふだん 1 日以内に返信
-
Enhancement request: Refine License Category - Copyleft Limited再び着手できるかも @hesa が 119 日前に担当しましたが、オープン中のプルリクエストはありません。 オープンdesign needed enhancement
aboutcode-org/dejacode#499 · コメント 13 件 · 担当者 3 名 ·
メンテナーはふだん 1 日以内に返信
-
BUG: Product overview page splits product with many versions across pages再び着手できるかも このイシューのプルリクエストはマージされずにクローズされました。 オープンbug design needed enhancement
難易度 3/5 1〜2日 初心者へのやさしさ 45/100
aboutcode-org/dejacode#460 ·
メンテナーはふだん 1 日以内に返信
aboutcode-org/dejacode の issue をすべて見る
似ている issue
-
難易度 2/5 1〜3時間 初心者へのやさしさ 76/100
pytest-dev/pytest-html#1085 ·
-
難易度 2/5 1〜3時間 初心者へのやさしさ 90/100
pollen-robotics/reachy_mini#1527 ·
メンテナーはふだん 1 日以内に返信
-
難易度 1/5 1時間未満 初心者へのやさしさ 66/100
メンテナーはふだん 2 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
メンテナーはふだん 1 日以内に返信
-
A seed and its negative give the same run, so realizations of a negative seed repeat each otherオープン
難易度 2/5 1〜3時間 初心者へのやさしさ 66/100
メンテナーはふだん 1 日以内に返信