В этом материале описывается последний выпуск Интерфейса командной строки CodeQL. Дополнительные сведения об этом выпуске см. в разделе https://github.com/github/codeql-cli-binaries/releases.
Чтобы просмотреть сведения о параметрах, доступных для этой команды в более раннем выпуске, выполните команду с параметром в терминале --help
.
Краткий обзор
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
[Дополнительно] Выйдите из ненулевых, если во время импорта ловушки возникает ошибка.
--[no-]include-location-in-star
[Дополнительно] Создайте идентификаторы сущностей, которые кодируют расположение в файле TRAP, из чего они поступили. Может быть полезно для отладки генераторов TRAP, но занимает много места в наборе данных.
--format=<fmt>
Выберите формат вывода (text
по умолчанию) или json
.
Общие параметры
-h, --help
Показать этот текст справки.
-J=<opt>
[Дополнительно] Предоставьте параметр виртуальной машине Java, запустив команду .
(Остерегайтесь, что параметры, содержащие пробелы, будут обрабатываться неправильно.)
-v, --verbose
Добавочное увеличение числа выводемых сообщений о ходе выполнения.
-q, --quiet
Постепенно уменьшайте количество выводемых сообщений о ходе выполнения.
--verbosity=<level>
[Дополнительно] Явно задайте уровень детализации для одной из ошибок, предупреждений, хода выполнения, хода выполнения+, хода выполнения++, хода выполнения+++. Переопределяет -v
и -q
.
--logdir=<dir>
[Дополнительно] Запись подробных журналов в один или несколько файлов в заданном каталоге с созданными именами, включая метки времени и имя выполняющейся подкоманды.
(Чтобы записать файл журнала с именем, над которым у вас есть полный контроль, вместо этого при необходимости предоставьте --log-to-stderr
и перенаправьте stderr.)