Testplan Config Schema 6.8.1

root generator

Конфигурация генератора (generator)

Тип: object

Блок специфических настроек тестового плана при type = GENERATOR

Пример:

tps:
  start: 10
  max: 100
  stepSize: 10
  stepTime: 1m
testdata:
- my-testdata
transportIn:
- http-transport

root generator tps

Настройки TPS (tps)

Тип: object Значение по умолчанию: {"start": 1.0, "max": 5.0, "stepTime": "1m", "stepSize": 1.0}

Блок конфигурации транзакций, выполняемых для генерации нагрузки

root generator tps start

Начальный TPS (start)

Тип: number Значение по умолчанию: 1

Начальное количество транзакций в секунду

Пример:

root generator tps max

Максимальный TPS (max)

Тип: number Значение по умолчанию: 5

Максимальное количество транзакций в секунду

Пример:

root generator tps stepTime

Интервал TPS (stepTime)

Тип: string or integerФормат: 1d2h3m4s5ms Значение по умолчанию: "1m"

Интервал увеличения нагрузки. Поддерживаются только статичные значения. Формат: d — дни, h — часы, m — минуты по умолчанию, s — секунды, ms — миллисекунды. Целое число трактуется как количество секунд

Пример:

5h35m10s

root generator tps stepSize

Шаг TPS (stepSize)

Тип: number Значение по умолчанию: 1

Шаг увеличения нагрузки

Пример:

root generator transportIn

Входные транспорты (transportIn)

Тип: array of string Значение по умолчанию: "transport_name"

Ссылка на транспорт из блока transport, задается как значение тега transport->name. Задает адрес (endpoint) на который генератор будет отсылать запросы

Массив должен содержать, как минимум 1 элементов

Тип элементов массива:

root generator transportIn[]

Тип: string

Примеры:

transport_name

[transport_name_1, transport_name_2]

root generator transportOut

Выходные транспорты (transportOut)

Тип: array of string Значение по умолчанию: "transport_name"

Ссылка на транспорт из блока transport, задается как значение тега transport->name. Используется для асинхронных протоколов (protocol=MQ|ARTEMIS|ACTIVE_MQ). Задает адрес (endpoint) на котором генератор будет ожидать ответы

Массив должен содержать, как минимум 1 элементов

Тип элементов массива:

root generator transportOut[]

Тип: string

Примеры:

transport_name

[transport_name_1, transport_name_2]

root generator testdata

Тестовые данные (testdata)

Тип: array of string Значение по умолчанию: "testplan_data"

Ссылка на тестовые данные из блока testdata, задается как значение тега testdata->name

Массив должен содержать, как минимум 1 элементов

Тип элементов массива:

root generator testdata[]

Тип: string

Пример:

testplan_data

root generator startRequestIndex

Начальное значение индекса (startRequestIndex)

Тип: integer

Задает значение, которое будет подставлено вместо выражения ${rqIndex()} в тестовых данных, привязанных к тестовому плану. Является автоинкрементным счетчиком. Используется вместе с maxRequestIndex

Пример:

root generator maxRequestIndex

Максимальное значение индекса (maxRequestIndex)

Тип: integer

Задает значение счетчика запросов, по достижении которого работа тестового плана будет прекращена. Используется вместе с startRequestIndex. Пример использования: при startRequestIndex = 1 и maxRequestIndex = 100 будет выполнено 100 транзакций, после этого тестовый план будет остановлен

Пример:

root generator retryCount

Количество повторов (retryCount)

Тип: integer

Кол-во попыток совершить повторное подключение при разрыве соединения для protocol=MQ|KAFKA|ACTIVE_MQ|ARTEMIS. Работает вместе с retryDelayTime

Пример:

root generator retryDelayTime

Время между попытками (retryDelayTime)

Тип: string or integerФормат: 1d2h3m4s5ms

Время между попытками переподключения. Работает вместе с retryCount. Поддерживаются только статичные значения. Формат: d — дни, h — часы, m — минуты по умолчанию, s — секунды, ms — миллисекунды. Целое число трактуется как количество секунд

Пример:

5h35m10s

root generator messageTimeout

Таймаут запросов (messageTimeout)

Тип: string or integerФормат: 1d2h3m4s5ms

Таймаут, в течение которого ожидается ответ. Поддерживаются только статичные значения. Формат: d — дни, h — часы, m — минуты по умолчанию, s — секунды, ms — миллисекунды. Целое число трактуется как количество секунд

Пример:

5h35m10s

root generator errorsToStop

Количество допустимых ошибок (errorsToStop)

Тип: integer Значение по умолчанию: "100"

Число статусов подряд в ответных сообщениях, не указанных в списке успешных, после которых тестплан принудительно завершается. Успешные статусы - значения в диапазоне 0-399 и значения из expectedStatus

Пример:

root generator ignoreErrorsDuringWarmup

Отсрочка остановки по количеству ошибок (ignoreErrorsDuringWarmup)

Тип: string or integerФормат: 1d2h3m4s5ms

Длительность, во время которой не учитываются ошибки способные остановить нагрузку (errorsToStop). Поддерживаются только статичные значения. Формат: d — дни, h — часы, m — минуты по умолчанию, s — секунды, ms — миллисекунды. Целое число трактуется как количество секунд

Пример:

5h35m10s

root generator correlation

Настройки корреляции (correlation)

Тип: object

Блок для настройки корреляции ответов с запросами. Применяется только для асинхронных протоколов (protocol=MQ|KAFKA|ACTIVE_MQ|ARTEMIS) при синхронных сценариях"

root generator correlation messageParser

Парсер сообщений (messageParser)

Тип: enum (of string) Значение по умолчанию: "NONE"

Задает формат сообщения для поиска значения внутренней переменной rq_uid и statuscode (код ответа). Применяется вместе с rqUIDTag и/или statusCodeTag
Значение rq_uid аналогично со значениями параметра:
NONE - парсинг отключен
XPATH - формат XML. Ожидается выражение в формате xpath 1.0
JSONPATH - формат json. Ожидается выражение в формате JsonPath https://github.com/json-path/JsonPath
HEADER - формат не важен, rq_uid/statusCode заданы в заголовке сообщения (testdatas[].headers)
XMLINJSON - используется в GRPC сообщениях для того, чтобы распарсить xml сообщение из тега body сообщения в формате JSON
JSONINJSON - аналогично XMLIN_JSON только для JSON сообщений

Возможные значения:

"NONE"
"XPATH"
"JSONPATH"
"HEADER"
"XML_IN_JSON"
"JSON_IN_JSON"

Пример:

["XPATH"]

root generator correlation correlationTag

Тег идентификатора запросов (correlationTag)

Тип: string

Для type=GENERATOR/STEPS:
Задает выражение для извлечения значения корреляционной переменной (rq_uid или uuid) из сообщения-ответа.
Полученное значение используется для корреляции ответа с запросом.
В сообщении-запросе должна присутствовать переменная ${rq_uid} или ${uuid}.

Для type=STUB:
Задает выражение для извлечения значения корреляционной переменной (rq_uid или uuid) из сообщения-запроса.
Полученное значение подставляется в сообщение-ответ вместо переменной ${rq_uid} или ${uuid}.

Применяется вместе с messageParser=XPATH|JSONPATH|HEADER.
После извлечения значения автоматически определяется тип: rq_uid (формат 00[0-9a-f]{14}) или uuid (UUID v4 формат).
Если извлечённое значение содержит префикс/суффикс (например "prefix#${uuid}"), используйте correlationRegex для извлечения чистого значения.

Примеры:

$.contextId

//RQ2

X-Correlation-ID

root generator correlation correlationRegex

Регулярное выражение для извлечения корреляционного значения (correlationRegex)

Тип: string

Опциональное регулярное выражение с одной capture group для извлечения чистого корреляционного значения из строки с префиксом/суффиксом.
Если значение поля, извлечённое по correlationTag, содержит дополнительные символы (например "id#${uuid}"),
используйте correlationRegex для извлечения чистого значения rq_uid или uuid.
Выражение должно содержать ровно одну capture group (в круглых скобках), которая будет использована как корреляционное значение.
Примеры:
- "PREFIX#(.+)" - извлекает ID после разделителя #
- "PREFIX_(.+)_SUFFIX" - извлекает значение между префиксом и суффиксом
- "(.+)" - извлекает всё значение (эквивалентно отсутствию regex)

Примеры:

id#(.+)

channel_agent#([^>]+)

(.*)#id

root generator correlation rqUIDTag

Тег идентификатора запросов (rq\_uid) (rqUIDTag)

Тип: string

[DEPRECATED] Используйте correlationTag вместо rqUIDTag.
Задает выражение для поиска значения внутренней переменной rq_uid.
Применяется вместе с messageParser=XPATH|JSONPATH|HEADER.
Сохраняется для обратной совместимости.

Пример:

/custom2/RQ2/@Attr1

root generator correlation requestTimeStorage

Хранилище запросов (requestTimeStorage)

Тип: enum (of string) Значение по умолчанию: "LOCAL_CACHE"

Используется для корреляции ответов с запросами, описание механизма корреляции приведено ниже. Возможные значения:
1. MEMORY_DB – время отправки каждого запроса сохраняется в локальный кеш (LOCAL_CACHE) и внешний кеш (Ignite/Radish/etcd). Также можно использовать алиас IGNITE.
Рекомендуется использовать для SyTester EE для protocol=MQ|KAFKA|ACTIVE_MQ|ARTEMIS
2. LOCAL_CACHE - время отправки каждого запроса сохраняется в локальный кеш.
Рекомендуется использовать:
1) для SyTester CE для всех сценариев
2) для SyTester EE:
2.1) для синхронных протоколов (protocol=HTTP|GRPC),
2.2) для асинхронных протоколов (protocol=MQ|KAFKA|ACTIVE_MQ|ARTEMIS) когда тест работает на 1 поде генератора
2.3) во всех остальных случаях, когда не нужны метрики задержки и статусы транзакции (в этом случае поведение аналогично none)
3. NONE – время отправки каждого запроса не сохраняется.
Рекомендуется использовать для SyTester CE и EE, при необходимости отсылать запросы без ответов. Метрики не доступны

Возможные значения:

"IGNITE"
"MEMORY_DB"
"LOCAL_CACHE"
"NONE"
"HEADER"
"STORE_FULL_REQUEST"

Пример:

MEMORY_DB

root generator correlation statusCodeTag

Тег кода статуса (statusCodeTag)

Тип: string

Задает выражение для поиска значения status_code из ответа. Применяется вместе с messageParser.
Используется для:
1. Понимания статуса вызова: успешно/неуспешно (если не успешно, то увеличится errorsToStop)
2. Формирование метрики статуса транзакции
3. Установки http статуса ответного сообщения на http заглушке

Пример для messageParser=header: "statusCodeTag": "mystatus_code", при условии, что во входящем сообщении есть header c <mystatus_code>333</mystatus_code>, в этом случае statusCode = 333

Пример:

root generator performance

Настройки производительности генератора (performance)

Тип: object

Блок описания работы тестового плана в облаке. Задает характеристики, связанные с работой модулей SyTester в общем и для конкретных протоколов

root generator performance podCount

Количество подов (podCount)

Тип: integer Значение по умолчанию: 0

Количество подов генераторов, на которых будет запущен тестовый план
Если параметр задан, то на поде (-ах) на которых запущен тест не будут запущены другие (следует применять для критичных тестов, для которых нужна полная изоляция)
Если параметр не задан (или задан 0), то на поде может быть запущено более одного теста с одинаковым значением protocol (но не более genMaxNT/max). genMaxNT определяется конкретным протоколом (задается в application.yml - см. Руководство по установке)

Пример:

root generator performance writeThreads

Количество записывающих потоков (writeThreads)

Тип: integer Значение по умолчанию: 0

Количество потоков для отправки сообщений генератором.
Если значение не задано (или задан 0), то количество потоков рассчитывается как целая часть результата выражения: maxTPS/100

Пример:

root generator periodicLoad

Настройки периодической нагрузки (periodicLoad)

Тип: object

Блок описания режима периодической нагрузки.
В режиме периодической нагрузки генератор может находиться в режиме нагрузки или в режиме простоя.
Режим нагрузки, длительность конфигурируется параметром loadDuration:
- в режиме нагрузки генератор выдает нагрузку на тестируемый сервис в штатном режиме
- по истечению времени нагрузки, генератор переходит в режим простоя
Режим простоя, длительность конфигурируется параметром loadCooldown:
- в режиме простоя генератор не выполняет никаких действий. Тестплан переходит в статус paused
- по истечения времени простоя, генератор переходит в режим нагрузки. Тестплан переходит в статус, предшествующий статусу paused

root generator periodicLoad loadDuration

Длительность нагрузки (loadDuration)

Тип: string or integerФормат: 1d2h3m4s5ms

Поддерживаются только статичные значения. Формат: d — дни, h — часы, m — минуты по умолчанию, s — секунды, ms — миллисекунды. Целое число трактуется как количество секунд

Пример:

5h35m10s

root generator periodicLoad loadCooldown

Длительность простоя (loadCooldown)

Тип: string or integerФормат: 1d2h3m4s5ms

Пример:

5h35m10s

root generator periodicLoad startWithLoad

Начинать с нагрузки (startWithLoad)

Тип: boolean

Начальный режим работы.
Возможные значения:
- true - генератор запускается в режиме нагрузки и подает нагрузку сразу
- false - генератор запускается в режиме простоя и подает нагрузку спустя loadCooldown

Пример:

true

root generator http

Настройки HTTP-транспорта генератора (http)

Тип: object

Блок специфических настроек тестового плана при protocol=HTTP

root generator http maxConnections

Максимальное число соединений (maxConnections)

Тип: integer Значение по умолчанию: "0"

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

Пример:

root generator http expectedStatus

Ожидаемые статусы (expectedStatus)

Тип: string

Список статусов, которые будут обозначены SyTester как успешные. Если значение не задано, то успешным считается 200 статус

Пример:

root generator grpc

Настройки GRPC-транспорта генератора (grpc)

Тип: object

Блок специфических настроек тестового плана при protocol=GRPC

root generator grpc maxConnections

Максимальное число соединений (maxConnections)

Тип: integer Значение по умолчанию: "0"

Количество потоков для отправки сообщений генератором. Если значение не задано (или задан 0), то количество потоков рассчитывается как целая часть результата выражения: maxTPS/100

Пример:

root generator mq

Настройки MQ-транспорта генератора (mq)

Тип: object

Блок специфических настроек тестового плана при protocol=MQ

root generator mq selectorFilter

Фильтр сообщений (selectorFilter)

Тип: string

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

Пример:

RQ

root generator mq consumerRateLimit

RateLimit потребителя (consumerRateLimit)

Тип: integer Значение по умолчанию: "0"

Максимальное число одновременных операций чтения из очереди входящих сообщений

Пример:

root generator mq encode64

Декодирование из base64 (encode64)

Тип: boolean Значение по умолчанию: "false"

Необходимость декодирования тела полученного сообщения из base64

Пример:

true

Пример:

5h35m10s

root generator observers

(observers)

Тип: array

Список наблюдателей, выполняющих мониторинг, при работе генератора

Тип элементов массива:

root generator observers[]

Наблюдатель генератора (generatorObserver)

Тип: object

Наблюдатель описывает ожидаемое событие или состояние(условие) и соответствующую ему действие, которое инициируется при его наступлении.

root generator observers[] condition

Условие (condition)

Тип: string or integerФормат: expression

Наблюдаемое условие генератора

Пример:

_steps['tps'].tps.current > 15

root generator observers[] action

Действие при выполнении условия (action)

Тип: enum (of string)

STOP — остановка тестового плана,
CONTINUE — переход на следующую итерацию текущего цикла,
BREAK — завершение выполнения текущего цикла.
Если поле не указано, то текущий шаг пошагового тестирования (type=STEPS) автоматически завершается.
Значения NONE и WARN устаревшие. При этих значениях поведение аналогично незаданному значению

Возможные значения:

"NONE"
"WARN"
"STOP"
"CONTINUE"
"BREAK"

Пример:

STOP

root stub

Конфигурация заглушки (stub)

Тип: object

Блок специфических настроек тестового плана при type = STUB

Пример:

type: RANDOM
transportIn:
- http

root stub type

Тип заглушки (type)

Тип: enum (of string) Значение по умолчанию: "RANDOM"

Режим работы:
* Random - заглушка вернет любой из заданных ответов для сервиса, заданного в тестовом плане
* Script - ответ формирует в выражении
* XSLT - заглушка вернет ответ, для которого заданный XSLT шаблон будет соответствовать телу пришедшего запроса
* Sequence - метод возвращает несколько ответов в очереди в ответ на 1 входное сообщение (только для protocol=MQ)
* STORED_XML - deprecated

Возможные значения:

"RANDOM"
"SCRIPT"
"XSLT"
"SEQUENCE"
"STORED_XML"

Пример:

RANDOM

root stub transportIn

Входные транспорты (transportIn)

Тип: array of string Значение по умолчанию: "transport_name"

Ссылка на транспорт из блока transport, задается как значение тега transport->name. Задает адрес (endpoint) на котором будут ожидаться запросы

Массив должен содержать, как минимум 1 элементов

Тип элементов массива:

root stub transportIn[]

Тип: string

Пример:

transport_name

root stub transportOut

Выходные транспорты (transportOut)

Тип: array of string Значение по умолчанию: "transport_name"

Ссылка на транспорт из блока transport, задается как значение тега transport->name. Задает адрес (endpoint) на который будут отсылаться ответы

Тип элементов массива:

root stub transportOut[]

Тип: string

Пример:

transport_name

root stub testdata

Тестовые данные (testdata)

Тип: array of string Значение по умолчанию: "testplan_data"

Ссылка на тестовые данные из блока testdata, задается как значение тега testdata->name. Если значение не задано, то заглушка будет работать в режиме echo-сервера (будет возвращать в ответе то, что пришло в запросе)

Тип элементов массива:

root stub testdata[]

Тип: string

Пример:

testplan_data

root stub script

Script-заглушка (script)

Тип: string

Script-заглушка формирует ответ в выражении, которое задается в атрибуте stub.script. Запись данных в формируемый ответ осуществляется с помощью переменной response.

Примеры:

"script": |
    const result = {
      name: "John"
    };
    response.body = json(result)
    response.headers = {
      "Content-Type": "application/json"
    }
    response.statusCode = 200

script: |-
    const result = {
        var: request.pathParams.var,
        query: request.queryParams.param,
        rawPath: request.path,
        rawQuery: request.query
    };
    response.body = json(result)
    response.headers = {
        "Content-Type": "application/json"
    }
    response.statusCode = 200

root stub delay

Задержка (delay)

Тип: string or integerФормат: expression

Пауза, которая будет применена после прочтения сообщения перед отправкой ответа. В качестве значения можно задать как статичное, так и вычисляемое в выражении значение. Статичное значение или результат выражения должен удовлетворять формату: d — дни, h — часы, m — минуты по умолчанию, s — секунды, ms — миллисекунды. Целое число трактуется как количество секунд. Значение вычисляется при каждом запросе

Пример:

10s

root stub startRequestIndex

Начальное значение индекса (startRequestIndex)

Тип: integer Значение по умолчанию: "0"

Задает значение, которое будет подставлено вместо внутренней переменной ${rq_index} в тестовых данных, привязанных к тестовому плану

Пример:

root stub maxRequestIndex

Максимальное значение индекса (maxRequestIndex)

Тип: integer

Задает значение счетчика запросов, по достижении которого работа тестового плана будет прекращена

Пример:

root stub retryCount

Количество повторов (retryCount)

Тип: integer

Пример:

root stub retryDelayTime

Время между попытками (retryDelayTime)

Тип: string or integerФормат: 1d2h3m4s5ms

Пример:

5h35m10s

root stub correlation

Настройки корреляции (correlation)

Тип: object

root generator correlation messageParser

Парсер сообщений (messageParser)

Тип: enum (of string) Значение по умолчанию: "NONE"

Возможные значения:

"NONE"
"XPATH"
"JSONPATH"
"HEADER"
"XML_IN_JSON"
"JSON_IN_JSON"

Пример:

["XPATH"]

root generator correlation correlationTag

Тег идентификатора запросов (correlationTag)

Тип: string

Примеры:

$.contextId

//RQ2

X-Correlation-ID

root generator correlation correlationRegex

Регулярное выражение для извлечения корреляционного значения (correlationRegex)

Тип: string

Примеры:

id#(.+)

channel_agent#([^>]+)

(.*)#id

root generator correlation rqUIDTag

Тег идентификатора запросов (rq\_uid) (rqUIDTag)

Тип: string

Пример:

/custom2/RQ2/@Attr1

root generator correlation requestTimeStorage

Хранилище запросов (requestTimeStorage)

Тип: enum (of string) Значение по умолчанию: "LOCAL_CACHE"

Возможные значения:

"IGNITE"
"MEMORY_DB"
"LOCAL_CACHE"
"NONE"
"HEADER"
"STORE_FULL_REQUEST"

Пример:

MEMORY_DB

root generator correlation statusCodeTag

Тег кода статуса (statusCodeTag)

Тип: string

Пример:

root stub performance

Настройки производительности заглушки (performance)

Тип: object

root stub performance podCount

Количество подов (podCount)

Тип: integer Значение по умолчанию: 0

Количество подов заглушек
Если protocol=HTTP|GRPC параметр не учитывается и заглушка будет запущена на всех работающих подах
Если параметр задан, то на поде (-ах) на которых запущен тест не будут запущены другие (следует применять для критичных тестов, для которых нужна полная изоляция)
Если параметр не задан (или задан 0), то на поде может быть запущено более одного теста с одинаковым значением protocol (но не более genMaxNT/max). genMaxNT определяется конкретным протоколом (задается в application.yml - см. Руководство по установке)

Пример:

root stub mq

Настройки MQ-транспорта заглушки (mq)

Тип: object

Блок, определяющий настройки работы с очередями

root stub mq replyQueueAndMQManager

Очередь ответа (replyQueueAndMQManager)

Тип: enum (of string) Значение по умолчанию: "FROM_INCOMING_MESSAGE"

FROM_INCOMING_MESSAGE - заглушка отвечает по Reply, значения ReplyQ/ReplyQM берутся из запроса
FROM_TESTPLAN - заглушка отправляет ответ в очередь/менеджер по списку транспортов, указанных в теге transportOut

Возможные значения:

"FROM_INCOMING_MESSAGE"
"FROM_TESTPLAN"

Пример:

FROM_INCOMING_MESSAGE

root stub mq selectorFilter

Фильтр сообщений (selectorFilter)

Тип: string

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

Пример:

selectorFilter

root stub mq consumerRateLimit

RateLimit потребителя (consumerRateLimit)

Тип: integer

Максимальное число одновременных операций чтения из очереди входящих сообщений

Пример:

root stub mq encode64

Декодирование из base64 (encode64)

Тип: boolean Значение по умолчанию: false

Необходимость декодирования тела полученного сообщения из base64

Пример:

true

Примеры:

intValue: 12
name: intVar

stringValue: Hello world!
name: stringVar

root steps vars[] name

Название переменной (name)

Тип: string

Пример:

countCm

root steps vars[] intValue

Целочисленное значение (intValue)

Тип: integer

Пример:

root steps vars[] doubleValue

Вещественное значение (doubleValue)

Тип: number

Пример:

1.0

root steps vars[] booleanValue

Логическое значение (booleanValue)

Тип: boolean

Пример:

True

root steps vars[] stringValue

Строковое значение (stringValue)

Тип: string

Пример:

abc

root steps vars[] value

(value)

Тип: object

root steps entry

Первый запускаемый шаг (entry)

Тип: string

Название шага, который будет выполнен при запуске тестового плана

Пример:

rest-step

root steps steps

Шаги (steps)

Тип: array

Список шагов тестирования. Их порядок не важен

Массив должен содержать, как минимум 1 элементов

Тип элементов массива:

root steps steps[]

Конфигурация шага тестирования (testplanStep)

Тип: object

root steps steps[] name

Название шага (name)

Тип: string

Пример:

step_1

root steps steps[] description

Описание шага (description)

Тип: string

Пример:

Описание шага

root steps steps[] type

Тип шага тестирования (type)

Тип: enum (of string) Значение по умолчанию: "PUT"

Выполняемое действие для шага:
PUT - отправка сообщения,
GET - получение сообщения (применимо для protocol=MQ|KAFKA и для HTTP с steps->ignite),
PUT_GET - синхронная работа по асинхронным протоколам
SLEEP - задержка,
K8S_APPLY - загрузка Kubernetes-ресурсов,
K8S_DELETE - удаление Kubernetes-ресурсов,
K8S_CHECK - проверка Kubernetes-ресурсов,
K8S_RESTART_PODS - перезагрузка подов,
K8S_AWAIT_CONDITION - ожидание условия для Kubernetes-ресурсов,
LOOP - итерации по заданной переменной с последовательным выполнением тела цикла,
SET_VAR - объявить переменную или изменить значение уже существующей переменной,
SERIAL - последовательно выполнить указанные шаги,
PARALLEL - параллельно выполнить указанные шаги,
TPS_LOADER - выполнение действия с заданным TPS,
EXPRESSION - выполнение выражения

Возможные значения:

"PUT"
"GET"
"SLEEP"
"PUT_GET"
"K8S_APPLY"
"K8S_DELETE"
"K8S_CHECK"
"K8S_CHANGE"
"K8S_RESTART_PODS"
"K8S_AWAIT_CONDITION"
"LOOP"
"SET_VAR"
"SERIAL"
"PARALLEL"
"TPS_LOADER"
"EXPRESSION"

Пример:

GET

root steps steps[] logLevel

Уровень логирования (logLevel)

Тип: enum (of string) Значение по умолчанию: "ERROR"

Уровень логирования при работе тестового плана

Возможные значения:

"DEBUG"
"INFO"
"WARN"
"ERROR"
"NONE"

Пример:

DEBUG

root steps steps[] transport

Транспорт (transport)

Тип: string

Ссылка на транспорт из блока transport, задается как значение тега transport->name

Пример:

transport

root steps steps[] testdata

Тестовые данные (testdata)

Тип: string

Ссылка на тестовые данные из блока testdata, задается как значение тега testdata->name. При stepType=K8S_APPLY в качестве тестовых данных должен быть задан шаблон ресурсов

Пример:

testdata

root steps steps[] timeout

Таймаут ожидания (timeout)

Тип: string

Таймаут, в течение которого ожидается ответ.

Пример:

5s

root steps steps[] vars

Формирование переменных (vars)

Тип: array

Блок списка переменных, которые будут сформированы по результату получения ответа на данном шаге. Используются для шагов stepType=GET|PUT. Их можно использовать на последующих шагах в заголовках или теле сообщения. Пример использования: ${varName}

Тип элементов массива:

root steps steps[] vars[]

Формирование переменной (varFormationConfig)

Тип: object

Формирование переменной на основе полученного ответа

root steps steps[] vars[] path

Путь (path)

Тип: string

Задает выражение для поиска значения varName в сообщении. Может содержать как простые строковые значения (type: header, const), так и xpath и jsonpath пути (type: xpath, jsonpath, jsonInJson, xmlInJson)

Пример:

first_var

root steps steps[] vars[] varName

Имя переменной (varName)

Тип: string

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

Пример:

var1

root steps steps[] vars[] type

Тип формирования переменной (type)

Тип: enum (of string)

Задает формат сообщения для поиска переменной:
* XPATH - формат xml. Ожидается выражение в формате xpath 1.0
* JSONPATH - формат JSON. Ожидается выражение в формате JsonPath https://github.com/json-path/JsonPath
* XML_IN_JSON - используется в GRPC сообщениях для того, чтобы распарсить xml сообщение из тега body сообщения в формате JSON
* JSON_IN_JSON - аналогично XML_IN_JSON только для JSON сообщений
* HEADER - используется для того, чтобы извлечь значение заголовка, имя тега задается в "path"
* CONST - используется для задания константного значения. Значение задается в "path"

Возможные значения:

"XPATH"
"JSONPATH"
"JSON_IN_JSON"
"XML_IN_JSON"
"HEADER"
"CONST"

Пример:

JSONPATH

root steps steps[] get

Настройки GET шага (get)

Тип: object

Блок специфических настроек шагов тестирования для stepType = GET

root steps steps[] get delay

Задержка (delay)

Тип: string or integerФормат: expression Значение по умолчанию: "5s"

Пауза, которая будет применена после выполнения шага. Используется для имитации задержки перед следующим шагом. В качестве значения можно задать как статичное, так и вычисляемое в выражении значение. Статичное значение или результат выражения должен удовлетворять формату: d — дни, h — часы, m — минуты по умолчанию, s — секунды, ms — миллисекунды. Целое число трактуется как количество секунд. Значение вычисляется при каждом запуске шага

Пример:

10s

root steps steps[] put

Настройки PUT шага (put)

Тип: object

Блок специфических настроек шагов тестирования для stepType = PUT

root steps steps[] put expectedStatus

Ожидаемый статус (expectedStatus)

Тип: integer

Пример:

root steps steps[] put http

Настройки HTTP-транспорта шага PUT (http)

Тип: object

Блок специфических настроек шага PUT при protocol=HTTP (не влияет на работу других протоколов)

root steps steps[] put http maxConnections

Максимальное число соединений (maxConnections)

Тип: string Значение по умолчанию: "100"

Пример:

root steps steps[] ignite

Использовать ли Ignite (ignite)

Тип: boolean Значение по умолчанию: false

Используется для поддержки синхронного сценария для асинхронных вызовов HTTP путем получения ответа через Ignite
Логика работы:
1. Выполняется запрос в тестируемую АС по HTTP
2. Тестируемая АС отвечает (асинхронный ответ по HTTP) в заглушку
3. Заглушка помещает ответ в Ignite
4. Ответ читается из Ignite
Для настройки нужно:
1. В тестовом плане с type=STUB и protocol=HTTP установить requestTimeStorage=storefullrequest и задать rqUIDTag
2. На любом шаге c stepType=PUT в тело сообщения добавить внутреннюю переменную $rq_uid
3. На следующем шаге установить ignite=true иh
3.1 Если stepType=GET, можно настроить steps.timeoutMs.
Также на этом шаге появляется возможность работы с переменными (см. steps.vars) и/или валидации сообщения (см. testdatas[].messageCompare->compareHeaders/compareBody)
3.2 Если stepType=PUT, отправить сообщение (которое заданно в тестовом плане)

Пример:

true

root steps steps[] correlation

Настройки корреляции (correlation)

Тип: object

root generator correlation messageParser

Парсер сообщений (messageParser)

Тип: enum (of string) Значение по умолчанию: "NONE"

Возможные значения:

"NONE"
"XPATH"
"JSONPATH"
"HEADER"
"XML_IN_JSON"
"JSON_IN_JSON"

Пример:

["XPATH"]

root generator correlation correlationTag

Тег идентификатора запросов (correlationTag)

Тип: string

Примеры:

$.contextId

//RQ2

X-Correlation-ID

root generator correlation correlationRegex

Регулярное выражение для извлечения корреляционного значения (correlationRegex)

Тип: string

Примеры:

id#(.+)

channel_agent#([^>]+)

(.*)#id

root generator correlation rqUIDTag

Тег идентификатора запросов (rq\_uid) (rqUIDTag)

Тип: string

Пример:

/custom2/RQ2/@Attr1

root generator correlation requestTimeStorage

Хранилище запросов (requestTimeStorage)

Тип: enum (of string) Значение по умолчанию: "LOCAL_CACHE"

Возможные значения:

"IGNITE"
"MEMORY_DB"
"LOCAL_CACHE"
"NONE"
"HEADER"
"STORE_FULL_REQUEST"

Пример:

MEMORY_DB

root generator correlation statusCodeTag

Тег кода статуса (statusCodeTag)

Тип: string

Пример:

root steps steps[] sleep

Длительность бездействия (sleep)

Тип: string or integerФормат: expression

Длительность бездействия. Обязательный параметр шага SLEEP. В качестве значения можно задать как статичное, так и вычисляемое в выражении значение. Статичное значение или результат выражения должен удовлетворять формату: d — дни, h — часы, m — минуты по умолчанию, s — секунды, ms — миллисекунды. Целое число трактуется как количество секунд. Значение вычисляется при каждом запуске шага

Пример:

10s

root steps steps[] k8s

Конфигурация k8s-шагов (k8s)

Тип: object

Блок специфических настроек шагов тестирования для stepType = K8S_*

root steps steps[] k8s applyCount

Количество загрузок (applyCount)

Тип: string or integerФормат: expression

Количество выполнений загрузки ресурсов шага K8S_APPLY

Пример:

countCm

root steps steps[] k8s packageSize

Размер пакета (packageSize)

Тип: integer Значение по умолчанию: "10"

Размер пакета постепенной работы с ресурсами. Используется для шага action=K8S_APPLY|K8S_DELETE|K8S_CHECK|K8S_AWAIT_CONDITION|K8S_CHANGE. Пример: если необходимо создать 25 ресурсов, то сначала будет создано 10, потом еще 10 и потом оставшиеся 5. При указании packageSize = 1 загрузка будет производиться строго по одному элементу, обеспечивая максимальную контролируемость процесса. Внутри одного пакета ресурсы обрабатываются последовательно.

Пример:

root steps steps[] k8s packageTimeout

Таймаут пакета (packageTimeout)

Тип: string or integerФормат: expression Значение по умолчанию: "10s"

Таймаут на обработку пакета. В случае если время обработки пакета будет превышено, оставшиеся ресурсы в пакете обработаны не будут. Используется для шага action=K8SAPPLY|K8SDELETE|K8SCHECK|K8SAWAITCONDITION|K8SCHANGE. В качестве значения можно задать как статичное, так и вычисляемое в выражении значение. Статичное значение или результат выражения должен удовлетворять формату: d — дни, h — часы, m — минуты по умолчанию, s — секунды, ms — миллисекунды. Целое число трактуется как количество секунд. Значение вычисляется при каждом запуске шага

Пример:

10s

root steps steps[] k8s resourceTypes

Типы ресурсов (resourceTypes)

Тип: array

Типы ресурсов для шагов K8S_DELETE, K8S_CHECK, K8S_CHANGE, K8S_AWAIT_CONDITION

Тип элементов массива:

root steps steps[] k8s resourceTypes[]

Тип ресурса (resourceType)

Тип: object

Тип k8s-ресурса

root steps steps[] k8s resourceTypes[] apiVersion

ApiVersion ресурса (apiVersion)

Тип: string

Пример:

apps/v1

root steps steps[] k8s resourceTypes[] kind

Kind ресурса (kind)

Тип: string

Пример:

ConfigMap

root steps steps[] k8s labelSelector

Селектор по меткам (labelSelector)

Тип: object

Селектор по меткам для шагов K8S_DELETE, K8S_CHECK, K8S_CHANGE, K8S_AWAIT_CONDITION, K8S_RESTART_PODS. Селектор меток состоит из нескольких пар key-value, ресурс должен обладать всеми указанными метками

Пример:

app.kubernetes.io/managed-by: sytester

Все дополнительные атрибуты должны соответствовать следующей схеме

root steps steps[] k8s labelSelector

Тип: string

root steps steps[] k8s nameSelector

Селектор по имени (nameSelector)

Тип: string

Селектор имени выполняет выборку строго по заданном имени ресурса

Пример:

sleep-http-stub

root steps steps[] k8s limit

Ограничение количества выгружаемых ресурсов (limit)

Тип: integer Значение по умолчанию: "10"

С помощью атрибута limit можно ограничить количество выгружаемых ресурсов.

Пример:

root steps steps[] k8s checks

Конфигурации проверок (checks)

Тип: array

Конфигурации проверок шага K8S_CHECK

Тип элементов массива:

root steps steps[] k8s checks[]

Конфигурация проверки ресурсов (k8sCheckConfig)

Тип: object

Проверяется соответствие значения полученного по Jsonpath ожидаемому

root steps steps[] k8s checks[] alias

Псевдоним проверки (alias)

Тип: string

Псевдоним проверки, под котором она идентифицируется в отчете

Пример:

CPU

root steps steps[] k8s checks[] jsonpath

Jsonpath (jsonpath)

Тип: string

JsonPath, по которому выполняется поиск проверяемого свойства ресурса

Пример:

$.status.phase

root steps steps[] k8s checks[] expectedResult

Ожидаемое значение (expectedResult)

Тип: string

Ожидаемый результат применения JsonPath

Пример:

Running

root steps steps[] k8s checks[] failAction

Действие (failAction)

Тип: enum (of string)

Действие при невыполнении условия. STOP — остановка тестового плана,
CONTINUE — переход на следующую итерацию текущего цикла,
BREAK — завершение выполнения текущего цикла.
Если поле не указано, то текущий шаг пошагового тестирования (type=STEPS) автоматически завершается.
Значения NONE и WARN устаревшие. При этих значениях поведение аналогично незаданному значению

Возможные значения:

"NONE"
"WARN"
"STOP"
"CONTINUE"
"BREAK"

Пример:

STOP

root steps steps[] k8s conditions

Конфигурации условий (conditions)

Тип: array

Конфигурации условий шага K8S_AWAIT_CONDITION

Тип элементов массива:

root steps steps[] k8s conditions[]

Ожидаемое условие (k8sConditionConfig)

Тип: object

Проверяется соответствие значения полученного по Jsonpath ожидаемому в течение заданного таймаута

root steps steps[] k8s conditions[] alias

Псевдоним условия (alias)

Тип: string

Псевдоним условие, под котором оно идентифицируется в отчете

Пример:

CPU

root steps steps[] k8s conditions[] jsonpath

Jsonpath (jsonpath)

Тип: string

JsonPath, по которому выполняется поиск проверяемого свойства ресурса

Пример:

$.status.phase

root steps steps[] k8s conditions[] expectedResult

Ожидаемое значение (expectedResult)

Тип: string

Ожидаемый результат применения JsonPath

Пример:

Running

root steps steps[] k8s conditions[] timeout

Таймаут ожидания (timeout)

Тип: string or integerФормат: expression

Таймаут на ожидание выполнения условия. По умолчания ожидание происходит бесконечно. В качестве значения можно задать как статичное, так и вычисляемое в выражении значение. Статичное значение или результат выражения должен удовлетворять формату: d — дни, h — часы, m — минуты по умолчанию, s — секунды, ms — миллисекунды. Целое число трактуется как количество секунд. Значение вычисляется при каждом запуске шага

Пример:

10s

root steps steps[] k8s conditions[] timeoutAction

Действие при таймауте (timeoutAction)

Тип: enum (of string)

Возможные значения:

"NONE"
"WARN"
"STOP"
"CONTINUE"
"BREAK"

Пример:

STOP

root steps steps[] k8s changes

Конфигурации изменений (changes)

Тип: array

Конфигурации изменений шага K8S_CHANGE

Тип элементов массива:

root steps steps[] k8s changes[]

Изменение (k8sChangeConfig)

Тип: object

Изменение по jsonpath на заданное значение

root steps steps[] k8s changes[] alias

Псевдоним изменения (alias)

Тип: string

Псевдоним изменения, под котором оно идентифицируется в отчете

Пример:

CPU

root steps steps[] k8s changes[] jsonpath

Jsonpath (jsonpath)

Тип: string

JsonPath, по которому выполняется поиск изменяемого свойства ресурса

Пример:

$.status.phase

root steps steps[] k8s changes[] value

Значение (value)

Тип: string

Новое значение свойства

Пример:

${newValue}

root steps steps[] k8s awaitDeleted

Конфигурация ожидания удаления (awaitDeleted)

Тип: object

Ожидание отсутствия удаленных ресурсов в Kubernetes-кластере шага K8S_DELETE

root steps steps[] k8s awaitDeleted timeout

Таймаут ожидания (timeout)

Тип: string or integerФормат: expression

Таймаут ожидания отсуствие ресурсов. По умолчания ожидание происходит бесконечно. В качестве значения можно задать как статичное, так и вычисляемое в выражении значение. Статичное значение или результат выражения должен удовлетворять формату: d — дни, h — часы, m — минуты по умолчанию, s — секунды, ms — миллисекунды. Целое число трактуется как количество секунд. Значение вычисляется при каждом запуске шага

Пример:

10s

root steps steps[] k8s awaitDeleted timeoutAction

Действие при таймауте (timeoutAction)

Тип: enum (of string)

Возможные значения:

"NONE"
"WARN"
"STOP"
"CONTINUE"
"BREAK"

Пример:

STOP

root steps steps[] k8s podRestart

Конфигурация перезапуска подов (podRestart)

Тип: object

Конфигурация перезапуска подов шага K8SRESTARTPODS

root steps steps[] k8s podRestart percentage

Процент (percentage)

Тип: number

Процент подов, которых необходимо перезапустить

Пример:

10.0

root steps steps[] k8s podRestart awaitDeletedTimeout

Таймаут ожидания удаления (awaitDeletedTimeout)

Тип: string or integerФормат: expression

Таймаут ожидания удаления пода перед его созданием при рестарте. В качестве значения можно задать как статичное, так и вычисляемое в выражении значение. Статичное значение или результат выражения должен удовлетворять формату: d — дни, h — часы, m — минуты по умолчанию, s — секунды, ms — миллисекунды. Целое число трактуется как количество секунд. Значение вычисляется при каждом запуске шага

Пример:

10s

root steps steps[] k8s cleaningAfter

Флаг автоматической очистки (cleaningAfter)

Тип: boolean

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

Пример:

true

root steps steps[] loop

Настройки цикла (loop)

Тип: object

Настройки шага цикла. Обязательный параметр шага LOOP. Шаг LOOP выполняет итерации по заданной переменной (loop.var) и последовательно выполняет действия тела цикла (loop.body)

root steps steps[] loop var

Настройки переменной цикла (var)

Тип: object

Настройки переменной цикла

root steps steps[] loop var name

Имя переменной (name)

Тип: string

Пример:

var

root steps steps[] loop var start

Начальное значение (start)

Тип: string or integerФормат: expression

Выражение

Пример:

startIndex

root steps steps[] loop var finish

Конечное значение (finish)

Тип: string or integerФормат: expression

Выражение

Пример:

finishIndex

root steps steps[] loop var step

Шаг изменения переменной (step)

Тип: string or integerФормат: expression Значение по умолчанию: "1"

Число, на которое будет увеличиваться переменной после каждого шага

Пример:

root steps steps[] loop body

Тело цикла (body)

Тип: array of string

Перечисление названий последовательно выполняющихся шагов

Массив должен содержать, как минимум 1 элементов

Тип элементов массива:

root steps steps[] loop body[]

Тип: string

Пример:

sleep

root steps steps[] setVar

Установка значения переменной (setVar)

Тип: object

Установка значения переменной. Обязательный параметр шага SET_VAR. Для задания типа переменной необходимо задать значение в определенный атрибут (для целочисленного - intValue и т.п.). Используется значение в порядке приоритета int > float > boolean > string

Примеры:

intValue: 12
name: intVar

stringValue: Hello world!
name: stringVar

root steps vars[] name

Название переменной (name)

Тип: string

Пример:

countCm

root steps vars[] intValue

Целочисленное значение (intValue)

Тип: integer

Пример:

root steps vars[] doubleValue

Вещественное значение (doubleValue)

Тип: number

Пример:

1.0

root steps vars[] booleanValue

Логическое значение (booleanValue)

Тип: boolean

Пример:

True

root steps vars[] stringValue

Строковое значение (stringValue)

Тип: string

Пример:

abc

root steps vars[] value

(value)

Тип: object

root steps steps[] children

Подчиненные шаги (children)

Тип: array of string

Список названий шагов, которые будут вызываться последовательно. Обязательный параметр шага SERIAL

Массив должен содержать, как минимум 1 элементов

Тип элементов массива:

root steps steps[] children[]

Тип: string

Пример:

post-step

root steps steps[] mq

Настройки MQ-транспорта (mq)

Тип: object

Блок специфических настроек шагов тестирования для protocol=MQ шагов PUT | GET

root steps steps[] mq queue

Очередь (queue)

Тип: string

Имя очереди для выполнения шага.
Может содержать следующие имена через разделительный символ @:
1. Очередь для отправки
2. Очередь для ответов (ReplyTOQ, будет записано в MQMD заголовок сообщения)
3. Менеджер для ответа (ReplyToQManager, будет записано в MQMD заголовок сообщения)
Если значение явно не задано и шаг PUT, то используется очередь request блока transport, если шаг GET - очередь response блока transport

Примеры:

SYTESTER.STEPS

SYTESTER.STEPS@ReplyTOQ@ReplyTOQManager

root steps steps[] kafka

Настройки транспорта Kafka (kafka)

Тип: object

Блок специфических настроек шагов тестирования для protocol=Kafka шагов PUT | GET | PUT_GET

root steps steps[] kafka readThreads

Количество читающих потоков (readThreads)

Тип: integer Значение по умолчанию: "1"

Пример:

root steps steps[] tpsLoader

Настройки TPS-нагрузки (tpsLoader)

Тип: object

Настройки шага TPS-нагрузки. Обязательный параметр шага TPS_LOADER. В шаге с заданной длительностью выполняется другой шаг с частотой контролируемой настройкой TPS

Пример:

tps:
  start: 1
  finish: 10
  increment:
    value: 1
    rate: 3s
duration: 30s
workload: http-put
threadCount: '10'
asyncMode: true

root steps steps[] tpsLoader tps

Настройки TPS (tps)

Тип: object

Настройки интервала TPS

root steps steps[] tpsLoader tps start

Начальный TPS (start)

Тип: string or integerФормат: expression

Начальное количество запросов в секунду

Пример:

root steps steps[] tpsLoader tps max

Конечный TPS (max)

Тип: string or integerФормат: expression

Максимальное количество запросов в секунду

Пример:

root steps steps[] tpsLoader tps stepSize

Значение инкремента (stepSize)

Тип: string or integerФормат: expression Значение по умолчанию: "1"

Шаг увеличения нагрузки

Пример:

root steps steps[] tpsLoader tps stepTime

Темп (stepTime)

Тип: string or integerФормат: expression Значение по умолчанию: "1s"

Темп выполнения инкремента TPS. В качестве значения можно задать как статичное, так и вычисляемое в выражении значение. Статичное значение или результат выражения должен удовлетворять формату: d — дни, h — часы, m — минуты по умолчанию, s — секунды, ms — миллисекунды. Целое число трактуется как количество секунд. Значение вычисляется при каждом запуске шага

Пример:

10s

root steps steps[] tpsLoader duration

Длительность (duration)

Тип: string or integerФормат: expression

Длительность выполнения TPS-нагрузки. В качестве значения можно задать как статичное, так и вычисляемое в выражении значение. Статичное значение или результат выражения должен удовлетворять формату: d — дни, h — часы, m — минуты по умолчанию, s — секунды, ms — миллисекунды. Целое число трактуется как количество секунд. Значение вычисляется при каждом запуске шага

Пример:

10s

root steps steps[] tpsLoader workload

Рабочая нагрузка (workload)

Тип: string

Название выполняемого шага

Пример:

step

root steps steps[] tpsLoader threadCount

Количество потоков (threadCount)

Тип: string or integerФормат: expression Значение по умолчанию: "1"

Количество потоков выполняющих нагрузку. По умолчанию нагрузка выполняется в 1 потоке. Влияет только на шаги с asyncMode = false.

Пример:

root steps steps[] tpsLoader frameSize

(frameSize)

Тип: string

Пример:

5s

root steps steps[] tpsLoader asyncMode

Переключатель модели подачи нагрузки (asyncMode)

Тип: string or integerФормат: expression Значение по умолчанию: "true"

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

Пример:

false

root steps steps[] tpsLoader errorsToStop

Количество ошибок (errorsToStop)

Тип: integer Значение по умолчанию: 100

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

Пример:

root steps steps[] tpsLoader ignoreErrorsDuringWarmup

Отсрочка остановки по количеству ошибок (ignoreErrorsDuringWarmup)

Тип: string or integerФормат: expression

Длительность, во время которой не учитываются ошибки способные остановить нагрузку (errorsToStop). В качестве значения можно задать как статичное, так и вычисляемое в выражении значение. Статичное значение или результат выражения должен удовлетворять формату: d — дни, h — часы, m — минуты по умолчанию, s — секунды, ms — миллисекунды. Целое число трактуется как количество секунд. Значение вычисляется при каждом запуске шага

Пример:

10s

root steps steps[] onError

Действие при ошибке выполнения шага (onError)

Тип: enum (of string)

Опциональное действие при ошибке. Выполняемый шаг прерывается в любом случае.
STOP — остановка тестового плана,
CONTINUE — переход на следующую итерацию текущего цикла,
BREAK — завершение выполнения текущего цикла.
Если поле не указано, то текущий шаг пошагового тестирования (type=STEPS) автоматически завершается.
Значения NONE и WARN устаревшие. При этих значениях поведение аналогично незаданному значению

Возможные значения:

"NONE"
"WARN"
"STOP"
"CONTINUE"
"BREAK"

root steps steps[] observers

Наблюдатели (observers)

Тип: array

Список наблюдателей, выполняющих мониторинг, при работе шага

Тип элементов массива:

root steps steps[] observers[]

Наблюдатель шага (stepObserver)

Тип: object

Наблюдатель, которые выполняет мониторинг определенного условия при работе шага тестирования

root steps steps[] observers[] condition

Условие (condition)

Тип: string or integerФормат: expression

Наблюдаемое условие шага

Пример:

"_steps['tps'].tps.current > 1000"

root steps steps[] observers[] action

Действие при выполнении условия (action)

Тип: enum (of string)

Возможные значения:

"NONE"
"WARN"
"STOP"
"CONTINUE"
"BREAK"

Пример:

STOP

root steps steps[] updaters

(updaters)

Тип: array

Тип элементов массива:

root steps steps[] updaters[]

(stepUpdater)

Тип: object

root steps steps[] updaters[] output

(output)

Тип: string

root steps steps[] updaters[] type

(type)

Тип: enum (of string)

Возможные значения:

"MAX"
"MIN"
"AVG"
"LAST"

root steps steps[] updaters[] expression

(expression)

Тип: string

root steps steps[] expression

Выражение (expression)

Тип: string or integerФормат: expression

Выражение выполняемое в шаге EXPRESSION

Пример:

clean('http-request')

root steps steps[] metadata

Метаданные, пользовательские атрибуты (metadata)

Тип: object

Объект для хранения пар ключ-значение клиента.
Содержимое объекта полностью контролируется пользователем и не влияет на работу тестового плана

Пример:

metadata:
  firstProperty: 10
  secondProperty: string

Все дополнительные атрибуты должны соответствовать следующей схеме

root steps steps[] metadata

(object)

Тип: object

root steps podCount

Количество подов (podCount)

Тип: integer Значение по умолчанию: 0

Количество генераторов для распределенной работы тестового плана

Пример:

root transports

Конфигурации транспортов (transports)

Тип: array

Тип элементов массива:

root transports[]

Конфигурация транспорта (transport)

Тип: object

Блок транспорта, описывающий параметры подключения для тестовых планов

Пример:

name: transport1
protocol: HTTP
host: localhost
port: 8080
request: /endpoint
http:
  method: GET

root transports[] name

Название транспорта (name)

Тип: string Значение по умолчанию: "transport_name"

Произвольное имя транспорта

Пример:

http-transport

root transports[] protocol

Протокол транспорта (protocol)

Тип: enum (of string)

Возможные значения:

"HTTP"
"GRPC"
"MQ"
"KAFKA"
"ACTIVE_MQ"
"POSTGRES"
"ARTEMIS"
"KUBEAPI"

Пример:

HTTP

root transports[] host

Хост транспорта (host)

Тип: string

IP адрес или доменное имя хоста для подключения. Для протокола HTTP может быть полным url. Обязательный параметр, кроме type=STUB

Примеры:

127.0.0.1

sytester-https-stub

http://sytester-https-stub:8080/endpoint

https://sytester-https-stub/endpoint

root transports[] port

Порт подключения (port)

Тип: integer

Для type=STUB и protocol=HTTP порт задается через тэг ConfigMap stubHttpDefaultServerPort, см. Руководство по установке

Пример:

root transports[] request

Запрос (request)

Тип: string

Варианты использования:
1. Для protocol=MQ|KAFKA|ACTIVE_MQ|ARTEMIS - имя очереди
2. Для protocol=GRPC - имя метода
3. Для protocol=HTTP - конечная точка
Обязательный параметр для type=GENERATOR (кроме HTTP протокола)
Для type=STUB с protocol=HTTP можно задавать шаблонные конечные точки с переменными в path и query params

Примеры:

topic_rq

/request

/request/${var}?param=${param}

root transports[] response

Ответ (response)

Тип: string

Для type=GENERATOR/STEPS - это необязательный параметр, очередь/топик для ответа, указывается когда нужна корреляция ответов с запросами для protocol=MQ|KAFKA|ACTIVE_MQ|ARTEMIS (для синхронных сценариев). В других случаях не заполняется.
Для type=STUB - это обязательный параметр, очередь/топик для ответа.

Пример:

topic_rs

root transports[] login

Логин (login)

Тип: string

Логин, при необходимости авторизации для подключения к серверу

Пример:

login

root transports[] password

Пароль (password)

Тип: string

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

Пример:

password

root transports[] ssl

Настройки SSL (ssl)

Тип: object

Блок настройка SSL-подключения

root transports[] ssl caFile

Файл CA (caFile)

Тип: string

Путь до файла корневого сертификата (для JKS)

Пример:

path

root transports[] ssl caPass

Пароль CA (caPass)

Тип: string

Пароль к файлу доверенных ключей (для JKS)

Пример:

password

root transports[] ssl keyFile

Файл клиентского хранилища (keyFile)

Тип: string

Путь до файла с клиентским хранилищем (для JKS и сертификатов)

Пример:

path

root transports[] ssl keyPass

Пароль клиентского хранилища (keyPass)

Тип: string

Пароль к клиентскому хранилищу (для JKS)

Пример:

password

root transports[] ssl keyFilePass

Пароль к файлу ключей шифрования (keyFilePass)

Тип: string

Пароль к файлу ключей шифрования (для JKS и одиночного сертификата)

Пример:

password

root transports[] ssl certFile

Файл клиентского сертификата (certFile)

Тип: string

Файл клиентского сертификата (для одиночного сертификата)

Пример:

path

root transports[] ssl chainFile

Файл цепочки сертификатов (chainFile)

Тип: string

Файл с цепочкой промежуточных CA сертификатов, подписавших клиентский/серверный сертификат (для CRT/PEM). Вместо цепочки может использоваться файл корневого сертификата.

Пример:

path

root transports[] ssl peerName

Идентификатор канала (peerName)

Тип: string

Идентификатор канала при подключении по SSL (для protocol=MQ)

Пример:

MQ_CHANNEL

root transports[] http

Настройки HTTP (http)

Тип: object

Блок специфических настроек тестового плана при protocol=HTTP

root transports[] http method

HTTP-метод (method)

Тип: string Значение по умолчанию: "POST"

Пример:

GET

root transports[] mq

Настройки MQ (mq)

Тип: object

Блок специфических настроек тестового плана при protocol=MQ|ACTIVE_MQ|ARTEMIS

root transports[] mq queueManager

Менеджер очереди (queueManager)

Тип: string

Название менеджера очереди

Пример:

MQ_MANAGER

root transports[] mq channel

Канал (channel)

Тип: string

Канал подключения

Пример:

MQ_CHANNEL

Блок специфических настроек тестового плана при protocol=KUBEAPI

root transports[] k8s token

Токен аутентификации для доступа к Kubernetes API (token)

Тип: string

Параметр определяет токен, используемый для выполнения аутентифицированных запросов к Kubernetes API (kube-apiserver).
Поддерживаются следующие способы задания:
1. Значение JWT-токена в кодировке Base64URL (например: eyJhb...).
2. Путь к файлу с токеном в файловой системе пода (например, при использовании Secman).
3. Имя ключа, содержащего токен, в секрете Kubernetes.
4. Если параметр не задан, используется токен Service Account Kubernetes.

Примеры:

eyJhb...

/k8s/token

token

root transports[] k8s namespace

Неймспейс (namespace)

Тип: string Значение по умолчанию: "default"

Название пространства имен в кластере Kubernetes

Пример:

default

root transports[] k8s connectionTimeout

Таймаут соединения (connectionTimeout)

Тип: string or integerФормат: 1d2h3m4s5ms

Таймаут на подключение к Kubernetes. Поддерживаются только статичные значения. Формат: d — дни, h — часы, m — минуты по умолчанию, s — секунды, ms — миллисекунды. Целое число трактуется как количество секунд. Если не задавать, используется значение HTTP-клиента Fabric8 (10 секунд)

Пример:

5h35m10s

root transports[] k8s requestTimeout

Таймаут запросов (requestTimeout)

Тип: string or integerФормат: 1d2h3m4s5ms

Таймаут запросов чтения ресурсов Kubernetes. Поддерживаются только статичные значения. Формат: d — дни, h — часы, m — минуты по умолчанию, s — секунды, ms — миллисекунды. Целое число трактуется как количество секунд. Если не задавать, используется значение HTTP-клиента Fabric8 (10 секунд)

Пример:

5h35m10s

root transports[] k8s uploadRequestTimeout

Таймаут запросов загрузки (uploadRequestTimeout)

Тип: string or integerФормат: 1d2h3m4s5ms

Таймаут запросов загрузки ресурсов Kubernetes. Поддерживаются только статичные значения. Формат: d — дни, h — часы, m — минуты по умолчанию, s — секунды, ms — миллисекунды. Целое число трактуется как количество секунд. Если не задавать, используется значение HTTP-клиента Fabric8 (120 секунд)

Пример:

5h35m10s

root transports[] k8s certs

Сертификаты (certs)

Тип: object

Сертификаты используемые для подключения к k8s

root transports[] k8s certs caCert

Корневой сертификат (caCert)

Тип: string

Путь до файла корневого сертификата

Пример:

path_to_cert

root transports[] k8s certs clientCertFile

Клиентский сертификат (clientCertFile)

Тип: string

Путь до файла клиентского сертификата

Пример:

path_to_cert

root transports[] k8s certs clientKeyFile

Клиентский приватный ключ (clientKeyFile)

Тип: string

Путь до файла c приватным ключом

Пример:

path_to_key

root transports[] postgres

Тип: object

Блок конфигурации шифрования/дешифрования данных для транспорта
publicKeyPath - путь до сертификата, которым будет проведено шифрование
privateKeyPath - путь до приватного ключа, которым будет проведено дешифрование (также используется для подписи сообщения в функции jwtSignRS256)
keyId - идентификатор ключа, который будет добавлен в публичную часть шифрованного сообщения

root transports[] encryption enabled

Включить шифрование (enabled)

Тип: boolean Значение по умолчанию: false

Флаг включения шифрования данных при отправке и дешифрования при получении

root transports[] encryption publicKeyPath

Путь к публичному ключу (publicKeyPath)

Тип: string

Путь к файлу с публичным ключом (сертификатом) для шифрования данных

Пример:

certs/crt.pem

root transports[] encryption privateKeyPath

Путь к приватному ключу (privateKeyPath)

Тип: string

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

Пример:

certs/key.pem

root transports[] encryption keyId

ID ключа (keyId)

Тип: string

Уникальный идентификатор ключа (опционально)

Пример:

key-123

root transports[] filter

Фильтр потребителя (filter)

Тип: string

Фильтр определяет какие сообщения будет прочитаны потребителем (для синхронного генератора из топика response, для заглушки — request). Поддерживается только протокол KAFKA

Примеры:

request.headers["recipientAgentName"] == "sber.support_platform.channel_agent"

jsonpath(request.body, "$.result.status.state") == "completed"

Testplan Config Schema 6.8.1

version

Версия схемы (version)

name Обязательный атрибут

Название тестового плана (name)

ownerUser

Владелец (ownerUser)

description

Описание тестового плана (description)

logLevel

Уровень логирования (logLevel)

Возможные значения:

testDuration

Длительность тестирования (testDuration)

type Обязательный атрибут

Тип тестирования (type)

Возможные значения:

generator

Конфигурация генератора (generator)

tps

Настройки TPS (tps)

start

Начальный TPS (start)

max

Максимальный TPS (max)

stepTime

Интервал TPS (stepTime)

stepSize

Шаг TPS (stepSize)

transportIn Обязательный атрибут

Входные транспорты (transportIn)

Тип элементов массива:

transportOut

Выходные транспорты (transportOut)

Тип элементов массива:

testdata Обязательный атрибут

Тестовые данные (testdata)

Тип элементов массива:

startRequestIndex

Начальное значение индекса (startRequestIndex)

maxRequestIndex

Максимальное значение индекса (maxRequestIndex)

retryCount

Количество повторов (retryCount)

retryDelayTime

Время между попытками (retryDelayTime)

messageTimeout

Таймаут запросов (messageTimeout)

errorsToStop

Количество допустимых ошибок (errorsToStop)

ignoreErrorsDuringWarmup

Отсрочка остановки по количеству ошибок (ignoreErrorsDuringWarmup)

correlation

Настройки корреляции (correlation)

messageParser Обязательный атрибут

Парсер сообщений (messageParser)

Возможные значения:

correlationTag

Тег идентификатора запросов (correlationTag)

correlationRegex

Регулярное выражение для извлечения корреляционного значения (correlationRegex)

rqUIDTag

Тег идентификатора запросов (rq\_uid) (rqUIDTag)

requestTimeStorage

Хранилище запросов (requestTimeStorage)

Возможные значения:

statusCodeTag

Тег кода статуса (statusCodeTag)

performance

Настройки производительности генератора (performance)

podCount

Количество подов (podCount)

writeThreads

Количество записывающих потоков (writeThreads)

periodicLoad

Настройки периодической нагрузки (periodicLoad)

loadDuration

Длительность нагрузки (loadDuration)

loadCooldown

Длительность простоя (loadCooldown)