{"blocks":[{"type":"expertLegacy","data":{"id":"1344"}},{"type":"paragraph","data":{"text":"Всем привет! Меня зовут Максим Кочетков. Я занимаюсь тестированием ПО более 10 лет. Из них около 7 лет автоматизацией на Java, Kotlin и Groovy. В команде Мир Plat.Form (ИТ-бренд Национальной системы платёжных карт) я отвечаю за вопросы, связанные с автоматизацией тестирования. Наши сервисы, например, платёжную систему «‎Мир»‎ и Систему быстрых платежей (СБП), используют десятки миллионов россиян."}},{"type":"paragraph","data":{"text":"В этой статье я расскажу, как сделать проект-шаблон для наращивания покрытия любых RestAPI сервисов. Мы создадим проект с нуля: поднимем RestAPI-сервис в контейнере и протестируем с помощью http-клиента Retrofit. Код напишем на Kotlin, а тестовый движок — в сочетании с Kotest. RestAPI-cервис будет реализован как заглушка с помощью библиотеки Wiremock. Поднимать контейнер мы будем в TestContainers. Результат теста сохраним в формате Allure и сгенерируем отчёт."}},{"type":"header2","data":{"level":2,"text":"Настраиваем Wiremock"}},{"type":"paragraph","data":{"text":"Wiremock — это инструмент для создания заглушек HTTP-сервисов, который написан на Java и под капотом использует производительный Netty сервер. Подходит не только для функционального, но и нагрузочного тестирования. Есть аналог MockServer, который создан на NodeJs. Я рекомендую именно Wiremock, потому что для него можно писать расширения на Java для реализации сложного поведения."}},{"type":"paragraph","data":{"text":"Есть 2 варианта описания и регистрации заглушек:"}},{"type":"list","data":{"items":["создать в Java-коде и передавать на сервер через Wiremock Admin API;","оформить в формате json и подкладывать в определённую папку на сервере."],"style":"unordered"}},{"type":"paragraph","data":{"text":"Будем использовать второй вариант — он более наглядный, и его могут редактировать не знакомые с Java коллеги. Например frontend-разработчик способен создавать Wiremock-заглушки для эмуляции backend части."}},{"type":"paragraph","data":{"text":"В ресурсах создаем папку wiremock, в ней под-папки __files и mappings. Названия этих двух директорий зарезервированы Wiremock."}},{"type":"paragraph","data":{"text":"Наш сервис будет иметь один контроллер — Employee с двумя методами POST и GET, на создание и получения сотрудника. Создаем два json файла с описанием заглушек в папке mappings — это описание того, как будет сопоставляться входящий запрос, и как формироваться исходящий ответ. Еще 2 файла в папке __files — это тело ответа, они находятся в отдельной директории. В будущем наша иерархия увеличится, а тело ответа разрастётся на сотню-другую строк, поэтому делаем сразу удобно."}},{"type":"image","data":{"file":{"id":155898,"url":"https://media.tproger.ru/uploads/2021/04/image-7.png"},"alt":"","title":"","caption":"","stretched":false,"withBackground":false,"withBorder":false,"width":492,"height":203,"optimizedFile":{"original":"https://media.tproger.ru/uploads/2021/04/image-7.png","alt":"Делаем типовой проект на Kotlin для тестирования RestAPI сервиса в Docker 1","dimensions":{"width":492,"height":203},"additionalSizes":{"srcSet":[{"url":"https://tproger.ru/signed_image/W5POK5kICKa9xhOAgioAQdwwF0EOe0pYct6nA1Fgtk8/rs:fill:492:0:true/cb:vimg_2/f:webp/aHR0cHM6Ly9tZWRpYS50cHJvZ2VyLnJ1L3VwbG9hZHMvMjAyMS8wNC9pbWFnZS03LnBuZw=","dpr":1,"width":492},{"url":"https://tproger.ru/signed_image/ptrAlfho4DLLY6WK6qjgn9t-sE0GLESM9cjKxV8hqDw/rs:fill:984:0:true/cb:vimg_2/f:webp/aHR0cHM6Ly9tZWRpYS50cHJvZ2VyLnJ1L3VwbG9hZHMvMjAyMS8wNC9pbWFnZS03LnBuZw=","dpr":1,"width":984},{"url":"https://tproger.ru/signed_image/W5POK5kICKa9xhOAgioAQdwwF0EOe0pYct6nA1Fgtk8/rs:fill:492:0:true/cb:vimg_2/f:webp/aHR0cHM6Ly9tZWRpYS50cHJvZ2VyLnJ1L3VwbG9hZHMvMjAyMS8wNC9pbWFnZS03LnBuZw=","dpr":1,"width":492},{"url":"https://tproger.ru/signed_image/ptrAlfho4DLLY6WK6qjgn9t-sE0GLESM9cjKxV8hqDw/rs:fill:984:0:true/cb:vimg_2/f:webp/aHR0cHM6Ly9tZWRpYS50cHJvZ2VyLnJ1L3VwbG9hZHMvMjAyMS8wNC9pbWFnZS03LnBuZw=","dpr":1,"width":984},{"url":"https://tproger.ru/signed_image/W5POK5kICKa9xhOAgioAQdwwF0EOe0pYct6nA1Fgtk8/rs:fill:492:0:true/cb:vimg_2/f:webp/aHR0cHM6Ly9tZWRpYS50cHJvZ2VyLnJ1L3VwbG9hZHMvMjAyMS8wNC9pbWFnZS03LnBuZw=","dpr":1,"width":492},{"url":"https://tproger.ru/signed_image/ptrAlfho4DLLY6WK6qjgn9t-sE0GLESM9cjKxV8hqDw/rs:fill:984:0:true/cb:vimg_2/f:webp/aHR0cHM6Ly9tZWRpYS50cHJvZ2VyLnJ1L3VwbG9hZHMvMjAyMS8wNC9pbWFnZS03LnBuZw=","dpr":1,"width":984},{"url":"https://tproger.ru/signed_image/h50nDNR6VRcSJMtpZQgKneYaKg5RztuxIqRO8BmfsGg/rs:fill:466:0:true/cb:vimg_2/f:webp/aHR0cHM6Ly9tZWRpYS50cHJvZ2VyLnJ1L3VwbG9hZHMvMjAyMS8wNC9pbWFnZS03LnBuZw=","dpr":1,"width":466},{"url":"https://tproger.ru/signed_image/0XNNYu6bc1TOrSqBzGTZxa6JxXaH-8vtlj-oCBKZfII/rs:fill:932:0:true/cb:vimg_2/f:webp/aHR0cHM6Ly9tZWRpYS50cHJvZ2VyLnJ1L3VwbG9hZHMvMjAyMS8wNC9pbWFnZS03LnBuZw=","dpr":1,"width":932}],"sizes":[{"media":"(min-width: 1441px)","size":"492px"},{"media":"(min-width: 1281px)","size":"492px"},{"media":"(min-width: 1281px)","size":"492px"},{"media":"(min-width: 961px)","size":"492px"},{"media":"(min-width: 671px)","size":"492px"},{"media":"(min-width: 500px)","size":"466px"}]}}}},{"type":"paragraph","data":{"text":"Описание заглушки employee_get.json:"}},{"type":"code","data":{"code":"{\n \"request\": {\n \"method\": \"GET\",\n \"urlPathPattern\": \"/employee/\\\\d+\"\n },\n \"response\": {\n \"status\": 200,\n \"bodyFileName\": \"employee_get_body.json\",\n \"headers\": {\n \"Content-Type\": \"application/json;charset=utf-8\"\n }\n }\n}","language":"clike lazy-code"}},{"type":"paragraph","data":{"text":"В заглушке ожидаем method GET с URL-path (все, что после порта) советующим регулярке “/employee/\\\\d+“. Если пришел такой запрос, — отвечаем 200 с указанными"}},{"type":"paragraph","data":{"text":"headers и телом из файла employee_get_body.json:"}},{"type":"code","data":{"code":"{ \"id\": \"{{request.pathSegments.[1]}}\", \"name\": \"Max\"}","language":"clike lazy-code"}},{"type":"paragraph","data":{"text":"В ответе двойные фигурные скобки вызывают встроенный движок шаблонов с широким набором функций. В данном случае — у пришедшего запроса взять сегмент URL-path с индексом 1 (нумерация с 0), то есть ID."}},{"type":"paragraph","data":{"text":"И вторая заглушка в файле employee_post.json"}},{"type":"code","data":{"code":"{\n \"request\": {\n \"method\": \"POST\",\n \"urlPathPattern\": \"/employee\",\n \"basicAuthCredentials\" : {\n \"username\" : \"user\",\n \"password\" : \"user\"\n }\n },\n \"response\": {\n \"status\": 200,\n \"bodyFileName\": \"employee_post_body.json\",\n \"headers\": {\n \"Content-Type\": \"application/json;charset=utf-8\"\n }\n }\n}","language":"clike lazy-code"}},{"type":"paragraph","data":{"text":"Тут все аналогично, но добавляется авторизация basicAuthCredentials. Обрабатываться будут только те запросы, у которых есть заголовок Authorization с логином и паролем в формате Basic авторизации. И ответ employee_post_body.json:"}},{"type":"code","data":{"code":"{\n \"id\": \"{{randomValue length=5 type='NUMERIC'}}\",\n \"name\": \"{{jsonPath request.body '$.name'}}\"\n}","language":"clike lazy-code"}},{"type":"paragraph","data":{"text":"randomValue length=5 type=’NUMERIC’ — функция, которая сгенерирует случайное число с пятью цифрами. А jsonPath request.body ‘$.name’ — взять значение из тела запроса по json-path поле name."}},{"type":"header2","data":{"level":2,"text":"Сборочный Gradle скрипт"}},{"type":"paragraph","data":{"text":"Перед написанием кода нужно настроить сборку нашего проекта и определить зависимости. Используем Gradle 6.8.3. Создаём необходимые файлы в корне проекта, сразу постараемся применить лучшие практики."}},{"type":"paragraph","data":{"text":"Предпочитаю Groovy DSL. Он лучше заточен на работу с замыканиями и благодаря динамической типизации менее многословен, но ничего не имею против Kotlin DSL"}},{"type":"paragraph","data":{"text":"settings.gradle — так как у нас одномодульный проект, то здесь только название. Если бы модулей было несколько, то были бы их имена, а также настройки, которые необходимо выполнить до запуска основного скрипта. Например откуда качать плагины, если у вас корпоративные ограничения:"}},{"type":"code","data":{"code":"rootProject.name = 'article-tprogger-first'","language":"clike lazy-code"}},{"type":"paragraph","data":{"text":"gradle.properties — здесь храним переменные проекта, которые доступны в сборочном скрипте. В основном это версии библиотек:"}},{"type":"code","data":{"code":"kotlin.code.style=official\n## Project Version\nversion=0.1.0\n## Project Group\ngroup=ru.iopump.qa.tprogger\n## Gradle version. Adjust 'Use Gradle From' = 'wrapper task'\ngradleWrapperVersion=6.8.3\n## Gradle Plugins\nbenManesPluginVersion=0.38.0\n## Kotest\nkotlinVersion=1.4.32\nkotestVersion=4.4.3\nkotestAllureVersion=1.0.1\n## Logger\nslf4jVersion=1.7.30\n## Reporting\nallureVersion=2.13.9\nallurePluginVersion=2.8.1\naspectVersion=1.9.6\n## Docker\ntestContainers=1.15.2\n## Http\nretrofitVersion=2.9.0\nokhttpVersion=4.9.1\n## Mock\nwiremockVersion=2.27.2","language":"clike lazy-code"}},{"type":"paragraph","data":{"text":"build.gradle — сборочный скрипт:"}},{"type":"code","data":{"code":"plugins {\n id 'idea'\n id 'com.github.ben-manes.versions' version \"$benManesPluginVersion\"\n id 'org.jetbrains.kotlin.jvm' version \"$kotlinVersion\"\n id \"io.qameta.allure\" version \"$allurePluginVersion\"\n}\nrepositories { mavenLocal(); mavenCentral() }\nwrapper {\n distributionType = Wrapper.DistributionType.ALL\n gradleVersion = gradleWrapperVersion\n}\ntest {\n useJUnitPlatform()\n systemProperties << ['wiremock.version': wiremockVersion]\n}\ndependencies {\n /* Kotlin */\n implementation 'org.jetbrains.kotlin:kotlin-stdlib-jdk8'\n /* Logging API and Impl*/\n implementation \"org.slf4j:slf4j-api:$slf4jVersion\"\n runtimeOnly \"org.slf4j:slf4j-simple:$slf4jVersion\"\n /* Retrofit Lib and Http Client Implementation */\n implementation \"com.squareup.retrofit2:retrofit:$retrofitVersion\"\n implementation \"io.qameta.allure:allure-okhttp3:$allureVersion\"\n /* Retrofit Convertors and Interceptors*/\n implementation \"com.squareup.retrofit2:converter-jackson:$retrofitVersion\"\n implementation \"com.squareup.retrofit2:converter-scalars:$retrofitVersion\"\n implementation \"com.squareup.okhttp3:logging-interceptor:$okhttpVersion\"\n /* Kotest */\n testImplementation \"io.kotest:kotest-runner-junit5:$kotestVersion\"\n testImplementation \"io.kotest:kotest-assertions-core:$kotestVersion\"\n testImplementation \"io.kotest:kotest-property:$kotestVersion\"\n /* Kotest Extensions */\n testImplementation \"ru.iopump.kotest:kotest-allure:$kotestAllureVersion\"\n testImplementation \"io.kotest:kotest-extensions-testcontainers:$kotestVersion\"\n /* Main Testcontainers lib */\n testImplementation \"org.testcontainers:testcontainers:$testContainers\"\n /* Wiremock Client */\n testImplementation \"com.github.tomakehurst:wiremock:$wiremockVersion\"\n}\ntasks.withType(org.jetbrains.kotlin.gradle.tasks.KotlinCompile).configureEach {\n sourceCompatibility = JavaVersion.VERSION_11\n targetCompatibility = JavaVersion.VERSION_11\n kotlinOptions.jvmTarget = JavaVersion.VERSION_11\n}\nallure {\n version = allureVersion\n aspectjVersion = aspectVersion\n autoconfigure = false\n aspectjweaver = true\n resultsDir = file \"$rootDir/allure-results\"\n}","language":"clike lazy-code"}},{"type":"paragraph","data":{"text":"Блок plugins — блок с плагинами для Kotlin, отчетов Allure и ben-manes.versions для обновления версий библиотек."}},{"type":"paragraph","data":{"text":"Блок test — настраиваем тестовый движок на junit5 и записываем в системные переменные теста версию Wiremock, которая пригодится для создания контейнера. На самом деле используем мы Kotest, но через адаптер к Junit5, чтобы переиспользовать весь функционал по интеграции Gradle и JUnit."}},{"type":"paragraph","data":{"text":"Блок tasks.withType(org.jetbrains.kotlin.gradle.tasks.KotlinCompile) — настройка версии Java для всех задач по компиляции (из документации Kotlin)."}},{"type":"paragraph","data":{"text":"Блок allure — настройка генерации отчета. Важно отключить autoconfigure и указать верный путь до результатов resultsDir"}},{"type":"header2","data":{"level":2,"text":"Описываем модель для http-клиента"}},{"type":"paragraph","data":{"text":"Модель сотрудника очень простая:"}},{"type":"code","data":{"code":"data class Employee(\n val id: Int? = null,\n val name: String? = null,\n)","language":"clike lazy-code"}},{"type":"paragraph","data":{"text":"Для DTO всегда используем nullable типы и выставляем по умолчанию null. Иначе могут быть NPE если сервер пришлет не все поля и не получится проверить отсутствие значения."}},{"type":"paragraph","data":{"text":"Retrofit позволяет описывать модель взаимодействия с сервисом с помощью Интерфейсов, где методы и их аргументы аннотируются всей необходимой информацией. Также для работы нужна реализация HTTP-клиента в нашем случае это OkHttp."}},{"type":"paragraph","data":{"text":"Последовательность такая:"}},{"type":"list","data":{"items":["описываем интерфейс взаимодействия;","создаем http клиент с нужным набором перехватчиков (Interseptor);","создаем инстанс Retrofit с базовым URL и созданным ранее http клиентом, а также с конвертором для тела запросов и ответов;","вызываем Retrofit.create<ServiceName>() для создания реализации интерфейса."],"style":"unordered"}},{"type":"paragraph","data":{"text":"Retrofit использует для реализации Java Dynamic Proxy. Аналоги: Feign(Netflix), Jax-rs. По тем же принципам работают ORM фреймворки / Spring Data JPA."}},{"type":"paragraph","data":{"text":"Теперь создаём модель взаимодействия"}},{"type":"code","data":{"code":"interface EmployeeService {\n\n @GET(\"employee/{id}\")\n fun get(@Path(\"id\") id: Int): Call\n\n @POST(\"employee\")\n fun create(\n @Header(\"Authorization\") bearer: String,\n @Body employee: Employee\n ): Call\n}","language":"clike lazy-code"}},{"type":"paragraph","data":{"text":"Каждый метод возвращает объект Call<T> — отложенный вызов. В качестве параметра используется класс DTO. Однако если мы не знаем что нам вернется или не хотим ничего конвертировать (сериализовать), то используем Call<ResponseBody>.ResponseBody. Это специальный класс от Retrofit который содержит сырой ответ."}},{"type":"paragraph","data":{"text":"Если путь начинается со слеша (/) , то Retrofit посчитает его корневым и удалит всё, что после порта в базовом URL. Например для @GET(“/employee”) адрес “http://localhost:80/one/two” превратится в “http://localhost:80/employee”, а для @GET(“employee”) в “http://localhost:80/one/two/employee”. "}},{"type":"paragraph","data":{"text":"Чтобы всё запустить необходимо инициировать запрос, вызвав блокирующий метод Call<T>.execute(). Он выполнит запрос, получит ответ и вернёт нам результат в виде контейнера Response<T>. Контейнер содержит все параметры ответа в том числе код и статус ответа, и сконвертированное тело."}},{"type":"paragraph","data":{"text":"Создадим утилитный класс для работы с Retrofit"}},{"type":"code","data":{"code":"object HttpUtil {\n private val log = LoggerFactory.getLogger(HttpUtil::class.java)\n\n val slf4jInterceptor: Interceptor = HttpLoggingInterceptor(log::info).apply {\n when {\n log.isTraceEnabled -> setLevel(HttpLoggingInterceptor.Level.BODY)\n log.isDebugEnabled -> setLevel(HttpLoggingInterceptor.Level.HEADERS)\n log.isInfoEnabled -> setLevel(HttpLoggingInterceptor.Level.BASIC)\n else -> setLevel(HttpLoggingInterceptor.Level.NONE)\n }\n }\n\n val allureInterceptor: Interceptor = AllureOkHttp3()\n\n val jsonConverter: Converter.Factory = JacksonConverterFactory.create()\n\n private fun createOkHttpClient(interceptors: Collection) =\n OkHttpClient.Builder().apply {\n interceptors.forEach { interceptor -> addInterceptor(interceptor) }\n }.build()\n \n fun createRetrofit(\n baseUrl: String,\n converter: Converter.Factory,\n interceptors: Collection\n ): Retrofit = Retrofit.Builder()\n .baseUrl(baseUrl)\n .client(createOkHttpClient(interceptors))\n .addConverterFactory(converter)\n .build()\n}","language":"clike lazy-code"}},{"type":"paragraph","data":{"text":"slf4jInterceptor — перехватчик для логирования всех запросов в Slf4J. В зависимости от уровня Slf4J устанавливаются подробности журналирования."}},{"type":"paragraph","data":{"text":"allureInterceptor — перехватчик для добавления всех запросов в Allure отчет."}},{"type":"paragraph","data":{"text":"jsonConverter — конвертер для Json запросов и ответов. Все конверторы идут как дополнительные зависимости от разработчиков Retrofit. Важно помнить, что этот конвертор всегда будет пытаться преобразовать в Json и будет выдавать ошибку, если формат тела некорректен. Существует множество видов конверторов и нужно аккуратно выбирать подходящий. Либо создавать свой вариант со сложной логикой. Есть возможность получать сырые запросы через Call<ResponseBody> в обход конвертора."}},{"type":"paragraph","data":{"text":"createOkHttpClient — функция для создания клиента с перехватчиками."}},{"type":"paragraph","data":{"text":"createRetrofit — функция для создания Retrofit с базовым URL, с перехватчиками и конвертором."}},{"type":"header2","data":{"level":2,"text":"Создаём конфигурацию тестов"}},{"type":"paragraph","data":{"text":"Перед написанием тестов выполним настройку движка и создадим класс Registry необходимых объектов, чтобы держать их в единичном экземпляре."}},{"type":"paragraph","data":{"text":"Для конфигурации тестов я предпочитаю использовать Spring Test и паттерн Dependency Injection. Но в статье мы этого делать конечно же не будем, так как это слишком большая тема."}},{"type":"paragraph","data":{"text":"Создаём класс-наследник от AbstractProjectConfig. Это позволит Kotest найти наш класс в classpath и применить переопределённые методы."}},{"type":"code","data":{"code":"object RegistryAndProjectConfiguration : AbstractProjectConfig() {\n\n override val parallelism: Int = 2\n\n private val wiremockVersion: String = System.getProperty(\"wiremock.version\")\n\n val GenericContainer<*>.containerUrl: String\n get() = \"http://$containerIpAddress:$firstMappedPort\"\n\n val wiremockContainer = GenericContainer(\n \"rodolpheche/wiremock:$wiremockVersion\"\n ).apply {\n withExposedPorts(8080)\n withCommand(\"--verbose\", \"--global-response-templating\")\n withClasspathResourceMapping(\"wiremock\", \"/home/wiremock\", BindMode.READ_ONLY)\n }\n\n val wiremockClient: WireMock by lazy {\n WireMock.create()\n .host(wiremockContainer.containerIpAddress)\n .port(wiremockContainer.firstMappedPort)\n .build()\n }\n\n val retrofitJson: Retrofit by lazy {\n HttpUtil.createRetrofit(\n wiremockContainer.containerUrl, \n jsonConverter,\n listOf(allureInterceptor, slf4jInterceptor)\n )\n }\n\n val employeeService: EmployeeService by lazy { retrofitJson.create() }\n\n override fun listeners(): List = listOf(\n wiremockContainer.perProject(\"wiremock\")\n )\n\n}","language":"clike lazy-code"}},{"type":"paragraph","data":{"text":"parallelism — это настройка Kotest, здесь указываем размер пула потоков для тестовых классов. Тесты внутри тестовых классов будут выполняться в одном потоке."}},{"type":"paragraph","data":{"text":"wiremockVersion — версия Wiremock из системной переменной, которую мы передали из build.gradle."}},{"type":"paragraph","data":{"text":"containerUrl — расширение для типа GenericContainer, чтобы собрать базовый URL доступа к контейнеру с хост машины."}},{"type":"paragraph","data":{"text":"wiremockContainer — описание контейнера Wiremock. В конструкторе задаем образ, а далее настройки:"}},{"type":"list","data":{"items":["withExposedPorts(8080) — пробрасываем внутренний порт 8080 на внешний случайный;","withCommand — добавляем аргументы к запуску сервер. –verbose — включить вывод логов. –global-response-templating — включить движок шаблонов Wiremock, для обработки выражений вида {{ function }};","withClasspathResourceMapping — смонтировать содержимое папки wiremock/ из тестовых ресурсов в нашем проекте на внутреннюю директорию контейнера /home/wiremock — отсюда Wiremock прочитает все описания заглушек. BindMode.READ_ONLY — означает, что во время работы Wiremock не сможет изменит содержание нашей локальной папки, даже если почистит смонтированную директорию в контейнере."],"style":"unordered"}},{"type":"paragraph","data":{"text":"wiremockClient — создаём клиент для настройки сервера Wiremock из кода тестов. Здесь используется делегат lazy для обеспечения ленивой инициализации по первому запросу, а в последующие запросы возвращает вычисленное значение и делает это потокобезопасно. Без lazy работать не будет, так как на момент создания нашей конфигурации контейнер ещё не запущен, и у него нет адреса и порта. А первый запрос делает из прогона теста, когда контейнер уже поднят."}},{"type":"paragraph","data":{"text":"retrofitJson — создаем инстанс Retrofit c базовым URL на контейнер, json конвертором и двумя перехватчиками. Также используем lazy."}},{"type":"paragraph","data":{"text":"employeeService — создаём реализацию интерфейса для доступа к сервису employee, так же в одном экземпляре."}},{"type":"paragraph","data":{"text":"listeners() — расширяем Kotest двумя слушателями."}},{"type":"list","data":{"items":["wiremockContainer.perProject — контроль за жизненным циклом контейнера, в данном случае один запуск на весь прогон (есть и другие варианты)"],"style":"unordered"}},{"type":"paragraph","data":{"text":"Конфигурация готова! Переходим к созданию тестов!"}},{"type":"header2","data":{"level":2,"text":"Создаём тестовый класс"}},{"type":"paragraph","data":{"text":"У нас будет пример с одним тестовым классом и двумя тестами внутри."}},{"type":"paragraph","data":{"text":"Kotest оперирует понятием спецификация, а не тестовый класс. Мы тоже будем с этого момента использовать понятие спецификация, а в голове держать, что это тоже самое, что тестовый класс. А тест мы будем называть сценарием. Внутри сценария будут шаги в BDD стиле Дано-Когда-Тогда."}},{"type":"paragraph","data":{"text":"Делаем заготовку для двух сценариев:"}},{"type":"code","data":{"code":"@Epic(\"Tproger example\")\n@Feature(\"Employee endpoint\")\n@Story(\"CRUD\")\n@Link(\"tproger.ru\", url = \"https://tproger.ru/\")\nclass EmployeeSpec : FreeSpec() {\n\n override fun concurrency(): Int = 2\n\n init {\n \"Scenario: Getting employee by id\" - { }\n\n \"Scenario: Creating new employee\" - { }\n }\n}","language":"clike lazy-code"}},{"type":"paragraph","data":{"text":"Спецификацию наследуем от FreeSpec. Это один из стилей написания тестов, который я предпочитаю использовать. Для простых unit-тестов рекомендую брать StringSpec."}},{"type":"paragraph","data":{"text":"Allure аннотации над тестом нужно для упорядочивания в отчете и связей с внешними системами контроля задач, требованиё и тестовых сценариев (приведены далеко не все):"}},{"type":"list","data":{"items":["@Epic — верхний уровень иерархии тестов и сущностей в Jira;","@Feature — тестируемый функционал;","@Story — минимальный законченный кусочек функционала с бизнес смыслом;","@Link — ссылка на требования либо несколько ссылок – @Links."],"style":"unordered"}},{"type":"paragraph","data":{"text":"concurrency() — устанавливаем количество одновременно запущенных сценариев. Отмечу, что запускаться они будут в одном потоке, но асинхронно. Как? Благодаря использованию coroutines в Kotest — каждый сценарий и его шаги это suspend-функции и запускаются в корутинах, таким образом Kotlin занимается управлением последовательностью команд в конкурентной среде. Фактически в тесте у нас есть неблокирующий вызов ввода/вывода при выполнении запроса к серверу и ожидании ответа, на который и тратится основное время (и не один). Это время простоя в ожидании ответа от сервера и позволяет выполнять тесты асинхронно в одном потоке и более эффективно использовать процессорное время!"}},{"type":"paragraph","data":{"text":"Блок init — в этом блоке мы собираем нашу тестовую модель. Сейчас там два сценария без реализации. Синтаксис “строка” — { } создаёт контейнер для будущих шагов сценария (обратите внимание, что используется оператор minus)."}},{"type":"paragraph","data":{"text":"Уже сейчас можно запустить пустую модель и получить отчет, например для проведения review."}},{"type":"paragraph","data":{"text":"Добавляем первый сценарий:"}},{"type":"code","data":{"code":"\"Scenario: Getting employee by id\" - {\n\n var expectedId = 0\n \"Given test environment is up and test data prepared\" {\n expectedId = Arb.positiveInts().next()\n }\n\n lateinit var response: Response\n \"When client sent request to get the employee by id=$expectedId\" {\n response = employeeService.get(expectedId).awaitResponse()\n }\n\n \"Then client received response with status 200 and id=$expectedId\" {\n response.asClue {\n it.code() shouldBe 200\n it.body().shouldNotBeNull().asClue { employee ->\n employee.name shouldBe \"Max\"\n employee.id shouldBe expectedId\n }\n }\n }\n }","language":"clike lazy-code"}},{"type":"paragraph","data":{"text":"В первом шаге используем генератор случайных данных Arb из библиотек Kotest."}},{"type":"paragraph","data":{"text":"Во втором шаге берём из Registry объектов employeeService, — вызов get() отдает объект Call<Employee>, а неблокирующий метод awaitResponse() возвращает результат Response<Employee>, который сохраняем в response."}},{"type":"paragraph","data":{"text":"В третьем шаге проверяем ответ:"}},{"type":"list","data":{"items":["response.asClue — если внутри блока asClue случится ошибка проверки, то в дополнении в ожидаемому и актуальному результату в сообщение AssertionError будет добавлен вывод toString() целого объекта response;","it.code() shouldBe 200 — проверяем статус код. shouldBe — базовая проверка из библиотеки ассертов Kotest;","it.body().shouldNotBeNull().asClue — получаем тело, проверяем на null, при этом не используем !! , так как хотим получить AssertionError с полноценным описанием ошибки, а не NPE. Далее вызов asClue необходим, чтобы добавить в сообщение об ошибке весь объект employee, так как toString() вышестоящего response не выводит тело, а лишь метаинформацию;","далее проверяем каждое поле employee."],"style":"unordered"}},{"type":"paragraph","data":{"text":"Ещё отмечу, что в шагах используется интерполяция строк, и в название добавляются ожидаемые значения, что очень помогает при анализе отчётов о выполнении."}},{"type":"paragraph","data":{"text":"Теперь сценарий на создание сотрудника:"}},{"type":"code","data":{"code":"\"Scenario: Creating new employee\" - {\n\n lateinit var employee: Employee\n \"Given test environment is up and test data prepared\" {\n employee = Employee(\n name = Arb.stringPattern(\"[A-Z]{1}[a-z]{5,10}\").next()\n )\n }\n\n lateinit var response: Response\n val basic = Credentials.basic(\"user\", \"user\")\n \"When client sent request to create new $employee\" {\n response = employeeService.create(basic, employee).awaitResponse()\n }\n\n \"Then server received request with $employee\" {\n wiremockClient.verifyThat(\n 1,\n WireMock.postRequestedFor(WireMock.urlPathEqualTo(\"/employee\"))\n .withHeader(\"Authorization\", WireMock.equalTo(basic))\n )\n }\n\n \"And client received response with status 200 and $employee\" {\n response.asClue {\n it.code() shouldBe 200\n it.body().shouldNotBeNull().asClue { e ->\n e.name shouldBe employee.name\n e.id.shouldNotBeNull().shouldBePositive()\n }\n }\n }\n }","language":"clike lazy-code"}},{"type":"paragraph","data":{"text":"В первом шаге используем генерацию строки по регулярному выражению Arb.stringPattern. Проще подключить Faker для генерации красивых имен, но сейчас нам не нужны лишние зависимости."}},{"type":"paragraph","data":{"text":"Во втором шаге отправляем запрос также как в первом тесте, но добавляем данные Basic авторизации в заголовок — Credentials.basic(“user”, “user”)"}},{"type":"paragraph","data":{"text":"Третий шаг — проверяем, что пришло на сервер заглушек. Метод wiremockClient.verifyThat отправляет запрос на сервер Wiremock, чтобы удостовериться, пришёл ли туда ровно один ожидаемый запрос с URL-path равным /employee и заголовком Authorization со значением созданной ранее Basic авторизацией. Часто этой проверкой пренебрегаю. Если Wiremock используется для эмуляции интеграции с другим сервисом, то крайне важно верифицировать все пришедшие запросы! "}},{"type":"paragraph","data":{"text":"И четвертый шаг почти полностью повторяет последний шаг из первого теста."}},{"type":"header2","data":{"level":2,"text":"Запускаем и генерируем отчет"}},{"type":"paragraph","data":{"text":"Всё готово к первому запуску. Осталось проверить, что в системе запущен Docker и есть разрешение на монтирование диска, где расположен проект. Ну и установлен JDK не ниже 11 версии. И ещё нужно установить в Idea плагин для Kotest, чтобы наблюдать результаты выполнения в динамике."}},{"type":"paragraph","data":{"text":"Выполняем в нашем проекте задачу gradle test из группы verification через Gradle Tools в Idea и наблюдаем за результатом:"}},{"type":"image","data":{"file":{"id":158776,"url":"https://media.tproger.ru/uploads/2021/04/image-10-1.png"},"alt":"","title":"","caption":"Обратите внимание на ход тестирования — оба сценария будут выполняться одновременно.","stretched":false,"withBackground":false,"withBorder":false,"width":675,"height":281,"optimizedFile":{"original":"https://media.tproger.ru/uploads/2021/04/image-10-1.png","alt":"Делаем типовой проект на Kotlin для тестирования RestAPI сервиса в Docker 2","dimensions":{"width":675,"height":281},"additionalSizes":{"srcSet":[{"url":"https://tproger.ru/signed_image/5UnkTvnFacV_5bdgqdar96YqCgTsmZIUdQvDtvEmnIY/rs:fill:675:0:true/cb:vimg_2/f:webp/aHR0cHM6Ly9tZWRpYS50cHJvZ2VyLnJ1L3VwbG9hZHMvMjAyMS8wNC9pbWFnZS0xMC0xLnBuZw=","dpr":1,"width":675},{"url":"https://tproger.ru/signed_image/Ry0nHSbtfpqytn2sZ_8yycm2cE-0_GqzmpmuDhEfur8/rs:fill:1350:0:true/cb:vimg_2/f:webp/aHR0cHM6Ly9tZWRpYS50cHJvZ2VyLnJ1L3VwbG9hZHMvMjAyMS8wNC9pbWFnZS0xMC0xLnBuZw=","dpr":1,"width":1350},{"url":"https://tproger.ru/signed_image/5UnkTvnFacV_5bdgqdar96YqCgTsmZIUdQvDtvEmnIY/rs:fill:675:0:true/cb:vimg_2/f:webp/aHR0cHM6Ly9tZWRpYS50cHJvZ2VyLnJ1L3VwbG9hZHMvMjAyMS8wNC9pbWFnZS0xMC0xLnBuZw=","dpr":1,"width":675},{"url":"https://tproger.ru/signed_image/Ry0nHSbtfpqytn2sZ_8yycm2cE-0_GqzmpmuDhEfur8/rs:fill:1350:0:true/cb:vimg_2/f:webp/aHR0cHM6Ly9tZWRpYS50cHJvZ2VyLnJ1L3VwbG9hZHMvMjAyMS8wNC9pbWFnZS0xMC0xLnBuZw=","dpr":1,"width":1350},{"url":"https://tproger.ru/signed_image/Cp9GGOLx_XQAs2s3k1VAO484GPjdM7ZfFsgLZXTddp4/rs:fill:636:0:true/cb:vimg_2/f:webp/aHR0cHM6Ly9tZWRpYS50cHJvZ2VyLnJ1L3VwbG9hZHMvMjAyMS8wNC9pbWFnZS0xMC0xLnBuZw=","dpr":1,"width":636},{"url":"https://tproger.ru/signed_image/6PXJfo3F4QLDwtM1YyeSAKtyJCA3AccSPUf4x5G9iUE/rs:fill:1272:0:true/cb:vimg_2/f:webp/aHR0cHM6Ly9tZWRpYS50cHJvZ2VyLnJ1L3VwbG9hZHMvMjAyMS8wNC9pbWFnZS0xMC0xLnBuZw=","dpr":1,"width":1272},{"url":"https://tproger.ru/signed_image/eEd_UqO83R56N3GrvWj0B2nso6hQQO8HH2tK_SgxA-w/rs:fill:466:0:true/cb:vimg_2/f:webp/aHR0cHM6Ly9tZWRpYS50cHJvZ2VyLnJ1L3VwbG9hZHMvMjAyMS8wNC9pbWFnZS0xMC0xLnBuZw=","dpr":1,"width":466},{"url":"https://tproger.ru/signed_image/56kjeYEXPb4imSM2C1ypqvpClGecqp8eU-adqDNMBfU/rs:fill:932:0:true/cb:vimg_2/f:webp/aHR0cHM6Ly9tZWRpYS50cHJvZ2VyLnJ1L3VwbG9hZHMvMjAyMS8wNC9pbWFnZS0xMC0xLnBuZw=","dpr":1,"width":932}],"sizes":[{"media":"(min-width: 1441px)","size":"675px"},{"media":"(min-width: 1281px)","size":"675px"},{"media":"(min-width: 1281px)","size":"675px"},{"media":"(min-width: 961px)","size":"675px"},{"media":"(min-width: 671px)","size":"636px"},{"media":"(min-width: 500px)","size":"466px"}]}}}},{"type":"paragraph","data":{"text":"Осталось сгенерировать отчет Allure."}},{"type":"paragraph","data":{"text":"Выполняем gradle allureReport из группы other также через Gradle Tools. Результат можно наблюдать в папке build/reports/allure-report, открыв index.html в браузере. Но обязательно через контекстное меню, так как для корректного отображения отчета необходим web-сервер, который нам любезно обеспечивает Idea. Есть вариант выполнить gradle allureServe, — тогда web-сервер запустит Gradle плагин."}},{"type":"image","data":{"file":{"id":158775,"url":"https://media.tproger.ru/uploads/2021/04/image-12-1.png"},"alt":"","title":"","caption":"ПКМ на index.html","stretched":false,"withBackground":false,"withBorder":false,"width":541,"height":228,"optimizedFile":{"original":"https://media.tproger.ru/uploads/2021/04/image-12-1.png","alt":"Делаем типовой проект на Kotlin для тестирования RestAPI сервиса в Docker 3","dimensions":{"width":541,"height":228},"additionalSizes":{"srcSet":[{"url":"https://tproger.ru/signed_image/p1Wwvb_fjkfeotCaCqApVMzeD1oYC-VAh2JUn6PNovU/rs:fill:541:0:true/cb:vimg_2/f:webp/aHR0cHM6Ly9tZWRpYS50cHJvZ2VyLnJ1L3VwbG9hZHMvMjAyMS8wNC9pbWFnZS0xMi0xLnBuZw=","dpr":1,"width":541},{"url":"https://tproger.ru/signed_image/TWjm4LhwO7QKfT43NYVQ5coiZuuRPtUY9Hlknjwp_cE/rs:fill:1082:0:true/cb:vimg_2/f:webp/aHR0cHM6Ly9tZWRpYS50cHJvZ2VyLnJ1L3VwbG9hZHMvMjAyMS8wNC9pbWFnZS0xMi0xLnBuZw=","dpr":1,"width":1082},{"url":"https://tproger.ru/signed_image/p1Wwvb_fjkfeotCaCqApVMzeD1oYC-VAh2JUn6PNovU/rs:fill:541:0:true/cb:vimg_2/f:webp/aHR0cHM6Ly9tZWRpYS50cHJvZ2VyLnJ1L3VwbG9hZHMvMjAyMS8wNC9pbWFnZS0xMi0xLnBuZw=","dpr":1,"width":541},{"url":"https://tproger.ru/signed_image/TWjm4LhwO7QKfT43NYVQ5coiZuuRPtUY9Hlknjwp_cE/rs:fill:1082:0:true/cb:vimg_2/f:webp/aHR0cHM6Ly9tZWRpYS50cHJvZ2VyLnJ1L3VwbG9hZHMvMjAyMS8wNC9pbWFnZS0xMi0xLnBuZw=","dpr":1,"width":1082},{"url":"https://tproger.ru/signed_image/p1Wwvb_fjkfeotCaCqApVMzeD1oYC-VAh2JUn6PNovU/rs:fill:541:0:true/cb:vimg_2/f:webp/aHR0cHM6Ly9tZWRpYS50cHJvZ2VyLnJ1L3VwbG9hZHMvMjAyMS8wNC9pbWFnZS0xMi0xLnBuZw=","dpr":1,"width":541},{"url":"https://tproger.ru/signed_image/TWjm4LhwO7QKfT43NYVQ5coiZuuRPtUY9Hlknjwp_cE/rs:fill:1082:0:true/cb:vimg_2/f:webp/aHR0cHM6Ly9tZWRpYS50cHJvZ2VyLnJ1L3VwbG9hZHMvMjAyMS8wNC9pbWFnZS0xMi0xLnBuZw=","dpr":1,"width":1082},{"url":"https://tproger.ru/signed_image/pVoCgRey9Yk0DDeHEFdlr56py8oSQy983qmtGNcY-V8/rs:fill:466:0:true/cb:vimg_2/f:webp/aHR0cHM6Ly9tZWRpYS50cHJvZ2VyLnJ1L3VwbG9hZHMvMjAyMS8wNC9pbWFnZS0xMi0xLnBuZw=","dpr":1,"width":466},{"url":"https://tproger.ru/signed_image/Q6mcEKNHnYVynRlDMp8b2LiuWoFx4rSh5DRFkh-atdA/rs:fill:932:0:true/cb:vimg_2/f:webp/aHR0cHM6Ly9tZWRpYS50cHJvZ2VyLnJ1L3VwbG9hZHMvMjAyMS8wNC9pbWFnZS0xMi0xLnBuZw=","dpr":1,"width":932}],"sizes":[{"media":"(min-width: 1441px)","size":"541px"},{"media":"(min-width: 1281px)","size":"541px"},{"media":"(min-width: 1281px)","size":"541px"},{"media":"(min-width: 961px)","size":"541px"},{"media":"(min-width: 671px)","size":"541px"},{"media":"(min-width: 500px)","size":"466px"}]}}}},{"type":"paragraph","data":{"text":"А вот как будет выглядеть отчет о тестировании:"}},{"type":"image","data":{"file":{"id":156591,"url":"https://media.tproger.ru/uploads/2021/04/image-14.png"},"alt":"","title":"","caption":"","stretched":false,"withBackground":false,"withBorder":false,"width":1905,"height":937,"optimizedFile":{"original":"https://media.tproger.ru/uploads/2021/04/image-14.png","alt":"Делаем типовой проект на Kotlin для тестирования RestAPI сервиса в Docker 4","dimensions":{"width":1905,"height":937},"additionalSizes":{"srcSet":[{"url":"https://tproger.ru/signed_image/uNtZSJk9opGkRKU7DNkC_pFZuPrTELWy9JC_AiytCFA/rs:fill:766:0:true/cb:vimg_2/f:webp/aHR0cHM6Ly9tZWRpYS50cHJvZ2VyLnJ1L3VwbG9hZHMvMjAyMS8wNC9pbWFnZS0xNC5wbmc","dpr":1,"width":766},{"url":"https://tproger.ru/signed_image/mPOAYZ0w5UTgvwIfQL7uHMcHHxA7ktkWHeQtQDj2qmo/rs:fill:1532:0:true/cb:vimg_2/f:webp/aHR0cHM6Ly9tZWRpYS50cHJvZ2VyLnJ1L3VwbG9hZHMvMjAyMS8wNC9pbWFnZS0xNC5wbmc","dpr":1,"width":1532},{"url":"https://tproger.ru/signed_image/X1gymravLOqfYjv1rq7j5VHKawrHuDDBSQz2MIPvquQ/rs:fill:686:0:true/cb:vimg_2/f:webp/aHR0cHM6Ly9tZWRpYS50cHJvZ2VyLnJ1L3VwbG9hZHMvMjAyMS8wNC9pbWFnZS0xNC5wbmc","dpr":1,"width":686},{"url":"https://tproger.ru/signed_image/EoBAHYrEDs2nbSTu-opfDn2SbCrLVkLPgOZUaJtCOKI/rs:fill:1372:0:true/cb:vimg_2/f:webp/aHR0cHM6Ly9tZWRpYS50cHJvZ2VyLnJ1L3VwbG9hZHMvMjAyMS8wNC9pbWFnZS0xNC5wbmc","dpr":1,"width":1372},{"url":"https://tproger.ru/signed_image/kFhQCaPR82IsA7rk_hMYNPHfZYeES1ksQhURtMyFBVQ/rs:fill:636:0:true/cb:vimg_2/f:webp/aHR0cHM6Ly9tZWRpYS50cHJvZ2VyLnJ1L3VwbG9hZHMvMjAyMS8wNC9pbWFnZS0xNC5wbmc","dpr":1,"width":636},{"url":"https://tproger.ru/signed_image/REHqT14_OPXtmbahKQ_7yYfE8cw9ntE6siPaycOJB3c/rs:fill:1272:0:true/cb:vimg_2/f:webp/aHR0cHM6Ly9tZWRpYS50cHJvZ2VyLnJ1L3VwbG9hZHMvMjAyMS8wNC9pbWFnZS0xNC5wbmc","dpr":1,"width":1272},{"url":"https://tproger.ru/signed_image/6_YBPpbUuu1zpyekd5vTggeKc-64oQlVjmf7EXzVIdE/rs:fill:466:0:true/cb:vimg_2/f:webp/aHR0cHM6Ly9tZWRpYS50cHJvZ2VyLnJ1L3VwbG9hZHMvMjAyMS8wNC9pbWFnZS0xNC5wbmc","dpr":1,"width":466},{"url":"https://tproger.ru/signed_image/IfkbEaZ9os2nKJtUbSPvvB_Lrd-rTCv0HdYUnskaqHQ/rs:fill:932:0:true/cb:vimg_2/f:webp/aHR0cHM6Ly9tZWRpYS50cHJvZ2VyLnJ1L3VwbG9hZHMvMjAyMS8wNC9pbWFnZS0xNC5wbmc","dpr":1,"width":932}],"sizes":[{"media":"(min-width: 1441px)","size":"766px"},{"media":"(min-width: 1281px)","size":"686px"},{"media":"(min-width: 1281px)","size":"766px"},{"media":"(min-width: 961px)","size":"766px"},{"media":"(min-width: 671px)","size":"636px"},{"media":"(min-width: 500px)","size":"466px"}]}}}},{"type":"paragraph","data":{"text":"Самый удобный вид для просмотра тестовой модели и результатов — Behaviors в левом меню. Два наших сценария находятся в конце структуры Epic -> Feature -> Story, которые мы описали в виде аннотация в тесте. В правой области расположено содержимое теста, а также присутствует активная ссылка из аннотации @Link и два вложения от allureInterceptor для http клиента: Request и Response. Обычно такие отчёты хранятся в специальном плагине для CI либо на отдельном сервере отчётов, где можно собирать метрики и анализировать результаты."}},{"type":"paragraph","data":{"text":"На этом всё!"}},{"type":"header2","data":{"level":2,"text":"Заключение"}},{"type":"paragraph","data":{"text":"Готовый проект, с написанным выше тестом, вы найдёте в моём GitHub. В итоге мы создали полноценный проект, готовый к масштабированию на сотни и тысячи API тестов."}},{"type":"paragraph","data":{"text":"Мы настроили Gradle сборку с плагинами для поддержки Kotlin и Allure отчётов. Сконфигурировали запуск тестов и максимально упростили работу с версиями зависимостей. Мы научились настраивать сервер заглушек Wiremock и запускать его в контейнере из кода тестов. Освоили Retrofit и дополнения к нему."}},{"type":"paragraph","data":{"text":"А самое главное научились быстро писать тесты с помощью тестового движка Kotest, генерировать тестовые данные и запускать сценарии параллельно."}},{"type":"paragraph","data":{"text":"Успехов вам в освоении новых технологий!"}}]}

Ошибка в настройках сайта