Оптимизация тестирования веб-интерфейса с помощью Arquillian, Docker и Selenium (часть 1)

Введение в проблему

Большую часть времени, когда вам нужно писать функциональные тесты / сквозные тесты для веб-интерфейса, вы в конечном итоге используете Selenium , который он может рассматривать в качестве фактического инструмента в мире Java для тестирования веб-интерфейса. Я уверен, что вы уже использовали его для такого рода тестов.

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

Например, одна из основных проблем, которые обычно встречаются в функциональных тестах, — это подготовка среды, для запуска тестов вам нужно загрузить сервер и развернуть приложение, затем установить / запустить базу данных, а также, возможно, систему кеша и т. Д. со всеми серверами, оставляя пользователю возможность локальной установки каждого сервиса. Могут возникнуть некоторые ошибки, например, установка неверной версии сервера, используемой в производственной среде, повторное использование другой локальной установки базы данных, которая может отличаться от версии, или, например, запуск их в другой версии JDK, отличной от той, которая используется в производственной среде.

Но также есть и другие проблемы, которые более специфичны для тестирования веб-интерфейса, такие как установка браузера или настройка свойств WebDriver.

Исправление первой проблемы

Чтобы решить первую проблему, самое простое решение, которое вы можете себе представить, — это использование контейнеров Docker и, конечно, создание Docker, поскольку вы можете определять и запускать мультиконтейнерные приложения Docker. Таким образом, в основном вы определяете в файле docker-compose все серверы, которые могут вам понадобиться для запуска тестов, поэтому при запуске тестов у вас все они работают и, что более важно, с фиксированной версией, поэтому вы можете быть уверены, что тесты всегда работать с известной / желаемой конкретной версией серверов, тем же JDK,… и не в зависимости от того, что установлено в машине разработчиков / CI.

Но у этого подхода есть одна проблема. Вам нужно специально запустить docker-compose up , docker-compose down. Конечно, вы можете автоматизировать это в своем скрипте сборки, который решит проблему в среде CI, но если разработчик хочет выполнить тест из IDE, скажем, для отладки, то он должен знать об этом факте.

И это то, что решает Arquillian Cube . Arquillian Cube — это расширение Arquillian, использующее файл docker-compose для запуска и настройки всех определенных в нем контейнеров, выполнения тестов и, наконец, закрытия всех из них. Хорошей новостью является то, что, поскольку Arquillian работает с JUnit (и TestNG и Spock), вы можете запускать тесты из IDE, не беспокоясь о запуске и остановке контейнеров, поскольку жизненным циклом Docker управляет Arquillian Cube.

Итак, первая часть проблемы, которая определяет среду тестирования, исправлена ​​с помощью Arquillian Cube. Давайте посмотрим, как исправить второй.

Исправление второй проблемы

Проект Selenium предоставляет образы Docker с автономным Selenium или узлом Selenium с браузером (Firefox или Chrome) и установленным сервером VNC.

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

Новые проблемы при использовании Docker для тестирования

И это круто, но у него есть некоторые проблемы. Во-первых, вам нужно создать файл docker-compose, специфичный для целей тестирования, хотя это само по себе неплохо, но для поддержки этого файла требуется больше управления со стороны dev и, конечно, повторять снова и снова. во всех проектах, которые вы хотите использовать, определяя используемый браузер и образ клиента VNC, чтобы получить запись для будущего осмотра.

Вторая проблема — это конфигурация WebDriver. При запуске WebDriver с удаленным браузером вам необходимо установить местоположение (IP) браузера и настроить RemoteWebDriver в соответствии с желаемыми возможностями.

Поэтому вам снова и снова приходится писать во всех тестах конфигурацию WebDriver. Вы можете создать фабричный класс, который можно повторно использовать во всех проектах, и это хорошо, но у вас все еще есть одна проблема: некоторые разработчики могут использовать машину Docker, поэтому IP-адрес не будет статичным и может меняться каждый раз, другие могут использовать собственный Docker, и, например, некоторые фазы конвейера CI могут запускать тесты в удаленной полностью среде, такой как среда подготовки, поэтому перед выполнением тестов вам потребуется вручную указать IP-адрес контейнера хоста Docker.

И третья проблема, с которой вы столкнетесь, заключается в том, что вам нужно дать WebDriver команду открыть страницу: webdriver.get («http://www.google.com»);

Проблема в том, что в этом случае браузер находится внутри инфраструктуры Docker, поэтому вам нужно установить внутренний IP-адрес контейнера сервера, поэтому вам нужно знать не только IP-адрес хоста Docker для подключения к удаленному веб-драйверу, но и внутренний IP-адрес контейнера сервера для открытия страницы в удаленном браузере с помощью
получить метод. И снова это может быть довольно трудно приобрести автоматически.

Но все эти проблемы решаются при использовании новой интеграции между Arquillian Drone и Arquillian Cube.

Исправление новых проблем

Arquillian Drone — это расширение Arquillian, которое интегрирует Selenium WebDriver в Arquillian. Это расширение управляет конфигурацией WebDriver, поэтому вам не нужно повторять его во всех ваших тестах, а также на протяжении всего жизненного цикла браузера.

Итак, как вы можете видеть, эта пара расширений идеально подходит для решения этих проблем. Drone заботится о конфигурации, в то время как Cube заботится о правильной настройке контейнеров Selenium / VNC, их запуске и остановке.

Как вы можете видеть, вам не нужно беспокоиться о создании файла docker-compose для тестирования. Вам нужно только создать тот, который используется для развертывания, а Arquillian позаботится обо всем остальном.

пример

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

Важно отметить, что вы используете определения спецификации для установки версий компонентов. Затем мы устанавливаем зависимость Arquillian Standalone, потому что наш тест не будет иметь
Метод @Deployment, поскольку файл развертывания уже создан внутри образа Docker, используемого в приложении. Наконец, добавлены зависимости Arquillian Cube и Arquillian Drone.

Следующим шагом является создание в src / test / resources файла arquillian.xml, который используется для настройки расширений.

Ты это видишь:

• Вам необходимо указать имя док-машины, где запускать контейнеры в случае использования док-машины. Если вы используете собственный Docker, вам не нужно устанавливать этот атрибут.
• Вам необходимо указать местоположение относительно корневой папки проекта, в которой находится файл docker-compose . Обратите внимание, что вы можете использовать любое другое имя.

Вы можете настроить WebDriver, а также настроить Arquillian Drone ( https://docs.jboss.org/author/display/ARQ/Drone ), но для этого теста достаточно значений по умолчанию. Обратите внимание, что теперь браузером по умолчанию является Firefox .

ВАЖНО : если вы используете встроенную установку Linux Docker, прокомментируйте строку конфигурации machineName . Если вы используете докер и он называется dev , то адаптируйте
machineName в arquillian.xml тоже.

Следующим шагом является создание файла docker-compose в корневом каталоге.

Простой составной файл, который определяет только один контейнер. Этот контейнер предоставляет порт 80, но затем он привязывается к порту 8080. Этот контейнер запускает программу Go, слушающую корневой контекст и возвращающую
Привет, мир в формате HTML.

И наконец тест:

В этом тесте есть несколько интересных частей.

• Это стандартный тест Arquillian в том смысле, что он использует бегун Arquillian.
• Использует механизм внедрения @Drone, предоставленный Arquillian Drone, для обогащения теста с помощью WebDriver, настроенного для подключения к удаленному браузеру.
• Использует аннотацию @CubeIp для обогащения теста внутренним IP- адресом контейнера helloworld . Поскольку браузер работает внутри хоста Docker, для этой цели мы можем использовать внутренний IP-адрес. Также важно, что вам нужно использовать открытый порт, а не порт привязки.
• Все остальное управляется Arquillian Cube, как запуск и остановка контейнеров Docker (в данном случае helloworld ), но также и те, которые содержат браузер и клиент VNC. Если вы поместите точку отладки в метод теста, а затем запустите docker ps на терминале, вы увидите, что запущены три контейнера, а не просто helloworld .
• Если после запуска теста вы осмотрите каталог target / reports / videos, вы найдете видеозапись теста.

Вы также можете увидеть скриншот этого в действии:

Так что, как вы можете видеть, использование Arquillian Cube с Arquillian Drone делает ваш тестовый и докерный файл выглядит действительно аккуратно. Тест содержит только то, что связано с тестом, а не о конфигурации WebDriver. Кроме того, ваш docker-compose выглядит ясно, он содержит только вещи, связанные с бизнесом, а не с тестированием.

В этом посте вы увидели, как использовать Arquillian Cube + Arquillian Drone. В следующем вы увидите интеграцию с Arquillian Graphene, которая еще больше упростит тестирование, сосредоточившись только на тестировании, а не на вызовах WebDriver.