codeql/ql
Henry Mercer 9409d7fdca
Merge pull request #16066 from github/henrymercer/ql-run-diagnostics
QL: Run diagnostics and summary metrics in code scanning
2024-04-02 10:45:50 +01:00
..
.vscode
buramu Merge pull request #16033 from github/dependabot/cargo/ql/regex-1.10.4 2024-04-02 07:52:17 +02:00
extractor Bump regex from 1.10.3 to 1.10.4 in /ql 2024-03-25 03:31:03 +00:00
ql QL: Run diagnostics and summary metrics in code scanning 2024-03-26 18:11:50 +00:00
scripts QL: Rename extractor to codeql-extractor-ql 2023-04-19 06:30:09 +00:00
tools QL: switch to shared YAML extractor 2023-05-22 19:28:59 +02:00
.gitattributes QL: move .git files into the ql/ folder 2021-12-15 12:25:08 +01:00
.gitignore QL: move .git files into the ql/ folder 2021-12-15 12:25:08 +01:00
Cargo.lock Merge pull request #16033 from github/dependabot/cargo/ql/regex-1.10.4 2024-04-02 07:52:17 +02:00
Cargo.toml QL: Merge extractor crates into one 2023-03-23 11:59:14 +13:00
README.md move create-extractor-pack to a `scripts` folder 2022-06-19 20:09:31 +02:00
codeql-extractor.yml Add supported build modes to extractor metadata 2024-02-06 19:51:13 +00:00
rust-toolchain.toml QL: Bump rust to 1.68 2023-03-23 11:59:14 +13:00

README.md

QL for QL

QL for QL is a CodeQL analysis designed to find common bug patterns in QL code.
This analysis is mostly used as a PR check in github/codeql.
QL for QL is experimental technology and not a supported product.

This directory contains the extractor, CodeQL libraries, and queries that power QL for QL.

Some setup is required to use QL for QL (see the below sections).

Building the tools from source

Install Rust (if using VSCode, you may also want the rust-analyzer extension), then run:

cargo build --release

Generating the database schema and QL library

The generated ql/src/ql.dbscheme and ql/src/codeql_ql/ast/internal/TreeSitter.qll files are included in the repository, but they can be re-generated as follows:

./scripts/create-extractor-pack.sh

Building a CodeQL database for a QL program

First, get an extractor pack:

Run ./scripts/create-extractor-pack.sh (Linux/Mac) or .\scripts\create-extractor-pack.ps1 (Windows PowerShell) and the pack will be created in the extractor-pack directory.

Then run

codeql database create <database-path> -l ql -s <project-source-path> --search-path <extractor-pack-path>

CodeQL can be configured to remember the extractor by setting the config file ~/.config/codeql/config to:

--search-path /full/path/to/extractor-pack

Running qltests

Run

codeql test run <test-path> --search-path <repository-root-path>