Справочник по параметрам командной строки Microsoft.Testing.Platform (MTP)

В этой статье приведена центральная точка входа для параметров командной строки MTP.

Параметры платформы

• @

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

  Параметры в файле ответа интерпретируются так, как если бы они присутствовали в этом месте в командной строке. Символ обратной косой черты \ нельзя использовать для объединения строк. Использование файла ответа помогает выполнять очень длинные команды, которые могут превышать ограничения терминала. Файл ответа можно объединить с встроенными аргументами командной строки. Рассмотрим пример.

  ./TestExecutable.exe @"filter.rsp" --timeout 10s
  

  где filter.rsp может содержать следующее содержимое:

  --filter "A very long filter"
  

  Или один файл rsp можно использовать для указания времени ожидания и фильтрации следующим образом:

  ./TestExecutable.exe @"arguments.rsp"
  

  --filter "A very long filter" --timeout 10s
  

  Замечание

  При использовании dotnet test средство синтаксического анализа командной строки SDK использует подход, при котором каждой строке соответствует один маркер, где каждая строка в файле ответа рассматривается как один маркер. В этом случае каждый аргумент должен находиться в отдельной строке:

  --filter
  A very long filter
  --timeout
  10s
  

• --config-file

  Указывает файл testconfig.json.

• --debug

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

  Замечание

  Этот параметр доступен в MTP начиная с версии 1.9.0. Он заменяет предыдущий --debug-wait-attach параметр (представленный в MTP 1.6.0); старое имя было удалено и больше не должно использоваться.

• --diagnostic

  Включает ведение журнала диагностики. Уровень журнала по умолчанию — Trace. Файл записывается в выходной каталог со следующим форматом имени log_[MMddHHssfff].diag.

• --diagnostic-synchronous-write

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

• --diagnostic-output-directory

  Каталог вывода журнала диагностики: если не указан, файл создается в каталоге по умолчанию TestResults.

• --diagnostic-file-prefix

  Префикс имени файла журнала. По умолчанию — "log".

• --diagnostic-verbosity

  Определяет уровень детализации при использовании переключателя --diagnostic. Доступные значения: Trace, Debug, Information, Warning, Errorили Critical.

• --exit-on-process-exit

  Завершите тестовый процесс, если зависимый процесс завершится. Необходимо указать PID.

• --filter-uid

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

  Замечание

  Этот параметр доступен в MTP начиная с версии 1.8.0.

• --help

  Выводит описание использования команды.

• --ignore-exit-code

  Позволяет игнорировать некоторые коды выхода, отличные от нуля, и вместо этого возвращается как 0. Дополнительные сведения см. в разделе Игнорировать определенные коды выхода.

• --info

  Отображает дополнительные сведения о тестовом приложении .NET, например:

  • Платформа.
  • Среда.
  • Каждый зарегистрированный поставщик командной строки, например name, version, description и options.
  • Каждое зарегистрированное средство, например command, name, version, description, и все поставщики командной строки.

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

• --list-tests

  Выводит список доступных тестов без их выполнения. При необходимости принимает аргумент, который управляет форматом выходных данных: text (по умолчанию, удобочитаемым человеком) или json.

  Замечание

  Формат json выходных данных доступен в MTP начиная с версии 2.3.0.

• --maximum-failed-tests

  Указывает максимальное количество сбоев тестов, которые при достижении прекратят выполнение теста. Поддержка этого коммутатора требует от авторов фреймворка реализовать возможность IGracefulStopTestExecutionCapability. Код выхода при достижении этого количества сбоев теста равен 13. Дополнительные сведения см. в разделе "Коды выхода MTP".

  Замечание

  Эта функция доступна в MTP начиная с версии 1.5.

• --minimum-expected-tests

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

• --no-banner

  Отключает баннер запуска, сообщение об авторских правах и баннер телеметрии. Тот же эффект можно получить с помощью TESTINGPLATFORM_NOBANNER или DOTNET_NOLOGOпеременных среды.

• --results-directory

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

• --timeout

  Тайм-аут выполнения глобального теста. Принимает один аргумент в виде строки в формате <value>[h|m|s], где <value> плавает.

• --treenode-filter

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

Опции расширения в зависимости от сценария

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

Сценарий	Документация по функциям
Сбор данных о покрытии кода	Покрытие кода
Сбор дампов сбоев или зависаний	Аварийное завершение и зависание дампов
Создание тестовых отчетов (например, TRX)	Тестовые отчеты
Настройка выходных данных терминала	Выходные данные терминала
Применение элементов управления уровня размещения	Горячая перезагрузка
Повторная проверка неудачных тестов	повторная попытка
Выполнение тестов, использующих Microsoft Fakes	Microsoft Fakes
Отправка трассировок и метрик OpenTelemetry	OpenTelemetry

Поиск параметров в тестовом приложении

Запустите тестовый исполняемый файл с --help, чтобы вывести доступные опции для текущего набора расширений.

Для расширенной диагностики зарегистрированных поставщиков и параметров выполните --info.

См. также

• Обзор MTP
• Функции MTP
• Тестирование с помощью dotnet test