codeql/rust
Geoffrey White b3f7a8a46f
Merge pull request #17908 from geoffw0/dfcons
Rust: Expose counts of data flow inconsistencies
2024-11-06 19:11:04 +00:00
..
ast-generator Rust: add `canonical_path` and `crate_origin` to `Item` 2024-10-25 16:58:04 +02:00
codegen Rust: remove useless blank line 2024-10-15 16:50:15 +02:00
extractor Rust: fix semantic merge conflict about semantics 2024-11-04 10:04:40 +01:00
ql Merge pull request #17908 from geoffw0/dfcons 2024-11-06 19:11:04 +00:00
schema Rust: add block ids to canonical paths, making them "extended" 2024-10-28 12:41:05 +01:00
tools Rust: fix qltest on macOS, and add CI cross-platform testing of it 2024-10-25 12:19:46 +02:00
BUILD.bazel Codegen/Rust: allow breaking up schema file 2024-09-19 15:57:42 +02:00
README.md Rust: Update example path. 2024-09-10 17:09:51 +01:00
codegen.conf Codegen/Rust: allow breaking up schema file 2024-09-19 15:57:42 +02:00
codeql-extractor.yml Fix definition of trap compression option 2024-09-10 17:13:49 +02:00
lint.py Rust: use shared path utilities 2024-09-17 12:27:57 +02:00
prefix.dbscheme Rust: integrate into standard files+location library 2024-09-12 13:17:10 +02:00

README.md

Rust on CodeQL

[!WARNING] Rust support for CodeQL is experimental. No support is offered. QL and database interfaces will change and break without notice or deprecation periods.

Development

Dependencies

If you don't have the semmle-code repo you may need to install Bazel manually, e.g. from https://github.com/bazelbuild/bazelisk.

Building the Rust Extractor

This approach uses a released codeql version and is simpler to use for QL development. From your semmle-code directory run:

bazel run @codeql//rust:rust-installer

You now need to create a per-user CodeQL configuration file and specify the option:

--search-path PATH/TO/semmle-code/ql

(wherever the codeql checkout is on your system)

You can now use the Rust extractor e.g. to run Rust tests from the command line or in VSCode.

Building the Rust Extractor (as a sembuild target)

This approach allows you to build a Rust extractor with a CLI built from source. From your semmle-code directory run:

./build target/intree/codeql-rust

You can now invoke it directly, for example to run some tests:

./target/intree/codeql-rust/codeql test run ql/rust/ql/test/PATH/TO/TEST/

Building a Database

TODO

Code Generation

TODO