akita - GitLite

KO | EN

gitlite — search

#hacktoberfest #react #ai #typescript #llm #android #deep-learning #macos #nodejs #awesome #kubernetes #awesome-list #vue #ios

akita

(★ 103)

BDD steps library for test automation

파일 탐색기

최종 버전 다운로드 (.zip)

- - gradle-wrapper.jar
  - gradle-wrapper.properties
- buildViaTravis.sh
.gitignore
.travis.yml
akita.png
build.gradle
CONTRIBUTION.md
gradle.properties.enc
gradlew
gradlew.bat
HEADER
LICENSE
README.md
settings.gradle

# 설치 가이드

1. 코드 내려받기

git clone https://github.com/alfa-laboratory/akita

깃허브에서 프로젝트 코드 전체를 내 컴퓨터로 내려받습니다.

cd akita

방금 내려받은 프로젝트 폴더 안으로 이동합니다.

2. Gradle (Java/Kotlin)

보통 추천

사전 준비물

Git GitHub에서 프로젝트 코드를 내려받으려면 필요합니다.
JDK (Java) Java/Kotlin 프로젝트를 빌드/실행하려면 필요합니다.
Gradle 레포에 포함된 gradlew(Gradle Wrapper)를 쓰면 Gradle을 따로 설치할 필요가 없습니다.

./gradlew build

Gradle로 빌드를 진행합니다.

✅ BUILD SUCCESSFUL 메시지가 뜨면 성공입니다. build/ 폴더에 결과물이 생성됩니다.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

<img align="left" width="140" height="140" title="akita"
     src="https://github.com/alfa-laboratory/akita/blob/master/akita.png" />

# Akita
[![Build Status](https://travis-ci.org/alfa-laboratory/akita.svg?branch=master)](https://travis-ci.org/alfa-laboratory/akita)
[![Coverage Status](https://coveralls.io/repos/github/alfa-laboratory/akita/badge.svg?branch=master)](https://coveralls.io/github/alfa-laboratory/akita?branch=master)
[![Download](https://api.bintray.com/packages/alfa-laboratory/maven-releases/akita/images/download.svg) ](https://bintray.com/alfa-laboratory/maven-releases/akita/_latestVersion)<br /> <br />  [![@akitaQA](https://img.shields.io/badge/Telegram-%40akitaQA-orange.svg)](https://t.me/joinchat/D53UAg8lG2xv81zgb7dEtQ)<br />
⇧ Join us! ⇧

Akita - бери и тестируй
=========================

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

Для написания тестового сценария достаточно подключить библиотеку и воспользоваться любым готовым шагом из ru.alfabank.steps

Например:
```
Функционал: Страница депозитов
  Сценарий: Открытие депозита
    Допустим совершен переход на страницу "Депозиты" по ссылке "depositsUrl"
    Когда выполнено нажатие на кнопку "Открыть депозит"
    Тогда страница "Открытие депозита" загрузилась
```

application.properties
=======================
Для указания дополнительных параметров или тестовых данных создайте в своем проекте файл application.properties
в main/java/resources

Хранение тестовых данных в YAML
=======================
Тестовые данные также можно хранить в Yaml-файлах. Положите yaml-файлы в папку ресурсов main/java/resources.

Использование данных без дополнительных Pojo-классов:
```java
JsonNode data = YamlDataLoader.readDataToJsonNode("testData.yml", "alfabank")
String inn = data.at("/details/inn").asText();
```

Десериализация в экземпляр класс:
```java
BankInfo bankInfo = YamlDataLoader.readDataToClassType("testData.yml", BankInfo.class, "alfabank");
```

Чтение и обьединение данных из нескольких yaml-файлов:
```java
JsonNode commonSettings = YamlDataLoader.readDataToJsonNode("testData.yml", "settings");
JsonNode devSettings = YamlDataLoader.readDataToJsonNode("testData_dev.yml", "settings");
devSettings = YamlDataLoader.mergeNodes(commonSettings, devSettings);
```

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

Новую текущую страницу можно установить шагом
```Когда страница "<Имя страницы>" загрузилась```

Для страницы депозитов шаг может выглядеть так
```Когда страница "Депозиты" загрузилась```

Каждая страница, с которой предполагается взаимодействие, должна быть описана в классе наследующемся от AkitaPage.
Для страницы и ее элементов следует задать имя на русском, через аннотацию Name, чтобы искать можно было именно по русскому описанию.
Элементы страницы ищутся по локаторам, указанным в аннотации FindBy и должны иметь тип SelenideElement или List<SelenideElement>.

Пример описания страницы:
```java
    @Name("Депозиты")
    public class DepositsPage extends AkitaPage {

@FindBy(css = ".deposit_open")
        @Name("Открыть депозит")
        private SelenideElement depositOpenButton;

@Optional
        @FindBy(css = ".deposit_close")
        @Name("Закрыть депозит")
        private SelenideElement depositCloseButton;

@Hidden
        @FindBy(css = ".deposit_list")
        @Name("Список депозитов")
        private List<SelenideElement> depositList;
    }
```

Инициализация страницы
Страница инициализируется каждый раз, когда вызываются методы initialize(<Имя класса страницы>.class)

Пример инициализации страницы "Депозиты":
```
DepositsPage page = (DepositsPage) getCurrentPage();
akitaScenario.setCurrentPage(page.initialize().appeared());
```

Пример получения конкретной страницы:
```
DepositsPage page = akitaScenario.getPage(DepositsPage.class);
```

Другой способ работы с методами страницы - это использование AkitaScenario.withPage
Пример использования: ```withPage(TestPage.class, page -> { some actions with TestPage methods});```

Для страницы инициализируется карта ее элементов - это те поля, что помечены аннотацией Name.
Кроме того, осуществляется проверка, что загружена требуемая страница.
Страница считается загруженной корректно, если за отведенное по умолчанию время были загружены основные ее элементы.
Основными элементами являются поля класса страницы с аннотацией Name, но без аннотации Optional.
Аннотация Optional указывает на то, что элемент является не обязательным для принятия решения о загрузке страницы.
Например, если на странице есть кнопка, которая отображается только для определенного типа пользователей,
её можно пометить как Optional.
Аннотация Hidden указывает на то, что элемент не должен отображаться при загрузке страницы.
Например, если на странице есть список, который раскрывается после нажатия не него, т.е. видим не сразу после загрузки страницы,
его можно пометить как Hidden.
Реализована возможность управления временем ожидания появления элемента на странице.
Чтобы установить timeout, отличный от базового, нужно добавить в application.properties строку
waitingAppearTimeout=150000

Доступ к элементам страницы
============================
Данные строки позволяют по имени элемента найти его в карте элементов текущей страницы.

```
akitaScenario.getCurrentPage().getElement("Открыть депозит")
akitaScenario.getCurrentPage().getElementsList("Список депозитов")
 ```
Блоки на странице
============================
Реализована возможность описывать блоки на странице (Page Element)
Например:
```
@FindBy(className = "header")
@Name("Шапка страницы")
public HeaderBlock header;
```
При загрузке страницы будут учитываться элементы, описанные в блоке

Screenshots
============================
Реализован кастомный StepFormatter. При подключении его к проеку с тестами, становится достуна опция снятия скриншотов после желаемого или каждого шага. ```@CucumberOptions(format = {"pretty", "ru.alfabank.tests.core.formatters.StepFormatter"})```

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

Есть также возможность получать скриншоты после каждого шага всех сценариев. Для этого необходимо задать системную переменную takeScreenshotAfterSteps=true.

Работа с REST запросами
=======================

В библиотеке реализована возможность отправки REST запросов и сохранения ответа в переменную.

Поддерживаются следующие типы запросов: GET, POST, PUT, DELETE.
   ```Когда выполнен POST запрос на URL "{depositsApi}deposits/{docNumber}/repay" с headers и parameters из таблицы. Полученный ответ сохранен в переменную
       | type   | name          | value           |
       | header | applicationId | test            |
       | header | customerId    | <userCus>       |
       | body   | repayment     | <fileForCreate> |
  ```
В таблице переменных поддерживаются типы: header, parameter, body
Для body-параметра сейчас поддерживается как работа с телом запроса, хранящимся в папке restBodies, так и с указанием текста body в самом шаге в соответствующей ячейке
Значения параметров таблицы и частей url можно указывать в application.properties

Отображение в отчете справочной информации
============================================

Для того, чтобы в отчете появился блок Output с информацией, полезной для анализа отчета, можно воспользоваться следующим методом
 ```
akitaScenario.write("Текущий URL = " + currentUrl + " \nОжидаемый URL = " + expectedUrl);
 ```

Проверка логического выражения
===============================
У нас есть шаг, который например может выглядеть так:
 ```
Тогда верно что "amountToPay == amountMonthly + penalty + 100"
 ```
Важно отметить, что равенство проверяется использованием операнда "==", неравенство, как "!="

Использование переменных
=========================
Иногда есть необходимость использовать значения из одного шага в последующих.
Для этого реализовано хранилище переменных в AkitaScenario.
Для сохранения/изъятия переменных используются методы setVar/getVar.

Сохранение переменной в хранилище:
```akitaScenario.setVar(<имя переменной>, <значение переменной>);```

Получение значения переменной из хранилища:
```akitaScenario.getVar(<имя переменной>)```

Кастомный драйвер - CustomDriverProvider
=========================================
Позволяет запускать тесты с кастомными настройками браузеров и на ремоуте. Параметры запуска можно задавать как системные переменные.
Например, можно указать браузер, версию браузера, remote Url(где будут запущены тесты), ширину и высоту окна браузера:
```
./gradlew clean gCR -Pbrowser=chrome -PbrowserVersion=64.0 -PremoteUrl=http://remote/url -Pwidth=1200 -Pheight=800
```
Если параметр remoteUrl не указан - тесты будут запущены локально в заданном браузере последней версии
(Пример настройки запуска тестов с кастомным браузером можно посмотреть в [Akita-testing-template](https://github.com/alfa-laboratory/akita-testing-template))

Если указан параметр headless `-Pheadless=true`, то браузеры chrome и firefox будут запускаться в [headless режиме](https://developers.google.com/web/updates/2017/04/headless-chrome).

Blacklist
=========================================
Иногда есть необходимость добавить определенные ресурсы в черный список.
Для этого была реализована возможность создать файл без расширения ```blacklist``` . Его необходимо положить в ```src/main/java/resources/```

```blacklist``` предназначен для хранения нежелательных, указанных пользователем ресурсов, которые будут добавлены в черный список при запуске тестов через ```CustomDriverProvider```.

Формат записи - каждый новый ресурс с новой строки, например:

.*ru.fp.kaspersky-labs.com.*
     http://google.com/ 200
При необходимости можно указывать возвращаемый статус код через пробел, например:
```http://google.com/ 200```

Если статус код не указан, по умолчанию будет присвоен ```404```

Proxy
=========================================
Реализована возможность включать proxy-сервер во время запуска тестов (а именно, BrowserMobProxy)

Для этого при старте тестов необходима указать параметр ```-Dproxy=true```

Если необходимо слушать определенный har, его можно задать в файле application.properties ```har=some.test.har```
В application.properties также можно указывать дополнительные capabilities для режима proxy, например

```
trustAllServers=true
acceptSslCerts=true
javascriptEnabled=true
```

Краткое описание главных классов
=================================

```ru.alfabank.alfatest.cucumber.api.AkitaEnvironment```
Используется для хранения страниц и переменных внутри сценария
scenario - Сценарий из Cucumber.api, с которым связана среда

```ru.alfabank.alfatest.cucumber.api.AkitaPage```
Класс для реализации паттерна PageObject. Тут описаны основные методы взаимодействия с элементами страницы

```ru.alfabank.alfatest.cucumber.api.AkitaScenario```
Позволяет заполнить хранилище переменных, существующее в рамках одного сценария, значениями и читать эти значения при необходимости.

```ru.alfabank.steps.DefaultApiSteps```
Шаги для тестирования API, доступные по умолчанию в каждом новом проекте

```ru.alfabank.steps.DefaultSteps```
Шаги для тестирования UI, доступные по умолчанию в каждом новом проекте

```ru.alfabank.steps.InitialSetupSteps```
Хуки предустановок, где происходит создание, закрытие браузера, получение скриншотов

```ru.alfabank.tests.core.drivers.MobileChrome```
Класс, описывающий создание экземпляра мобильной версии Google Chrome драйвера

```ru.alfabank.tests.core.helpers.PropertyLoader```
Класс для получения свойств

```ru.alfabank.tests.core.drivers.CustomDriverProvider```
Провайдер кастомного драйвера

## Testing Template 
https://github.com/alfa-laboratory/akita-testing-template
## Контакты
[Telegram](https://t.me/akitaQA)

Используемые зависимости:
--------------------------
> nebula-release-plugin - Apache License Version 2.0
> coveralls-gradle-plugin - The MIT License (MIT)
> com.codeborne.selenide - The MIT License (MIT)
> io.rest-assured.rest-assured - Apache License Version 2.0
> com.google.inject.guice - Apache License Version 2.0
> org.mockito.mockito-core - The MIT License
> com.github.tomakehurst:wiremock - Apache License Version 2.0
>org.hamcrest.hamcrest-all - BSD License
>org.codehaus.groovy - Apache License Version 2.0
>JUnit - Eclipse Public License
>org.slf4j.slf4j-simple - The MIT License (MIT)
>org.projectlombok.lombok - The MIT License (MIT)
>info.cukes.cucumber-java - The MIT License (MIT)
>info.cukes.cucumber-core - The MIT License (MIT)
>org.reflections.reflections