Как установить allure windows 10

1. Enter cmd and use powershell

C:\Users\CZY>powershell
Windows PowerShell
 Copyright (C) Microsoft Corporation. all rights reserved.

2. Check the version of powershell, scoop requires powershell version to be at least 5 or higher

PS C:\Users\CZY> $PSVersionTable

Name                           Value
----                           -----
PSVersion                      5.1.17134.765
PSEdition                      Desktop
PSCompatibleVersions           {1.0, 2.0, 3.0, 4.0...}
BuildVersion                   10.0.17134.765
CLRVersion                     4.0.30319.42000
WSManStackVersion              3.0
PSRemotingProtocolVersion      2.3
SerializationVersion           1.1.0.1

3. Download and install scoop

PS C:\Users\CZY> iex (new-object net.webclient).downloadstring('https://get.scoop.sh')
PowerShell requires an execution policy of 'RemoteSigned' to run Scoop.
To make this change please run:
'Set-ExecutionPolicy RemoteSigned -scope CurrentUser'
#If there is the above prompt when executing the iex command, follow the prompt

PS C:\Users\CZY> Set-ExecutionPolicy RemoteSigned -scope CurrentUser

PS C:\Users\CZY> iex (new-object net.webclient).downloadstring('https://get.scoop.sh')
Initializing...
Downloading scoop...
Extracting...
Creating shim...
Downloading main bucket...
Extracting...
Adding ~\scoop\shims to your path.
'lastupdate' has been set to '2019-07-18T23:23:48.8724096+08:00'
Scoop was installed successfully!
Type 'scoop help' for instructions.

4. Check whether scoop is installed

PS C:\Users\CZY> scoop help
Usage: scoop <command> [<args>]
...

5. Install allure

PS C:\Users\CZY> scoop install allure
Installing 'allure' (2.12.1) [64bit]
allure-commandline-2.12.1.zip (16.3 MB) [=====================================================================] 100%
Checking hash of allure-commandline-2.12.1.zip ... ok.
Extracting allure-commandline-2.12.1.zip ... done.
Linking ~\scoop\apps\allure\current => ~\scoop\apps\allure\2.12.1
Creating shim for 'allure'.
'allure' (2.12.1) was installed successfully!

6. To use allure, you need to install Java jdk in advance. The official document recommends using jdk8. The jdk8 installation is omitted here.

7. View the allure version in cmd

  C:\Users\CZY>allure —version
  2.12.1

Display the version number, indicating that allure has succeeded

8. Use allure to specify the test case to generate a report and store it in the specified file

# allure Specify the test case to run and specify the directory to generate the report
>pytest -s -q C:\Users\CZY\PycharmProjects\Demo\src\test_selenium2.py --alluredir=C:\Users\CZY\PycharmProjects\Demo\report\test_json\    
 # Directory to store json report data

>allure generate C:\Users\CZY\PycharmProjects\Demo\report\test_json\  -o C:\Users\CZY\PycharmProjects\Demo\report\report1
 # The directory where the test result data is stored and the directory where the test report is saved

allure generates reports, refer to official documents

https://docs.qameta.io/allure/#_python

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

В этом руководстве мы пройдем через основные шаги по созданию вашего первого отчета Allure и откроем для себя все фантастические возможности, которые он привносит в рутинные отчеты автоматизированного тестирования.

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

Установка Allure Report

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

Linux

Для репозиториев на базе debian предоставляется PPA:

sudo apt-add-repository ppa:qameta/allure
sudo apt-get update
sudo apt-get install allure

Mac OS X

Для Maс OS автоматическая установка доступна через Homebrew:

brew install allure

Windows

Для Windows Allure доступен из командной строки-установщика Scoop.

Чтобы установить Allure, скачайте и установите Scoop, а затем выполните в Powershell:

scoop install allure

Ручная установка

Загрузите последнюю версию в виде zip-архива с GitHub releases.

• Распакуйте архив в каталог allure-commandline.
• Перейдите в каталог bin.
• Используйте allure.bat для Windows или allure для Unix-платформ.
• Добавьте allure в системный PATH.
• Allure CLI требует установки Java Runtime Environment.

Подключение Allure к коду

Следующий шаг – предоставить все необходимые зависимости в конфигурационном файле, чтобы инструмент сборки смог использовать Allure.

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

Хорошие новости! Qameta Software, сопровождающий Allure Report, разрабатывает генератор шаблонных проектов на основе графического интерфейса. Шаблоны будут представлять собой самостоятельные примеры с несколькими макетными тестами и всеми инфраструктурными пресетами! Следите за новостями и подписывайтесь на наш блог, чтобы получить инструмент в числе первых.

Добавление аннотаций в отчет Allure Report

Подключив Allure Report к кодовой базе, мы можем запустить его. Однако отчет будет пустым.

Для того чтобы предоставить Allure все необходимые данные, нам нужно аннотировать тесты. Существует несколько типов аннотаций:

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

Описательные аннотации Allure Report

@epic, @Feature, @story

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

Эпик определяет задачу самого высокого уровня, которая будет декомпозирована на функции. Функции будут группировать конкретные истории, обеспечивая легко читаемую структуру.

Поскольку история является самой нижней частью иерархии epic-feature-story, история на уровне класса добавляет данные во все методы класса.

@Description

Аннотация, содержащая подробное описание метода/класса теста для отображения в Allure Report.

@Owner

Простая аннотация для выделения человека, стоящего за конкретным тестовым случаем, чтобы все знали, к кому обратиться за исправлением в случае поломки/неудачи теста. Очень полезно для больших команд.

@Severity

В Allure любой @тест может быть определен с аннотацией @Severity с любым из этих значений: BLOCKER, CRITICAL, NORMAL, MINOR, TRIVIAL.

Уровень серьезности будет отображаться в отчете, чтобы тестировщик понимал уровень серьезности теста в случае неудачи.

Примеры тестов

Вы можете найти пример использования всех этих аннотаций в коде Java, аннотации для любой другой технологии будут выглядеть довольно похоже:

public class AllureExampleTest {

    @Test
        @Epic("Sign In flow")
        @Feature("Login form")
        @Story("User enters wrong password")
        @Owner("Nicola Tesla")
        @Severity(SeverityLevel.BLOCKER)
    @Description("Test that verifies a user cannot enter the page without logging in")
    public void annotationDescriptionTest() {
    }

    /**
     * JavaDoc description
     */
    @Test
    @Description(useJavaDoc = true)
    public void javadocDescriptionTest() {
    }
}

Аннотация шагов отчета Allure

Подробные отчеты с шагами – одна из тех особенностей Allure Report, за которые его любят. Именно аннотация @step делает это возможным, предоставляя человекочитаемое описание любого действия в тесте. Шаги можно использовать в различных сценариях тестирования. Они могут: быть параметризованными, выполнять проверки, иметь вложенные шаги и создавать вложения. Каждый шаг имеет имя.

Чтобы определить шаги в коде, каждый метод должен иметь аннотацию @step с описанием String; в противном случае имя шага равно аннотированному имени метода.

Обратите внимание, что механика шагов была пересмотрена и теперь поддерживает анализ интеллектуальных полей. В Allure 1 пользователи должны были указывать индексы для ссылки на то, какие значения args они хотят ввести в шаг. Allure 2 использует подход, основанный на отражении, который обеспечивает глубокое извлечение полей по их именам.

В коде аннотация Step будет выглядеть следующим образом:

package io.qameta.allure.examples.junit5;

import io.qameta.allure.Allure;
import io.qameta.allure.Step;
import org.junit.jupiter.api.Test;

public class AllureStepTest {

    private static final String GLOBAL_PARAMETER = "global value";

    @Test
    public void annotatedStepTest() {
        annotatedStep("local value");
    }

    @Test
    public void lambdaStepTest() {
        final String localParameter = "parameter value";
        Allure.step(String.format("Parent lambda step with parameter [%s]", localParameter), (step) -> {
            step.parameter("parameter", localParameter);
            Allure.step(String.format("Nested lambda step with global parameter [%s]", GLOBAL_PARAMETER));
        });
    }

    @Step("Parent annotated step with parameter [{parameter}]")
    public void annotatedStep(final String parameter) {
        nestedAnnotatedStep();
    }

    @Step("Nested annotated step with global parameter [{this.GLOBAL_PARAMETER}]")
    public void nestedAnnotatedStep() {

    }

Аннотации параметров отчета Allure

Прикрепление

Аннотация позволяет прикрепить к отчету строку или массив байтов. Аннотация используется для прикрепления снимка экрана или трассировки стека ошибок к результату.

Ссылка / Ссылки

Здесь все просто. Если вам нужно добавить ссылку к тесту, будь то ссылка или

Для этого требуется несколько параметров:

name: link text
url: an actual link
type: type of link
value: similar to name

Приглушенный

Аннотация, исключающая тест из отчета.

TmsLink

Способ связать результат с объектом TMS, если вы его используете. Позволяет ввести только идентификатор тестового случая, который будет добавлен к предварительно настроенному (через allure.link.tms.pattern) URL. Аннотация принимает значение String, которое является ссылкой на систему управления. Например, если в нашем тестовом примере на TMS ссылка https://tms.yourcompany.com/browse/tc-12, то в качестве значения можно использовать tc-12.

Запуск отчета Allure

Локальный

Отличный способ начать работу с Allure Report – запустить его локально. Локальное выполнение не предоставляет историю выполнения и результатов, а также графики трендов.

Лучший способ попробовать Allure Report – открыть пример в IDE. Проверьте все зависимости и соберите проект с помощью Gradle.

После этого нужно запустить тесты с помощью команды ./gradlew test. Когда тесты будут выполнены, Gradle сохранит результаты в целевом каталоге.

Давайте возьмем эти данные и построим отчет! С помощью команды allure serve /path/to/the/project/allure-example/build/allure-results мы запускаем экземпляр Allure Report и строим локальный веб-отчет, который автоматически открывается как страница.

CI (Jenkins, TeamCity и Bamboo)

Allure Report имеет несколько аккуратных интеграций с различными CI-системами. Настройка каждой системы имеет свои особенности, поэтому мы не будем рассматривать их в этом посте. Шаги по созданию отчета с помощью CI-системы описаны на странице документации.

Особенности отчетов Allure

Параметризированные тесты

Allure умеет работать с параметризованными автоматизированными тестами. В качестве примера рассмотрим тест JUnit. Сначала создадим тестовый класс с параметризованными тестами следующего вида:

@Layer("rest")
@Owner("baev")
@Feature("Issues")
public class IssuesRestTest {

    private static final String OWNER = "allure-framework";
    private static final String REPO = "allure2";

    private final RestSteps steps = new RestSteps();

    @TM4J("AE-T1")
    @Story("Create new issue")
    @Microservice("Billing")
    @Tags({@Tag("api"), @Tag("smoke")})

    **@ParameterizedTest(name = "Create issue via api")**

    @ValueSource(strings = {"First Note", "Second Note"})
    public void shouldCreateUserNote(String title) {
        parameter("owner", OWNER);
        parameter("repo", REPO);
        parameter("title", title);

        steps.createIssueWithTitle(OWNER, REPO, title);
        steps.shouldSeeIssueWithTitle(OWNER, REPO, title);
    }

Как вы видите, после выполнения Allure предоставляет результаты выполнения параметризованного теста в виде набора тестов. Если какой-либо из тестов не работает, Allure предоставляет подробную информацию об этом конкретном случае.

Категории

Категории – одна из наиболее экономящих время функций Allure Report. Она обеспечивает простую автоматизацию для разрешения ошибок. По умолчанию существует две категории дефектов:

• Дефекты продукта (неудачные тесты)
• Дефекты тестирования (неработающие тесты).

Она полностью настраивается с помощью простой конфигурации json. Для создания пользовательской классификации дефектов добавьте файл categories.json в каталог allure-results перед генерацией отчета.

Open json template [ { "name": "Ignored tests", "matchedStatuses": ["skipped"] }, { "name": "Infrastructure problems", "matchedStatuses": ["broken", "failed"], "messageRegex": ".*bye-bye.*" }, { "name": "Outdated tests", "matchedStatuses": ["broken"], "traceRegex": ".*FileNotFoundException.*" }, { "name": "Product defects", "matchedStatuses": ["failed"] }, { "name": "Test defects", "matchedStatuses": ["broken"] } ]

Файл json включает следующие данные:

• (обязательно) название категории
• (необязательный) список подходящих статусов тестов. По умолчанию [“failed”, “broken”, “passed”, “skipped”, “unknown”].
• (необязательный) regex-шаблон для проверки сообщения об ошибке теста. По умолчанию “.”
• (необязательный) regex-шаблон для проверки трассировки стека. По умолчанию “.”.
• Результат теста попадает в категорию, если его статус находится в списке и сообщение об ошибке и трассировка стека соответствуют шаблону.

В случае использования плагинов allure-maven или allure-gradle, файл categories.json может быть сохранен в каталоге ресурсов теста.

Повторные попытки

Повторы – это выполнение одних и тех же тестовых случаев (сигнатура вычисляется на основе имени тестового метода и параметров) в рамках одного выполнения тестового набора, например, при использовании TestNG IRetryAnalyzer или JUnit retry Rules. Не поддерживается для локальных запусков.

История тестов

Allure 2 поддерживает историю для тестов в отчете. При каждой генерации отчета во время сборки, Jenkins, Allure Plugin будет пытаться получить доступ к рабочей директории предыдущей сборки и скопировать содержимое папки allure-reporthistory в текущий отчет.

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

Структура отчета и приборные панели

Обзор

По умолчанию используется страница ‘Обзор’ с приборными панелями и виджетами. На странице есть несколько виджетов по умолчанию, представляющих основные характеристики вашего проекта и тестовой среды:

• Статистика – общая статистика отчета.
• Запуски – если отчет представляет несколько запусков теста, здесь будет показана статистика по каждому запуску.
• Поведение – информация о результатах, агрегированная по историям и особенностям.
• Исполнители – информация об исполнителях тестов, которые использовались для запуска тестов.
• History Trend – если тесты накапливают некоторые исторические данные, их тренд будет рассчитан и показан на графике.
• Окружение – информация о тестовом окружении.

Виджеты главной страницы можно перетаскивать и настраивать. Кроме того, Allure поддерживает собственную систему плагинов, поэтому возможны совершенно разные варианты компоновки виджетов.

Категории

На странице отображаются общие дефекты. Если тест является сбоем утверждения, то отчет выводится как ‘Product defect’, а если тест не прошел из-за какого-то исключения, то отчет выводится как ‘Test defect’.

Наборы, поведения и пакеты

Три вкладки, которые показывают дерево тестовых примеров, построенное по различным критериям:

• Suites отображает тестовые случаи, основанные на выполненном наборе.
• Вкладка Behaviors строит дерево на основе историй и аннотаций функций.
• Вкладка Packages показывает тестовые случаи, сгруппированные по именам пакетов.

Графики

Вкладка для визуализации результатов тестирования с помощью графиков. Конфигурации по умолчанию обеспечивают:

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

Временная шкала

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

Вот и все!

Qameta Software фокусируется на разработке удивительных инструментов, которые помогают тестировщикам программного обеспечения. Узнайте больше о Allure Framework, легком инструменте отчетности автоматизации, и Allure TestOps, универсальной платформе для тестирования DevOps.

Следите за нами на LinkedIn или Twitter, или обращайтесь за помощью на GitHub Discussions.