4110636032
This is a small devex improvement to the rust code generator. Usage of `sorted` in `rustgen.py` was causing the generated code to be completely reshuffled on renames, which made diffs hard to follow. As an example see [this generated file diff](https://github.com/github/codeql/pull/19059/files#diff-c938ba77a3398dd4c633ada5702a03477705c24740a2f7d1e40d4b270d8c3f86). This will make the order deterministically based on the order of definitions in the schema file. This means that renames will find the same place in the generated file, and the place in the generated file will generally be more predictable with respect to the schema. However, that does mean this change is heavily reshuffling the generated code.
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 anywhere under your semmle-code or codeql directory you can run:
bazel run @codeql//rust:install
You can use shorter versions of the above command:
bazel run //rust:install # if under the `codeql` checkout
bazel run rust:install # if at the root of the `codeql` checkout
bazel run :install # if at the `rust` directory of the `codeql` checkout
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
If you make changes to either
ast-generator/, orschema/*.py
you'll need to regenerate code. You can do so running
bazel run @codeql//rust/codegen
Sometimes, especially if resolving conflicts on generated files, you might need to run
bazel run @codeql//rust/codegen -- --force
for code generation to succeed.