FIXTURES_REQUIRED

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

Фикстуры — способ привязать задачи настройки и очистки к набору тестов. Если тест требует определённой фикстуры, то все тесты, помеченные как задачи настройки для этой фикстуры, будут выполнены первыми (один раз для всего набора тестов, а не один раз для каждого теста, требующего фикстуру). После завершения всех тестов, требующих определённую фикстуру, CTest гарантирует выполнение всех тестов, помеченных как задачи очистки для этой фикстуры. Тесты помечаются как задачи настройки с помощью свойства FIXTURES_SETUP, а как задачи очистки — с помощью свойства FIXTURES_CLEANUP. Если какой-либо из тестов настройки фикстуры завершается неудачно, все тесты, перечисляющие эту фикстуру в своём свойстве FIXTURES_REQUIRED, не будут выполнены. Тесты очистки для фикстуры всегда будут выполнены, даже если некоторые тесты настройки завершатся неудачно.

Когда CTest требуется выполнить только подмножество тестов (например, с помощью регулярных выражений или при запуске с параметром командной строки --rerun-failed), он автоматически добавит любые тесты настройки или очистки для фикстур, необходимых любым из тестов, которые находятся в наборе выполнения. Это поведение можно переопределить с помощью параметров командной строки -FS, -FC и -FA для ctest(1), если это необходимо.

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

Понятие фикстуры отличается от понятия ресурса, указанного в RESOURCE_LOCK, но их можно использовать вместе. Фикстура определяет набор тестов, которые имеют общие требования к настройке и очистке, тогда как блокировка ресурса влияет на обеспечение того, что определённый набор тестов не запускается параллельно. В некоторых ситуациях может потребоваться и то, и другое, например, при настройке базы данных, сериализации доступа к этой базе данных и удалении базы данных в конце. В таких случаях тесты будут заполнять как FIXTURES_REQUIRED, так и RESOURCE_LOCK для объединения двух поведений. Имена, используемые для RESOURCE_LOCK, не связаны с именами фикстур, поэтому обратите внимание, что блокировка ресурса не подразумевает фикстуру и наоборот.

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

add_test(NAME testsDone   COMMAND emailResults)
add_test(NAME fooOnly     COMMAND testFoo)
add_test(NAME dbOnly      COMMAND testDb)
add_test(NAME dbWithFoo   COMMAND testDbWithFoo)
add_test(NAME createDB    COMMAND initDB)
add_test(NAME setupUsers  COMMAND userCreation)
add_test(NAME cleanupDB   COMMAND deleteDB)
add_test(NAME cleanupFoo  COMMAND removeFoos)

set_tests_properties(setupUsers PROPERTIES DEPENDS createDB)

set_tests_properties(createDB   PROPERTIES FIXTURES_SETUP    DB)
set_tests_properties(setupUsers PROPERTIES FIXTURES_SETUP    DB)
set_tests_properties(cleanupDB  PROPERTIES FIXTURES_CLEANUP  DB)
set_tests_properties(cleanupFoo PROPERTIES FIXTURES_CLEANUP  Foo)
set_tests_properties(testsDone  PROPERTIES FIXTURES_CLEANUP  "DB;Foo")

set_tests_properties(fooOnly    PROPERTIES FIXTURES_REQUIRED Foo)
set_tests_properties(dbOnly     PROPERTIES FIXTURES_REQUIRED DB)
set_tests_properties(dbWithFoo  PROPERTIES FIXTURES_REQUIRED "DB;Foo")

set_tests_properties(dbOnly dbWithFoo createDB setupUsers cleanupDB
                     PROPERTIES RESOURCE_LOCK DbAccess)

Ключевые моменты из этого примера:

• Определены две фикстуры: DB и Foo. Тесты могут требовать одной фикстуры, как fooOnly и dbOnly, или они могут зависеть от нескольких фикстур, как dbWithFoo.
• Установлено отношение DEPENDS, чтобы гарантировать, что setupUsers произойдёт после createDB, оба из которых являются тестами настройки для фикстуры DB и, следовательно, будут выполнены перед тестами dbOnly и dbWithFoo автоматически.
• Явных отношений DEPENDS не требовалось, чтобы тесты настройки выполнялись до или тесты очистки после обычных тестов.
• Для фикстуры Foo не определены тесты настройки, только один тест очистки.
• testsDone — это тест очистки для фикстур DB и Foo. Следовательно, он будет выполняться только один раз после завершения обычных тестов для обеих фикстур (т.е. после fooOnly, dbOnly и dbWithFoo). Отношение DEPENDS не было указано для testsDone, поэтому он свободен выполняться до, после или одновременно с другими тестами очистки для любой из фикстур.
• Тесты настройки и очистки никогда не указывают фикстуры, для которых они предназначены, в своём свойстве FIXTURES_REQUIRED, так как это приведёт к зависимости от самих себя и будет рассматриваться как ошибка.