Перейти к основному содержимому

Сценарии из нескольких шагов

Редакция: OpenIDE Pro.

Передача результата через pathParam​

Результат запроса нельзя подставлять в строку URL: скрипт только регистрирует запросы, а значения разрешаются во время выполнения. Для подстановки используются плейсхолдер {name} в адресе и pathParam.

val orderId by POST("$host/api/orders") {
contentType("application/json")
body("""{"productId": 42, "quantity": 1}""")
} then {
decode<Long>("$.id")
}

GET("$host/api/orders/{orderId}") {
pathParam("orderId", orderId)
} then {
assert(code == 200)
}

Так делать нельзя:

// Результат другого запроса в строке URL
GET("$host/api/orders/$orderId") then {
assert(code == 200)
}

Группировка в useCase​

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

data class Order(val id: Long, val status: String)

val created by useCase("Заказ: создание и проверка") {
val order by POST("$host/api/orders") {
contentType("application/json")
body("""{"productId": 42, "quantity": 1}""")
} then {
assert(code == 201)
decode<Order>()
}

GET("$host/api/orders/{orderId}") {
pathParam("orderId", order.id)
} then {
assert(code == 200)
val fetched = decode<Order>()
assert(fetched.status == "created")
}

order
}
Сценарий из нескольких шагов: запросы выполняются по очереди, в журнале видно каждый запрос, ответ и ссылку на сохранённое тело

Сценарию можно не давать имя:

useCase {
GET("$host/api/health") then { assert(code == 200) }
GET("$host/api/ready") then { assert(code == 200) }
}

Когда useCase не нужен​

Один запрос в useCase не оборачивается — даже если у него есть блок then. useCase нужен там, где несколько шагов передают данные друг другу.

val order by POST("$host/api/orders") {
contentType("application/json")
body("""{"productId": 42, "quantity": 1}""")
} then {
decode<Order>()
}

Подготовка тестовых данных​

Сценарий полезен не только для проверок. Частая задача — наполнить приложение данными перед ручным тестированием, когда фронтенда ещё нет или нужного эндпоинта в нём не существует:

useCase("Наполнение тестовыми данными") {
POST("$host/api/categories") {
contentType("application/json")
bearerAuth(token)
body("""{"name": "Books"}""")
} then {
assert(code == 201)
}

POST("$host/api/categories") {
contentType("application/json")
bearerAuth(token)
body("""{"name": "Business"}""")
} then {
assert(code == 201)
}
}

Такой сценарий коммитится в репозиторий и раскатывает одинаковый набор данных на любом стенде — это надёжнее, чем повторять те же запросы руками.

Повторяющиеся шаги

Однотипные шаги внутри useCase можно оборачивать в функции и параметризовать. В справочнике DSL этот приём не описан, хотя на практике работает, — проверьте поведение на своей сборке, прежде чем строить на нём большой сценарий.

Типизация ответа​

Объявите data class на верхнем уровне скрипта и разбирайте ответ через decode<T>():

data class Order(val id: Long, val status: String)

val order by GET("$host/api/orders/1") then { decode<Order>() }

Для доступа к отдельным значениям без объявления класса есть JSONPath:

GET("$host/api/stats") then {
val ctx = jsonPath()
val total = ctx.decode<Int>("$.totalCount")
val names = ctx.decode<List<String>>("$.items[*].name")
}