From ed663885515788f306b4cf8dc27d173c96911fff Mon Sep 17 00:00:00 2001 From: Andrew Eisenberg Date: Thu, 18 Aug 2022 15:28:50 -0700 Subject: [PATCH] Port Pack Docs changes to 3.7 This moves the following three PRs to the 3.7 branch: - https://github.com/github/codeql/pull/10182 - https://github.com/github/codeql/pull/10146 - https://github.com/github/codeql/pull/10105 --- docs/codeql/codeql-cli/about-codeql-packs.rst | 306 ++++++++++++++++-- .../codeql-cli/about-codeql-workspaces.rst | 94 ++++++ docs/codeql/codeql-cli/about-ql-packs.rst | 245 -------------- ...nalyzing-databases-with-the-codeql-cli.rst | 89 ++--- .../codeql-cli/codeql-cli-reference.rst | 9 +- ...creating-and-working-with-codeql-packs.rst | 15 +- .../codeql-cli/creating-codeql-databases.rst | 64 ++-- .../creating-codeql-query-suites.rst | 77 +++-- .../getting-started-with-the-codeql-cli.rst | 25 +- .../publishing-and-using-codeql-packs.rst | 3 +- .../codeql-cli/query-reference-files.rst | 22 +- ...options-in-a-codeql-configuration-file.rst | 10 +- .../codeql-cli/testing-custom-queries.rst | 111 +++---- .../codeql-cli/testing-query-help-files.rst | 42 +-- .../codeql-cli/upgrading-codeql-databases.rst | 55 ---- ...ing-custom-queries-with-the-codeql-cli.rst | 19 +- .../codeql-cli/using-the-codeql-cli.rst | 15 +- .../analyzing-your-projects.rst | 14 +- ...etting-up-codeql-in-visual-studio-code.rst | 2 +- .../codeql-overview/codeql-glossary.rst | 52 +-- .../ql-language-specification.rst | 14 +- docs/codeql/reusables/test-qlpack.rst | 14 +- .../about-codeql-queries.rst | 4 +- 23 files changed, 668 insertions(+), 633 deletions(-) create mode 100644 docs/codeql/codeql-cli/about-codeql-workspaces.rst delete mode 100644 docs/codeql/codeql-cli/about-ql-packs.rst delete mode 100644 docs/codeql/codeql-cli/upgrading-codeql-databases.rst diff --git a/docs/codeql/codeql-cli/about-codeql-packs.rst b/docs/codeql/codeql-cli/about-codeql-packs.rst index 2f9c6eebd37..dca601c530a 100644 --- a/docs/codeql/codeql-cli/about-codeql-packs.rst +++ b/docs/codeql/codeql-cli/about-codeql-packs.rst @@ -14,11 +14,18 @@ There are two types of CodeQL packs: query packs and library packs. You can use the package management commands in the CodeQL CLI to create CodeQL packs, add dependencies to packs, and install or update dependencies. For more information, see ":ref:`Creating and working with CodeQL packs `." You can also publish and download CodeQL packs using the CodeQL CLI. For more information, see ":doc:`Publishing and using CodeQL packs `." + +The standard CodeQL packages for all supported languages are published in the `GitHub Container registry `__. +The `CodeQL repository `__ contains source files for the standard CodeQL packs for all supported languages. + +.. _codeql-pack-structure: + CodeQL pack structure --------------------- -A CodeQL pack must contain a file called ``qlpack.yml`` in its root directory. In the ``qlpack.yml`` file, the ``name:`` field must have a value that follows the format of ``/``, where ```` is the GitHub organization or user account that the pack will be published to and ```` is the name of the pack. The other -files and directories within the pack should be logically organized. For example, typically: +A CodeQL pack must contain a file called ``qlpack.yml`` in its root directory. In the ``qlpack.yml`` file, the ``name:`` field must have a value that follows the format of ``/``, where ```` is the GitHub organization or user account that the pack will be published to and ```` is the name of the pack. Additionally, query packs and library packs with CodeQL tests contain a ``codeql-pack.lock.yml`` file that contains the resolved dependencies of the pack. This file is generated during a call to the ``codeql pack install`` command, is not meant to be edited by hand, and should be added to your version control system. + +The other files and directories within the pack should be logically organized. For example, typically: - Queries are organized into directories for specific categories. - Queries for specific products, libraries, and frameworks are organized into @@ -27,21 +34,17 @@ files and directories within the pack should be logically organized. For example About ``qlpack.yml`` files -------------------------- -When executing query-related commands, CodeQL first looks in siblings of the installation directory (and their subdirectories) for ``qlpack.yml`` files. -Then it checks the package cache for CodeQL packs which have been downloaded. This means that when you are developing queries locally, the local packages +When executing query-related commands, CodeQL first looks in siblings of the installation directory (and their subdirectories) for ``qlpack.yml`` files. +Then it checks the package cache for CodeQL packs which have been downloaded. This means that when you are developing queries locally, the local packages in the installation directory override packages of the same name in the package cache, so that you can test your local changes. -The metadata in each `qlpack.yml`` file tells +The metadata in each ``qlpack.yml`` file tells CodeQL how to compile any queries in the pack, what libraries the pack depends on, and where to find query suite definitions. -The contents of the CodeQL pack (queries or libraries used in CodeQL analysis) is -included in the same directory as ``qlpack.yml``, or its subdirectories. +The contents of the CodeQL pack (queries or libraries used in CodeQL analysis) is included in the same directory as ``qlpack.yml``, or its subdirectories. -The location of ``qlpack.yml`` defines the library path for the content -of the CodeQL pack. That is, for all ``.ql`` and ``.qll`` files in the pack, -CodeQL will resolve all import statements relative to the ``qlpack.yml`` at the -pack's root. +The directory containing the ``qlpack.yml`` file serves as the root directory for the content of the CodeQL pack. That is, for all ``.ql`` and ``.qll`` files in the pack, CodeQL will resolve all import statements relative to the directory containing the ``qlpack.yml`` file at the pack's root. .. _codeqlpack-yml-properties: @@ -56,49 +59,282 @@ The following properties are supported in ``qlpack.yml`` files. * - Property - Example - - Required + - Required by - Purpose * - ``name`` - - ``octo-org/security-queries`` + - .. code-block:: yaml + + name: octo-org/security-queries + - All packs - - The scope, where the CodeQL pack is published, and the name of the pack defined using alphanumeric characters and hyphens. It must be unique as CodeQL cannot differentiate between CodeQL packs with identical names. Name components cannot start or end with a hyphen. Additionally, a period is not allowed in pack names at all. Use the pack name to specify queries to run using ``database analyze`` and to define dependencies between QL packs (see examples below). + - The scope, where the CodeQL pack is published, and the name of the pack defined using alphanumeric characters and hyphens. It must be unique as CodeQL cannot differentiate between CodeQL packs with identical names. Use the pack name to specify queries to run using ``database analyze`` and to define dependencies between CodeQL packs (see examples below). * - ``version`` - - ``0.0.0`` + - .. code-block:: yaml + + version: 0.0.0 + - All packs - - A version range for this CodeQL pack. This must be a valid semantic version that meets the `SemVer v2.0.0 specification `__. + - A semantic version for this CodeQL pack that must adhere to the `SemVer v2.0.0 specification `__. * - ``dependencies`` - - ``codeql/javascript-all: ^1.2.3`` - - Optional - - The names and version ranges of any CodeQL packs that this pack depends on, as a mapping. This gives the pack access to any libraries, database schema, and query suites defined in the dependency. For more information, see `SemVer ranges `__ in the NPM documentation. + - .. code-block:: yaml + + dependencies: + codeql/cpp-all: ^0.0.2 + + - Packs that define CodeQL package dependencies on other packs + - A map from pack references to the semantic version range that is compatible with this pack. Supported for CLI versions v2.6.0 and later. + * - ``defaultSuiteFile`` + - .. code-block:: yaml + + defaultSuiteFile: cpp-code-scanning.qls + + - Packs that export a set of default queries to run + - The path to a query suite file relative to the package root, containing all of the queries that are run by default when this pack is passed to the ``codeql database analyze`` command. Supported from CLI version v2.6.0 and onwards. Only one of ``defaultSuiteFile`` or ``defaultSuite`` can be defined. + * - ``defaultSuite`` + - .. code-block:: yaml + + defaultSuite: + queries: . + exclude: + precision: medium + + - Packs that export a set of default queries to run + - An inlined query suite containing all of the queries that are run by default when this pack is passed to the ``codeql database analyze`` command. Supported from CLI version v2.6.0 and onwards. Only one of ``defaultSuiteFile`` or ``defaultSuite`` can be defined. + * - ``library`` + - .. code-block:: yaml + + library: true + + - Library packs + - A boolean value that indicates whether this pack is a library pack. Library packs do not contain queries and are not compiled. Query packs can ignore this field or explicitly set it to ``false``. * - ``suites`` - - ``octo-org-query-suites`` + - .. code-block:: yaml + + suites: octo-org-query-suites + - Optional - - The path to a directory in the pack that contains the query suites you want to make known to the CLI, defined relative to the pack directory. QL pack users can run "well-known" suites stored in this directory by specifying the pack name, without providing their full path. This is not supported for CodeQL packs downloaded from a package registry. For more information about query suites, see ":doc:`Creating CodeQL query suites `." + - The path to a directory in the pack that contains the query suites you want to make known to the CLI, defined relative to the pack directory. CodeQL pack users can run "well-known" suites stored in this directory by specifying the pack name, without providing their full path. This is not supported for CodeQL packs downloaded from the Container registry. For more information about query suites, see ":doc:`Creating CodeQL query suites `." * - ``extractor`` - - ``javascript`` - - All test packs - - The CodeQL language extractor to use when the CLI creates a database in the pack. For more information about testing queries, see ":doc:`Testing custom queries `." + - .. code-block:: yaml + + extractor: javascript + + - All packs containing CodeQL tests + - The CodeQL language extractor to use when running the CodeQL tests in the pack. For more information about testing queries, see ":doc:`Testing custom queries `." * - ``tests`` - - ``.`` - - Optional for test packs - - The path to a directory within the pack that contains tests, defined relative to the pack directory. Use ``.`` to specify the whole pack. Any queries in this directory are run as tests when ``test run`` is run with the ``--strict-test-discovery`` option. These queries are ignored by query suite definitions that use ``queries`` or ``qlpack`` instructions to ask for all queries in a particular pack. + - .. code-block:: yaml + + tests: . + + - Optional for packs containing CodeQL tests. Ignored for packs without tests. + - The path to a directory within the pack that contains tests, defined relative to the pack directory. Use ``.`` to specify the whole pack. Any queries in this directory are run as tests when ``test run`` is run with the ``--strict-test-discovery`` option. These queries are ignored by query suite definitions that use ``queries`` or ``qlpack`` instructions to ask for all queries in a particular pack. If this property is missing, then ``.`` is assumed. * - ``dbscheme`` - - ``semmlecode.python.dbscheme`` + - .. code-block:: yaml + + dbscheme: semmlecode.python.dbscheme + - Core language packs only - The path to the :ref:`database schema ` for all libraries and queries written for this CodeQL language (see example below). * - ``upgrades`` - - ``.`` + - .. code-block:: yaml + + upgrades: . + - Core language packs only - - The path to a directory within the pack that contains upgrade scripts, defined relative to the pack directory. The ``database upgrade`` action uses these scripts to update databases that were created by an older version of an extractor so they're compatible with the current extractor (see `Upgrade scripts for a language <#upgrade-scripts-for-a-language>`__ below.) + - The path to a directory within the pack that contains database upgrade scripts, defined relative to the pack directory. Database upgrades are used internally to ensure that a database created with a different version of the CodeQL CLI is compatible with the current version of the CLI. * - ``authors`` - - ``example@github.com`` + - .. code-block:: yaml + + authors: author1@github.com,author2@github.com + - All packs - Metadata that will be displayed on the packaging search page in the packages section of the account that the CodeQL pack is published to. - * - ``licenses`` - - ``(LGPL-2.1 AND MIT)`` + * - ``license`` + - .. code-block:: yaml + + license: MIT + - All packs - - Metadata that will be displayed on the packaging search page in the packages section of the account that the CodeQL pack is published to. For a list of allowed licenses, see `SPDX License List `__ in the SPDX Specification. + - Metadata that will be displayed on the packaging search page in the packages section of the account that the CodeQL pack is published to. For a list of allowed licenses, see `SPDX License List `__ in the SPDX Specification. * - ``description`` - - ``Human-readable description of the contents of the CodeQL pack.`` + - .. code-block:: yaml + + description: Human-readable description of the contents of the CodeQL pack. + - All packs - Metadata that will be displayed on the packaging search page in the packages section of the account that the CodeQL pack is published to. + * - ``libraryPathDependencies`` + - .. code-block:: yaml + + libraryPathDependencies: codeql/javascript-all + + - Optional, deprecated + - Use the ``dependencies`` property instead. The names of any CodeQL packs that this CodeQL pack depends on, as an array. This gives the pack access to any libraries, database schema, and query suites defined in the dependency. + +.. _about-codeql-pack-lock: + +About ``codeql-pack.lock.yml`` files +------------------------------------ + +``codeql-pack.lock.yml`` files store the versions of the resolved transitive dependencies of a CodeQL pack. This file is created by the ``codeql pack install`` command if it does not already exist and should be added to your version control system. The ``dependencies`` section of the ``qlpack.yml`` file contains version ranges that are compatible with the pack. The ``codeql-pack.lock.yml`` file locks the versions to precise dependencies. This ensures that running ``codeql pack install`` on this the pack will always retrieve the same versions of dependencies even if newer compatible versions exist. + +For example, if a ``qlpack.yml`` file contains the following dependencies: + +.. code-block:: yaml + + dependencies: + codeql/cpp-all: ^0.1.2 + my-user/my-lib: ^0.2.3 + other-dependency/from-source: "*" + +The ``codeql-pack.lock.yml`` file will contain something like the following: + +.. code-block:: yaml + + dependencies: + codeql/cpp-all: + version: 0.1.4 + my-user/my-lib: + version: 0.2.4 + my-user/transitive-dependency: + version: 1.2.4 + +The ``codeql/cpp-all`` dependency is locked to version 0.1.4. The ``my-user/my-lib`` dependency is locked to version 0.2.4. The ``my-user/transitive-dependency``, which is a transitive dependency and is not specified in the ``qlpack.yml`` file, is locked to version 1.2.4. The ``other-dependency/from-source`` is absent from the lock file since it is resolved from source. This dependency must be available in the same CodeQL workspace as the pack. For more information about CodeQL workspaces and resolving dependencies from source, see ":doc:`About CodeQL Workspaces `." + +In most cases, the ``codeql-pack.lock.yml`` file is only relevant for query packs since library packs are non-executable and usually do not need their transitive dependencies to be fixed. The exception to this is for library packs that contain tests. In this case, the ``codeql-pack.lock.yml`` file is used to ensure that the tests are always run with the same versions of dependencies to avoid spurious failures when there are mismatched dependencies. + +.. _custom-codeql-packs: + +Examples of custom CodeQL packs +------------------------------- + +When you write custom queries or tests, you should save them in custom CodeQL packs. For simplicity, try to organize each pack logically. For more information, see "`CodeQL pack structure <#codeql-pack-structure>`__." Save files for queries and tests in separate packs and, where possible, organize custom packs into specific folders for each target language. This is particuarly useful if you intend to publish your CodeQL packs so they can be shared with others or used in GitHub `Code scanning `__. + +CodeQL packs for custom libraries +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +A custom CodeQL pack containing custom C++ libraries, with no queries or tests, may have a ``qlpack.yml`` file containing: + +.. code-block:: yaml + + name: my-github-user/my-custom-libraries + version: 1.2.3 + library: true + dependencies: + codeql/cpp-all: ^0.1.2 + +where ``codeql/cpp-all`` is the name of the CodeQL pack for C/C++ analysis included in the CodeQL repository. The version range ``^0.1.2`` indicates that this pack is compatible with all versions of ``codeql/cpp-all`` that are greater than or equal to ``0.1.2`` and less than ``0.2.0``. Any CodeQL library file (a file with a ``.qll`` extension) defined in this pack will be available to queries defined in any query pack that includes this pack in its dependencies block. + +The ``library`` property indicates that this pack is a library pack and does not contain any queries. + +CodeQL packs for custom queries +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +A custom CodeQL pack containing custom C++ queries and libraries may have a ``qlpack.yml`` file containing: + +.. code-block:: yaml + + name: my-github-user/my-custom-queries + version: 1.2.3 + dependencies: + codeql/cpp-all: ^0.1.2 + my-github-user/my-custom-libraries: ^1.2.3 + suites: my-custom-suites + +where ``codeql/cpp-all`` is the name of the CodeQL pack for C/C++ analysis included in the CodeQL repository. The version range ``^0.1.2`` indicates that this pack is compatible with all versions of ``codeql/cpp-all`` that are greater than or equal to ``0.1.2`` and less than ``0.2.0``. ``my-github-user/my-custom-libraries`` is the name of a CodeQL pack containing custom CodeQL libraries for C++. Any CodeQL library file (a file with a ``.qll`` extension) defined in this pack will be available to queries in the ``my-github-user/my-custom-queries`` pack. + +The ``suites`` property indicates a directory where "well-known" query suites can be found. These suites can be used on the command line by referring to their name only, rather than their full path. For more information about query suites, see ":doc:`Creating CodeQL query suites `." + +CodeQL packs for custom tests +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +For custom CodeQL packs containing test files, you also need to include an +``extractor`` property so that the ``test run`` command knows how to create test +databases. You may also wish to specify the ``tests`` property. + +.. include:: ../reusables/test-qlpack.rst + +For more information about running tests, see ":doc:`Testing custom queries +`." + +.. _standard-codeql-packs: + +Examples of CodeQL packs in the CodeQL repository +------------------------------------------------- + +Each of the languages in the CodeQL repository has four main CodeQL packs: + +- Core library pack for the language, with the :ref:`database schema ` + used by the language, and CodeQL libraries, and queries at ``/ql/lib`` +- Core query pack for the language that includes the default queries for the language, along + with their query suites at ``/ql/src`` +- Tests for the core language libraries and queries at ``/ql/test`` +- Example queries for the language at ``/ql/examples`` + +Core library pack +~~~~~~~~~~~~~~~~~ + +Here is an example ``qlpack.yml`` file for the `C/C++ analysis libraries +`__ +core language pack: + +.. code-block:: yaml + + name: codeql/cpp-all + version: x.y.z-dev + dbscheme: semmlecode.cpp.dbscheme + library: true + upgrades: upgrades + +Some extra notes on the following properties: + +- ``library``: Indicates that this is a library pack with no executable queries. It is only meant to be used as a dependency for other packs. +- ``dbscheme`` and ``upgrades``: These properties are internal to the CodeQL CLI and should only be defined in the core QL pack for a language. + +.. _standard-codeql-query-packs: + +Core query pack +~~~~~~~~~~~~~~~ + +Here is an example ``qlpack.yml`` file for `C/C++ analysis queries +`__ +core query pack: + +.. code-block:: yaml + + name: codeql/cpp-queries + version: x.y.z-dev + dependencies: + codeql/cpp-all: "*" + codeql/suite-helpers: "*" + suites: codeql-suites + defaultSuiteFile: codeql-suites/cpp-code-scanning.qls + +Some extra notes on the following properties: + +- ``dependencies``: This query pack depends on ``codeql/cpp-all`` and ``codeql/suite-helpers``. Since these dependencies are resolved from source, it does not matter what version of the CodeQL pack they are compatible with. For more information about resolving dependencies from source, see ":ref:`Source Dependencies `." +- ``suites``: Indicates the directory containing "well-known" query suites. +- ``defaultSuiteFile``: The name of the default query suite file that is used when no query suite is specified. + +Tests for the core CodeQL pack +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Here is an example ``qlpack.yml`` file for `C/C++ analysis tests +`__ +core test pack: + +.. code-block:: yaml + + name: codeql/cpp-tests + dependencies: + codeql/cpp-all: "*" + codeql/cpp-queries: "*" + extractor: cpp + tests: . + +Some extra notes on the following properties: + +- ``dependencies``: This pack depends on the core CodeQL query and library packs for C++. +- ``extractor``: This specifies that all the tests will use the same C++ extractor to create the database for the tests. +- ``tests``: This specifies the location of the tests. In this case, the tests are in the root folder (and all sub-folders) of the pack. +- ``version``: There is no ``version`` property for the tests pack. This prevents test packs from accidentally being published. diff --git a/docs/codeql/codeql-cli/about-codeql-workspaces.rst b/docs/codeql/codeql-cli/about-codeql-workspaces.rst new file mode 100644 index 00000000000..3f27672d502 --- /dev/null +++ b/docs/codeql/codeql-cli/about-codeql-workspaces.rst @@ -0,0 +1,94 @@ +.. _about-codeql-workspaces: + +About CodeQL Workspaces +======================= + +.. include:: ../reusables/beta-note-package-management.rst + +CodeQL workspaces are used to group multiple CodeQL packs together. A typical use case for a CodeQL workspace is to develop a set of CodeQL library and query packs that are mutually dependent. For more information on CodeQL packs, see ":doc:`About CodeQL packs `." + +The main benefit of a CodeQL workspace is that it makes it easier for you to develop and maintain multiple CodeQL packs. When you use a CodeQL workspace, all the CodeQL packs in the workspace are available as *source dependencies* for each other when you run a CodeQL command that resolves queries. This makes it easier to develop, maintain, and publish multiple, related CodeQL packs. + +In most cases, you should store the CodeQL workspace and the CodeQL packs contained in it in one git repository. This makes it easier to share your CodeQL development environment. + +The ``codeql-workspace.yml`` file +--------------------------------- + +A CodeQL workspace is defined by a ``codeql-workspace.yml`` yaml file. This file contains a ``provide`` block, and optionally an ``ignore`` block. + +* The ``provide`` block contains a list of glob patterns that define the CodeQL packs that are available in the workspace. +* The ``ignore`` block contains a list of glob patterns that define CodeQL packs that are not available in the workspace. + +Each entry in the ``provide`` or ``ignore`` section must map to the location of a ``qlpack.yml`` file. All glob patterns are defined relative to the directory that contains the workspace file. For a list of patterns accepted in this file, see" `@actions/glob `__ . + +For example, the following ``codeql-workspace.yml`` file defines a workspace that contains all the CodeQL packs recursively found in the ``codeql-packs`` directory, except for the packs in the ``experimental`` directory: + +.. code-block:: yaml + + provide: + - "*/codeql-packs/**/qlpack.yml" + ignore: + - "*/codeql-packs/**/experimental/**/qlpack.yml" + +To verify that your ``codeql-workspace.yml`` file includes the CodeQL packs that you expect, run the ``codeql pack ls`` command in the same directory as your workspace. The result of the command is a list of all CodeQL packs in the workspace. + +.. _source-dependencies: + +Source Dependencies +------------------- + +Source dependencies are CodeQL packs that are resolved from the local file system outside of the CodeQL package cache. These dependencies can be in the same CodeQL workspace, or specified as a path option using the ``--additional-packs`` argument. When you compile and run queries locally, source dependencies override any dependencies found in the CodeQL package cache as well as version constraints defined in the ``qlpack.yml``. All references to CodeQL packs in the same workspace are resolved as source dependencies. + +This is particularly useful in the following situations: + +- One of the dependencies of the query pack you are running is not yet published. Resolving from source is the only way to reference that pack. +- You are making changes to multiple packs at the same time and want to test them together. Resolving from source ensures that you are using the version of the pack with your changes in it. + +CodeQL workspaces and query resolution +-------------------------------------- + +All CodeQL packs in a workspace are available as source dependencies for each other when you run any CodeQL command that resolves queries or packs. For example, when you run ``codeql pack install`` in a pack directory in a workspace, any dependency that can be found in the workspace will be used instead of downloading that dependency to the package cache and adding it to the ``codeql-pack.lock.yml`` file. For more information, see ":ref:Adding and Installing Dependencies `." + +Similarly, when you publish a CodeQL query pack to the GitHub container registry using ``codeql pack publish`` the command will always use the dependencies from the workspace instead of using dependencies found in the local package cache. + +This ensures that any local changes you make to a query library in a dependency are automatically reflected in any query packs you publish from that workspace. + +Example +~~~~~~~ + +Consider the following ``codeql-workspace.yml`` file: + +.. code-block:: yaml + + provide: + - "**/qlpack.yml" + +And the following CodeQL library pack ``qlpack.yml`` file in the workspace: + +.. code-block:: yaml + + name: my-company/my-library + library: true + version: 1.0.0 + +And the following CodeQL query pack ``qlpack.yml`` file in the workspace: + +.. code-block:: yaml + + name: my-company/my-queries + version: 1.0.0 + dependencies: + my-company/my-library: "*" + codeql/cpp-all: ~0.2.0 + +Notice that the ``dependencies`` block for the CodeQL query pack, ``my-company/my-queries``, specifies ``"*"`` as the version of the library pack. Since the library pack is already defined as a source dependency in ``codeql-workspace.yml``, the library pack's content is always resolved from inside the workspace. Any version constraint you define will be ignored in this case. We recommend that you use ``"*"`` for source dependencies to make it clear that the version is inherited from the workspace. + +When you execute ``codeql pack install`` from the query pack directory, an appropriate version of ``codeql/cpp-all`` is downloaded to the local package cache. Also, a ``codeql-pack.lock.yml`` file is created that contains the resolved version of ``codeql/cpp-all``. The lock file won't contain an entry for ``my-company/my-library`` since it is resolved from source dependencies. The ``codeql-pack.lock.yml`` file will look something like this: + +.. code-block:: yaml + + dependencies: + codeql/cpp-all: + version: 0.2.2 + +When you execute ``codeql pack publish`` from the query pack directory, the ``codeql/cpp-all`` dependency from the package cache and the ``my-company/my-library`` from the workspace are bundled with ``my-company/my-queries`` and published to the GitHub container registry. diff --git a/docs/codeql/codeql-cli/about-ql-packs.rst b/docs/codeql/codeql-cli/about-ql-packs.rst deleted file mode 100644 index 6568cf0a3e6..00000000000 --- a/docs/codeql/codeql-cli/about-ql-packs.rst +++ /dev/null @@ -1,245 +0,0 @@ -.. _about-ql-packs: - -About QL packs -============== - -QL packs are used to organize the files used in CodeQL analysis. They -contain queries, library files, query suites, and important metadata. - -The `CodeQL repository `__ contains standard QL packs for all supported languages. -You can also make custom QL packs to contain your own queries and libraries. - -QL pack structure ------------------ - -A QL pack must contain a file called ``qlpack.yml`` in its root directory. The other -files and directories within the pack should be logically organized. For example, typically: - -- Queries are organized into directories for specific categories. -- Queries for specific products, libraries, and frameworks are organized into - their own top-level directories. -- There is a top-level directory named ``/`` for query library - (``.qll``) files. Within this directory, ``.qll`` files should be organized into - subdirectories for specific categories. - -About ``qlpack.yml`` files --------------------------- - -When executing commands, CodeQL scans siblings of the installation directory (and -their subdirectories) for ``qlpack.yml`` files. The metadata in the file tells -CodeQL how to compile queries, what libraries the pack depends on, and where to -find query suite definitions. - -The content of the QL pack (queries and libraries used in CodeQL analysis) is -included in the same directory as ``qlpack.yml``, or its subdirectories. - -The location of ``qlpack.yml`` defines the library path for the content -of the QL pack. That is, for all ``.ql`` and ``.qll`` files in the QL pack, -CodeQL will resolve all import statements relative to the ``qlpack.yml`` at the -pack's root. - -For example, in a QL pack with the following contents, you can import ``CustomSinks.qll`` -from any location in the pack by declaring ``import mycompany.java.CustomSinks``. - -.. code-block:: none - - qlpack.yml - mycompany/ - java/ - security/ - CustomSinks.qll - Security/ - CustomQuery.ql - -For more information, see ":ref:`Importing modules `" -in the QL language reference. - -.. _qlpack-yml-properties: - -``qlpack.yml`` properties -~~~~~~~~~~~~~~~~~~~~~~~~~ - -The following properties are supported in ``qlpack.yml`` files. - -.. list-table:: - :header-rows: 1 - :widths: auto - - * - Property - - Example - - Required - - Purpose - * - ``name`` - - ``org-queries`` - - All packs - - The name of the QL pack defined using alphanumeric characters, hyphens, and periods. It must be unique as CodeQL cannot differentiate between QL packs with identical names. If you intend to distribute the pack, prefix the name with your (or your organization's) name followed by a hyphen. Use the pack name to specify queries to run using ``database analyze`` and to define dependencies between QL packs (see examples below). - * - ``version`` - - ``0.0.0`` - - All packs - - A version number for this QL pack. This must be a valid semantic version that meets the `SemVer v2.0.0 specification `__. - * - ``libraryPathDependencies`` - - ``codeql/javascript-all`` - - Optional - - The names of any QL packs that this QL pack depends on, as a sequence. This gives the pack access to any libraries, database schema, and query suites defined in the dependency. - * - ``suites`` - - ``suites`` - - Optional - - The path to a directory in the pack that contains the query suites you want to make known to the CLI, defined relative to the pack directory. QL pack users can run "well-known" suites stored in this directory by specifying the pack name, without providing their full path. For more information about query suites, see ":doc:`Creating CodeQL query suites `." - * - ``extractor`` - - ``javascript`` - - All test packs - - The CodeQL language extractor to use when the CLI creates a database from test files in the pack. For more information about testing queries, see ":doc:`Testing custom queries `." - * - ``tests`` - - ``.`` - - Optional for test packs - - Supported from release 2.1.0 onwards. The path to a directory within the pack that contains tests, defined relative to the pack directory. Use ``.`` to specify the whole pack. Any queries in this directory are run as tests when ``test run`` is run with the ``--strict-test-discovery`` option. These queries are ignored by query suite definitions that use ``queries`` or ``qlpack`` instructions to ask for all queries in a particular pack. - * - ``dbscheme`` - - ``semmlecode.python.dbscheme`` - - Core language pack only - - The path to the :ref:`database schema ` for all libraries and queries written for this CodeQL language (see example below). - * - ``upgrades`` - - ``.`` - - Packs with upgrades - - The path to a directory within the pack that contains upgrade scripts, defined relative to the pack directory. The ``database upgrade`` action uses these scripts to update databases that were created by an older version of an extractor so they're compatible with the current extractor (see `Upgrade scripts for a language <#upgrade-scripts-for-a-language>`__ below.) - * - ``dependencies`` - - .. code-block:: yaml - - dependencies: - codeql/cpp-all: ^0.0.2 - - - Packs that define CodeQL package dependencies on other packs - - A map from pack references to the semantic version range that is compatible with this pack. Supported from CLI version v2.6.0 and onwards. - * - ``defaultSuiteFile`` - - ``defaultSuiteFile: cpp-code-scanning.qls`` - - Packs that export a set of default queries to run - - The path to a query suite file containing all of the queries that are run by default when this pack is passed to the ``codeql database analyze`` command. Supported from CLI version v2.6.0 and onwards. - -.. _custom-ql-packs: - -Examples of custom QL packs ---------------------------- - -When you write custom queries or tests, you should save them in -custom QL packs. For simplicity, try to organize each pack logically. For more -information, see `QL pack structure <#ql-pack-structure>`__. Save files for queries -and tests in separate packs and, where possible, organize custom packs into specific -folders for each target language. - -QL packs for custom queries -~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -A custom QL pack for queries must include a ``qlpack.yml`` file at -the pack root, containing ``name``, ``version``, -and ``libraryPathDependencies`` properties. If the pack contains query suites, you can -use the ``suites`` property to define their location. Query suites defined -here are called "well-known" suites, and can be used on the command line by referring to -their name only, rather than their full path. -For more information about query suites, see ":doc:`Creating CodeQL query suites `." - -For example, a ``qlpack.yml`` file for a QL pack featuring custom C++ queries -and libraries may contain: - -.. code-block:: yaml - - name: my-custom-queries - version: 0.0.0 - libraryPathDependencies: codeql/cpp-all - suites: my-custom-suites - -where ``codeql/cpp-all`` is the name of the QL pack for C/C++ analysis included in -the CodeQL repository. - -.. pull-quote:: - - Note - - When you create a custom QL pack, it's usually a good idea to add it to the search path in your CodeQL configuration. - This will ensure that any libraries the pack contains are available to the CodeQL CLI. - For more information, see ":ref:`Specifying command options in a CodeQL configuration file `." - -QL packs for custom test files -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -For custom QL packs containing test files, you also need to include an -``extractor`` property so that the ``test run`` command knows how to create test -databases. You may also wish to specify the ``tests`` property. - -.. include:: ../reusables/test-qlpack.rst - -For more information about running tests, see ":doc:`Testing custom queries -`." - -.. _standard-ql-packs: - -Examples of QL packs in the CodeQL repository ---------------------------------------------- - -Each of the languages in the CodeQL repository has four main QL packs: - -- Core library pack for the language, with the :ref:`database schema ` - used by the language, and CodeQL libraries, and queries at ``ql//ql/lib`` -- Core query pack for the language that includes the default queries for the language, along - with their query suites at ``ql//ql/src`` -- Tests for the core language libraries and queries at ``ql//ql/test`` -- Upgrade scripts for the language at ``ql//upgrades`` - -Core library pack -~~~~~~~~~~~~~~~~~ - -The ``qlpack.yml`` file for a core library pack uses the following properties: -``name``, ``version``, ``dbscheme``. -The ``dbscheme`` property should only be defined in the core QL -pack for a language. - -For example, the ``qlpack.yml`` file for `C/C++ analysis libraries -`__ -contains: - -.. code-block:: yaml - - name: codeql/cpp-all - version: 0.0.0 - dbscheme: semmlecode.cpp.dbscheme - upgrades: upgrades - -Core query pack -~~~~~~~~~~~~~~~ - -The ``qlpack.yml`` file for a core query pack uses the following properties: -``name``, ``version``, ``suites``, ``defaultSuiteFile``, ``dependencies`` . - -For example, the ``qlpack.yml`` file for `C/C++ analysis queries -`__ -contains: - -.. code-block:: yaml - - name: codeql/cpp-queries - version: 0.0.0 - suites: codeql-suites - defaultSuiteFile: codeql-suites/cpp-code-scanning.qls - dependencies: - codeql/cpp-all: "*" - codeql/suite-helpers: "*" - -Tests for the core QL pack -~~~~~~~~~~~~~~~~~~~~~~~~~~ - -The ``qlpack.yml`` file for the tests for the core QL packs use the following -properties: ``name``, ``version``, and ``dependencies``. -The ``dependencies`` always specifies the core QL pack. - -For example, the ``qlpack.yml`` file for `C/C++ analysis tests -`__ -contains: - -.. code-block:: yaml - - name: codeql/cpp-tests - version: 0.0.0 - dependencies: - codeql/cpp-all: "*" - codeql/cpp-queries: "*" - - -.. _upgrade-ql-packs: diff --git a/docs/codeql/codeql-cli/analyzing-databases-with-the-codeql-cli.rst b/docs/codeql/codeql-cli/analyzing-databases-with-the-codeql-cli.rst index bb428f2c00d..cf12953f600 100644 --- a/docs/codeql/codeql-cli/analyzing-databases-with-the-codeql-cli.rst +++ b/docs/codeql/codeql-cli/analyzing-databases-with-the-codeql-cli.rst @@ -36,6 +36,7 @@ You can analyze a database by running the following command:: codeql database analyze --format= --output= + You must specify: - ````: the path to the CodeQL database you want to analyze. @@ -58,9 +59,10 @@ You can also specify: - a path to a directory containing query files - a path to a query suite file - the name of a CodeQL query pack - If omitted, the default query suite for the language - of the database being analyzed will be used. For more information, see the - :ref:`examples ` below. + - with an optional version range + - with an optional path to a query, directory, or query suite inside the pack + + If omitted, the default query suite for the language of the database being analyzed will be used. For more information, see the :ref:`examples ` below. - ``--sarif-category``: an identifying category for the results. Used when you want to upload more than one set of results for a commit. @@ -78,17 +80,17 @@ You can also specify: - .. include:: ../reusables/threads-query-execution.rst - .. pull-quote:: Upgrading databases - If the CodeQL queries you want to use are newer than the - extractor used to create the database, then you may see a message telling you + For databases that were created by CodeQL CLI v2.3.3 or earlier, you will need + to explicitly upgrade the database before you can run an analysis with a newer + version of the CodeQL CLI. If this step is necessary, then you will see a message telling you that your database needs to be upgraded when you run ``database analyze``. - You can quickly upgrade a database by running the ``database upgrade`` - command. For more information, see ":doc:`Upgrading CodeQL databases - `." + + For databases that were created by CodeQL CLI v2.3.4 or later, the CLI will implicitly run any + required upgrades. Explicitly running the upgrade command is not necessary. For full details of all the options you can use when analyzing databases, see the `database analyze reference documentation <../manual/database-analyze>`__. @@ -122,6 +124,14 @@ You can also run your own custom queries with the ``database analyze`` command. For more information about preparing your queries to use with the CodeQL CLI, see ":doc:`Using custom queries with the CodeQL CLI `." +If you do not have the CodeQL repository checked out, you can execute the same queries by specifying the query pack name and the path to the queries:: + + codeql database analyze --download codeql/javascript-queries:Declarations/UnusedVariable.ql --format=csv --output=js-analysis/js-results.csv + +Use the ``--download`` flag to download the query pack if it isn't yet available locally. + +.. _run-query-pack: + Running a CodeQL pack ~~~~~~~~~~~~~~~~~~~~~ @@ -135,6 +145,34 @@ pack names and use the ``--download`` flag:: The ``analyze`` command above runs the default suite from ``microsoft/coding-standards v1.0.0`` and the latest version of ``github/security-queries`` on the specified database. For further information about default suites, see ":ref:`Publishing and using CodeQL packs `". +Running all queries in a directory +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +You can run all the queries located in a directory by providing the directory +path, rather than listing all the individual query files. Paths are searched +recursively, so any queries contained in subfolders will also be executed. + +.. pull-quote:: + + Important + + You should avoid specifying the root of a :ref:`core CodeQL query pack + ` when executing ``database analyze`` + as it might contain some special queries that aren't designed to be used with + the command. Rather, :ref:`run the query pack ` to include the + pack's default queries in the analysis, or run one of the + code scanning query suites. + +For example, to execute all Python queries contained in the ``Functions`` directory you would run:: + + codeql database analyze ../ql/python/ql/src/Functions/ --format=sarif-latest --output=python-analysis/python-results.sarif + +When the analysis has finished, a SARIF results file is generated. Specifying ``--format=sarif-latest`` ensures +that the results are formatted according to the most recent SARIF specification +supported by CodeQL. + +.. _including-query-help-for-custom-codeql-queries-in-sarif-files: + Running a subset of queries in a CodeQL pack ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -192,10 +230,10 @@ For more information, see `Analyzing a CodeQL database `__ in the GitHub documentation. CodeQL query suites are ``.qls`` files that use directives to select queries to run -based on certain metadata properties. The standard QL packs have metadata that specify +based on certain metadata properties. The standard CodeQL packs have metadata that specify the location of the query suites used by code scanning, so the CodeQL CLI knows where to find these suite files automatically, and you don't have to specify the full path on the command line. -For more information, see ":ref:`About QL packs `." +For more information, see ":ref:`About CodeQL packs `." The standard query suites are stored at the following paths in the CodeQL repository:: @@ -227,35 +265,6 @@ Integrating a CodeQL pack into a code scanning workflow in GitHub You can use CodeQL query packs in your code scanning setup. This allows you to select query packs published by various sources and use them to analyze your code. For more information, see "`Using CodeQL query packs in the CodeQL action `_" or "`Downloading and using CodeQL query packs in your CI system `_." - -Running all queries in a directory -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -You can run all the queries located in a directory by providing the directory -path, rather than listing all the individual query files. Paths are searched -recursively, so any queries contained in subfolders will also be executed. - -.. pull-quote:: - - Important - - You shouldn't specify the root of a :doc:`QL pack - ` when executing ``database analyze`` - as it contains some special queries that aren't designed to be used with - the command. Rather, to run a wide range of useful queries, run one of the - LGTM.com query suites. - -For example, to execute all Python queries contained in the ``Functions`` -directory you would run:: - - codeql database analyze ../ql/python/ql/src/Functions/ --format=sarif-latest --output=python-analysis/python-results.sarif - -A SARIF results file is generated. Specifying ``--format=sarif-latest`` ensures -that the results are formatted according to the most recent SARIF specification -supported by CodeQL. - -.. _including-query-help-for-custom-codeql-queries-in-sarif-files: - Including query help for custom CodeQL queries in SARIF files ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ diff --git a/docs/codeql/codeql-cli/codeql-cli-reference.rst b/docs/codeql/codeql-cli/codeql-cli-reference.rst index e0ffdeaaa36..a1928e2439d 100644 --- a/docs/codeql/codeql-cli/codeql-cli-reference.rst +++ b/docs/codeql/codeql-cli/codeql-cli-reference.rst @@ -3,22 +3,21 @@ CodeQL CLI reference ==================== -Learn more about the files you can use when running CodeQL processes and the results format and exit codes that CodeQL generates. +Learn more about the files you can use when running CodeQL processes and the results format and exit codes that CodeQL generates. .. toctree:: :titlesonly: :hidden: about-codeql-packs - about-ql-packs + about-codeql-workspaces query-reference-files sarif-output exit-codes extractor-options -- :doc:`About CodeQL packs `: CodeQL packs are created with the CodeQL CLI and are used to create, depend on, publish, and run CodeQL queries and libraries. -- :doc:`About QL packs `: QL packs are used to organize the files used in CodeQL analysis. They - contain queries, library files, query suites, and important metadata. +- :doc:`About CodeQL packs `: CodeQL packs are created with the CodeQL CLI and are used to create, depend on, publish, and run CodeQL queries, libraries, and query suites. +- :doc:`About CodeQL workspaces `: CodeQL workspaces are used to group multiple CodeQL packs together. - :doc:`Query reference files `: A query reference file is text file that defines the location of one query to test. - :doc:`SARIF output `: CodeQL supports SARIF as an output format for sharing static analysis results. - :doc:`Exit codes `: The CodeQL CLI reports the status of each command it runs as an exit code. diff --git a/docs/codeql/codeql-cli/creating-and-working-with-codeql-packs.rst b/docs/codeql/codeql-cli/creating-and-working-with-codeql-packs.rst index da7a0872803..7d2001dded5 100644 --- a/docs/codeql/codeql-cli/creating-and-working-with-codeql-packs.rst +++ b/docs/codeql/codeql-cli/creating-and-working-with-codeql-packs.rst @@ -34,24 +34,28 @@ You must specify: The ``codeql pack init`` command creates the directory structure and configuration files for a CodeQL pack. By default, the command creates a query pack. If you want to create a library pack, you must edit the ``qlpack.yml`` file to explicitly declare the file as a library pack by including the ``library:true`` property. -Modifying an existing QL pack to create a CodeQL pack ------------------------------------------------------ +Modifying an existing legacy QL pack to create a CodeQL pack +------------------------------------------------------------ + If you already have a ``qlpack.yml`` file, you can edit it manually to convert it into a CodeQL pack. #. Edit the ``name`` property so that it matches the format ``/``, where ```` is the name of the GitHub organization or user account that you will publish to. #. In the ``qlpack.yml`` file, include a ``version`` property with a semver identifier, as well as an optional ``dependencies`` block. +#. Migrate the list of dependencies in ``libraryPathDependencies`` to the ``dependencies`` block. Specify the version range for each dependency. If the range is unimportant, or you are unsure of compatibility, you can specify ``"*"``, which indicates that any version is acceptable and will default to the latest version when you run ``codeql pack install``. For more information about the properties, see ":ref:`About CodeQL packs `." +.. _adding-and-installing-dependencies: + Adding and installing dependencies to a CodeQL pack --------------------------------------------------- -You can add dependencies on CodeQL packs using the command ``codeql pack add``. You must specify the scope, name, and version range. +You can add dependencies on CodeQL packs using the command ``codeql pack add``. You must specify the scope, name, and (optionally) a compatible version range. :: codeql pack add /@x.x.x / -The version range is optional. If you leave off the version range, the latest version will be added. Otherwise, the latest version that satisfies the requested range will be added. +If you don't specify a version range, the latest version will be added. Otherwise, the latest version that satisfies the requested range will be added. This command updates the ``qlpack.yml`` file with the requested dependencies and downloads them into the package cache. Please note that this command will reformat the file and remove all comments. @@ -67,7 +71,8 @@ This command downloads all dependencies to the shared cache on the local disk. Note - Running the ``codeql pack add`` and ``codeql pack install`` commands will generate or update the ``qlpack.lock.yml`` file. This file should be checked-in to version control. The ``qlpack.lock.yml`` file contains the precise version numbers used by the pack. + Running the ``codeql pack add`` and ``codeql pack install`` commands will generate or update the ``codeql-pack.lock.yml`` file. This file should be checked-in to version control. The ``codeql-pack.lock.yml`` file contains the precise version numbers used by the pack. + For more information, see ":ref:`About codeql-pack.lock.yml files `." .. pull-quote:: diff --git a/docs/codeql/codeql-cli/creating-codeql-databases.rst b/docs/codeql/codeql-cli/creating-codeql-databases.rst index aa60cb24e79..28d4289694b 100644 --- a/docs/codeql/codeql-cli/creating-codeql-databases.rst +++ b/docs/codeql/codeql-cli/creating-codeql-databases.rst @@ -7,8 +7,8 @@ Before you analyze your code using CodeQL, you need to create a CodeQL database containing all the data required to run queries on your code. CodeQL analysis relies on extracting relational data from your code, and -using it to build a :ref:`CodeQL database `. CodeQL -databases contain all of the important information about a codebase, which can +using it to build a :ref:`CodeQL database `. CodeQL +databases contain all of the important information about a codebase, which can be analyzed by executing CodeQL queries against it. Before you generate a CodeQL database, you need to: @@ -18,9 +18,9 @@ Before you generate a CodeQL database, you need to: should be ready to build, with all dependencies already installed. For information about using the CodeQL CLI in a third-party CI system to create results -to display in GitHub as code scanning alerts, see `Configuring CodeQL CLI in your CI system `__ +to display in GitHub as code scanning alerts, see `Configuring CodeQL CLI in your CI system `__ in the GitHub documentation. For information about enabling CodeQL code scanning using GitHub Actions, -see `Setting up code scanning for a repository `__ +see `Setting up code scanning for a repository `__ in the GitHub documentation. Running ``codeql database create`` @@ -37,38 +37,38 @@ You must specify: - ````: a path to the new database to be created. This directory will be created when you execute the command---you cannot specify an existing - directory. + directory. - ``--language``: the identifier for the language to create a database for. - When used with ``--db-cluster``, the option accepts a comma-separated list, + When used with ``--db-cluster``, the option accepts a comma-separated list, or can be specified more than once. CodeQL supports creating databases for the following languages: .. include:: ../reusables/extractors.rst -You can specify additional options depending on the location of your source file, -if the code needs to be compiled, and if you want to create CodeQL databases for +You can specify additional options depending on the location of your source file, +if the code needs to be compiled, and if you want to create CodeQL databases for more than one language: - ``--source-root``: the root folder for the primary source files used in database creation. By default, the command assumes that the current directory is the source root---use this option to specify a different location. - ``--db-cluster``: use for multi-language codebases when you want to create - databases for more than one language. + databases for more than one language. - ``--command``: used when you create a database for one or more compiled languages, - omit if the only languages requested are Python and JavaScript. - This specifies the build commands needed to invoke the compiler. + omit if the only languages requested are Python and JavaScript. + This specifies the build commands needed to invoke the compiler. Commands are run from the current folder, or ``--source-root`` if specified. If you don't include a ``--command``, CodeQL will attempt to - detect the build system automatically, using a built-in autobuilder. -- ``--no-run-unnecessary-builds``: used with ``--db-cluster`` to suppress the build - command for languages where the CodeQL CLI does not need to monitor the build + detect the build system automatically, using a built-in autobuilder. +- ``--no-run-unnecessary-builds``: used with ``--db-cluster`` to suppress the build + command for languages where the CodeQL CLI does not need to monitor the build (for example, Python and JavaScript/TypeScript). You can specify extractor options to customize the behavior of extractors that create CodeQL databases. For more information, see ":doc:`Extractor options `." For full details of all the options you can use when creating databases, -see the `database create reference documentation <../manual/database-create>`__. +see the `database create reference documentation <../manual/database-create>`__. Progress and results -------------------- @@ -117,7 +117,7 @@ extract both JavaScript and TypeScript files:: Here, we have specified a ``--source-root`` path, which is the location where database creation is executed, but is not necessarily the checkout root of the -codebase. +codebase. By default, files in ``node_modules`` and ``bower_components`` directories are not extracted. @@ -127,7 +127,7 @@ Python When creating databases for Python you must ensure: - You have the all of the required versions of Python installed. -- You have access to the `pip `__ +- You have access to the `pip `__ packaging management system and can install any packages that the codebase depends on. - You have installed the `virtualenv `__ pip module. @@ -143,14 +143,14 @@ generating a new Python database at ``/python-database``. Ruby ~~~~ -Creating databases for Ruby requires no additional dependencies. +Creating databases for Ruby requires no additional dependencies. In the command line you must specify ``--language=ruby``. For example:: codeql database create --language=ruby --source-root /ruby-database Here, we have specified a ``--source-root`` path, which is the location where database creation is executed, but is not necessarily the checkout root of the -codebase. +codebase. Creating databases for compiled languages ----------------------------------------- @@ -179,11 +179,11 @@ build steps, you may need to explicitly define each step in the command line. .. pull-quote:: Creating databases for Go - + For Go, install the Go toolchain (version 1.11 or later) and, if there are dependencies, the appropriate dependency manager (such as `dep `__). - + The Go autobuilder attempts to automatically detect code written in Go in a repository, and only runs build scripts in an attempt to fetch dependencies. To force CodeQL to limit extraction to the files compiled by your build script, set the environment variable @@ -194,7 +194,7 @@ Specifying build commands ~~~~~~~~~~~~~~~~~~~~~~~~~ The following examples are designed to give you an idea of some of the build -commands that you can specify for compiled languages. +commands that you can specify for compiled languages. .. pull-quote:: Important @@ -210,11 +210,10 @@ commands that you can specify for compiled languages. - C# project built using ``dotnet build``:: - For C# projects using either `dotnet build` or `msbuild`, you should specify `/p:UseSharedCompilation=false` - in the build command. It is also a good idea to add `/t:rebuild` to ensure that all code will be built (code - that is not built will not be included in the CodeQL database): + It is a good idea to add `/t:rebuild` to ensure that all code will be built, or do a + prior `dotnet clean` (code that is not built will not be included in the CodeQL database): - codeql database create csharp-database --language=csharp --command='dotnet build /p:UseSharedCompilation=false /t:rebuild' + codeql database create csharp-database --language=csharp --command='dotnet build /t:rebuild' - Go project built using the ``CODEQL_EXTRACTOR_GO_BUILD_TRACING=on`` environment variable:: @@ -260,7 +259,7 @@ commands that you can specify for compiled languages. - Project built using a custom build script:: codeql database create new-database --language= --command='./scripts/build.sh' - + This command runs a custom script that contains all of the commands required to build the project. @@ -279,7 +278,7 @@ You must specify: - ````: a path to the new database to be created. This directory will be created when you execute the command---you cannot specify an existing - directory. + directory. - ``--begin-tracing``: creates scripts that can be used to set up an environment in which build commands will be traced. You may specify other options for the ``codeql database init`` command as normal. @@ -349,8 +348,7 @@ The following example shows how you could use indirect build tracing in an Azure - task: VSBuild@1 inputs: solution: '**/*.sln' - # Disable MSBuild shared compilation for C# builds. - msbuildArgs: /p:OutDir=$(Build.ArtifactStagingDirectory) /p:UseSharedCompilation=false + msbuildArgs: /p:OutDir=$(Build.ArtifactStagingDirectory) platform: Any CPU configuration: Release # Execute a clean build, in order to remove any existing build artifacts prior to the build. @@ -388,14 +386,10 @@ Obtaining databases from LGTM.com CodeQL. For each project on LGTM.com, you can download an archived CodeQL database corresponding to the most recently analyzed revision of the code. These databases can also be analyzed using the CodeQL CLI or used with the CodeQL -extension for Visual Studio Code. +extension for Visual Studio Code. .. include:: ../reusables/download-lgtm-database.rst -Before running an analysis, unzip the databases and try :doc:`upgrading ` the -unzipped databases to ensure they are compatible with your local copy of the -CodeQL queries and libraries. - .. pull-quote:: Note diff --git a/docs/codeql/codeql-cli/creating-codeql-query-suites.rst b/docs/codeql/codeql-cli/creating-codeql-query-suites.rst index ceaa104f4d0..1e212755367 100644 --- a/docs/codeql/codeql-cli/creating-codeql-query-suites.rst +++ b/docs/codeql/codeql-cli/creating-codeql-query-suites.rst @@ -4,7 +4,7 @@ Creating CodeQL query suites ============================ CodeQL query suites provide a way of selecting queries, based on their -filename, location on disk or in a QL pack, or metadata properties. +filename, location on disk or in a CodeQL pack, or metadata properties. Create query suites for the queries that you want to frequently use in your CodeQL analyses. @@ -18,8 +18,8 @@ suite definition have been executed, the result is a set of selected queries. .. pull-quote:: Note - Any custom queries that you want to add to a query suite must be in a :doc:`QL - pack ` and contain the correct query metadata. + Any custom queries that you want to add to a query suite must be in a :doc:`CodeQL + pack ` and contain the correct query metadata. For more information, see ":doc:`Using custom queries with the CodeQL CLI `." @@ -35,7 +35,7 @@ queries using: - query: - The argument must be one or more file paths, relative to the QL pack containing + The argument must be one or more file paths, relative to the CodeQL pack containing the suite definition. - A ``queries`` instruction---tells CodeQL to recursively scan a directory @@ -43,22 +43,30 @@ queries using: - queries: - The path of the directory must be relative to the root of the QL pack that + The path of the directory must be relative to the root of the CodeQL pack that contains the suite definition file. To find the queries relative to a - different QL pack, add a ``from`` field:: + different CodeQL pack, add a ``from`` field:: - queries: from: + version: ^x.y.z + + The ``version`` field is optional and specifies a range of compatible versions of this CodeQL pack. + If you don't specify a version, then the most recent version of the pack is used. - A ``qlpack`` instruction---tells CodeQL to resolve queries in the default suite of the - named QL pack:: + named CodeQL pack:: - qlpack: + version: ^x.y.z The default suite of a query pack includes a recommended set of queries inside of that query pack. Not all query packs have a default suite. If the given query pack does not define a default suite, the `qlpack` instruction will resolve to all of the queries within the pack. + The ``version`` field is optional and specifies a range of compatible versions of this CodeQL pack. + If you don't specify a version, then the most recent version of the pack is used. + .. pull-quote:: Note When pathnames appear in query suite definitions, they must always @@ -68,7 +76,7 @@ queries using: You must add at least one ``query``, ``queries``, or ``qlpack`` instruction to your suite definition, otherwise no queries will be selected. If the suite contains no further instructions, all the queries found from the list of files, -in the given directory, or in the named QL pack are selected. If there are further +in the given directory, or in the named CodeQL pack are selected. If there are further filtering instructions, only queries that match the constraints imposed by those instructions will be selected. @@ -117,7 +125,7 @@ In addition to metadata tags, the keys in the constraint block can also be: - ``query filename``---matches on the last path component of the query file name. - ``query path``---matches on the path to the query file relative to its - enclosing QL pack. + enclosing CodeQL pack. - ``tags contain``---one of the given match strings must match one of the space-separated components of the value of the ``@tags`` metadata property. - ``tags contain all``---each of the given match strings must match one of the @@ -127,7 +135,7 @@ Examples ~~~~~~~~ To define a suite that selects all queries in the default suite of the -``codeql/cpp-queries`` QL pack, and then refines them to only include +``codeql/cpp-queries`` CodeQL pack, and then refines them to only include security queries, use:: - qlpack: codeql/cpp-queries @@ -153,7 +161,7 @@ recommendation``, use:: problem.severity: recommendation To create a suite that selects all queries with ``@tag security`` and -``@problem.severity high`` or ``very-high`` from the ``codeql/cpp-queries`` QL pack, +``@problem.severity high`` or ``very-high`` from the ``codeql/cpp-queries`` CodeQL pack, use:: - queries: . @@ -174,12 +182,16 @@ Existing query suite definitions can be reused by specifying: - import: - The path to the imported suite must be relative to the QL pack containing the + The path to the imported suite must be relative to the CodeQL pack containing the current suite definition. If the imported query suite is in a different QL pack you can use:: - import: from: + version: ^x.y.z + + The ``version`` field is optional and specifies a range of compatible versions of this CodeQL pack. + If you don't specify a version, then the most recent version of the pack is used. Queries added using an ``import`` instruction can be filtered using subsequent ``exclude`` instructions. @@ -200,6 +212,8 @@ Existing query suite definitions can be reused by specifying: instruction, but takes a full suite definition as the argument, rather than the path to a ``.qls`` file on disk. +To see what queries are included in a query suite, you can run the ``codeql resolve queries my-suite.qls`` command. + Example ~~~~~~~ @@ -216,28 +230,27 @@ following in a file called ``reusable-instructions.yml``:: - high - very-high -Add ``reusable-instructions.yml`` to the same QL pack as your current query -suite (for example, ``my-custom-queries``). Apply the reusable instructions -to the queries in your current suite using:: - - - qlpack: my-custom-queries - - apply: reusable-instructions.yml - -To apply the same conditions to a different suite or directory within the same -QL pack, create a new definition and change (or replace) the ``qlpack`` -instruction. For example:: +Add ``reusable-instructions.yml`` to the same CodeQL pack as your current query +suite. Then, in one or more query suites, use the ``apply`` instruction to apply +the reusable instructions to the current suite. For example:: - queries: queries/cpp/custom - apply: reusable-instructions.yml +This will filter the queries in ``queries/cpp/custom`` to only include those that match the reusable conditions. + You can also create a suite definition using ``reusable-instructions.yml`` on -queries in a different QL pack. If the ``.qls`` file is in the same QL pack as +queries in a different CodeQL pack. If the ``.qls`` file is in the same CodeQL pack as the queries, you can add a ``from`` field immediately after the ``apply`` instruction:: - - qlpack: my-other-custom-queries + # load queries from the default suite of my-org/my-other-custom-queries + - qlpack: my-org/my-other-custom-queries + + # apply the reusable instructions from the my-org/my-custom-instructions CodeQL pack - apply: reusable-instructions.yml - from: + from: my-org/my-custom-instructions + version: ^1.2.3 # optional Naming a query suite -------------------- @@ -255,20 +268,20 @@ directory. For more information, see "`Specifying well-known query suites Saving a query suite -------------------- -Save your query suite in a file with a ``.qls`` extension and add it to a QL -pack. For more information, see ":ref:`About QL packs `." +Save your query suite in a file with a ``.qls`` extension and add it to a CodeQL +pack. For more information, see ":ref:`About CodeQL packs `." Specifying well-known query suites ---------------------------------- -You can use QL packs to declare directories that contain "well-known" query +You can use CodeQL packs to declare directories that contain "well-known" query suites. You can use "well-known" query suites on the command line by referring to their file name, without providing their full path. This gives you a simple way of specifying a -set of queries, without needing to search inside QL packs and distributions. +set of queries, without needing to search inside CodeQL packs and distributions. To declare a directory that contains "well-known" query suites, add the directory -to the ``suites`` property in the ``qlpack.yml`` file at the root of your QL pack. -For more information, see ":ref:`About QL packs `." +to the ``suites`` property in the ``qlpack.yml`` file at the root of your CodeQL pack. +For more information, see ":ref:`About CodeQL packs `." Using query suites with CodeQL ------------------------------ @@ -288,7 +301,7 @@ JavaScript, visit https://github.com/github/codeql/tree/main/javascript/ql/src/codeql-suites. These suite definitions apply reusable filter patterns to the queries -located in the standard QL packs for each supported language. For more +located in the standard CodeQL packs for each supported language. For more information, see the `suite-helpers `__ in the CodeQL repository. diff --git a/docs/codeql/codeql-cli/getting-started-with-the-codeql-cli.rst b/docs/codeql/codeql-cli/getting-started-with-the-codeql-cli.rst index f859f07cb7c..0fd8e6b8fa0 100644 --- a/docs/codeql/codeql-cli/getting-started-with-the-codeql-cli.rst +++ b/docs/codeql/codeql-cli/getting-started-with-the-codeql-cli.rst @@ -23,11 +23,11 @@ and 4 are slightly different---for further details, see the sections labeled **Information for macOS "Catalina" (or newer) users**. If you are using macOS on Apple Silicon (e.g. Apple M1), ensure that the `Xcode command-line developer tools `__ and `Rosetta 2 -`__ are installed. +`__ are installed. .. pull-quote:: Note - The CodeQL CLI is currently not compatible with non-glibc Linux + The CodeQL CLI is currently not compatible with non-glibc Linux distributions such as (muslc-based) Alpine Linux. For information about installing the CodeQL CLI in a CI system to create results @@ -47,7 +47,7 @@ Conditions `__. .. pull-quote:: Important - There are several different versions of the CLI available to download, depending + There are different versions of the CLI available to download, depending on your use case: - If you want to use the most up to date CodeQL tools and features, download the @@ -202,8 +202,6 @@ CLI that you will extract in step 4. If you use git on the command line, you can clone and rename the repository in a single step by running ``git clone git@github.com:github/codeql.git codeql-repo`` in the ``codeql-home`` folder. -For Go analysis, run ``codeql-repo/go/scripts/install-deps.sh`` to install its dependencies. - .. pull-quote:: Note The CodeQL libraries and queries for Go analysis used to live in a @@ -213,10 +211,10 @@ For Go analysis, run ``codeql-repo/go/scripts/install-deps.sh`` to install its d For more information, see the `Relocation announcement `__. -Within this repository, the queries and libraries are organized into QL -packs. Along with the queries themselves, QL packs contain important metadata +Within this repository, the queries and libraries are organized into CodeQL +packs. Along with the queries themselves, CodeQL packs contain important metadata that tells the CodeQL CLI how to process the query files. For more information, -see ":doc:`About QL packs `." +see ":doc:`About CodeQL packs `." .. pull-quote:: Important @@ -232,10 +230,7 @@ see ":doc:`About QL packs `." may need to be upgraded before you can analyze them. - For the most up to date CodeQL queries, check out the ``main`` branch. - This branch represents the very latest version of CodeQL's analysis. Even - databases created using the most recent version of the CLI may have to be - upgraded before you can analyze them. For more information, see - ":doc:`Upgrading CodeQL databases `." + This branch represents the very latest version of CodeQL's analysis. - For the queries used in a particular LGTM Enterprise release, check out the branch tagged with the relevant release number. For example, the branch @@ -245,7 +240,7 @@ see ":doc:`About QL packs `." `__ in the LGTM admin help. -4. Extract the zip archive +1. Extract the zip archive ~~~~~~~~~~~~~~~~~~~~~~~~~~ For Linux, Windows, and macOS users (version 10.14 "Mojave", and earlier) @@ -271,8 +266,8 @@ up to create and analyze databases: - Run ``codeql resolve languages`` to show which languages are available for database creation. This will list the languages supported by default in your CodeQL CLI package. -- Run ``codeql resolve qlpacks`` to show which QL packs the CLI can find. This - will display the names of all the QL packs directly available to the CodeQL CLI. +- Run ``codeql resolve qlpacks`` to show which CodeQL packs the CLI can find. This + will display the names of all the CodeQL packs directly available to the CodeQL CLI. This should include: - Query packs for each supported language, for example, ``codeql/{language}-queries``. diff --git a/docs/codeql/codeql-cli/publishing-and-using-codeql-packs.rst b/docs/codeql/codeql-cli/publishing-and-using-codeql-packs.rst index 985ca2659f3..3aa61e2b7fe 100644 --- a/docs/codeql/codeql-cli/publishing-and-using-codeql-packs.rst +++ b/docs/codeql/codeql-cli/publishing-and-using-codeql-packs.rst @@ -60,12 +60,13 @@ To analyze a CodeQL database with a CodeQL pack, run the following command: :: - codeql database analyze /@x.x.x + codeql database analyze /@x.x.x: - ````: the CodeQL database to be analyzed. - ````: the name of the GitHub organization that the pack is published to. - ````: the name for the pack that you are using. - ``@x.x.x``: an optional version number. If omitted, the latest version will be used. +- ``:``: an optional path to a query, directory, or query suite. If omitted, the pack's default query suite will be used. The ``analyze`` command will run the default suite of any specified CodeQL packs. You can specify multiple CodeQL packs to be used for analyzing a CodeQL database. For example: diff --git a/docs/codeql/codeql-cli/query-reference-files.rst b/docs/codeql/codeql-cli/query-reference-files.rst index f19996aae29..ea1624e3982 100644 --- a/docs/codeql/codeql-cli/query-reference-files.rst +++ b/docs/codeql/codeql-cli/query-reference-files.rst @@ -10,10 +10,10 @@ to run a query that's not part of a test directory. There are two ways to specify queries that you want to run as tests: #. Use a query reference file to specify the location of a query to test. - This is useful when you create tests for alert and path queries that - are intended to identify problems in real codebases. You might create + This is useful when you create tests for alert and path queries that + are intended to identify problems in real codebases. You might create several directories of test code, each focusing on different - aspects of the query. Then you would add a query reference file to + aspects of the query. Then you would add a query reference file to each directory of test code, to specify the query to test. #. Add the query directly to a directory of tests. These is typically useful when you're writing queries explicitly to test the behavior @@ -25,22 +25,24 @@ Defining a query reference file Each query reference file, ``.qlref``, contains a single line that defines where to find one query. The location must be defined relative -to the root of the QL pack that contains the query. -Usually, this is a QL pack specified by the ``libraryPathDependencies`` for the test pack. +to the root of the CodeQL pack that contains the query. +Usually, this is either the CodeQL pack that contains the ``.qlref``, a CodeQL pack +specified in the ``dependencies`` block for the test pack, or a transitive dependency of +the CodeQL pack. You should use forward slashes in the path on all operating -systems to ensure compatibility between systems. +systems to ensure compatibility between systems. Example -^^^^^^^^ +^^^^^^^ A query reference file to test a JavaScript alert query: `DeadAngularJSEventListener.qlref `__ -The `QL pack `__ -for the ``javascript/ql/test`` directory defines the ``codeql-javascript`` queries as +The ```qlpack.yml`` file `__ +for the CodeQL pack at ``javascript/ql/test`` defines ``codeql/javascript-queries`` as a dependency. So the query reference file defines the location of the query relative -to the ``codeql-javascript`` QL pack:: +to the ``codeql/javascript-queries`` CodeQL pack:: AngularJS/DeadAngularJSEventListener.ql diff --git a/docs/codeql/codeql-cli/specifying-command-options-in-a-codeql-configuration-file.rst b/docs/codeql/codeql-cli/specifying-command-options-in-a-codeql-configuration-file.rst index f0b3571feb8..1aef971bea3 100644 --- a/docs/codeql/codeql-cli/specifying-command-options-in-a-codeql-configuration-file.rst +++ b/docs/codeql/codeql-cli/specifying-command-options-in-a-codeql-configuration-file.rst @@ -8,15 +8,15 @@ configuration file. You can specify CodeQL CLI command options in two ways: -- Directly in the command line, using the appropriate flag. +- Directly in the command line, using the appropriate flag. - In a configuration (or ``config``) file that CodeQL scans for relevant options each time a command is executed. For options that are likely to change each time you execute a command, specifying the value on the command line is the most convenient way of passing the information to CodeQL. Saving options in a ``config`` file is a good way to -specify options you use frequently. -It's also a good way to add custom QL packs that you use regularly to your search path. +specify options you use frequently. +It's also a good way to add custom CodeQL packs that you use regularly to your search path. Using a CodeQL configuration file --------------------------------- @@ -39,7 +39,7 @@ To apply the same options to more than one command you can: .. pull-quote:: Note - + - ``config`` files only accept spaces between between option flags and values---CodeQL will throw an error if you use ``=`` to specify an option value. - If you specify an option in the command line, this overrides the ``config`` @@ -66,7 +66,7 @@ Examples --ram 4096 --threads 4 -- To globally specify a directory for CodeQL to scan for QL packs (which is not a +- To globally specify a directory for CodeQL to scan for CodeQL packs (which is not a sibling of the installation directory), use:: --search-path diff --git a/docs/codeql/codeql-cli/testing-custom-queries.rst b/docs/codeql/codeql-cli/testing-custom-queries.rst index 7f347de8b1c..f6c7f2d32f7 100644 --- a/docs/codeql/codeql-cli/testing-custom-queries.rst +++ b/docs/codeql/codeql-cli/testing-custom-queries.rst @@ -13,10 +13,10 @@ on the query and the expected results until the actual results and the expected results exactly match. This topic shows you how to create test files and execute tests on them using the ``test run`` subcommand. -Setting up a test QL pack for custom queries --------------------------------------------- +Setting up a test CodeQL pack for custom queries +------------------------------------------------ -All CodeQL tests must be stored in a special "test" QL pack. +All CodeQL tests must be stored in a special "test" CodeQL pack. That is, a directory for test files with a ``qlpack.yml`` file that defines: @@ -24,22 +24,25 @@ file that defines: name: version: 0.0.0 - libraryPathDependencies: + dependencies: + : "*" extractor: -The ``libraryPathDependencies`` value specifies the CodeQL queries to test. -The ``extractor`` defines which language the CLI will use -to create test databases from the code files stored in this QL pack. -For more information, see ":doc:`About QL packs `." +The ``dependencies`` value specifies the CodeQL packs containing queries to test. +Typically, these packs will be resolved from source, and so it is not necessary +to specify a fixed version of the pack. +The ``extractor`` defines which language the CLI will use +to create test databases from the code files stored in this CodeQL pack. +For more information, see ":doc:`About CodeQL packs `." -You may find it useful to look at the way query tests are organized in the -`CodeQL repository `__. -Each language has a ``src`` directory, ``ql//ql/src``, -that contains libraries and queries for analyzing codebases. -Alongside the ``src`` directory, -there's a ``test`` directory with tests for these libraries and queries. +You may find it useful to look at the way query tests are organized in the +`CodeQL repository `__. +Each language has a ``src`` directory, ``ql//ql/src``, +that contains libraries and queries for analyzing codebases. +Alongside the ``src`` directory, there is a ``test`` directory with tests for +these libraries and queries. -Each ``test`` directory is configured as a test QL pack with two subdirectories: +Each ``test`` directory is configured as a test CodeQL pack with two subdirectories: - ``query-tests`` a series of subdirectories with tests for queries stored in the ``src`` directory. Each subdirectory contains test code and a QL reference file that specifies the query to test. @@ -49,18 +52,18 @@ Each ``test`` directory is configured as a test QL pack with two subdirectories: Setting up the test files for a query ------------------------------------- -For each query you want to test, you should create a sub-directory in the test QL pack. +For each query you want to test, you should create a sub-directory in the test CodeQL pack. Then add the following files to the subdirectory before you run the test command: - A query reference file (``.qlref`` file) defining the location of the query to test. - The location is defined relative to the root of the QL pack that contains the - query. Usually, this is a QL pack specified by the - ``libraryPathDependencies`` for the test pack. + The location is defined relative to the root of the CodeQL pack that contains the + query. Usually, this is a CodeQL pack specified in the + ``dependencies`` block of the test pack. For more information, see ":doc:`Query reference files `." - You don't need to add a query reference file if the query you want to + You do not need to add a query reference file if the query you want to test is stored in the test directory, - but it's generally good practice to store queries separately from tests. + but it is generally good practice to store queries separately from tests. The only exception is unit tests for QL libraries, which tend to be stored in test packs, separate from queries that generate alerts or paths. @@ -68,15 +71,13 @@ Then add the following files to the subdirectory before you run the test command should consist of one or more files containing examples of the code the query is designed to identify. -You can also define the results you expect to see when you run the query against +You can also define the results you expect to see when you run the query against the example code, by creating a file with the extension ``.expected``. Alternatively, you can leave the test command to create the ``.expected`` file -for you. (If you're using CodeQL CLI 2.0.2--2.0.6, you need to create an -``.expected`` file otherwise the command will fail to find your test query. -You can create an empty ``.expected`` file to workaround this limitation.) +for you. For an example showing how to create and test a query, see the `example -<#example>`__ below. +<#example>`__ below. .. pull-quote:: Important @@ -86,14 +87,14 @@ For an example showing how to create and test a query, see the `example it must have the same base name as the corresponding ``.expected`` file. For example, if the query is ``MyJavaQuery.ql``, the expected results file must be ``MyJavaQuery.expected``. - + If you want to specify a ``.qlref`` file in the command, it must have the same base name as the corresponding ``.expected`` file, but the query itself - may have a different name. + may have a different name. The names of the example code files don't have to be consistent with the other test files. All example code files found next to the ``.qlref`` (or ``.ql``) - file and in any subdirectories will be used to create a test database. + file and in any subdirectories will be used to create a test database. Therefore, for simplicity, we recommend you don't save test files in directories that are ancestors of each other. @@ -108,10 +109,10 @@ The ```` argument can be one or more of the following: - Path to a ``.ql`` file. - Path to a ``.qlref`` file that references a ``.ql`` file. -- Path to a directory that will be searched recursively for ``.ql`` and +- Path to a directory that will be searched recursively for ``.ql`` and ``.qlref`` files. -You can also specify: +You can also specify: - .. include:: ../reusables/threads-query-execution.rst @@ -123,7 +124,7 @@ Example The following example shows you how to set up a test for a query that searches Java code for ``if`` statements that have empty ``then`` blocks. It includes -steps to add the custom query and corresponding test files to separate QL packs +steps to add the custom query and corresponding test files to separate CodeQL packs outside your checkout of the CodeQL repository. This ensures when you update the CodeQL libraries, or check out a different branch, you won't overwrite your custom queries and tests. @@ -144,36 +145,36 @@ Prepare a query and test files #. Save the query to a file named ``EmptyThen.ql`` in a directory with your other custom queries. For example, - ``custom-queries/java/queries/EmptyThen.ql``. - -#. If you haven't already added your custom queries to a QL pack, - create a QL pack now. For example, if your custom Java queries + ``custom-queries/java/queries/EmptyThen.ql``. + +#. If you haven't already added your custom queries to a CodeQL pack, + create a CodeQL pack now. For example, if your custom Java queries are stored in ``custom-queries/java/queries``, add a ``qlpack.yml`` file with the following contents to ``custom-queries/java/queries``: .. code-block:: yaml name: my-custom-queries - version: 0.0.0 - libraryPathDependencies: codeql-java + dependencies: + codeql/java-queries: "*" - For more information about QL packs, see ":doc:`About QL packs - `." + For more information about CodeQL packs, see ":doc:`About CodeQL packs + `." -#. Create a QL pack for your Java tests by adding a ``qlpack.yml`` file +#. Create a CodeQL pack for your Java tests by adding a ``qlpack.yml`` file with the following contents to ``custom-queries/java/tests``, - updating ``libraryPathDependencies`` to match the name of your QL pack of custom queries: + updating the ``dependencies`` to match the name of your CodeQL pack of custom queries: .. include:: ../reusables/test-qlpack.rst #. Within the Java test pack, create a directory to contain the test files associated with ``EmptyThen.ql``. - For example, ``custom-queries/java/tests/EmptyThen``. + For example, ``custom-queries/java/tests/EmptyThen``. -#. In the new directory, create ``EmptyThen.qlref`` to define the location of ``EmptyThen.ql``. +#. In the new directory, create ``EmptyThen.qlref`` to define the location of ``EmptyThen.ql``. The path to the query must be specified relative to the root of - the QL pack that contains the query. In this case, the query is in the - top level directory of the QL pack named ``my-custom-queries``, + the CodeQL pack that contains the query. In this case, the query is in the + top level directory of the CodeQL pack named ``my-custom-queries``, which is declared as a dependency for ``my-query-tests``. Therefore, ``EmptyThen.qlref`` should simply contain ``EmptyThen.ql``. @@ -191,7 +192,7 @@ Prepare a query and test files System.out.println("Empty argument"); } } - + public void good(String arg) { if (arg.isEmpty()) { System.out.println("Empty argument"); @@ -211,8 +212,8 @@ When the test runs it: #. Extracts a CodeQL database from the ``.java`` files stored in the ``EmptyThen`` directory. #. Compiles the query referenced by the ``EmptyThen.qlref`` file. - If this step fails, it's because the CLI can't find your custom QL pack. - Re-run the command and specify the location of your custom QL pack, for example: + If this step fails, it's because the CLI can't find your custom CodeQL pack. + Re-run the command and specify the location of your custom CodeQL pack, for example: ``codeql test run --search-path=java java/tests/EmptyThen`` @@ -234,14 +235,14 @@ CodeQL generates the following files in the ``EmptyThen`` directory: When tests complete successfully, this database is deleted in a housekeeping step. You can override this step by running ``test run`` with the ``--keep-databases`` option. -In this case, the failure was expected and is easy to fix. +In this case, the failure was expected and is easy to fix. If you open the ``EmptyThen.actual`` file, you can see the results of the test: .. code-block:: none - + | Test.java:3:5:3:22 | stmt | This if statement has an empty then. | -This file contains a table, with a column for the location of the result, +This file contains a table, with a column for the location of the result, along with separate columns for each part of the ``select`` clause the query outputs. Since the results are what we expected, we can update the file extension to define this as the expected result for this test (``EmptyThen.expected``). @@ -252,17 +253,17 @@ If you rerun the test now, the output will be similar but it will finish by repo If the results of the query change, for example, if you revise the ``select`` statement for the query, the test will fail. For failed results, the CLI output includes a unified diff of the ``EmptyThen.expected`` and ``EmptyThen.actual`` files. -This information may be sufficient to debug trivial test failures. +This information may be sufficient to debug trivial test failures. For failures that are harder to debug, you can import ``EmptyThen.testproj`` into CodeQL for VS Code, execute ``EmptyThen.ql``, and view the results in the ``Test.java`` example code. For more information, see ":ref:`Analyzing your projects `" in the CodeQL for VS Code -help. +help. Further reading --------------- - ":ref:`CodeQL queries `" -- ":ref:`Testing CodeQL queries in Visual Studio Code `" \ No newline at end of file +- ":ref:`Testing CodeQL queries in Visual Studio Code `" diff --git a/docs/codeql/codeql-cli/testing-query-help-files.rst b/docs/codeql/codeql-cli/testing-query-help-files.rst index 26cea264043..d00420d71e9 100644 --- a/docs/codeql/codeql-cli/testing-query-help-files.rst +++ b/docs/codeql/codeql-cli/testing-query-help-files.rst @@ -3,7 +3,7 @@ Testing query help files ======================== -Test query help files by rendering them as markdown to ensure they are valid +Test query help files by rendering them as markdown to ensure they are valid before uploading them to the CodeQL repository or using them in code scanning. Query help is documentation that accompanies a query to explain how the query works, @@ -12,46 +12,46 @@ It is good practice to write query help for all new queries. For more informatio see `Contributing to CodeQL `__ in the CodeQL repository. -The CodeQL CLI includes a command to test query help and render the content as -markdown, so that you can easily preview the content in your IDE. Use the command to validate -query help files before uploading them to the CodeQL repository or sharing them with other users. -From CodeQL CLI 2.7.1 onwards, you can also include the markdown-rendered query help in SARIF files -generated during CodeQL analyses so that the query help can be displayed in the code scanning UI. -For more information, see +The CodeQL CLI includes a command to test query help and render the content as +markdown, so that you can easily preview the content in your IDE. Use the command to validate +query help files before uploading them to the CodeQL repository or sharing them with other users. +From CodeQL CLI 2.7.1 onwards, you can also include the markdown-rendered query help in SARIF files +generated during CodeQL analyses so that the query help can be displayed in the code scanning UI. +For more information, see ":ref:`Analyzing databases with the CodeQL CLI `." Prerequisites ------------- -- The query help (``.qhelp``) file must have an accompanying query (``.ql``) file with +- The query help (``.qhelp``) file must have an accompanying query (``.ql``) file with an identical base name. - The query help file should follow the standard structure and style for query help documentation. - For more information, see the `Query help style guide `__ - in the CodeQL repository. + For more information, see the `Query help style guide `__ + in the CodeQL repository. Running ``codeql generate query-help`` -------------------------------------- You can test query help files by running the following command:: - codeql generate query-help --format= [--output=] + codeql generate query-help --format= [--output=] where ```` is one of: - the path to a ``.qhelp`` file. - the path to a ``.ql`` file. - the path to a directory containing queries and query help files. -- the path to a query suite, or the name of a well-known query suite for a QL pack. +- the path to a query suite, or the name of a well-known query suite for a CodeQL pack. For more information, see "`Creating CodeQL query suites `__." -You must specify a ``--format`` option, which defines how the query help is rendered. -Currently, you must specify ``markdown`` to render the query help as markdown. +You must specify a ``--format`` option, which defines how the query help is rendered. +Currently, you must specify ``markdown`` to render the query help as markdown. The ``--output`` option defines a file path where the rendered query help will be saved. -- For directories containing ``.qhelp`` files or a query suites - defining one or more ``.qhelp`` files, you must specify an ``--output`` directory. - Filenames within the output directory will be derived from the ``.qhelp`` file names. +- For directories containing ``.qhelp`` files or a query suites + defining one or more ``.qhelp`` files, you must specify an ``--output`` directory. + Filenames within the output directory will be derived from the ``.qhelp`` file names. - For single ``.qhelp`` or ``.ql`` files, you may specify an ``--output`` option. If you don't specify an output path, the rendered query help is written to ``stdout``. @@ -63,15 +63,15 @@ see the `generate query-help reference documentation Results ------- -When you run the command, CodeQL attempts to render +When you run the command, CodeQL attempts to render each ``.qhelp`` file that has an accompanying ``.ql`` file. For single files, the rendered -content will be printed to ``stdout`` if you don't specify an ``--output`` option. For all other -use cases, the rendered content is saved to the specified output path. +content will be printed to ``stdout`` if you don't specify an ``--output`` option. For all other +use cases, the rendered content is saved to the specified output path. By default, the CodeQL CLI will print a warning message if: - Any of the query help is invalid, along with a description of the invalid query help elements -- Any ``.qhelp`` files specified in the command don't have the same base name +- Any ``.qhelp`` files specified in the command don't have the same base name as an accompanying ``.ql`` file - Any ``.ql`` files specified in the command don't have the same base name as an accompanying ``.qhelp`` file diff --git a/docs/codeql/codeql-cli/upgrading-codeql-databases.rst b/docs/codeql/codeql-cli/upgrading-codeql-databases.rst deleted file mode 100644 index 334a7501392..00000000000 --- a/docs/codeql/codeql-cli/upgrading-codeql-databases.rst +++ /dev/null @@ -1,55 +0,0 @@ -.. _upgrading-codeql-databases: - -Upgrading CodeQL databases -========================== - -As the CodeQL CLI tools and queries evolve, you may find that some of your -CodeQL databases become out of date. You must upgrade out-of-date databases -before you can analyze them. - -Databases become out of date when: - -- For databases created using the CodeQL CLI, the version of CLI tools used to - create them is older than your copy of the CodeQL queries. -- For databases downloaded from LGTM.com, the CodeQL tools used by LGTM.com to create - that revision of the code are older than your copy of the CodeQL queries. - -If you have a local checkout of the ``github/codeql`` repository, please note that -the ``main`` branch of the CodeQL queries is updated more often than both the -CLI and LGTM.com, so databases are most likely to become out of date if you use -the queries on this branch. For more information about the different versions of -the CodeQL queries, see ":ref:`Getting started with the CodeQL CLI `." - -Out-of-date databases must be upgraded before they can be analyzed. This topic -shows you how to upgrade a CodeQL database using the ``database upgrade`` -subcommand. - -Prerequisites -------------- - -Archived databases downloaded from LGTM.com must be unzipped before they are -upgraded. - -Running ``codeql database upgrade`` ------------------------------------ - -CodeQL databases are upgraded by running the following command:: - - codeql database upgrade - -where ````, the path to the CodeQL database you -want to upgrade, must be specified. - -For full details of all the options you can use when upgrading databases, -see the "`database upgrade <../manual/database-upgrade>`__" reference documentation. - -Progress and results --------------------- - -When you execute the ``database upgrade`` command, CodeQL identifies the version -of the :ref:`schema ` associated with the database. From -there, it works out what (if anything) is required to make the database work -with your queries and libraries. It will rewrite the database, if necessary, or -make no changes if the database is already compatible (or if it finds no -information about how to perform an upgrade). Once a database has been upgraded -it cannot be downgraded for use with older versions of the CodeQL products. diff --git a/docs/codeql/codeql-cli/using-custom-queries-with-the-codeql-cli.rst b/docs/codeql/codeql-cli/using-custom-queries-with-the-codeql-cli.rst index 8208cd59a56..0af320f9bb5 100644 --- a/docs/codeql/codeql-cli/using-custom-queries-with-the-codeql-cli.rst +++ b/docs/codeql/codeql-cli/using-custom-queries-with-the-codeql-cli.rst @@ -54,23 +54,20 @@ Packaging custom QL queries .. include:: ../reusables/beta-note-package-management.rst -When you write your own queries, you should save them in a custom QL pack -directory. When you are ready to share your queries with other users, you can publish the pack as a CodeQL pack to GitHub Packages - the GitHub Container registry. +When you write your own queries with the intention to share them with others, you should +save them in a custom CodeQL pack. You can publish the pack as a CodeQL pack to GitHub +Packages - the GitHub Container registry. For further information see +":ref:`About CodeQL packs `." -QL packs organize the files used in CodeQL analysis and can store queries, +CodeQL packs organize the files used in CodeQL analysis and can store queries, library files, query suites, and important metadata. Their root directory must contain a file named ``qlpack.yml``. Your custom queries should be saved in the -QL pack root, or its subdirectories. +CodeQL pack root, or its subdirectories. -For each QL pack, the ``qlpack.yml`` file includes information that tells CodeQL +For each CodeQL pack, the ``qlpack.yml`` file includes information that tells the CodeQL CLI how to compile the queries, which other CodeQL packs and libraries the pack depends on, and where to find query suite definitions. For more information -about what to include in this file, see ":ref:`About QL packs `." - -CodeQL packages are used to create, share, depend on, and run CodeQL queries and -libraries. You can publish your own CodeQL packages and download ones created by -others via the the Container registry. For further information see -":ref:`About CodeQL packs `." +about what to include in this file, see ":ref:`About CodeQL packs `." Contributing to the CodeQL repository ------------------------------------- diff --git a/docs/codeql/codeql-cli/using-the-codeql-cli.rst b/docs/codeql/codeql-cli/using-the-codeql-cli.rst index 7b67af59c6a..4d5ea6be7a0 100644 --- a/docs/codeql/codeql-cli/using-the-codeql-cli.rst +++ b/docs/codeql/codeql-cli/using-the-codeql-cli.rst @@ -7,7 +7,7 @@ Using the CodeQL CLI See the following links to learn how to get set up and run CodeQL commands: -- :doc:`About the CodeQL CLI `: Software +- :doc:`About the CodeQL CLI `: Software developers and security researchers can secure their code using the CodeQL CLI. - :doc:`Getting started with the CodeQL CLI @@ -17,19 +17,15 @@ See the following links to learn how to get set up and run CodeQL commands: - :doc:`Creating CodeQL databases `: Create relational representations of source code that can be queried like any other database. - + - :doc:`Extractor options - `: Set options for the + `: Set options for the behavior of extractors that create CodeQL databases. - :doc:`Analyzing CodeQL databases with the CodeQL CLI `: Analyze your code using queries written in a specially-designed, object-oriented query language. -- :doc:`Upgrading CodeQL databases - `: Upgrade your databases so - that they can be analyzed using the most up to date CodeQL products. - - :doc:`Using custom queries with the CodeQL CLI `: Use custom queries to extend your analysis or highlight errors that are specific to a particular codebase. @@ -42,7 +38,7 @@ See the following links to learn how to get set up and run CodeQL commands: your analysis. - :doc:`Testing query help files `: - Test query help files by rendering them as markdown to ensure they are valid + Test query help files by rendering them as markdown to ensure they are valid before adding them to the CodeQL repository or using them in code scanning. - :doc:`Creating and working with CodeQL packs `: @@ -51,7 +47,7 @@ See the following links to learn how to get set up and run CodeQL commands: - :doc:`Publishing and using CodeQL packs `: Publish your own or use others CodeQL packs for code scanning. -- :doc:`Specifying command options in a CodeQL configuration file `: +- :doc:`Specifying command options in a CodeQL configuration file `: You can save default or frequently used options for your commands in a per-user configuration file. .. toctree:: @@ -63,7 +59,6 @@ See the following links to learn how to get set up and run CodeQL commands: creating-codeql-databases extractor-options analyzing-databases-with-the-codeql-cli - upgrading-codeql-databases using-custom-queries-with-the-codeql-cli creating-codeql-query-suites testing-custom-queries diff --git a/docs/codeql/codeql-for-visual-studio-code/analyzing-your-projects.rst b/docs/codeql/codeql-for-visual-studio-code/analyzing-your-projects.rst index 71f72223620..b23ddacf157 100644 --- a/docs/codeql/codeql-for-visual-studio-code/analyzing-your-projects.rst +++ b/docs/codeql/codeql-for-visual-studio-code/analyzing-your-projects.rst @@ -19,7 +19,7 @@ To analyze a project, you need to add a :ref:`CodeQL database ` .. image:: ../images/codeql-for-visual-studio-code/choose-database.png :width: 350 :alt: Choose a database to analyze - + For more information about obtaining a local database, see below. #. Once you've chosen a database, it is displayed in the Databases view. To see the menu options for interacting with a database, right-click an entry in the list. You can select multiple databases using **Ctrl/Cmd+click**. @@ -27,7 +27,7 @@ To analyze a project, you need to add a :ref:`CodeQL database ` Obtaining a local database ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -If you have a CodeQL database saved locally, as an unarchived folder or as a ZIP file, you can add it to Visual Studio Code. There are several ways to obtain a local CodeQL database. +If you have a CodeQL database saved locally, as an unarchived folder or as a ZIP file, you can add it to Visual Studio Code. There are several ways to obtain a local CodeQL database. - To create a database with the CodeQL CLI, see ":ref:`Creating CodeQL databases `." @@ -36,14 +36,14 @@ If you have a CodeQL database saved locally, as an unarchived folder or as a ZIP - To analyze a test database, add a ``.testproj`` folder to the Databases view. Test databases (that is, folders with a ``.testproj`` extension) are generated when you run regression tests on custom queries using the :ref:`CodeQL CLI `. If a query fails a regression test, you may want to analyze the test database in Visual Studio Code to debug the failure. - - For more information about running query tests, see ":ref:`Testing custom queries `" in the CodeQL CLI help. + + For more information about running query tests, see ":ref:`Testing custom queries `" in the CodeQL CLI help. Running a query ------------------------ The `CodeQL repository `__ on GitHub contains lots of example queries. -If you have that folder (or a different QL pack) available in your workspace, you can access existing queries under ``/ql/src/``, for example ``java/ql/src/Likely Bugs``. +If you have that folder (or a different CodeQL pack) available in your workspace, you can access existing queries under ``/ql/src/``, for example ``java/ql/src/Likely Bugs``. #. Open a query (``.ql``) file. It is displayed in the editor, with IntelliSense features such as syntax highlighting and autocomplete suggestions. #. Right-click in the query window and select **CodeQL: Run Query**. (Alternatively, run the command from the Command Palette.) @@ -77,7 +77,7 @@ To run the query, use **CodeQL: Run Query**. You can see all quick queries that you've run in the current session in the Query History view. Click an entry to see the exact text of the quick query that produced the results. -Once you're happy with your quick query, you should save it in a QL pack so you can access it later. For more information, see ":ref:`About QL packs `." +Once you're happy with your quick query, you should save it in a CodeQL pack so you can access it later. For more information, see ":ref:`About CodeQL packs `." .. _running-a-specific-part-of-a-query-or-library: @@ -87,7 +87,7 @@ Running a specific part of a query or library This is helpful if you're debugging a query or library and you want to locate the part that is wrong. Instead of using **CodeQL: Run Query** to run the whole query (the :ref:`select clause ` and any :ref:`query predicates `), you can use **CodeQL: Quick Evaluation** to run a specific part of a ``.ql`` or ``.qll`` file. -**CodeQL: Quick Evaluation** evaluates a code snippet (instead of the whole query) and displays results of that selection in the Results view. +**CodeQL: Quick Evaluation** evaluates a code snippet (instead of the whole query) and displays results of that selection in the Results view. Possible targets for quick evaluation include: - Selecting the name of a CodeQL entity (such as a :ref:`class ` or :ref:`predicate `) to evaluate that entity. diff --git a/docs/codeql/codeql-for-visual-studio-code/setting-up-codeql-in-visual-studio-code.rst b/docs/codeql/codeql-for-visual-studio-code/setting-up-codeql-in-visual-studio-code.rst index b4969ce785d..1c762348a9d 100644 --- a/docs/codeql/codeql-for-visual-studio-code/setting-up-codeql-in-visual-studio-code.rst +++ b/docs/codeql/codeql-for-visual-studio-code/setting-up-codeql-in-visual-studio-code.rst @@ -110,7 +110,7 @@ For example, to make a custom CodeQL folder called ``my-custom-cpp-pack`` depend version: 0.0.0 libraryPathDependencies: codeql/cpp-all -For more information about why you need to add a ``qlpack.yml`` file, see ":ref:`About QL packs `." +For more information about why you need to add a ``qlpack.yml`` file, see ":ref:`About CodeQL packs `." Further reading ---------------- diff --git a/docs/codeql/codeql-overview/codeql-glossary.rst b/docs/codeql/codeql-overview/codeql-glossary.rst index 0acc7bd25f1..3770cab7921 100644 --- a/docs/codeql/codeql-overview/codeql-glossary.rst +++ b/docs/codeql/codeql-overview/codeql-glossary.rst @@ -5,7 +5,7 @@ CodeQL glossary =============== -An overview of the technical terms and concepts in CodeQL. +An overview of the technical terms and concepts in CodeQL. .. _bqrs-file: @@ -26,11 +26,11 @@ exported as a variety of different formats, including SARIF. CodeQL database --------------- -A database (or CodeQL database) is a directory containing: +A database (or CodeQL database) is a directory containing: - queryable data, extracted from the code. - a source reference, for displaying query results directly in the code. -- query results. +- query results. - log files generated during database creation, query execution, and other operations. @@ -39,15 +39,15 @@ A database (or CodeQL database) is a directory containing: DIL --- -DIL stands for Datalog Intermediary Language. It is an intermediate -representation between QL and relation algebra (RA) that is generated -during query compilation. DIL is useful for advanced users as an aid -for debugging query performance. +DIL stands for Datalog Intermediary Language. It is an intermediate +representation between QL and relation algebra (RA) that is generated +during query compilation. DIL is useful for advanced users as an aid +for debugging query performance. The DIL format may change without warning between CLI releases. -When you specify the ``--dump-dil`` option for ``codeql query compile``, CodeQL -prints DIL to standard output for the queries it compiles. You can also -view results in DIL format when you run queries in VS Code. +When you specify the ``--dump-dil`` option for ``codeql query compile``, CodeQL +prints DIL to standard output for the queries it compiles. You can also +view results in DIL format when you run queries in VS Code. For more information, see ":ref:`Analyzing your projects `" in the CodeQL for VS Code help. .. _extractor: @@ -56,7 +56,7 @@ Extractor --------- An extractor is a tool that produces the relational data and source -reference for each input file, from which a CodeQL database can be built. +reference for each input file, from which a CodeQL database can be built. .. _codeql-database-schema: @@ -67,7 +67,7 @@ A QL database schema is a file describing the column types and extensional relations that make up a raw QL dataset. It is a text file with the ``.dbscheme`` extension. -The extractor and core QL pack for a language each declare the database +The extractor and core CodeQL pack for a language each declare the database schema that they use. This defines the database layout they create or expect. When you create a CodeQL database, the extractor copies its schema into the database. The CLI uses this to check whether the @@ -83,16 +83,16 @@ There is currently no public-facing specification for the syntax of schemas. -------------- ``.qlo`` files are optionally generated during query compilation. -If you specify the ``--dump-qlo`` option for ``codeql query compile``, +If you specify the ``--dump-qlo`` option for ``codeql query compile``, CodeQL writes ``.qlo`` files for the queries it compiles. They can be used -as an aid for debugging and performance tuning for advanced users. +as an aid for debugging and performance tuning for advanced users. -``.qlo`` is a binary format that represents a compiled -and optimized query in terms of relational algebra (RA) or the -intermediate :ref:`DIL ` format. ``.qlo`` files can be expanded to -readable text using ``codeql query decompile``. +``.qlo`` is a binary format that represents a compiled +and optimized query in terms of relational algebra (RA) or the +intermediate :ref:`DIL ` format. ``.qlo`` files can be expanded to +readable text using ``codeql query decompile``. -The exact details of the ``.qlo`` format may change without warning between CLI releases. +The exact details of the ``.qlo`` format may change without warning between CLI releases. .. _sarif-file: @@ -101,22 +101,22 @@ SARIF file Static analysis results interchange format (SARIF) is an output format used for sharing static analysis results. For more information, see ":ref:`SARIF -output `." +output `." .. _source-reference: Source reference ---------------- -A source reference is a mechanism that allows the retrieval of the -contents of a source file, given an absolute filename at which that file +A source reference is a mechanism that allows the retrieval of the +contents of a source file, given an absolute filename at which that file resided during extraction. Specific examples include: -- A source archive directory, within which the requested absolute +- A source archive directory, within which the requested absolute filename maps to a UTF8-encoded file. -- A source archive, typically in ZIP format, which contains the UTF8-encoded +- A source archive, typically in ZIP format, which contains the UTF8-encoded content of all source files. -- A source archive repository, typically in ``git`` format, typically bare, +- A source archive repository, typically in ``git`` format, typically bare, which contains the UTF8-encoded content of all source files. Source references are typically included in CodeQL databases. @@ -126,7 +126,7 @@ Source references are typically included in CodeQL databases. TRAP file --------- -A TRAP file is a UTF-8 encoded file generated by a CodeQL extractor +A TRAP file is a UTF-8 encoded file generated by a CodeQL extractor with the extension ``.trap``. To save space, they are usually archived. They contain the information that, when interpreted relative to a QL database schema, is used to create a QL dataset. diff --git a/docs/codeql/ql-language-reference/ql-language-specification.rst b/docs/codeql/ql-language-reference/ql-language-specification.rst index 46d0123d6d4..ea90ebbf843 100644 --- a/docs/codeql/ql-language-reference/ql-language-specification.rst +++ b/docs/codeql/ql-language-reference/ql-language-specification.rst @@ -68,7 +68,7 @@ contain a single top-level tag named of the active database schema (for example, ````). -A ``qlpack.yml`` file defines a :ref:`QL pack `. +A ``qlpack.yml`` file defines a :ref:`CodeQL pack `. The content of a ``qlpack.yml`` file is described in the CodeQL CLI documentation. If both a ``queries.xml`` and a ``qlpack.yml`` exist in the same @@ -77,16 +77,16 @@ exist for compatibility with older tooling). The CodeQL CLI and newer tools based on it (such as, GitHub code scanning and the CodeQL extension for Visual Studio Code) -construct a library path using QL packs. For each QL pack -added to the library path, the QL packs named in its +construct a library path using CodeQL packs. For each CodeQL pack +added to the library path, the CodeQL packs named in its ``libraryPathDependencies`` will be subsequently added to the library path, and the process continues until all packs have been resolved. The actual library path consists of the root directories of -the selected QL packs. This process depends on a mechanism for finding -QL packs by pack name, as described in the :ref:`CodeQL CLI documentation `. +the selected CodeQL packs. This process depends on a mechanism for finding +CodeQL packs by pack name, as described in the :ref:`CodeQL CLI documentation `. When the query directory contains a ``queries.xml`` file but no -``qlpack.yml``, the QL pack resolution behaves as if it defines a QL +``qlpack.yml``, the CodeQL pack resolution behaves as if it defines a QL pack with no name and a single library path dependency named ``legacy-libraries-LANGUAGE`` where ``LANGUAGE`` is taken from ``queries.xml``. The ``github/codeql`` repository provides packs with @@ -94,7 +94,7 @@ names following this pattern, which themselves depend on the actual CodeQL libraries for each language. When the query directory contains neither a ``queries.xml`` nor -``qlpack.yml`` file, it is considered to be a QL pack with no name and +``qlpack.yml`` file, it is considered to be a CodeQL pack with no name and no library dependencies. This causes the library path to consist of *only* the query directory itself. This is not generally useful, but it suffices for running toy examples of QL code that don't diff --git a/docs/codeql/reusables/test-qlpack.rst b/docs/codeql/reusables/test-qlpack.rst index fe2fc5f4199..6ba9760248c 100644 --- a/docs/codeql/reusables/test-qlpack.rst +++ b/docs/codeql/reusables/test-qlpack.rst @@ -1,15 +1,9 @@ .. code-block:: yaml - name: my-query-tests - version: 0.0.0 - libraryPathDependencies: my-custom-queries + name: my-github-user/my-query-tests + dependencies: + my-github-user/my-custom-queries: ^1.2.3 extractor: java tests: . -This ``qlpack.yml`` file states that ``my-query-tests`` depends on -``my-custom-queries``. It also declares that the CLI should use the -Java ``extractor`` when creating test databases. -Supported from CLI 2.1.0 onward, the ``tests: .`` line declares -that all ``.ql`` files in the pack should be -run as tests when ``codeql test run`` is run with the -``--strict-test-discovery`` option. +This ``qlpack.yml`` file states that ``my-github-user/my-query-tests`` depends on ``my-github-user/my-custom-queries`` at a version greater than or equal to 1.2.3 and less than 2.0.0. It also declares that the CLI should use the Java ``extractor`` when creating test databases. The ``tests: .`` line declares that all ``.ql`` files in the pack should be run as tests when ``codeql test run`` is run with the ``--strict-test-discovery`` option. Typically, test packs do not contain a ``version`` property. This prevents you from accidentally publishing them. diff --git a/docs/codeql/writing-codeql-queries/about-codeql-queries.rst b/docs/codeql/writing-codeql-queries/about-codeql-queries.rst index be5bca75622..61d81bf6f3e 100644 --- a/docs/codeql/writing-codeql-queries/about-codeql-queries.rst +++ b/docs/codeql/writing-codeql-queries/about-codeql-queries.rst @@ -3,7 +3,7 @@ About CodeQL queries #################### -CodeQL queries are used to analyze code for issues related to security, correctness, maintainability, and readability. +CodeQL queries are used to analyze code for issues related to security, correctness, maintainability, and readability. Overview ******** @@ -13,7 +13,7 @@ CodeQL includes queries to find the most relevant and interesting problems for e - **Alert queries**: queries that highlight issues in specific locations in your code. - **Path queries**: queries that describe the flow of information between a source and a sink in your code. -You can add custom queries to :doc:`QL packs <../codeql-cli/about-ql-packs>` to analyze your projects with "`Code scanning `__", use them to analyze a database with the ":ref:`CodeQL CLI `," or you can contribute to the standard CodeQL queries in our `open source repository on GitHub `__. +You can add custom queries to :doc:`CodeQL packs <../codeql-cli/about-codeql-packs>` to analyze your projects with "`Code scanning `__", use them to analyze a database with the ":ref:`CodeQL CLI `," or you can contribute to the standard CodeQL queries in our `open source repository on GitHub `__. This topic is a basic introduction to query files. You can find more information on writing queries for specific programming languages in the ":ref:`CodeQL language guides `," and detailed technical information about QL in the ":ref:`QL language reference `." For more information on how to format your code when contributing queries to the GitHub repository, see the `CodeQL style guide `__.