derek.holloway
7502bf64a4
CodeQL / Analyze (actions) (push) Canceled after 0s
CodeQL / Analyze (python) (push) Canceled after 0s
pre-commit / pre-commit (push) Canceled after 0s
Multi-Arch CI / setup (push) Canceled after 0s
Publish build_manylinux_x86_64 images / publish_build_manylinux_x86_64 (push) Canceled after 0s
Setup (Multi-Arch) / setup (push) Canceled after 0s
Multi-Arch CI / Linux::${{ fromJSON(needs.setup.outputs.linux_build_config || '{}').build_variant_label || 'skip' }} (push) Canceled after 0s
Publish TheRock Docker image / build-and-push-image (push) Canceled after 0s
Publish no_rocm_image_ubi10 image / publish_no_rocm_image_ubi10 (push) Canceled after 0s
Multi-Arch CI / Windows::${{ fromJSON(needs.setup.outputs.windows_build_config || '{}').build_variant_label || 'skip' }} (push) Canceled after 0s
Publish TheRock Docker image / build-and-push-image (push) Canceled after 0s
Multi-Arch CI / Manifest Diff (push) Canceled after 0s
TheRock Manifest Diff Report / Generate Manifest Diff Report (push) Canceled after 0s
Multi-Arch CI / CI Summary (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04 images / publish_no_rocm_image_ubuntu24_04 (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04_ocl_rt images / publish_no_rocm_image_ubuntu24_04_ocl_rt (push) Canceled after 0s
Publish TheRock Docker image / build-and-push-image (push) Canceled after 0s
Publish TheRock Docker image / build-and-push-image (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04 images / publish_no_rocm_image_ubuntu24_04_rocgdb (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04_rocgdb images / publish_no_rocm_image_ubuntu24_04_rocgdb (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04 images / publish_no_rocm_image_ubuntu24_04_ocl_rt (push) Canceled after 0s
Publish TheRock Docker image / build-and-push-image (push) Canceled after 0s
Unit Tests / Unit Tests :: ubuntu-24.04 (push) Canceled after 0s
Unit Tests / Unit Tests :: windows-2022 (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04 images / publish_no_rocm_image_ubuntu24_04_media (push) Canceled after 0s
Unit Tests / Unit Tests Summary (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04 images / publish_no_rocm_image_ubuntu24_04_openmpi (push) Canceled after 0s
41 lines
1.5 KiB
Markdown
41 lines
1.5 KiB
Markdown
# Using CodeQL
|
|
|
|
## Installation
|
|
|
|
`install_codeql` called by the docker files to install the CodeQL CLI and external queries. If invoking this script manually, be sure to run `export PATH=$PATH:/opt/codeql/codeql`.
|
|
|
|
## Setup
|
|
|
|
`setup_codeql` sets up the directories and externally authored queries.
|
|
|
|
## Create Database
|
|
|
|
`create_database` builds the cpp project and creates the CodeQL database.
|
|
|
|
## Analyse / Run Queries
|
|
|
|
`analyze_database` runs all queries on the CodeQL database and outputs the result to `build/codeql.sarif` and `build/codeql.html`. The errors/warnings/recommendations can be visualised with a [SARIF viewer](https://sarifweb.azurewebsites.net/#Viewers).
|
|
|
|
## Creating New Queries
|
|
|
|
New queries should be stored in `<language>/src/`. Libraries that may be included in one or more queries should be stored in `<language>/lib/` (libraries cannot contain queries).
|
|
|
|
### Run A Single Query
|
|
|
|
`run_single_query <path/to/query.ql>` runs a singular query.
|
|
For example, `codeql/run_single_query codeql/cpp/src/ToStringNaming.ql`.
|
|
|
|
### Create Tests for Query
|
|
|
|
`codeql/inflate_new_test_dir.py -p codeql/<language>/test/ <NewQueryName>` to setup a directory with the files required for testing.
|
|
For example `codeql/inflate_new_test_dir.py -p codeql/cpp/test/ ToStringNaming`.
|
|
|
|
### Run Tests
|
|
|
|
`codeql/run_tests` to run tests for the queries.
|
|
|
|
## Useful Docummentation
|
|
|
|
[CodeQL for C and C++](https://codeql.github.com/docs/codeql-language-guides/codeql-for-cpp/)
|
|
[QL Language Reference](https://codeql.github.com/docs/ql-language-reference/)
|