ctest(1)

Синопсис

ctest [<options>]

Описание

Исполняемый файл «ctest» — это программа-драйвер тестов CMake. Деревья сборки, сгенерированные CMake для проектов, использующих команды ENABLE_TESTING и ADD_TEST, имеют поддержку тестирования. Эта программа будет запускать тесты и сообщать результаты.

Параметры

-C <cfg>, --build-config <cfg>

Выбор конфигурации для тестирования.

Некоторые сгенерированные CMake деревья сборки могут иметь несколько конфигураций сборки в одном дереве. Этот параметр позволяет указать, какая конфигурация должна быть протестирована. Примеры конфигураций: «Debug» и «Release».

-V,--verbose

Включить подробный вывод тестов.

Вывод тестов обычно подавляется, и отображается только сводная информация. Этот параметр покажет весь вывод тестов.

-VV,--extra-verbose

Включить более подробный вывод тестов.

Вывод тестов обычно подавляется, и отображается только сводная информация. Этот параметр покажет ещё больше вывода тестов.

--debug

Отображение более подробных внутренних данных CTest.

Эта функция приведет к большому количеству вывода, который в основном полезен для отладки проблем с информационной панелью.

--output-on-failure

Вывод всего вывода программы теста, если тест должен завершиться ошибкой. Этот параметр также можно включить, задав переменную окружения CTEST_OUTPUT_ON_FAILURE.

-F

Включить резервирование.

Этот параметр позволяет ctest возобновить выполнение набора тестов, который был ранее прерван. Если прерывания не произошло, параметр -F не повлияет.

-j <jobs>, --parallel <jobs>

Выполнять тесты параллельно, используя указанное количество задач.

Этот параметр указывает ctest на параллельное выполнение тестов, используя заданное количество задач. Этот параметр также можно установить, задав переменную окружения CTEST_PARALLEL_LEVEL.

--test-load <level>

Во время параллельного выполнения тестов (например, с -j) стараться не запускать тесты, которые могут привести к превышению заданного порога загрузки процессора.

Когда ctest запускается как клиент информационной панели, это устанавливает параметр TestLoad шага тестирования CTest.

-Q,--quiet

Сделать ctest тихим.

Этот параметр подавит весь вывод. Файл журнала вывода всё равно будет создан, если указан параметр –output-log. Такие параметры, как –verbose, –extra-verbose и –debug игнорируются, если указан –quiet.

-O <file>, --output-log <file>

Вывод в файл журнала

Этот параметр указывает ctest записывать весь свой вывод в файл журнала.

-N,--show-only

Отключить фактическое выполнение тестов.

Этот параметр указывает ctest вывести список тестов, которые будут выполнены, но не выполнять их фактически. Полезно в сочетании с параметрами -R и -E.

-L <regex>, --label-regex <regex>

Выполнить тесты с метками, соответствующими регулярному выражению.

Этот параметр указывает ctest выполнять только тесты, метки которых соответствуют заданному регулярному выражению.

-R <regex>, --tests-regex <regex>

Выполнить тесты, соответствующие регулярному выражению.

Этот параметр указывает ctest выполнить только тесты, имена которых соответствуют заданному регулярному выражению.

-E <regex>, --exclude-regex <regex>

Исключить тесты, соответствующие регулярному выражению.

Этот параметр указывает ctest НЕ выполнять тесты, имена которых соответствуют заданному регулярному выражению.

-LE <regex>, --label-exclude <regex>

Исключить тесты с метками, соответствующими регулярному выражению.

Этот параметр указывает ctest НЕ выполнять тесты, метки которых соответствуют заданному регулярному выражению.

-D <dashboard>, --dashboard <dashboard>

Выполнить тест информационной панели

Этот параметр указывает ctest действовать как клиент CDash и выполнить тест информационной панели. Все тесты имеют вид <Mode><Test>, где Mode может быть Experimental, Nightly и Continuous, а Test может быть Start, Update, Configure, Build, Test, Coverage и Submit.

-D <var>:<type>=<value>

Определить переменную для режима скрипта

Передать значения переменных в командной строке. Использовать в сочетании с -S для передачи значений переменных скрипту информационной панели. Парсинг аргументов -D в качестве значений переменных выполняется только в том случае, если значение, следующее за -D, не соответствует ни одному из известных типов информационной панели.

-M <model>, --test-model <model>

Устанавливает модель для информационной панели

Этот параметр указывает ctest действовать как клиент CDash, где TestModel может быть Experimental, Nightly и Continuous. Сочетание -M и -T аналогично -D

-T <action>, --test-action <action>

Устанавливает действие информационной панели

Этот параметр указывает ctest действовать как клиент CDash и выполнить какое-либо действие, такое как start, build, test и т. д. Сочетание -M и -T аналогично -D

--track <track>

Указать трек для отправки данных информационной панели

Отправить данные информационной панели в указанный трек вместо стандартного. По умолчанию, данные информационной панели отправляются в трек Nightly, Experimental или Continuous, но с помощью этого параметра трек может быть произвольным.

-S <script>, --script <script>

Выполнить информационную панель для конфигурации

Этот параметр указывает ctest загрузить скрипт конфигурации, который устанавливает ряд параметров, таких как бинарные и исходные каталоги. Затем ctest выполнит необходимые действия для создания и запуска информационной панели. Этот параметр в основном настраивает информационную панель и затем запускает ctest -D с соответствующими параметрами.

-SP <script>, --script-new-process <script>

Выполнить информационную панель для конфигурации

Этот параметр выполняет те же операции, что и -S, но выполняет их в отдельном процессе. Это в первую очередь полезно в тех случаях, когда скрипт может изменить среду, и вы не хотите, чтобы изменённая среда влияла на другие скрипты -S.

-A <file>, --add-notes <file>

Добавить файл заметок при отправке данных информационной панели

Этот параметр указывает ctest включить файл заметок при отправке данных информационной панели.

-I [Start,End,Stride,test#,test#|Test file], --tests-information

Выполнить определённое количество тестов по номеру.

Этот параметр заставляет ctest запускать тесты, начиная с номера Start, заканчивая номером End и увеличивая с шагом Stride. Любые дополнительные номера после Stride считаются отдельными номерами тестов. Start, End или stride могут быть пустыми. При необходимости можно указать файл, содержащий ту же синтаксическую конструкцию, что и в командной строке.

-U, --union

Взять объединение -I и -R

Когда оба параметра -R и -I заданы, по умолчанию выполняется пересечение тестов. При указании -U вместо этого выполняется объединение тестов.

--rerun-failed

Выполнить только те тесты, которые ранее завершились с ошибкой

Этот параметр указывает ctest выполнить только те тесты, которые завершились ошибкой во время предыдущего запуска. При указании этого параметра ctest игнорирует все другие параметры, предназначенные для изменения списка запускаемых тестов (-L, -R, -E, -LE, -I и т. д.). В случае, если CTest выполнится, и ни один тест не завершится с ошибкой, последующие вызовы ctest с параметром –rerun-failed выполнят набор тестов, который последний раз завершился с ошибкой (если таковые были).

--repeat-until-fail <n>

Требуется, чтобы каждый тест выполнялся <n> раз без ошибок, чтобы считаться пройденным.

Это полезно для выявления спорадических ошибок в тестовых случаях.

--max-width <width>

Установить максимальную ширину имени теста для вывода

Установите максимальную ширину каждого имени теста для отображения в выводе. Это позволяет пользователю расширить вывод, чтобы избежать обрезания имени теста, что может быть очень раздражающим.

--interactive-debug-mode [0|1]

Установить интерактивный режим в 0 или 1.

Этот параметр заставляет ctest выполнять тесты в интерактивном или неинтерактивном режиме. В Windows это означает, что в неинтерактивном режиме все всплывающие окна отладки системы блокируются. В режиме информационной панели (Experimental, Nightly, Continuous) значение по умолчанию — неинтерактивный. При простом запуске тестов, не для информационной панели, значение по умолчанию — разрешить всплывающие окна и интерактивную отладку.

--no-label-summary

Отключить сводную информацию о времени выполнения для меток.

Этот параметр указывает ctest не выводить сводную информацию для каждой метки, связанной с запущенными тестами. Если тесты не имеют меток, дополнительный вывод не отображается.

--build-and-test

Настроить, скомпилировать и запустить тест.

Этот параметр указывает ctest настроить (т. е. запустить cmake), скомпилировать и/или выполнить тест. Шаги настройки и тестирования необязательны. Аргументы этой командной строки — каталоги исходных и бинарных файлов. По умолчанию это выполнит CMake в каталогах Source/Bin, указанных, если не указан –build-nocmake. Параметр –build-generator обязателен для использования –build-and-test. Если указан –test-command, он будет выполнен после завершения сборки. Другие параметры, которые влияют на этот режим, — –build-target –build-nocmake, –build-run-dir, –build-two-config, –build-exe-dir, –build-project,–build-noclean, –build-options

--build-target

Указать конкретную цель для сборки.

Этот параметр используется с параметром –build-and-test, если он не указан, то собирается целевой объект all.

--build-nocmake

Выполнить сборку без предварительного запуска cmake.

Пропустить шаг cmake.

--build-run-dir

Указать каталог для запуска программ.

Каталог, в котором будут находиться программы после компиляции.

--build-two-config

Выполнить CMake дважды

--build-exe-dir

Указать каталог для исполняемого файла.

--build-generator

Указать используемый генератор.

--build-generator-platform

Указать платформу, специфичную для генератора.

--build-generator-toolset

Указать набор инструментов, специфичный для генератора.

--build-project

Указать имя проекта для сборки.

--build-makeprogram

Переопределить программу make, выбранную CTest, на заданную.

--build-noclean

Пропустить шаг очистки make.

--build-config-sample

Образец исполняемого файла для определения конфигурации

Образец исполняемого файла, используемый для определения конфигурации, которая должна быть использована. Например, Debug/Release и т. д.

--build-options

Добавить дополнительные параметры к шагу сборки.

Этот параметр должен быть последним параметром, за исключением –test-command

--test-command

Тест для запуска с параметром –build-and-test.

--test-output-size-passed <size>

Ограничить вывод пройденных тестов до <размер> байт.

--test-output-size-failed <size>

Ограничить вывод завершённых с ошибкой тестов до <размер> байт.

--test-timeout

Время ожидания в секундах, только для внутреннего использования.

--tomorrow-tag

Nightly или experimental запускаются с меткой следующего дня.

Это полезно, если сборка не завершится за один день.

--ctest-config

Файл конфигурации, используемый для инициализации состояния CTest при отправке данных на панели мониторинга.

Этот параметр сообщает CTest использовать другой файл инициализации вместо CTestConfiguration.tcl. Таким образом, можно использовать несколько файлов инициализации, например, для отправки данных на несколько панелей мониторинга.

--overwrite

Переопределить параметр конфигурации CTest.

По умолчанию ctest использует параметры конфигурации из файла конфигурации. Этот параметр переопределит параметр конфигурации.

--extra-submit <file>[;<file>]

Отправить дополнительные файлы на панель мониторинга.

Этот параметр отправит дополнительные файлы на панель мониторинга.

--force-new-ctest-process

Запускать дочерние экземпляры CTest как новые процессы

По умолчанию CTest будет запускать дочерние экземпляры CTest в рамках одного процесса. Если это поведение нежелательно, этот аргумент заставит использовать новые процессы для дочерних процессов CTest.

--schedule-random

Использовать случайный порядок планирования тестов

Этот параметр запустит тесты в случайном порядке. Он обычно используется для выявления явных зависимостей в наборе тестов.

--submit-index

Параметр устаревшей поддержки старой функции сервера панели мониторинга Dart2. Не использовать.

--timeout <seconds>

Установить глобальный таймаут для всех тестов.

Этот параметр установит глобальный таймаут для всех тестов, для которых ещё не установлен таймаут.

--stop-time <time>

Установить время, по которому все тесты должны быть остановлены.

Установить реальное время суток, по которому все тесты должны завершиться по таймауту. Пример: 7:00:00 -0400. Принимается любой формат времени, понимаемый парсером даты curl. Если часовой пояс не указан, предполагается местное время.

--http1.0

Отправлять данные с использованием HTTP 1.0.

Этот параметр заставит CTest использовать HTTP 1.0 для отправки файлов на панель мониторинга вместо HTTP 1.1.

--no-compress-output

Не сжимать выходные данные тестов при отправке.

Этот флаг отключит автоматическое сжатие выходных данных тестов. Используйте его для сохранения совместимости со старой версией CDash, которая не поддерживает сжатые выходные данные тестов.

--print-labels

Вывести все доступные метки тестов.

Этот параметр не выполнит никаких тестов, а просто выведет список всех меток, связанных с набором тестов.

--help,-help,-usage,-h,-H,/?

Вывести информацию об использовании и завершить работу.

Информация об использовании описывает базовый интерфейс командной строки и его параметры.

--version,-version,/V [<f>]

Показать баннер с именем/версией программы и завершить работу.

Если файл указан, версия записывается в него. Помощь выводится в указанный файл <f> если он задан.

--help-full [<f>]

Вывести все руководства по помощи и завершить работу.

Все руководства выводятся в удобочитаемом текстовом формате. Помощь выводится в указанный файл <f> если он задан.

--help-manual <man> [<f>]

Вывести одно руководство по помощи и завершить работу.

Указанное руководство выводится в удобочитаемом текстовом формате. Помощь выводится в указанный файл <f> если он задан.

--help-manual-list [<f>]

Вывести список доступных руководств по помощи и завершить работу.

Список содержит все руководства, для которых помощь может быть получена с помощью параметра --help-manual за которым следует имя руководства. Помощь выводится в указанный файл <f> если он задан.

--help-command <cmd> [<f>]

Вывести справку по одной команде и завершить работу.

Запись справки cmake-commands(7) для <cmd> выводится в удобочитаемом текстовом формате. Помощь выводится в указанный файл <f> если он задан.

--help-command-list [<f>]

Вывести список команд с доступной помощью и завершить работу.

Список содержит все команды, для которых помощь может быть получена с помощью параметра --help-command за которым следует имя команды. Помощь выводится в указанный файл <f> если он задан.

--help-commands [<f>]

Вывести руководство cmake-commands и завершить работу.

Руководство cmake-commands(7) выводится в удобочитаемом текстовом формате. Помощь выводится в указанный файл <f> если он задан.

--help-module <mod> [<f>]

Вывести справку по одному модулю и завершить работу.

Запись справки cmake-modules(7) для <mod> выводится в удобочитаемом текстовом формате. Помощь выводится в указанный файл <f> если он задан.

--help-module-list [<f>]

Вывести список модулей с доступной помощью и завершить работу.

Список содержит все модули, для которых помощь может быть получена с помощью параметра --help-module за которым следует имя модуля. Помощь выводится в указанный файл <f> если он задан.

--help-modules [<f>]

Вывести руководство cmake-modules и завершить работу.

Руководство cmake-modules(7) выводится в удобочитаемом текстовом формате. Помощь выводится в указанный файл <f> если он задан.

--help-policy <cmp> [<f>]

Вывести справку по одному политике и завершить работу.

Запись справки cmake-policies(7) для <cmp> выводится в удобочитаемом текстовом формате. Помощь выводится в указанный файл <f> если он задан.

--help-policy-list [<f>]

Вывести список политик с доступной помощью и завершить работу.

Список содержит все политики, для которых помощь может быть получена с помощью параметра --help-policy за которым следует имя политики. Помощь выводится в указанный файл <f> если он задан.

--help-policies [<f>]

Вывести руководство cmake-policies и завершить работу.

Руководство cmake-policies(7) выводится в удобочитаемом текстовом формате. Помощь выводится в указанный файл <f> если он задан.

--help-property <prop> [<f>]

Вывести справку по одному свойству и завершить работу.

Записи справки cmake-properties(7) для <prop> выводятся в удобочитаемом текстовом формате. Помощь выводится в указанный файл <f> если он задан.

--help-property-list [<f>]

Вывести список свойств с доступной помощью и завершить работу.

Список содержит все свойства, для которых помощь может быть получена с помощью параметра --help-property за которым следует имя свойства. Помощь выводится в указанный файл <f> если он задан.

--help-properties [<f>]

Вывести руководство cmake-properties и завершить работу.

Руководство cmake-properties(7) выводится в удобочитаемом текстовом формате. Помощь выводится в указанный файл <f> если он задан.

--help-variable <var> [<f>]

Вывести справку по одной переменной и завершить работу.

Запись справки cmake-variables(7) для <var> выводится в удобочитаемом текстовом формате. Помощь выводится в указанный файл <f> если он задан.

--help-variable-list [<f>]

Вывести список переменных с доступной помощью и завершить работу.

Список содержит все переменные, для которых помощь может быть получена с помощью параметра --help-variable за которым следует имя переменной. Помощь выводится в указанный файл <f> если он задан.

--help-variables [<f>]

Вывести руководство cmake-variables и завершить работу.

Руководство cmake-variables(7) выводится в удобочитаемом текстовом формате. Помощь выводится в указанный файл <f> если он задан.

Клиент панели мониторинга

CTest может работать как клиент приложения-панели мониторинга качества программного обеспечения CDash. В качестве клиента панели мониторинга CTest выполняет последовательность шагов для настройки, сборки и тестирования программного обеспечения, а затем отправляет результаты на сервер CDash.

Шаги клиента панели мониторинга

CTest определяет упорядоченный список шагов тестирования, некоторые или все из которых могут быть выполнены как клиент панели мониторинга:

Start

Начать новую отправку в панель мониторинга, которая будет составлена из результатов, записанных в следующих шагах. См. раздел Шаг начала CTest ниже.

Update

Обновить дерево исходных кодов из его репозитория системы управления версиями. Записать старые и новые версии, а также список обновленных файлов исходных кодов. См. раздел Шаг обновления CTest ниже.

Configure

Настроить программное обеспечение, выполнив команду в дереве сборки. Записать лог конфигурации. См. раздел Шаг конфигурации CTest ниже.

Build

Собрать программное обеспечение, выполнив команду в дереве сборки. Записать лог сборки, обнаружить предупреждения и ошибки. См. раздел Шаг сборки CTest ниже.

Test

Тестировать программное обеспечение, загрузив CTestTestfile.cmake из дерева сборки и выполнив определенные тесты. Записать вывод и результат каждого теста. См. раздел Шаг тестирования CTest ниже.

Coverage

Вычислить покрытие исходного кода, запустив инструмент анализа покрытия и записав его вывод. См. раздел Шаг покрытия CTest ниже.

MemCheck

Запустить набор тестов программного обеспечения через инструмент проверки памяти. Записать вывод тестов, результаты и проблемы, сообщенные инструментом. См. раздел Шаг CTest проверки памяти ниже.

Submit

Отправить результаты, записанные из других шагов тестирования, на сервер панели мониторинга качества программного обеспечения. См. раздел Шаг отправки CTest ниже.

Режимы работы клиента панели мониторинга

CTest определяет три режима работы в качестве клиента панели мониторинга:

Nightly

Этот режим предназначен для вызова один раз в день, обычно ночью. Он по умолчанию включает шаги Start, Update, Configure, Build, Test, Coverage, и Submit. Выбранные шаги выполняются даже если шаг Update не сообщает о каких-либо изменениях в дереве исходных кодов.

Continuous

Этот режим предназначен для многократного вызова в течение дня. Он по умолчанию включает шаги Start, Update, Configure, Build, Test, Coverage, и Submit, но завершается после шага Update при отсутствии изменений в дереве исходных кодов.

Experimental

Этот режим предназначен для вызова разработчиком для тестирования локальных изменений. Он по умолчанию включает шаги Start, Configure, Build, Test, Coverage, и Submit.

Клиент панели мониторинга через командную строку CTest

CTest может выполнять тестирование на уже сгенерированном дереве сборки. Выполните команду ctest с текущей рабочей директории, установленной в дереве сборки, и используйте одну из этих подписей:

ctest -D <mode>[<step>]
ctest -M <mode> [ -T <step> ]...

<mode> должен быть одним из указанных выше Режимов работы клиента панели мониторинга, а каждый <step> должен быть одним из указанных выше Шагов клиента панели мониторинга.

CTest считывает параметры конфигурации Конфигурации клиента панели мониторинга из файла в дереве сборки, который называется либо CTestConfiguration.ini или DartConfiguration.tcl (названия являются историческими). Формат файла:

# Lines starting in '#' are comments.
# Other non-blank lines are key-value pairs.
<setting>: <value>

где <setting> — имя параметра, а <value> — значение параметра.

В деревьях сборки, сгенерированных CMake, этот конфигурационный файл генерируется модулем CTest, если он включён в проект. Модуль использует переменные для получения значения каждого параметра, как описано в документации по параметрам ниже.

Клиент панели мониторинга через скрипт CTest

CTest может выполнять тестирование, управляемое скриптом cmake-language(7), который создает и поддерживает дерево исходных кодов и дерево сборки, а также выполняет шаги тестирования. Выполните команду ctest с текущей рабочей директорией за пределами любого дерева сборки и используйте одну из этих подписей:

ctest -S <script>
ctest -SP <script>

Файл <script> должен вызывать команды Команды CTest для явного выполнения шагов тестирования, как описано ниже. Команды получают параметры конфигурации Конфигурации клиента панели мониторинга из своих аргументов или из переменных, установленных в скрипте.

Конфигурация клиента панели мониторинга

Шаги Клиента панели мониторинга можно настроить с помощью именованных параметров, как описано в следующих разделах.

Шаг начала CTest

Начать новую отправку в панель мониторинга, которая будет составлена из результатов, записанных в следующих шагах.

В скрипте CTest команда ctest_start() выполняет этот шаг. Аргументы команды могут указать некоторые из параметров шага. Сначала команда выполняет команду, указанную в переменной CTEST_CHECKOUT_COMMAND, если она установлена, для инициализации каталога исходных кодов.

Настройки конфигурации включают:

BuildDirectory

Полный путь к дереву сборки проекта.

• Переменная скрипта CTest: CTEST_BINARY_DIRECTORY
• Переменная модуля CTest: CTest

SourceDirectory

Полный путь к дереву исходных кодов проекта.

• Переменная скрипта CTest: CTEST_SOURCE_DIRECTORY
• Переменная модуля CTest: CTest

Шаг обновления CTest

В скрипте CTest команда ctest_update() выполняет этот шаг. Аргументы команды могут указать некоторые из параметров шага.

Настройки конфигурации для указания инструмента управления версиями включают:

BZRCommand

bzr утилита командной строки для использования, если дерево исходного кода управляется Bazaar.

• Скрипт CTest переменная: CTEST_BZR_COMMAND
• CTest переменная модуля: none

BZRUpdateOptions

Опции командной строки для BZRCommand при обновлении исходного кода.

• Скрипт CTest переменная: CTEST_BZR_UPDATE_OPTIONS
• CTest переменная модуля: none

CVSCommand

cvs утилита командной строки для использования, если дерево исходного кода управляется CVS.

• Скрипт CTest переменная: CTEST_CVS_COMMAND
• CTest переменная модуля: CVSCOMMAND

CVSUpdateOptions

Опции командной строки для CVSCommand при обновлении исходного кода.

• Скрипт CTest переменная: CTEST_CVS_UPDATE_OPTIONS
• CTest переменная модуля: CVS_UPDATE_OPTIONS

GITCommand

git утилита командной строки для использования, если дерево исходного кода управляется Git.

• Скрипт CTest переменная: CTEST_GIT_COMMAND
• CTest переменная модуля: GITCOMMAND

GITUpdateCustom

Укажите пользовательскую команду (в формате список через точку с запятой) для выполнения в дереве исходного кода (рабочая область Git), чтобы обновить его вместо выполнения GITCommand.

• Скрипт CTest переменная: CTEST_GIT_UPDATE_CUSTOM
• CTest переменная модуля: CTEST_GIT_UPDATE_CUSTOM

GITUpdateOptions

Опции командной строки для GITCommand при обновлении исходного кода.

• Скрипт CTest переменная: CTEST_GIT_UPDATE_OPTIONS
• CTest переменная модуля: GIT_UPDATE_OPTIONS

HGCommand

hg утилита командной строки для использования, если дерево исходного кода управляется Mercurial.

• Скрипт CTest переменная: CTEST_HG_COMMAND
• CTest переменная модуля: none

HGUpdateOptions

Опции командной строки для HGCommand при обновлении исходного кода.

• Скрипт CTest переменная: CTEST_HG_UPDATE_OPTIONS
• CTest переменная модуля: none

P4Client

Значение опции -c для P4Command.

• Скрипт CTest переменная: CTEST_P4_CLIENT
• CTest переменная модуля: CTEST_P4_CLIENT

P4Command

p4 утилита командной строки для использования, если дерево исходного кода управляется Perforce.

• Скрипт CTest переменная: CTEST_P4_COMMAND
• CTest переменная модуля: P4COMMAND

P4Options

Опции командной строки для P4Command для всех вызовов.

• Скрипт CTest переменная: CTEST_P4_OPTIONS
• CTest переменная модуля: CTEST_P4_OPTIONS

P4UpdateCustom

Укажите пользовательскую команду (в формате список через точку с запятой) для выполнения в дереве исходного кода (дерево Perforce), чтобы обновить его вместо выполнения P4Command.

• Скрипт CTest переменная: none
• CTest переменная модуля: CTEST_P4_UPDATE_CUSTOM

P4UpdateOptions

Опции командной строки для P4Command при обновлении исходного кода.

• Скрипт CTest переменная: CTEST_P4_UPDATE_OPTIONS
• CTest переменная модуля: CTEST_P4_UPDATE_OPTIONS

SVNCommand

svn утилита командной строки для использования, если дерево исходного кода управляется Subversion.

• Скрипт CTest переменная: CTEST_SVN_COMMAND
• CTest переменная модуля: SVNCOMMAND

SVNOptions

Опции командной строки для SVNCommand для всех вызовов.

• Скрипт CTest переменная: CTEST_SVN_OPTIONS
• CTest переменная модуля: CTEST_SVN_OPTIONS

SVNUpdateOptions

Опции командной строки для SVNCommand при обновлении исходного кода.

• Скрипт CTest переменная: CTEST_SVN_UPDATE_OPTIONS
• CTest переменная модуля: SVN_UPDATE_OPTIONS

UpdateCommand

Укажите утилиту командной строки для системы управления версиями без определения VCS, который управляет деревом исходного кода.

• Скрипт CTest переменная: CTEST_UPDATE_COMMAND
• CTest переменная модуля: <VCS>COMMAND при UPDATE_TYPE равном <vcs>, иначе UPDATE_COMMAND

UpdateOptions

Командная строка опций для UpdateCommand.

• Сценарий CTest переменная: CTEST_UPDATE_OPTIONS
• CTest модульная переменная: <VCS>_UPDATE_OPTIONS когда UPDATE_TYPE равно <vcs>, иначе UPDATE_OPTIONS

UpdateType

Укажите систему управления версиями, которая управляет деревом исходного кода, если её нельзя автоматически определить. Значение может быть bzr, cvs, git, hg, p4, или svn.

• Сценарий CTest переменная: без значения, определённая из дерева исходного кода
• CTest модульная переменная: UPDATE_TYPE если установлена, иначе CTEST_UPDATE_TYPE

UpdateVersionOnly

Укажите, что вы хотите, чтобы команда обновления системы управления версиями обнаруживала только текущую проверенную версию, а не обновляла её до другой версии.

• Сценарий CTest переменная: CTEST_UPDATE_VERSION_ONLY

Дополнительные параметры конфигурации включают:

NightlyStartTime

В режиме панели Nightly укажите "время начала ночной сборки". С централизованными системами управления версиями (cvs и svn) этап Update проверяет версию программного обеспечения на эту дату и время, чтобы несколько клиентов выбирали одну общую версию для тестирования. Это не определено в системах распределённого контроля версий, поэтому настройка игнорируется.

• Сценарий CTest переменная: CTEST_NIGHTLY_START_TIME
• CTest модульная переменная: NIGHTLY_START_TIME если установлена, иначе CTEST_NIGHTLY_START_TIME

Шаг CTest Configure

В сценарии CTest команда ctest_configure() выполняет этот шаг. Аргументы команды могут указать некоторые параметры шага.

Параметры конфигурации включают:

ConfigureCommand

Командная строка для запуска процесса конфигурации программного обеспечения. Она будет выполнена в расположении, указанном настройкой BuildDirectory.

• Сценарий CTest переменная: CTEST_CONFIGURE_COMMAND
• CTest модульная переменная: CMAKE_COMMAND после PROJECT_SOURCE_DIR

Шаг CTest Build

В сценарии CTest команда ctest_build() выполняет этот шаг. Аргументы команды могут указать некоторые параметры шага.

Параметры конфигурации включают:

DefaultCTestConfigurationType

Когда система сборки позволяет выбрать конфигурацию во время сборки (например, Debug, Release), это задаёт конфигурацию по умолчанию для сборки, когда не указан параметр -C для команды ctest. Значение будет подставлено в значение MakeCommand для замены буквальной строки ${CTEST_CONFIGURATION_TYPE} если она появляется.

• Сценарий CTest переменная: CTEST_CONFIGURATION_TYPE
• CTest модульная переменная: DEFAULT_CTEST_CONFIGURATION_TYPE, инициализирована переменной окружения CMAKE_CONFIG_TYPE

MakeCommand

Командная строка для запуска процесса сборки программного обеспечения. Она будет выполнена в расположении, указанном настройкой BuildDirectory.

• Сценарий CTest переменная: CTEST_BUILD_COMMAND
• CTest модульная переменная: MAKECOMMAND, инициализирована командой build_command()

UseLaunchers

Для деревьев сборки, сгенерированных CMake с использованием одного из генераторов Makefile или Ninja генератора, укажите, включена ли функция CTEST_USE_LAUNCHERS модулем CTestUseLaunchers (также включен модулем CTest). При включении сгенерированная система сборки обернёт каждый вызов компилятора, компоновщика или пользовательской командной строки "запускателем", который взаимодействует с CTest через переменные окружения и файлы, чтобы сообщить подробную информацию о предупреждениях и ошибках сборки. В противном случае CTest должен "извлекать" данные диагностики из лога вывода сборки.

• Сценарий CTest переменная: CTEST_USE_LAUNCHERS
• CTest модульная переменная: CTEST_USE_LAUNCHERS

Шаг CTest Test

В сценарии CTest команда ctest_test() выполняет этот шаг. Аргументы команды могут указать некоторые параметры шага.

Параметры конфигурации включают:

TestLoad

Во время параллельного выполнения тестов (например, с -j) постарайтесь не запускать тесты, которые могут привести к превышению заданного порога загрузки ЦП.

• Сценарий CTest переменная: CTEST_TEST_LOAD
• CTest модульная переменная: CTEST_TEST_LOAD

TimeOut

Предустановленный тайм-аут для каждого теста, если не указан свойством теста TIMEOUT.

• Сценарий CTest переменная: CTEST_TEST_TIMEOUT
• CTest модульная переменная: DART_TESTING_TIMEOUT

Шаг CTest Coverage

В сценарии CTest команда ctest_coverage() выполняет этот шаг. Аргументы команды могут указать некоторые параметры шага.

Параметры конфигурации включают:

CoverageCommand

Инструмент командной строки для выполнения анализа покрытия программного обеспечения. Он будет выполнен в указанном месте параметром BuildDirectory.

• Скрипт CTest переменная: CTEST_COVERAGE_COMMAND
• CTest модульная переменная: COVERAGE_COMMAND

CoverageExtraFlags

Укажите параметры командной строки для инструмента CoverageCommand.

• Скрипт CTest переменная: CTEST_COVERAGE_EXTRA_FLAGS
• CTest модульная переменная: COVERAGE_EXTRA_FLAGS

Шаг CTest MemCheck

В скрипте CTest команда ctest_memcheck() выполняет этот шаг. Аргументы к команде могут указать некоторые настройки шага.

Настройки конфигурации включают:

MemoryCheckCommand

Инструмент командной строки для выполнения динамического анализа. Команды тестов будут запускаться через этот инструмент.

• Скрипт CTest переменная: CTEST_MEMORYCHECK_COMMAND
• CTest модульная переменная: MEMORYCHECK_COMMAND

MemoryCheckCommandOptions

Укажите параметры командной строки для инструмента MemoryCheckCommand. Они будут размещены перед командой запуска теста.

• Скрипт CTest переменная: CTEST_MEMORYCHECK_COMMAND_OPTIONS
• CTest модульная переменная: MEMORYCHECK_COMMAND_OPTIONS

MemoryCheckType

Укажите тип проверки памяти для выполнения.

• Скрипт CTest переменная: CTEST_MEMORYCHECK_TYPE
• CTest модульная переменная: MEMORYCHECK_TYPE

MemoryCheckSanitizerOptions

Укажите параметры для инструментов проверки, при запуске со сборкой, включенной для проверки.

• Скрипт CTest переменная: CTEST_MEMORYCHECK_SANITIZER_OPTIONS
• CTest модульная переменная: MEMORYCHECK_SANITIZER_OPTIONS

MemoryCheckSuppressionFile

Укажите файл, содержащий правила подавления для инструмента MemoryCheckCommand. Он будет передан с параметрами, соответствующими инструменту.

• Скрипт CTest переменная: CTEST_MEMORYCHECK_SUPPRESSIONS_FILE
• CTest модульная переменная: MEMORYCHECK_SUPPRESSIONS_FILE

Дополнительные настройки конфигурации включают:

BoundsCheckerCommand

Укажите MemoryCheckCommand, который известен как совместимый с командной строкой с Bounds Checker.

• Скрипт CTest переменная: нет
• CTest модульная переменная: нет

PurifyCommand

Укажите MemoryCheckCommand, который известен как совместимый с командной строкой с Purify.

• Скрипт CTest переменная: нет
• CTest модульная переменная: PURIFYCOMMAND

ValgrindCommand

Укажите MemoryCheckCommand, который известен как совместимый с командной строкой с Valgrind.

• Скрипт CTest переменная: нет
• CTest модульная переменная: VALGRIND_COMMAND

ValgrindCommandOptions

Укажите параметры командной строки для инструмента ValgrindCommand. Они будут размещены перед командой запуска теста.

• Скрипт CTest переменная: нет
• CTest модульная переменная: VALGRIND_COMMAND_OPTIONS

Шаг CTest Submit

В скрипте CTest команда ctest_submit() выполняет этот шаг. Аргументы к команде могут указать некоторые настройки шага.

Настройки конфигурации включают:

BuildName

Опишите платформу клиента панели мониторинга кратким описанием. (Операционная система, компилятор и т. д.)

• Сценарий CTest переменная: CTEST_BUILD_NAME
• CTest модульная переменная: BUILDNAME

CDashVersion

Укажите версию CDash на сервере.

• Сценарий CTest переменная: ни одной, обнаружено из сервера
• CTest модульная переменная: CTEST_CDASH_VERSION

CTestSubmitRetryCount

Укажите количество попыток повторной отправки при сбое сети.

• Сценарий CTest переменная: ни одной, используйте параметр ctest_submit() RETRY_COUNT.
• CTest модульная переменная: CTEST_SUBMIT_RETRY_COUNT

CTestSubmitRetryDelay

Укажите задержку перед повторной отправкой при сбое сети.

• Сценарий CTest переменная: ни одной, используйте параметр ctest_submit() RETRY_DELAY.
• CTest модульная переменная: CTEST_SUBMIT_RETRY_DELAY

CurlOptions

Укажите список параметров, разделенных точкой с запятой, для управления библиотекой Curl, которую CTest использует в процессе подключения к серверу. Возможные параметры: CURLOPT_SSL_VERIFYPEER_OFF и CURLOPT_SSL_VERIFYHOST_OFF.

• Сценарий CTest переменная: CTEST_CURL_OPTIONS
• CTest модульная переменная: CTEST_CURL_OPTIONS

DropLocation

Путь на сервере панели мониторинга для отправки сдачи.

• Сценарий CTest переменная: CTEST_DROP_LOCATION
• CTest модульная переменная: DROP_LOCATION если установлено, иначе CTEST_DROP_LOCATION

DropMethod

Укажите метод отправки результатов на сервер панели мониторинга. Значение может быть cp, ftp, http, https, scp, или xmlrpc (если CMake был скомпилирован с поддержкой этого).

• Сценарий CTest переменная: CTEST_DROP_METHOD
• CTest модульная переменная: DROP_METHOD если установлено, иначе CTEST_DROP_METHOD

DropSite

Имя сервера панели мониторинга (для ftp, http, и https, scp, и xmlrpc).

• Сценарий CTest переменная: CTEST_DROP_SITE
• CTest модульная переменная: DROP_SITE если установлено, иначе CTEST_DROP_SITE

DropSitePassword

Пароль для входа на сервер панели мониторинга, если требуется (для ftp, http, и https).

• Сценарий CTest переменная: CTEST_DROP_SITE_PASSWORD
• CTest модульная переменная: DROP_SITE_PASSWORD если установлено, иначе CTEST_DROP_SITE_PASWORD

DropSiteUser

Имя пользователя для входа на сервер панели мониторинга, если требуется (для ftp, http, и https).

• Сценарий CTest переменная: CTEST_DROP_SITE_USER
• CTest модульная переменная: DROP_SITE_USER если установлено, иначе CTEST_DROP_SITE_USER

IsCDash

Укажите, является ли сервер панели мониторинга CDash или более старой реализацией сервера панели мониторинга, требующей TriggerSite.

• Сценарий CTest переменная: CTEST_DROP_SITE_CDASH
• CTest модульная переменная: CTEST_DROP_SITE_CDASH

ScpCommand

scp командная утилита для использования при DropMethod равно scp.

• Сценарий CTest переменная: CTEST_SCP_COMMAND
• CTest модульная переменная: SCPCOMMAND

Site

Опишите сайт хоста клиента панели мониторинга кратким описанием. (Имя хоста, домен и т. д.)

• Сценарий CTest переменная: CTEST_SITE
• CTest модульная переменная: SITE, инициализируется командой site_name()

TriggerSite

Запись параметра для поддержки более старых реализаций серверов панели мониторинга. Не используется, когда IsCDash равно true.

• Сценарий CTest переменная: CTEST_TRIGGER_SITE
• CTest модульная переменная: TRIGGER_SITE если установлено, иначе CTEST_TRIGGER_SITE

См. также

Для получения помощи по использованию CMake доступны следующие ресурсы:

Главная страница

https://cmake.org

Основная точка входа для изучения CMake.

Часто задаваемые вопросы

https://cmake.org/Wiki/CMake_FAQ

На Вики предоставляются ответы на часто задаваемые вопросы.

Онлайн-документация

https://cmake.org/documentation

Ссылки на доступную документацию можно найти на этой странице.

Список рассылки

https://cmake.org/mailing-lists

Для получения помощи и обсуждения использования CMake предоставляется список рассылки по адресу cmake@cmake.org. Список доступен только для членов, но можно зарегистрироваться на веб-сайте CMake. Прежде чем задавать вопросы в список, пожалуйста, сначала ознакомьтесь с полной документацией по адресу https://cmake.org.