Skip to main content

此版本的 GitHub Enterprise Server 已于以下日期停止服务 2024-07-09. 即使针对重大安全问题,也不会发布补丁。 为了获得更好的性能、更高的安全性和新功能,请升级到最新版本的 GitHub Enterprise。 如需升级帮助,请联系 GitHub Enterprise 支持

测试提取

[Plumbing] 为测试目录生成数据集。

谁可以使用此功能?

GitHub CodeQL 在安装后按用户授权。 根据许可证限制,只能将 CodeQL 用于某些任务。 有关详细信息,请参阅“关于 CodeQL CLI”。

如果你有 GitHub Advanced Security 许可证,则可以使用 CodeQL 进行自动分析、持续集成和持续交付。 有关详细信息,请参阅“关于 GitHub 高级安全性”。

本文内容

此内容描述了 CodeQL CLI 的最新版本。 有关此版本的详细信息,请参阅 https://github.com/github/codeql-cli-binaries/releases

若要查看早期版本中此命令可用选项的详细信息,请在终端中使用 --help 选项运行命令。

摘要

Shell
codeql test extract <options>... -- <testDir>

说明

[Plumbing] 为测试目录生成数据集。

为指定测试目录生成数据库,而无需实际运行任何测试查询。 输出要针对其执行测试查询的原始 QL 数据集的路径。

选项

主要选项

<testDir>

[必需] 测试目录的路径。

--database=<dir>

替代要创建的数据库的位置。 默认情况下,这将是一个子目录,其名称派生自测试目录本身的名称,并追加“.testproj”。

--search-path=<dir>[:<dir>...]

可在其中找到提取程序包的目录列表。 目录可以是提取程序包本身,也可以是包含提取程序作为直接子目录的目录。

如果路径包含多个目录树,则目录树的顺序定义了各自之间的优先级:如果目标语言在多个目录树中匹配,则给定的第一个目录树优先。

与 CodeQL 工具链本身捆绑的提取程序始终都能找到,但如果需要单独使用分布式提取程序,则需要提供此选项(或者更佳方式是,在每用户配置文件中设置 --search-path)。

(注意:在 Windows 上,路径分隔符为 ;)。

--cleanup

移除而不是创建测试数据库。

--[no-]show-extractor-output

[高级] 显示用于创建测试数据库的提取程序脚本的输出。 这在开发或编辑测试用例时很有用。 请注意,如果将它用于多个线程,则可能会导致输出重复或格式错误!

--[no-]check-undefined-labels

[高级] 报告未定义标签的错误。

--[no-]check-unused-labels

[高级] 报告未使用标签的错误。

--[no-]check-repeated-labels

[高级] 报告重复标签的错误。

--[no-]check-redefined-labels

[高级] 报告重新定义标签的错误。

--[no-]check-use-before-definition

[高级] 报告标签在定义前就已使用的错误。

--[no-]fail-on-trap-errors

[高级] 如果在 trap 导入期间发生错误,则退出非零。

--[no-]include-location-in-star

[高级] 构造实体 ID,这些 ID 对它们在 TRAP 文件中的源位置进行编码。 可能对调试 TRAP 生成器非常有用,但会在数据集中占用大量空间。

--[no-]linkage-aware-import

[高级] 控制 codeql 数据集导入是否具有链接感知(默认值)__。 对于在数据库创建这一部分占用过多内存的项目,禁用此选项可能有助于其运行,但会牺牲数据库的完整性。

v2.15.3 起可用。

--format=<fmt>

选择输出格式:text(默认)或 json

常用选项

-h, --help

显示此帮助文本。

-J=<opt>

[高级] 为运行命令的 JVM 提供选项。

(请注意,无法正确处理包含空格的选项。)

-v, --verbose

以增量方式增加输出的进度消息数。

-q, --quiet

以增量方式减少输出的进度消息数。

--verbosity=<level>

[高级] 将详细级别显式设置为“错误”、“警告”、“进度”、“进度+”、“进度++”、“进度+++”之一。 重写 -v-q

--logdir=<dir>

[高级] 将详细日志写入给定目录中的一个或多个文件,其中生成的名称包括时间戳和正在运行的子命令的名称。

(若要使用可以完全控制的名称编写日志文件,请根据需要提供 --log-to-stderr 并重定向 stderr。)

--common-caches=<dir>

[高级] 控制磁盘上缓存数据的位置,此位置会在多次运行 CLI(例如下载的 QL 包和已编译查询计划)期间暂留。 如果未明确设置,则默认为用户主目录中名为 .codeql 的目录;如果尚不存在,则会创建该目录。

v2.15.2 起可用。