Build tracing filtering: path-based inclusion & content-based exclusion
- 主要言語
- CodeQL
- スター
- 10.1k
- フォーク
- 2.1k
- 平均マージ
- 2日 15時間
- マージ済み PR(30日)
- 141
説明
I'm using the CodeQL CLI with a large Java/Kotlin project that makes heavy use of autogenerated source during the build process. Because of this, I am using build tracing (`codeql database trace-command`) to extract CodeQL databases.
Is there any way to filter the files processed by the extractor in the following ways? If not, please consider this a feature request :)
---
### Include-filtering by path
I'd like to be able to extract databases for certain components of the project. Due to the complexity of the project's build system, it's not easy to just build/trace only those components of the project; instead it would be much easier if I could just restrict extraction to those components' files by providing path globs during build tracing.
I'm aware that files can be excluded using the `exclude` extractor option, but this only allows certain path globs to be *excluded*, not *included*.
### Exclude-filtering by file contents
As mentioned earlier, the project has a lot of autogenerated code, some (but only some) of which needs to be ignored. This code is often generated with paths that are not easily excludable using the existing path-glob-based exclusions. It would be great if I can specify regexes to search for in the content of files that indicate that the file should not be extracted (e.g. to look for things like "// Autogenerated file, do not edit", etc.)
---
If there isn't a way to do these, I'm happy to hear about hacky workarounds. For example, the commands I trace are already wrapped in shell scripts that wrap the underlying compilers (`javac` etc.) in order to provide for more filtering criteria than mentioned here. However, it's hard to do the above properly using such a wrapper because of i.e. the need to properly parse the original compiler command line arguments, handle things like files in JAR files, [indirect command line options](https://docs.oracle.com/en/java/javase/17/docs/specs/man/javac.html#option-at), etc. The extractor is much better placed to handle such filtering.
コントリビューションガイド
調査の方向性
CodeQL CLI の `database trace-command` フローと既存の extractor の `exclude` オプションから始め、Java および Kotlin コンパイラの入力がどのように抽出処理へ渡されるかを追跡します。この依頼には、パスベースの包含とコンテンツベースの除外という 2 つの別個の目的があります。両方のフィルタリング動作を定義して実装し、そのコマンドライン設定とサポートされるマッチングセマンティクスを文書化すれば完了です。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- java, kotlin
- 領域
- build-system, tooling
- issue の種類
- 機能追加
- 難易度
- 5/5
- 見積もり時間
- 1週間以上
- 活発さ
- 静か
- 明瞭さ
- おおむね明確
- 初心者へのやさしさ
- 38/100