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, так как это приведет к зависимости от самих себя и будет считаться ошибкой.