Параметры командной строки

Конфигурация

--bootstrap <file>

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

-c, --configuration <file>

Читает конфигурацию из указанного XML-файла вместо файла по умолчанию phpunit.xml. Это позволяет поддерживать несколько файлов конфигурации для разных сценариев тестирования.

--no-configuration

Игнорирует файл конфигурации phpunit.xml по умолчанию. Полезно, если нужно запустить тесты без применения какой-либо конфигурации на основе XML.

--extension <class>

Регистрирует расширение средства запуска тестов, указывая его класс загрузки. Расширение будет загружено и активировано для текущего запуска тестов.

--no-extensions

Запрещает регистрацию любых расширений средства запуска тестов. Это отключает все расширения, включая настроенные в файле конфигурации XML.

--include-path <path(s)>

Добавляет указанный путь или пути в начало include_path PHP. Можно указать несколько путей, разделив их разделителем путей, используемым в данной платформе.

-d <key[=value]>

Задает значение конфигурации php.ini на время выполнения тестов. Для логических параметров значение можно не указывать, чтобы установить 1.

--cache-directory <dir>

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

• test-results: результаты предыдущего запуска набора тестов (например, используются для изменения порядка тестов на основе предыдущих дефектов или длительности выполнения с параметром --order-by)

• code-coverage: результаты статического анализа тестируемого кода и кода тестов (записываются только при запросе отчета о покрытии кода; значительно повышают производительность анализа покрытия кода при последующих запусках)

--generate-configuration

Создает файл конфигурации phpunit.xml с рекомендуемыми настройками с помощью интерактивного мастера. Это удобный способ создать начальную конфигурацию PHPUnit.

--migrate-configuration

Переводит существующий файл конфигурации XML в текущий формат. Это полезно после обновления PHPUnit до новой основной версии, в которой изменена конфигурация.

--generate-baseline <file>

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

--use-baseline <file>

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

--ignore-baseline

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

Выбор

--all

Игнорирует выбор тестов, заданный в файле конфигурации XML, и запускает все обнаруженные тесты. Переопределяет любую фильтрацию <testsuites> из конфигурации.

--list-suites

Выводит список всех наборов тестов, заданных в файле конфигурации XML, и завершает работу. Тесты не выполняются.

--testsuite <name>

Ограничивает выполнение тестов указанным набором или наборами тестов. Несколько имен наборов можно разделить запятыми.

--exclude-testsuite <name>

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

--list-groups

Выводит список всех доступных групп тестов и завершает работу. Тесты не выполняются.

--group <name>

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

--exclude-group <name>

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

--covers <name>

Запускает только тесты, в которых объявлено намерение проверить указанное свойство класса или функцию. Фильтрация выполняется на основе атрибутов #[Covers*]. Этот параметр можно использовать несколько раз.

--uses <name>

Запускает только тесты, в которых объявлено намерение использовать указанный класс или функцию. Фильтрация выполняется на основе атрибутов #[Uses*]. Этот параметр можно использовать несколько раз.

--requires-php-extension <name>

Запускает только тесты, в которых объявлено требование к указанному расширению PHP. Тесты, для которых это требование не задано, пропускаются.

--list-test-files

Выводит список всех файлов тестов, которые были бы запущены, и завершает работу. Тесты фактически не запускаются.

--list-test-ids

Выводит список всех тестов, которые были бы запущены, в виде идентификаторов тестов и завершает работу. Идентификатор теста — это полное имя теста, например PHPUnit\TestFixture\ExampleTest::testOne. Для тестов с наборами данных добавляется суффикс # с индексом или именем набора данных, например PHPUnit\TestFixture\ExampleTest::testOne#0 или PHPUnit\TestFixture\ExampleTest::testOne#named data set.

--list-tests

Выводит список всех тестов, которые были бы запущены, и завершает работу. Для каждого теста указывается его полное имя.

--list-tests-xml <file>

Выводит список всех тестов, которые были бы запущены, в формате XML и записывает результат в указанный файл. Тесты фактически не запускаются.

--filter <pattern>

Выбирает тесты, имена которых соответствуют <pattern>. Помимо полных регулярных выражений PCRE, для выбора отдельных наборов данных доступен сокращенный синтаксис (testFoo#3, testFoo#1-3, testFoo@named set, testFoo#named set). Полное описание синтаксиса см. в разделе Фильтрация по имени теста.

--exclude-filter <pattern>

Действует противоположно параметру --filter; принимает тот же синтаксис шаблонов и удаляет соответствующие тесты из запуска.

--test-suffix <suffix>

Ограничивает поиск файлов тестов файлами с указанным суффиксом. По умолчанию используются Test.php и .phpt. Этот параметр можно использовать несколько раз.

--test-files-file <file>

Запускает только тесты из файлов, перечисленных в указанном файле, по одному пути к файлу в каждой строке. Таким образом можно явно указать список файлов тестов для запуска.

--run-test-id <test-id>

Запускает только один тест, идентифицированный с помощью <test-id>. Сопоставление выполняется строго и точно. Идентификатор теста — это полное имя теста, например PHPUnit\TestFixture\ExampleTest::testOne. Для тестов с наборами данных добавляется суффикс # с индексом или именем набора данных, например PHPUnit\TestFixture\ExampleTest::testOne#0 или PHPUnit\TestFixture\ExampleTest::testOne#named data set.

--test-id-filter-file <file>

Запускает только тесты, перечисленные в указанном файле по идентификатору теста, по одному идентификатору в каждой строке. Идентификатор теста — это полное имя теста, например PHPUnit\TestFixture\ExampleTest::testOne.

Выполнение

--process-isolation

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

--globals-backup

Сохраняет и восстанавливает суперглобальную переменную $GLOBALS до и после каждого теста. Это предотвращает непреднамеренное влияние тестов друг на друга через глобальное состояние.

--static-backup

Сохраняет и восстанавливает статические свойства всех классов до и после каждого теста. Это предотвращает влияние тестов друг на друга через общее статическое состояние.

--strict-coverage

Включает строгий режим для метаданных покрытия кода. Тесты, выполняющие код, не объявленный в метаданных #[Covers*] или #[Uses*], будут помечены как рискованные.

--require-coverage-contribution

Помечает тесты как рискованные, если для них заданы цели покрытия кода, но они не выполняют ни одной строки целевого кода.

--strict-global-state

Включает строгую проверку изменений глобального состояния. Тесты, изменяющие глобальное состояние (например, глобальные переменные, суперглобальные переменные или статические свойства), будут помечены как рискованные.

--disallow-test-output

Помечает как рискованные тесты, которые выводят данные (с помощью echo, print и т. д.). Это помогает гарантировать, что тесты сообщают результаты только с помощью утверждений.

--enforce-time-limit

Устанавливает ограничения на время выполнения тестов в зависимости от их размера. По умолчанию для небольших тестов отводится 1 секунда, для средних — 10 секунд, а для больших — 60 секунд.

--default-time-limit <sec>

Задает время ожидания в секундах для тестов, размер которых не объявлен. Используется вместе с параметром --enforce-time-limit.

--do-not-report-useless-tests

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

--stop-on-defect[=<n>]

Останавливает выполнение тестов после первой (или n-й) ошибки, неудачи, предупреждения или рискованного теста. Это сокращенная запись для включения всех отдельных параметров остановки. Если значение не указано, выполнение останавливается после первого дефекта. Если задан порог n, выполнение останавливается после обнаружения n дефектов.

--stop-on-error[=<n>]

Останавливает выполнение тестов после первого (или n-го) теста, завершившегося ошибкой.

--stop-on-failure[=<n>]

Останавливает выполнение тестов после первого (или n-го) теста, завершившегося неудачей.

--stop-on-warning[=<n>]

Останавливает выполнение тестов после первого (или n-го) теста, вызвавшего предупреждение.

--stop-on-risky[=<n>]

Останавливает выполнение тестов после первого (или n-го) теста, признанного рискованным.

--stop-on-deprecation[=<n>]

Останавливает выполнение тестов после первого (или n-го) теста, вызвавшего сообщение об устаревшей функциональности.

--stop-on-notice[=<n>]

Останавливает выполнение тестов после первого (или n-го) теста, вызвавшего уведомление.

--stop-on-skipped[=<n>]

Останавливает выполнение тестов после первого (или n-го) пропущенного теста.

--stop-on-incomplete[=<n>]

Останавливает выполнение тестов после первого (или n-го) незавершенного теста.

--fail-on-empty-test-suite

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

--fail-on-warning

Заставляет PHPUnit возвращать код завершения, сигнализирующий о неудаче, если какой-либо тест вызывает предупреждение.

--fail-on-risky

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

--fail-on-deprecation

Заставляет PHPUnit возвращать код завершения, сигнализирующий о неудаче, если какой-либо тест вызывает сообщение об устаревшей функциональности.

--fail-on-phpunit-deprecation

Заставляет PHPUnit возвращать код завершения, сигнализирующий о неудаче, если вызывается сообщение PHPUnit об устаревшей функциональности. Такие сообщения относятся к использованию устаревших элементов собственного API PHPUnit.

--fail-on-phpunit-notice

Заставляет PHPUnit возвращать код завершения, сигнализирующий о неудаче, если вызывается уведомление PHPUnit. Уведомления PHPUnit — это информационные сообщения о проблемах, связанных с PHPUnit.

--fail-on-phpunit-warning

Заставляет PHPUnit возвращать код завершения, сигнализирующий о неудаче, если вызывается предупреждение PHPUnit.

--fail-on-notice

Заставляет PHPUnit возвращать код завершения, сигнализирующий о неудаче, если какой-либо тест вызывает уведомление.

--fail-on-skipped

Заставляет PHPUnit возвращать код завершения, сигнализирующий о неудаче, если какой-либо тест пропущен.

--fail-on-incomplete

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

--fail-on-all-issues

Заставляет PHPUnit возвращать код завершения, сигнализирующий о неудаче, если возникает какая-либо проблема. Это сокращенная запись, включающая одновременно все параметры --fail-on-*.

--do-not-fail-on-empty-test-suite

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

--do-not-fail-on-warning

Отключает сигнализацию о неудаче при возникновении предупреждения. Переопределяет соответствующий параметр конфигурации XML.

--do-not-fail-on-risky

Отключает сигнализацию о неудаче, если тест признан рискованным. Переопределяет соответствующий параметр конфигурации XML.

--do-not-fail-on-deprecation

Отключает сигнализацию о неудаче при появлении сообщения об устаревшей функциональности. Переопределяет соответствующий параметр конфигурации XML.

--do-not-fail-on-phpunit-deprecation

Отключает сигнализацию о неудаче при появлении сообщения PHPUnit об устаревшей функциональности. Переопределяет соответствующий параметр конфигурации XML.

--do-not-fail-on-phpunit-notice

Отключает сигнализацию о неудаче при появлении уведомления PHPUnit. Переопределяет соответствующий параметр конфигурации XML.

--do-not-fail-on-phpunit-warning

Отключает сигнализацию о неудаче при появлении предупреждения PHPUnit. Переопределяет соответствующий параметр конфигурации XML.

--do-not-fail-on-notice

Отключает сигнализацию о неудаче при появлении уведомления. Переопределяет соответствующий параметр конфигурации XML.

--do-not-fail-on-skipped

Отключает сигнализацию о неудаче, если тест пропущен. Переопределяет соответствующий параметр конфигурации XML.

--do-not-fail-on-incomplete

Отключает сигнализацию о неудаче, если тест помечен как незавершенный. Переопределяет соответствующий параметр конфигурации XML.

--cache-result

Включает запись результатов тестов в файл кэша test-results. Кэш результатов используется параметрами --order-by defects и --order-by duration для изменения порядка тестов на основе результатов предыдущих запусков набора тестов.

--do-not-cache-result

Отключает запись результатов тестов в файл кэша test-results. Переопределяет соответствующий параметр конфигурации XML.

--order-by <order>

Управляет порядком выполнения тестов. Основные варианты упорядочивания: default, defects, duration-ascending, duration-descending, random, reverse, size-ascending и size-descending. Их можно сочетать с модификаторами зависимостей depends и no-depends, разделяя значения запятой. Полный список допустимых комбинаций см. в разделе Атрибут executionOrder. Значения duration и size по-прежнему принимаются как сокращения для duration-ascending и size-ascending соответственно, но считаются устаревшими и будут удалены в PHPUnit 14.

--resolve-dependencies

Псевдоним для --order-by depends.

--ignore-dependencies

Псевдоним для --order-by no-depends.

--random-order

Псевдоним для --order-by random.

--random-order-seed <N>

Задает начальное значение генератора случайных чисел при использовании --order-by random. При использовании одного и того же начального значения порядок тестов будет одинаковым, что полезно для воспроизведения сбоев.

--reverse-order

Псевдоним для --order-by reverse.

Отчеты

--colors=<flag>

Управляет использованием цветов в выводе терминала. Допустимые значения: never, auto (использовать цвета, если терминал их поддерживает) и always.

--columns <n>

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

--columns max

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

--diff-context <n>

Задает количество контекстных строк, отображаемых вокруг изменений в различиях (по умолчанию: 3). Если тест завершается неудачей и PHPUnit показывает различие между ожидаемым и фактическим значениями, этот параметр определяет, сколько неизмененных строк будет показано до и после каждого изменения.

--stderr

Записывает вывод в STDERR вместо STDOUT. Это может быть полезно, если STDOUT перенаправляется или перехватывается.

--no-progress

Отключает раздел хода выполнения в выводе по умолчанию (см. раздел Ход выполнения). На альтернативные форматы вывода, выбранные с помощью --testdox, --teamcity, --compact или --debug, этот параметр не влияет.

--no-results

Отключает разделы результатов тестов и сводки в выводе по умолчанию (см. разделы Результаты тестов и Сводка). На альтернативные форматы вывода, выбранные с помощью --testdox, --teamcity, --compact или --debug, этот параметр не влияет.

--no-output

Отключает вывод PHPUnit по умолчанию (информацию о времени выполнения, ход выполнения, результаты тестов и сводку). На альтернативные форматы вывода, выбранные с помощью --testdox, --teamcity, --compact или --debug, этот параметр не влияет: для них по-прежнему будет сформирован собственный вывод.

--display-incomplete

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

--display-skipped

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

--display-deprecations

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

--display-phpunit-deprecations

Показывает подробную информацию о сообщениях PHPUnit об устаревшей функциональности в результатах тестов.

--display-phpunit-notices

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

--display-errors

Показывает подробную информацию об ошибках, вызванных тестами. Сюда входят ошибки PHP, например E_ERROR, возникшие во время выполнения тестов.

--display-notices

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

--display-warnings

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

--display-all-issues

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

--reverse-list

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

--compact

Заменяет стандартный вывод хода выполнения и результатов компактным форматом, в котором отсутствуют раздел хода выполнения, строка с данными о времени и использовании памяти, а также цветовые коды. По умолчанию подробно отображаются только ошибки, неудачные и рискованные тесты; для включения дополнительных проблем можно использовать параметры --display-*. Компактный вывод также можно включить, установив переменную окружения PHPUNIT_COMPACT_OUTPUT в значение 1. Подробнее см. раздел Компактный формат.

--teamcity

Заменяет стандартный вывод хода выполнения и результатов форматом TeamCity. Используется для интеграции с JetBrains TeamCity и другими инструментами CI, поддерживающими протокол служебных сообщений TeamCity.

--testdox

Заменяет стандартный вывод результатов форматом TestDox. TestDox преобразует имена методов тестов в удобочитаемые предложения, представляя набор тестов в виде сценариев поведения. Чтобы вместо этого записать вывод TestDox в файл, используйте --testdox-html или --testdox-text (см. раздел Журналирование).

--testdox-summary

Повторно выводит в конце запуска тестов результаты TestDox для тестов, завершившихся ошибками, неудачами или другими проблемами. Это позволяет получить в формате TestDox краткую сводку проблемных тестов. Требуется параметр --testdox.

--debug

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

--with-telemetry

Включает в отладочный вывод данные телеметрии, например сведения о времени выполнения и использовании памяти. Этот параметр используется вместе с --debug.

Журналирование

--log-junit <file>

Записывает результаты тестов в указанное место в формате JUnit XML. Этот формат широко поддерживается инструментами CI/CD для формирования отчетов о результатах тестирования.

--log-otr <file>

Записывает результаты тестов в указанное место в формате Open Test Reporting XML. Это новый стандартизированный формат отчетов о результатах тестирования.

--include-git-information

Добавляет в файл журнала Open Test Reporting XML сведения Git, например ветку и хеш коммита. Это помогает связать результаты тестов с конкретными версиями кода.

--log-teamcity <file>

Записывает результаты тестов в указанное место в формате TeamCity. Это полезно, если требуется получить вывод в формате TeamCity в файле журнала, используя при этом другой формат вывода в консоль.

--testdox-html <file>

Записывает результаты тестов в формате TestDox в виде HTML-файла. В результате создается доступный для просмотра и удобочитаемый документ с описанием поведения тестов. Этот параметр предназначен для записи отчета в файл; для вывода в консоль в формате TestDox используйте вместо него --testdox.

--testdox-text <file>

Записывает результаты тестов в формате TestDox в виде обычного текстового файла. В результате создается простой текстовый документ с описанием поведения тестов. Этот параметр предназначен для записи отчета в файл; для вывода в консоль в формате TestDox используйте вместо него --testdox.

--log-events-text <file>

Записывает в указанный файл все события средства запуска тестов в виде обычного текста. Это обеспечивает подробный журнал всех событий, произошедших во время запуска тестов.

--log-events-verbose-text <file>

Записывает в указанный файл все события средства запуска тестов в виде обычного текста с расширенной информацией. Содержит больше подробностей, чем --log-events-text.

--no-logging

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

Покрытие кода

--coverage-clover <file>

Записывает отчет о покрытии кода в указанное место в формате Clover XML. Этот формат поддерживается многими инструментами CI и платформами контроля качества кода.

--coverage-openclover <file>

Записывает отчет о покрытии кода в указанное место в формате OpenClover XML. OpenClover — это продолжение формата Clover с открытым исходным кодом.

--coverage-cobertura <file>

Записывает отчет о покрытии кода в указанное место в формате Cobertura XML. Этот формат широко используется такими инструментами CI, как GitLab CI и Jenkins.

--coverage-crap4j <file>

Записывает отчет о покрытии кода в указанное место в формате Crap4J XML. Crap4J объединяет данные о покрытии кода с цикломатической сложностью, чтобы выявлять рискованный код.

--coverage-html <dir>

Записывает отчет о покрытии кода в указанную директорию в формате HTML. В результате создается интерактивный отчет с подсветкой покрытия для каждой строки.

--coverage-php <file>

Записывает сериализованные данные о покрытии кода в указанный файл. Позже эти данные можно объединить с другими данными о покрытии или обработать программно.

--coverage-text[=<file>]

Записывает отчет о покрытии кода в формате обычного текста. Если указан файл, отчет записывается в него; в противном случае — в стандартный поток вывода.

--only-summary-for-coverage-text

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

--show-uncovered-for-coverage-text

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

--coverage-xml <dir>

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

--exclude-source-from-xml-coverage

Исключает элемент <source> из XML-отчета о покрытии. Это уменьшает размер создаваемых XML-файлов за счет исключения исходного кода.

--warm-coverage-cache

Заранее выполняет статический анализ тестируемого кода и кода тестов и сохраняет результат в каталог кэша code-coverage. Без этого параметра статический анализ, необходимый для построения отчета о покрытии кода, выполняется на лету во время запуска набора тестов, после чего результат сохраняется в кэше.

--coverage-filter <dir>

Добавляет указанную директорию в фильтр покрытия кода. В отчет о покрытии будут включены только файлы из отфильтрованных директорий.

--path-coverage

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

--disable-coverage-ignore

Отключает метаданные @codeCoverageIgnore. При использовании этого параметра код с метаданными, исключающими его из анализа покрытия, будет включен в отчет о покрытии.

--no-coverage

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

Разное

-h, --help

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

--version

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

--atleast-version <min>

Проверяет, не ниже ли установленная версия PHPUnit указанной минимальной версии. Завершает работу с кодом 0, если условие выполнено, и с кодом 1 в противном случае.

--check-version

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

--check-php-configuration

Проверяет, соответствует ли текущая конфигурация PHP рекомендациям по запуску PHPUnit. Сообщает о любых параметрах php.ini, которые могут вызвать проблемы во время выполнения тестов.