io.qameta.allure.junit5assert.AllureJunit5Assert Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of allure-junit5-assert Show documentation
Allure Junit5 Assertions Integration
There is a newer version: 2.29.1
/*
 *  Copyright 2019 Qameta Software OÜ
 *
 *  Licensed under the Apache License, Version 2.0 (the "License");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 */
package io.qameta.allure.junit5assert;

import io.qameta.allure.Allure;
import io.qameta.allure.AllureLifecycle;
import io.qameta.allure.model.Status;
import io.qameta.allure.model.StepResult;
import io.qameta.allure.util.ObjectUtils;
import org.aspectj.lang.JoinPoint;
import org.aspectj.lang.annotation.AfterReturning;
import org.aspectj.lang.annotation.AfterThrowing;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Before;
import org.aspectj.lang.annotation.Pointcut;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import java.util.Arrays;
import java.util.List;
import java.util.UUID;
import java.util.stream.Collectors;

import static io.qameta.allure.util.ResultsUtils.getStatus;

/**
 * @author legionivo (Andrey Konovka).
 */
@SuppressWarnings("all")
@Aspect
public class AllureJunit5Assert {

    private static final Logger LOGGER = LoggerFactory.getLogger(AllureJunit5Assert.class);
    private StepResult stepResult;


    private static InheritableThreadLocal lifecycle = new InheritableThreadLocal() {
        @Override
        protected AllureLifecycle initialValue() {
            return Allure.getLifecycle();
        }
    };

    @Pointcut("call(void org.junit.jupiter.api.Assertions.*(..)) || throwable()")
    public void anyAssert() {

    }

    @Pointcut("call(Throwable org.junit.jupiter.api.Assertions.*(..))")
    public void throwable() {

    }

    @Before("anyAssert()")
    public void stepStart(final JoinPoint joinPoint) {
        if (joinPoint.getArgs().length > 1) {
            final String uuid = UUID.randomUUID().toString();
            final String assertName = joinPoint.getSignature().getName();
            String name;
            if (joinPoint.getSignature().getName().equalsIgnoreCase("assertAll")) {
                name = String.format("assert All in " + " \'%s\'", joinPoint.getArgs()[0].toString());
            } else {

                final String actual = joinPoint.getArgs().length > 0
                        ? ObjectUtils.toString(joinPoint.getArgs()[1])
                        : "";
                final String expected = joinPoint.getArgs().length > 0
                        ? ObjectUtils.toString(joinPoint.getArgs()[0])
                        : "";

                final List assertArray = Arrays.asList(assertName.split("(?=[A-Z])"));
                if (assertArray.size() >= 3) {
                    name = String.format(assertArray.get(0) + " " + assertArray.get(1) + " \'%s\'", expected)
                            + " " + String.format(assertArray.stream()
                            .skip(2)
                            .collect(Collectors.joining(" ")) + " \'%s\'", actual);
                } else {
                    name = String.format(assertArray.get(0) + " \'%s\'", expected) + " " + String.format(assertArray.get(1) + " \'%s\'", actual);
                }
            }
            final StepResult result = new StepResult()
                    .setName(name)
                    .setStatus(Status.PASSED);
            getLifecycle().startStep(uuid, result);
        } else if (joinPoint.getArgs().length > 0) {
            final String actual = joinPoint.getArgs().length > 0
                    ? ObjectUtils.toString(joinPoint.getArgs()[0])
                    : "";
            final String uuid = UUID.randomUUID().toString();
            final String assertName = joinPoint.getSignature().getName();
            final String name = String.format(assertName + " \'%s\'", actual);

            final StepResult result = new StepResult()
                    .setName(name)
                    .setStatus(Status.PASSED);
            getLifecycle().startStep(uuid, result);
        }
    }

    @AfterThrowing(pointcut = "anyAssert()", throwing = "e")
    public void stepFailed(final Throwable e) {
        getLifecycle().updateStep(s -> s
                .setStatus(getStatus(e).orElse(Status.BROKEN)));
        getLifecycle().stopStep();
    }

    @AfterReturning(pointcut = "anyAssert()")
    public void stepStop() {
        getLifecycle().updateStep(s -> s.setStatus(Status.PASSED));
        getLifecycle().stopStep();
    }

    /**
     * For tests only.
     *
     * @param allure allure lifecycle to set.
     */
    public static void setLifecycle(final AllureLifecycle allure) {
        lifecycle.set(allure);
    }

    public static AllureLifecycle getLifecycle() {
        return lifecycle.get();
    }

}