Allure2: убираем аннотации @Step и интеграция с Selenide

Привет, друзья! В преддверии Нового года решил поделиться еще одним замечательным советом, который поможет вам в повседневной работе. В этот раз речь пойдет об интеграции Allure2 и Selenide, а также я покажу, как можно отказаться от аннотаций @Step.

В августе я уже писал статью о том, как можно убрать аннотации @Step для Allure1. О мотивации и подходе можете почитать в архивной заметке.

После той статьи многие просили показать пример для Allure2. На своих проектах я давно им пользуюсь, но количество наших тестов было настолько мало (до 100), что кастомизации нам были просто не нужны. Теперь наш тест-сьют вырос до больших размеров и без информативного отчета жизнь стала грустной.

Пришло время разбираться, как же там это все сделать для второй версии отчета. Ниже вы можете наблюдать работающий код примеров. Как и для первой версии пишем кастомный AspectJ класс:

import io.qameta.allure.Allure;
import io.qameta.allure.AllureLifecycle;
import io.qameta.allure.model.Status;
import io.qameta.allure.model.StepResult;
import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.annotation.Around;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Pointcut;
import org.aspectj.lang.reflect.MethodSignature;

import java.util.Objects;
import java.util.UUID;
import java.util.stream.Collectors;
import java.util.stream.Stream;

import static io.qameta.allure.Allure.getLifecycle;
import static io.qameta.allure.util.ResultsUtils.getStatus;
import static io.qameta.allure.util.ResultsUtils.getStatusDetails;

@SuppressWarnings("unused")
@Aspect
public class CustomAspect {

    private static AllureLifecycle lifecycle;

    @Pointcut("execution(* com.pages.*.*(..))")  // -> (2)
    public void anyMethod() {
        //pointcut body, should be empty
    }

    @Around("anyMethod()")
    public Object step(ProceedingJoinPoint joinPoint) throws Throwable {
        final MethodSignature methodSignature = (MethodSignature) joinPoint.getSignature();
        final String name = joinPoint.getArgs().length > 0
                ? String.format("%s (%s)", methodSignature.getName(), arrayToString(joinPoint.getArgs())) // -> (1)
                : methodSignature.getName();
        final String uuid = UUID.randomUUID().toString();
        final StepResult result = new StepResult()
                .withName(name);
        getLifecycle().startStep(uuid, result);
        try {
            final Object proceed = joinPoint.proceed();
            getLifecycle().updateStep(uuid, s -> s.withStatus(Status.PASSED));
            return proceed;
        } catch (Throwable e) {
            getLifecycle().updateStep(uuid, s -> s
                    .withStatus(getStatus(e).orElse(Status.BROKEN))
                    .withStatusDetails(getStatusDetails(e).orElse(null)));
            throw e;
        } finally {
            getLifecycle().stopStep(uuid);
        }

    }

    public static AllureLifecycle getLifecycle() {
        if (Objects.isNull(lifecycle)) {
            lifecycle = Allure.getLifecycle();
        }
        return lifecycle;
    }

    private static String arrayToString(final Object... array) {
        return Stream.of(array)
                .map(object -> {
                    if (object.getClass().isArray()) {
                        return arrayToString((Object[]) object);
                    }
                    return Objects.toString(object);
                })
                .collect(Collectors.joining(", "));
    }

}
  1. Строчка, в которой происходит форматирование имени метода и параметров

  2. Место, в котором нужно указать имя пакета с классами PageObject

Далее, как и в первой версии отчета, в папке src/main/resources/META-INF создаем файл aop-ajc.xml c содержанием:

<aspectj>
    <aspects>
        <aspect name="com.aspect.CustomAspect"/>
    </aspects>
</aspectj>

Все, теперь можно запускать тесты и наслаждаться отчетом. Достаточно просто, нужно еще что-то подкрутить! Крутые пацаны не останавливаются на достигнутом. Хотим, чтобы методы Selenide логировались в Allure отчет.

Благо, что такую фичу тоже достаточно легко сделать. В репозитории allure-java уже есть пример. Все, что вам нужно, - это в своем проекте создать такой класс:

import com.codeborne.selenide.WebDriverRunner;
import com.codeborne.selenide.logevents.LogEvent;
import com.codeborne.selenide.logevents.LogEventListener;
import io.qameta.allure.Allure;
import io.qameta.allure.AllureLifecycle;
import io.qameta.allure.model.Status;
import io.qameta.allure.model.StatusDetails;
import io.qameta.allure.model.StepResult;
import io.qameta.allure.util.ResultsUtils;
import org.openqa.selenium.OutputType;
import org.openqa.selenium.TakesScreenshot;

import java.nio.charset.StandardCharsets;
import java.util.UUID;

public class AllureSelenide implements LogEventListener {

    private final AllureLifecycle lifecycle;

    public AllureSelenide() {
        this(Allure.getLifecycle());
    }

    public AllureSelenide(final AllureLifecycle lifecycle) {
        this.lifecycle = lifecycle;
    }

    @Override
    public void onEvent(final LogEvent event) {
        lifecycle.getCurrentTestCase().ifPresent(uuid -> {
            final String stepUUID = UUID.randomUUID().toString();
            lifecycle.startStep(stepUUID, new StepResult()
                    .withName(event.toString())
                    .withStatus(Status.PASSED));

            lifecycle.updateStep(stepResult -> stepResult.setStart(stepResult.getStart() - event.getDuration()));

            if (LogEvent.EventStatus.FAIL.equals(event.getStatus())) {
                lifecycle.addAttachment("Screenshot", "image/png", "png", getScreenshotBytes());
                lifecycle.addAttachment("Page source", "text/html", "html", getPageSourceBytes());
                lifecycle.updateStep(stepResult -> {
                    final StatusDetails details = ResultsUtils.getStatusDetails(event.getError())
                            .orElse(new StatusDetails());
                    stepResult.setStatus(Status.FAILED);
                    stepResult.setStatusDetails(details);
                });
            }
            lifecycle.stopStep(stepUUID);
        });
    }


    private static byte[] getScreenshotBytes() {
        return ((TakesScreenshot) WebDriverRunner.getWebDriver()).getScreenshotAs(OutputType.BYTES);
    }

    private static byte[] getPageSourceBytes() {
        return WebDriverRunner.getWebDriver().getPageSource().getBytes(StandardCharsets.UTF_8);
    }

}

Затем этот класс нужно зарегистрировать в Selenide:

@BeforeClass
public void setUp() throws Exception {
   SelenideLogger.addListener("allure", new AllureSelenide());
}

Теперь смотрим на все в куче. Пишем класс страницы:

Calculator
public class Calulator {

    public Calulator open() {
        Selenide.open("http://juliemr.github.io/protractor-demo/");
        return this;
    }

    public void add(String one, String two) {
        $("input[ng-model='first']").setValue(one);
        $("input[ng-model='second']").setValue(two);
        $("#gobutton").click();
    }

}

Пишем тест:

TestCalculator
public class TestCalculator extends BaseTest {

    @org.testng.annotations.Test
    public void testName() throws Exception {
        new Calulator()
                .open()
                .add("1", "2");
    }
}

Запускаем тест и тешимся результатами.

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

Нужна помощь? Закажи частную консультацию