Плагин для IDE JetBrains

Возможности плагина

ТестОпс для IDE Jetbrains позволяет выполнять следующие действия:

1. Загрузка результатов тестов локального запуска на сервер ТестОпс.
   • случай использования: локальный запуск тестов для недавно автоматизированных тестов
   • случай использования: автоматизация ручного теста, который существует в ТестОпс
2. Создание нового автоматизированного тест-кейса в ТестОпс из IDE.
   • случай использования: создание совершенно нового тест-кейса, AllureID будет присвоен методу, созданному в коде
3. Массовая операция для присвоения AllureID
   • случай использования: чтобы предотвратить создание новых тест-кейсов и забрасывание старых при изменении кода, необходимо присвоить Allure ID тест-кейсу в вашем коде.
4. Импорт всех метаданных ручного теста для его автоматизации в IDE.
   • случай использования: вы сэкономите много времени на создании метаданных в вашем коде, если импортируете данные тест-кейса из ТестОпс в IDE.
5. Генерация отчета Allure Report на основе результатов тестов
6. Открытие сгенерированного отчета Allure Report
7. Обслуживание (создание временного отчета) Allure Report на основе результатов тестов

IDE JetBrains

В таблице ниже показаны поддерживаемые языки программирования и тестовые фреймворки с указанием названия IDE JetBrains.

Язык программирования	Тестовый фреймворк	IDE
Java	JUnit4	IntelliJ IDEA
Java	JUnit5	IntelliJ IDEA
Java	TestNG	IntelliJ IDEA
Kotlin	JUnit4	IntelliJ IDEA
Kotlin	JUnit5	IntelliJ IDEA
Kotlin	TestNG	IntelliJ IDEA
Java	Cucumber	IntelliJ IDEA
Groovy	Spock	IntelliJ IDEA
Python	pytest	PyCharm
Python	Robot Framework	PyCharm
PHP	Codeception	PHP Storm
JavaScript	WIP	Семейство IDE JetBrains

Установка (IDE JetBrains)

• Перейдите в раздел плагинов в настройках вашей IDE.

  • выберите File > Settings > Plugins

• В поле поиска начните вводить Allure TestOps Support

• Затем в поле результатов найдите плагин и нажмите Install

  

• Перезапустите IDE.

Следующим шагом будет авторизация плагина для выполнения операций на стороне ТестОпс.

Для авторизации плагина в ТестОпс вам нужно сгенерировать персональный токен доступа в меню пользователя на стороне ТестОпс.

Ранний доступ

Qameta Software также публикует предварительные версии функций для плагина ТестОпс для IDE JetBrains в канале Early Access Program (EAP).

Важно

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

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

Добавление канала EAP в вашу IDE

1. Откройте настройки IDE
2. Перейдите в раздел плагинов.
3. Нажмите на значок шестеренки. Он находится на той же линии, что и списки установленных / маркетплейс плагинов.
4. Нажмите пункт меню Manage Plugin Repositories....

5. Добавьте репозиторий EAP
   1. нажмите +
   2. добавьте строку https://plugins.jetbrains.com/plugins/eap/list
   3. нажмите Ok

6. Если доступна какая-либо версия плагина раннего доступа, IDE предложит обновиться до нее.

Отмена обновлений сборок EAP

1. Откройте настройки IDE
2. Перейдите в раздел плагинов.
3. Нажмите на значок шестеренки. Он находится на той же линии, что и списки установленных / маркетплейс плагинов.
4. Нажмите пункт меню Manage Plugin Repositories....
5. Удалите канал EAP из настроек.
6. Удалите плагин ТестОпс.
7. Установите ТестОпс из стабильного канала релизов (по умолчанию).

Настройки подключения плагина

Важно

Для выпусков плагина 3.18+

Настройки плагина находятся в разделе Tools IDE JetBrains.

Перейдите в Preferences > Tools > Allure TestOps

Конфигурация плагина

Предварительные условия

• Сгенерируйте персональный токен доступа
• Для работы с проектами ТестОпс с использованием плагина IDE, вам необходимо иметь как минимум роль ROLE_USER и как минимум разрешение project:write.

Конфигурация плагина

1. Откройте настройки плагина.
2. Введите URL-адрес вашего экземпляра ТестОпс.
3. Укажите персональный токен доступа.
4. Нажмите Check connection
5. Если все данные выше (пункты 2 и 3) верны, система предоставит ваше имя пользователя, зарегистрированное в ТестОпс.

Настройки проекта

Плагин позволяет выбрать проект ТестОпс по умолчанию для текущего проекта IDE, т.е. все операции будут выполняться для определенного проекта в ТестОпс, и вам не нужно будет выбирать проект каждый раз, когда нужно загрузить результаты.

Перейдите в IDE > Preferences > Tools > Allure TestOps > Project settings и выберите проект, который вы хотите использовать по умолчанию для плагина.

Загрузка результатов тестов в ТестОпс из IntelliJ IDEA

Зачем

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

Как

1. Запустите тесты в вашей среде разработки, т.е. на вашем локальном компьютере.
2. Выберите папку с результатами allure в дереве проекта и затем щелкните правой кнопкой мыши по папке.
3. В контекстном меню выберите Allure: Upload results
4. Обновите имя для нового запуска, который плагин собирается создать (если необходимо)
5. Результаты будут доступны в ТестОпс в разделе Launches.

Связывание тестов в IDE с тест-кейсами в ТестОпс через AllureID

Что

ТестОпс использует определенные правила для связывания вашего автоматизированного теста с тест-кейсом ТестОпс.

Правила связывания зависят от тестового фреймворка, но в целом это работает следующим образом:

AllureID будет связан с полным путем вашего тестового метода, например <package>.<class name>.<method name>.

ТестОпс также использует параметры теста для связывания тест-кейса с определенным AllureID, т.е. тест <package>.<class name>.<method name> без параметров и с одним параметром не являются одинаковыми, это будут два разных тест-кейса с разными AllureID.

Зачем

Просто, AllureID — это идентификатор тест-кейса в базе данных ТестОпс. AllureID — это уникальный номер, в то время как полный путь и параметры теста могут изменяться со временем из-за рефакторинга вашего кода, например.

Важно

Если вы измените любую часть этого сопоставления, ТестОпс будет рассматривать такой тест как новый тест-кейс и создаст для вас новый с новым AllureID. Таким образом, у вас будет два тест-кейса – один со старым путем (набором параметров) и новый с новым путем и набором параметров.

Это приведет к следующему:

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

Как

Чтобы избежать забрасывания тест-кейсов, вы должны пометить ваш тест аннотацией AllureID.

1. Если тесты никогда не были отправлены в ТестОпс, вам нужно загрузить результаты тестов в первый раз в ТестОпс, как описано:
   • щелкните правой кнопкой мыши по папке с результатами allure
   • выберите Allure: Upload results
   • выберите проект для загрузки
   • назовите запуск

2. Закройте запуск для обработки результатов, новые тест-кейсы будут созданы
   • тест-кейсы создаются и обновляются в ТестОпс только при закрытии запуска.

3. Щелкните правой кнопкой мыши по пакету или классу для обработки и выберите Allure: Assign ID

4. В модальном окне выберите проект в ТестОпс, в который вы отправили результаты тестов
5. Тесты будут аннотированы @AllureId.

Теперь, если вы измените либо имя пакета, либо имя класса, либо имя теста, это будет правильно сопоставлено с тест-кейсом ТестОпс.

Автоматизация ручных тест-кейсов

Что

Следующий рабочий процесс позволяет легко автоматизировать ручной тест-кейс, который у вас есть в ТестОпс.

Как

1. Допустим, в проекте у вас есть ручной тест-кейс, который вы хотите автоматизировать.

2. В IDE создайте новый класс или используйте существующий и добавьте новый метод (тест), помеченный аннотацией @Test

3. Щелкните правой кнопкой мыши по методу и выберите Allure: Import test case

4. В модальном диалоге укажите Allure ID из ТестОпс в поле Test Case ID и выберите элементы для импорта из ручного тест-кейса ТестОпс.

5. Ваш тест в IntelliJ IDEA будет обновлен с выбранной информацией и будет присвоен @AllureId

6. Обновите сценарий вашего теста

7. Выполните обновленный тест и загрузите результаты
8. Закройте запуск на стороне ТестОпс для обработки результатов
9. Ваш ручной тест-кейс ТестОпс станет автоматизированным

10. Теперь, чтобы завершить процесс автоматизации, вам нужно сравнить ручные и автоматизированные сценарии, нажав кнопку сравнения рядом с элементом Scenario

11. Если вы довольны результатами, удалите ручной сценарий, и сценарий из результатов теста будет использоваться

12. Теперь сценарий вашего тест-кейса берется из последнего результата теста

13. Теперь ваш тест полностью автоматизирован

Создание автоматизированных тестов из IDE и резервирование Allure ID

Зачем

Если вы разрабатываете автоматизированный тест с нуля, вам не нужно импортировать данные из ручного тест-кейса, поэтому вы можете создать пустой автоматизированный тест-кейс из IDE и присвоить ему Allure ID с самого начала, чтобы все изменения в именах и параметрах отражались в том же тест-кейсе на стороне ТестОпс.

Что

Рабочий процесс следующий:

1. Вы создаете тестовый метод в вашей IDE
2. Вы запрашиваете Allure ID для вашего теста
3. ТестОпс резервирует AllureID для вашего теста и создает ссылку между AllureID и полным путем вашего теста (<packageName>.<ClassName>.<methodName>).
4. Тест-кейс в ТестОпс помечен как удаленный до тех пор, пока вы не отправите результаты тестов в ТестОпс.

Как

1. Создайте новый тестовый метод и щелкните по нему правой кнопкой мыши. Выберите Allure: Create Test Case

2. Выберите имя проекта, в котором вы хотите создать ваш тест-кейс.

3. Плагин ТестОпс создаст тест-кейс в удаленном состоянии и предоставит AllureID вашему коду.

4. Теперь вы можете открыть тест-кейс в интерфейсе ТестОпс, щелкнув по элементу контекстного меню Allure: Open Test Case

5. Созданный тест-кейс добавлен в удаленном состоянии, так как создание только резервирует AllureID.

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

7. Как только результаты тестов поступят и запуск будет закрыт, ваш тест-кейс появится в списке с другими тест-кейсами, и состояние Удалено будет снято.