Spec-Zone.ru › AWS CLI v2

[ aws . codebuild ]

describe-test-cases

Описание

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

См. также: Документацию API AWS

describe-test-cases является постраничной операцией. Для получения всего набора результатов могут быть вызваны несколько вызовов API. Вы можете отключить постраничную обработку, предоставив аргумент --no-paginate. При использовании --output text и аргумента --query в ответе с постраничной обработкой, аргумент --query должен извлекать данные из результатов следующих выражений запроса: testCases

Синтаксис

  describe-test-cases
--report-arn <value>
[--filter <value>]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Параметры

--report-arn (строка)

ARN отчета, для которого возвращаются тестовые случаи.

--filter (структура)

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

status -> (строка)

Статус, используемый для фильтрации тестовых случаев. У TestCaseFilter может быть один статус. Допустимые значения:

  • SUCCEEDED
  • FAILED
  • ERROR
  • SKIPPED
  • UNKNOWN

keyword -> (строка)

Ключевое слово, используемое для фильтрации по name или prefix тестовых случаев. Будут возвращены только те тестовые случаи, где ключевое слово является подстрокой в name или prefix.

Сокращённый синтаксис:

status=string,keyword=string

Синтаксис JSON:

{
  "status": "string",
  "keyword": "string"
}

--cli-input-json | --cli-input-yaml (строка) Читает аргументы из предоставленной строки JSON. Строка JSON следует формату, указанному в --generate-cli-skeleton. Если другие аргументы указаны в командной строке, эти значения переопределят значения, предоставленные в формате JSON. Невозможно передавать произвольные двоичные данные, используя предоставленное значение в формате JSON, так как строка будет взята буквально. Это не может быть указано вместе с --cli-input-yaml.

--starting-token (строка)

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

Примеры использования см. в разделе Постраничная обработка в Руководстве пользователя AWS Command Line Interface.

--page-size (целое число)

Размер каждой страницы для получения в вызове AWS-сервиса. Это не влияет на количество элементов, возвращаемых в выводе команды. Установка меньшего размера страницы приводит к большему количеству вызовов AWS-сервиса, получая меньше элементов в каждом вызове. Это может помочь предотвратить таймаут вызовов AWS-сервиса.

Примеры использования см. в разделе Постраничная обработка в Руководстве пользователя AWS Command Line Interface.

--max-items (целое число)

Общее количество элементов для возврата в выводе команды. Если общее количество доступных элементов больше, чем указанное значение, в выводе команды предоставляется NextToken. Для возобновления постраничной обработки предоставьте значение NextToken в аргументе starting-token последующей команды. Не используйте элемент ответа NextToken непосредственно за пределами AWS CLI.

Примеры использования см. в разделе Постраничная обработка в Руководстве пользователя AWS Command Line Interface.

--generate-cli-skeleton (строка) Выводит JSON-скелет в стандартный вывод без отправки запроса API. Если предоставлено без значения или со значением input, выводит пример входного JSON, который может быть использован в качестве аргумента для --cli-input-json. Аналогично, если предоставлено значение yaml-input, выведет пример входного YAML, который можно использовать с --cli-input-yaml. Если предоставлено значение output, он проверяет входные данные команды и возвращает пример выходного JSON для этой команды. Сгенерированный JSON-скелет не стабилен между версиями AWS CLI, и нет гарантий обратной совместимости в сгенерированном JSON-скелете.

Глобальные параметры

--debug (логическое значение)

Включить отладку ведения журнала.

--endpoint-url (строка)

Переопределить URL по умолчанию команды на указанный URL.

--no-verify-ssl (логическое значение)

По умолчанию AWS CLI использует SSL при взаимодействии с AWS-сервисами. Для каждого подключения SSL AWS CLI будет проверять сертификаты SSL. Этот параметр переопределяет поведение проверки сертификатов SSL по умолчанию.

--no-paginate (логическое значение)

Отключить автоматическую постраничную обработку. Если автоматическая постраничная обработка отключена, AWS CLI сделает только один вызов для первой страницы результатов.

--output (строка)

Стиль форматирования вывода команды.

  • json
  • text
  • table
  • yaml
  • yaml-stream

--query (строка)

Запрос JMESPath для фильтрации данных ответа.

--profile (строка)

Использовать определённый профиль из файла аутентификации.

--region (строка)

Регион для использования. Переопределяет настройки конфигурации/среды.

--version (строка)

Отобразить версию данного инструмента.

--color (строка)

Включить/выключить цветной вывод.

  • on
  • off
  • auto

--no-sign-request (логическое значение)

Не подписывать запросы. Учётные данные не будут загружены, если этот аргумент предоставлен.

--ca-bundle (строка)

Файл сертификата CA для использования при проверке сертификатов SSL. Переопределяет настройки конфигурации/среды.

--cli-read-timeout (целое число)

Максимальное время чтения сокета в секундах. Если значение установлено в 0, чтение сокета будет блокирующим и не будет таймаута. Значение по умолчанию составляет 60 секунд.

--cli-connect-timeout (целое число)

Максимальное время подключения к сокету в секундах. Если значение установлено в 0, подключение к сокету будет блокирующим и не будет таймаута. Значение по умолчанию составляет 60 секунд.

--cli-binary-format (строка)

Стиль форматирования, используемый для двоичных блоков. Формат по умолчанию — base64. Формат base64 ожидает, что двоичные блоки будут предоставлены в виде строки, закодированной в base64. Формат raw-in-base64-out сохраняет совместимость с поведением AWS CLI V1, и двоичные значения должны передаваться буквально. При предоставлении содержимого из файла, которое соответствует двоичному блоку, fileb:// всегда будет обрабатываться как двоичный и использовать содержимое файла напрямую независимо от настройки cli-binary-format. При использовании file:// содержимое файла должно быть должным образом отформатировано для конфигурированного cli-binary-format.

  • base64
  • raw-in-base64-out

--no-cli-pager (логическое значение)

Отключить кли-пайпер для вывода.

--cli-auto-prompt (логическое значение)

Автоматически запрашивать параметры ввода CLI.

--no-cli-auto-prompt (логическое значение)

Отключить автоматическое запроса параметров ввода CLI.

Примеры

Примечание

Для использования следующих примеров вам необходимо установить и настроить AWS CLI. См. руководство по началу работы в Руководстве пользователя AWS CLI для получения дополнительной информации.

Если не указано иное, все примеры используют правила цитирования unix-подобных оболочек. Эти примеры необходимо адаптировать к правилам цитирования вашей оболочки. См. Использование кавычек со строками в Руководстве пользователя AWS CLI.

Чтобы получить подробную информацию о тестовых случаях в AWS CodeBuild.

Следующий пример describe-test-cases получает информацию о тестовых случаях в указанном отчете.

aws codebuild describe-test-cases \
    --report-arn arn:aws:codebuild:<region-ID>:<account-ID>:report/<report-group-name>:<report-ID>

Вывод:

{
    "testCases": [
        {
            "reportArn": "arn:aws:codebuild:<region-ID>:<account-ID>:report/<report-group-name>:<report-ID>",
            "testRawDataPath": "<test-report-path>",
            "prefix": "NUnit.Tests.Assemblies.MockTestFixture",
            "name": "NUnit.Tests.Assemblies.MockTestFixture.NotRunnableTest",
            "status": "ERROR",
            "durationInNanoSeconds": 0,
            "message": "No arguments were provided\n",
            "expired": "2020-11-20T17:52:10+00:00"
        },
        {
            "reportArn": "arn:aws:codebuild:<region-ID>:<account-ID>:report/<report-group-name>:<report-ID>",
            "testRawDataPath": "<test-report-path>",
            "prefix": "NUnit.Tests.Assemblies.MockTestFixture",
            "name": "NUnit.Tests.Assemblies.MockTestFixture.TestWithException",
            "status": "ERROR",
            "durationInNanoSeconds": 0,
            "message": "System.ApplicationException : Intentional Exception\nat NUnit.Tests.Assemblies.MockTestFixture.MethodThrowsException()\nat NUnit.Tests.Assemblies.MockTestFixture.TestWithException()\n\n",
            "expired": "2020-11-20T17:52:10+00:00"
        }
    ]
}

Дополнительную информацию см. в разделе Работа с отчетами о тестировании в AWS CodeBuild в Руководстве пользователя AWS CodeBuild.

Вывод

nextToken -> (строка)

Во время предыдущего вызова максимальное количество возвращаемых элементов — это значение, указанное в maxResults. Если в списке больше элементов, то возвращается уникальная строка, называемая nextToken. Чтобы получить следующую партию элементов в списке, вызовите эту операцию снова, добавив следующий токен в вызов. Чтобы получить все элементы в списке, продолжайте вызывать эту операцию с каждым последующим возвращённым токеном, пока больше токенов не возвращаются.

testCases -> (список)

Возвращаемый список тестовых случаев.

(структура)

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

reportArn -> (строка)

ARN отчета, которому принадлежит тестовый случай.

testRawDataPath -> (строка)

Путь к файлу с сырыми данными, содержащим результат теста.

prefix -> (строка)

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

name -> (строка)

Имя тестового случая.

status -> (строка)

Статус, возвращённый тестовым случаем после его выполнения. Допустимые статусы: SUCCEEDED, FAILED, ERROR, SKIPPED и UNKNOWN.

durationInNanoSeconds -> (длинное целое число)

Количество наносекунд, затраченное на выполнение этого тестового случая.

message -> (строка)

Сообщение, связанное с тестовым случаем. Например, сообщение об ошибке или стек-трейс.

expired -> (временная метка)

Дата и время истечения срока действия тестового случая. Тестовый случай истекает через 30 дней после его создания. Истекший тестовый случай недоступен для просмотра в CodeBuild.

testSuiteName -> (строка)

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

© Copyright 2025, Amazon Web Services. Created using Sphinx.

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API