Содержание
В современной разработке программного обеспечения комплексный инструмент отчетности так же важен, как и сами тестовые примеры. Allure стал очень гибким и проницательным инструментом для создания отчетов, который позволяет получить подробное представление о том, что было протестировано и что требует дальнейшего внимания. Если вы используете Vedro, прагматичный фреймворк для тестирования, его интеграция с Allure может значительно расширить ваши возможности по созданию тестовых отчетов.
Закладывая основу
Прежде чем приступить к интеграции, убедитесь, что у вас установлен Vedro:
pip install vedro
Рассмотрим следующий простой сценарий Vedro, который тестирует получение репозиториев для пользователя GitHub:
импорт vedro
импорт httpx
class Scenario(vedro.Scenario):
subject = "retrieve user repos"
def given_user(self):
self.user = "gvanrossum"
def when_guest_retrieves_repos(self):
self.response = httpx.get(f "https://api.github.com/users/{self.user}/repos")
def then_it_should_return_a_successful_response(self):
assert self.response.status_code == 200
Далее давайте интегрируем это с Allure.
Шаг 1: Установите плагин Allure для Vedro
Чтобы начать работу с Allure в Vedro, сначала установите плагин Allure Reporter:
vedro plugin install vedro-allure-reporter
Шаг 2: Выполнение тестов и генерация данных отчета
После установки плагина вы можете выполнять тесты и генерировать данные отчетов Allure:
vedro run -r rich allure
По умолчанию эта команда сохраняет данные отчета в каталоге ./allure_reports. Чтобы указать другой каталог, используйте:
vedro run -r rich allure --allure-report-dir ./custom_allure_reports
Шаг 3: Визуализация отчета с помощью Allure CLI
Чтобы просмотреть отчет, сначала нужно установить инструмент командной строки Allure. Следуйте инструкциям по установке, приведенным в официальном руководстве Allure.
После установки Allure CLI откройте отчет:
allure serve ./allure_reports
Эта команда сгенерирует и откроет отчет в веб-браузере по умолчанию, обеспечив наглядное и интерактивное представление результатов тестирования.
Улучшение отчетов за счет категоризации и маркировки
Чтобы улучшить визуализацию и понимание отчетов, подумайте о маркировке тестов. Например, пометьте ранее определенный сценарий, чтобы отнести его к категории ”Тестирование API GitHub”:
импорт vedro
из vedro_allure_reporter import allure_labels, Story, Epic, Feature
@allure_labels(Epic("GitHub API Testing"), Feature("User Repositories"))
class Scenario(vedro.Scenario):
subject = "retrieve user repos"
...
Маркировка особенно полезна, когда у вас обширный набор тестов и вам нужно отфильтровать или сгруппировать тесты. Например, чтобы запустить тесты, помеченные под определенной эпопеей, используйте:
vedro run --allure-labels epic="GitHub API Testing"
Таким образом, интеграция Vedro с Allure не только улучшает рабочий процесс тестирования, но и предоставляет комплексную интерактивную отчетность, облегчая отслеживание, фильтрацию и понимание результатов тестирования.