Типовой фреймворк для автотестов

BDD фреймворк для автотестов на Java, использующий:

• Selenide для тестирования Web UI
• REST assured для тестирования REST API
• Cucumber для написания сценариев в стиле BDD

Как начать писать WEB автотесты

1. Page Objects

В модуле autotest-web в директории src/main/java/pages находятся классы PageObjects
1.1 Каждый PageObject должен наследоваться от класса WebPage
1.2 Над классом необходимо проставить аннотацию @Name(value = "<имя страницы>")
Пример:

@Name(value = "Google")
public class GooglePage extends WebPage {
    
    @Name("поле поиска") 
    private SelenideElement searchField = $x("//input[@name='q']");

    @Name("результаты поиска")
    private ElementCollections results = $x(xpath);
}

2. Степы

2.1 В классе со степами необходимо объявить поле PageManager и конструктор класса следующим образом:

public class MySteps {
    private PageManager pageManager;
		
    public MySteps(PageManager pageManager) {  
	    this.pageManager = pageManager;  
    }
    // steps
}

• ссылка pageManager хранит в себе инициализированный контекст текущей страницы, с помощью которой можно достать элемент через value аннотации @Name элемента
  
• При компиляции ссылка pageManager проинициализируется автоматически путем Dependency Injection через PicoContainer
  
• Более подробно о подходе можно ознакомиться по ссылке Cucumber PicoContainer
  

2.2 Пример инициализации страницы:
Для того, чтобы получить доступ к элементу, нам необходимо перед этим проинициализировать PageObject
pageName - это value аннотации Name класса PageObject - в нашем примере "Google"

public void setPage(String pageName) {
    WebPage page = Environment.getPage(pageName);
    pageManager.setCurrentPage(page);
}

2.3 Теперь страница проинициализирована и получить доступ к элементам можно по его имени (value)

@Если("кликнуть на элемент {string}")
public void clickOnElement(String elementName) {
    SelenideElement element = pageManager
                        .getCurrentPage()
                        .getElement(elementName);
    element.shouldBe(visible).click();
}

3. Тесты

#language:ru
Функционал: Поиск гугл
  Сценарий: Открытие страницы google.com, ввод значения в поис

    * открыть url "https://www.google.ru/"
    * инициализация страницы "Google"
    * ввести в поле "поле поиска" значение "Погода в Москве"
    * на странице имеется элемент "результаты поиска"
    * кликнуть на элемент "кнопка поиска"
    * инициализация страницы "страница результатов поиска"
    * на странице присутствует текст "Погода в Москве"

• Шаг 1 - открытие веб страницы
• Шаг 2 - инициализация PageObject через его value аннотации @Name
• Шаг 3 - как в примере 2.3 получаем текущий элемент по его value аннотации @Name и производим действия/проверки

4. Настройки

В директории autotest-web/src/test/resources/config имеются примеры config-файлов для разных браузеров.

webdriver.browser.size=1920x1080 - разрешение браузера
webdriver.browser.name=chrome  - название браузера
webdriver.timeoutSeconds=4  - таймаут ожидания состояния веб-элементов
polling.timeoutMs=200  - периодичность опроса веб-элемента
webdriver.version=91.0  - версия веб-драйвера
pages.package=pages  - пакет в котором находятся пейджи
screenAfterStep=false - необходимость аттачить скриншот к каждому шагу

Так же с помощью одноименных переменных окружения можно переопределить данные настройки
Драйвера скачиваются с помощью WebDriverManager, учитывайте это если находитесь в закрытом контуре

Как начать писать API тесты

Принцип написания тестов похож на подход создания и отправки запроса в Postman

Шаг 1. Конфигурируем запрос с помощью шага

* создать запрос  
  | method | path | body | url |

Если какой то из столбцов не указан в данном шаге, то он не учитывается в запросе Например:

* создать запрос  
  | method | path  | body            |  
  | POST   | /user | createUser.json |
ИЛИ
* создать запрос  
  | method | path  |      body        |  
  | POST   | /user | {<тело запроса>} |
ИЛИ
* создать запрос  
  | method |                  url                           |   
  | GET    | https://petstore.swagger.io/v2/user/<username> |

• Можно указать basePath через одноименную системную переменную или в файле конфигурации configuration.properties. Тогда вместо столбца url можно указывать просто path. И наоборот, если указать столбец url с полным url хоста и path то basePath не учитывается, даже если указан с системных переменных.
• Тело запроса - в качестве тела можно передать в таблицу, как просто текст, так и название файла json, которое будет лежать по пути autotest-rest/src/test/resources/json

Шаг 2. Добавление Headers и Query

* добавить header  
  | Content-Type | application/json |
* добавить query параметры  
  | city | Moscow |

Шаг 3. Отправка запроса

* отправить запрос

Шаг 4. Проверка ответа

* статус код 200

Если необходимо проверить тело ответа, то данные можно вытащить с помощью jsonpath. Значение сохранится в переменную из столбца 1

* извлечь данные  
  | user_id | $.message |

Проверить извлеченные данные можно с помощью шага:

* сравнить значения  
| ${user_id} | != | null |
ИЛИ
| ${user_id} | == | 1234567890 |
ИЛИ
| ${user_id} | > | 0 |
ИЛИ
| ${user_id} | < | 100 |
ИЛИ
| ${user_id} | содержит | qwerty123 |

Иная информация.

С помощью следующего шага можно сгенерить переменные для последующего использования в тесте

* сгенерировать переменные
   | id         | 0                 |
   | username   | EEEEEEEE          |
   | firstName  | EEEEEEEE          |
   | lastName   | EEEEEEEE          |
   | email      | EEEEEEE@EEEDDD.EE |
   | password   | DDDEEEDDDEEE      |

R - случайная русская буква
E - случайная английская буква
D - случайное число
Другие символы в строке игнорируются и остаются неизменяемыми Сгенерированные значения хранятся в контексте теста. Их можно подставлять в запросы, тела запросов. Достать их можно используя синтаксис ${username}

Запуск API через консоль

mvn -am -pl autotest-rest test -Dtags="@test" -Ddataproviderthreadcount=5

Запуск WEB через консоль

mvn -am -pl autotest-web test -Dtags="@google" -Ddataproviderthreadcount=5

Так же запустить тесты можно через плагин Cucumber (предварительно установив его в Idea), для этого необходимо открыть любой feature-файл, и кликнуть по зеленой стрелке рядом со стройкой Функционал или Сценарий

Генерация отчета

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

По итогу сформируется Html страница с отчетом.

В отчете можно провалиться в каждый шаг и посмотреть информацию по нему