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 и выполнить тестовый запуск панели мониторинга. Все тесты имеют вид <Режим><Тест>, где Режим может быть Экспериментальный, Ежедневный и Непрерывный, а Тест может быть Запуск, Обновление, Настройка, Сборка, Тест, Покрытие и Отправка.

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

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

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

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

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

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

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

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

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

--track <track>

Укажите дорожку, в которую нужно отправить панель мониторинга

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

-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 это означает, что в неинтерактивном режиме все всплывающие окна отладки системы блокируются. В режиме панели мониторинга (Экспериментальный, Ежедневный, Непрерывный) по умолчанию используется неинтерактивный режим. При простом запуске тестов, не предназначенных для панели мониторинга, по умолчанию разрешаются всплывающие окна и интерактивная отладка.

--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>

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

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

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

--test-timeout

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

--tomorrow-tag

Ежедневный или экспериментальный запуск со следующим тегом дня.

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

--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: PROJECT_BINARY_DIR

SourceDirectory

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

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

Шаг обновления 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

Дерево исходного кода обновляется с помощью git fetch, за которым следует git reset --hard в FETCH_HEAD. Результат аналогичен git pull, за исключением того, что любые локальные изменения перезаписываются. Используйте GITUpdateCustom для указания другого подхода.

GITInitSubmodules

При установленной настройке CTest обновит подмодули репозитория до обновления.

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

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

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

• Сценарий 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 Настройка

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

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

ConfigureCommand

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

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

Шаг CTest Сборка

В Сценарии 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 Тестирование

В Сценарии 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 переменная: none
• CTest модуль переменная: none

PurifyCommand

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

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

ValgrindCommand

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

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

ValgrindCommandOptions

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

• Сценарий CTest переменная: none
• 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

Wiki содержит ответы на часто задаваемые вопросы.

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

https://cmake.org/documentation

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

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

https://cmake.org/mailing-lists

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