AllureAspectJ.java

/*
 *  Copyright 2016-2024 Qameta Software Inc
 *
 *  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.assertj;

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.After;
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.Optional;
import java.util.UUID;
import java.util.stream.Collectors;
import java.util.stream.Stream;

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

/**
 * @author charlie (Dmitry Baev).
 * @author sskorol (Sergey Korol).
 */
@SuppressWarnings("all")
@Aspect
public class AllureAspectJ {

    private static final Logger LOGGER = LoggerFactory.getLogger(AllureAspectJ.class);

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

    @Pointcut("execution(!private org.assertj.core.api.AbstractAssert.new(..))")
    public void anyAssertCreation() {
        //pointcut body, should be empty
    }

    @Pointcut("execution(* org.assertj.core.api.AssertJProxySetup.*(..))")
    public void proxyMethod() {
        //pointcut body, should be empty
    }

    @Pointcut("execution(public * org.assertj.core.api.AbstractAssert+.*(..)) && !proxyMethod()")
    public void anyAssert() {
        //pointcut body, should be empty
    }

    @After("anyAssertCreation()")
    public void logAssertCreation(final JoinPoint joinPoint) {
        final String actual = joinPoint.getArgs().length > 0
                ? ObjectUtils.toString(joinPoint.getArgs()[0])
                : "<?>";
        final String uuid = UUID.randomUUID().toString();
        final String name = String.format("assertThat \'%s\'", actual);

        final StepResult result = new StepResult()
                .setName(name)
                .setStatus(Status.PASSED);

        getLifecycle().startStep(uuid, result);
        getLifecycle().stopStep(uuid);
    }

    @Before("anyAssert()")
    public void stepStart(final JoinPoint joinPoint) {
        final String uuid = UUID.randomUUID().toString();
        final String name = getStepName(joinPoint);
        if (isStartBubbling(name)) return;

        final StepResult result = new StepResult()
                .setName(name);

        getLifecycle().startStep(uuid, result);
    }

    @AfterThrowing(pointcut = "anyAssert()", throwing = "e")
    public void stepFailed(final JoinPoint joinPoin, final Throwable e) {
        final String name = getStepName(joinPoin);
        if (isEndBubbling(name)) return;

        getLifecycle().updateStep(s -> s
                .setStatus(getStatus(e).orElse(Status.BROKEN))
                .setStatusDetails(getStatusDetails(e).orElse(null)));
        getLifecycle().stopStep();
    }

    @AfterReturning(pointcut = "anyAssert()")
    public void stepStop(final JoinPoint joinPoin) {
        final String name = getStepName(joinPoin);
        if (isEndBubbling(name)) return;

        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();
    }

    private static String arrayToString(final Object... array) {
        return Stream.of(array)
                .map(ObjectUtils::toString)
                .collect(Collectors.joining(" "));
    }

    private String getStepName(JoinPoint joinPoint) {
        return joinPoint.getArgs().length > 0
                ? String.format("%s \'%s\'", joinPoint.getSignature().getName(), arrayToString(joinPoint.getArgs()))
                : joinPoint.getSignature().getName();
    }

    private boolean isStartBubbling(String stepName) {
        final Optional<StepResult> lastResult = getLifecycle().getCurrentStepResult();
        if (!lastResult.isPresent()) return false;
        if (lastResult.get().getStop() != null) return false;
        return stepName.equals(lastResult.get().getName());
    }

    private boolean isEndBubbling(String stepName) {
        final Optional<StepResult> lastResult = getLifecycle().getCurrentStepResult();
        if (!lastResult.isPresent()) return true;
        if (lastResult.get().getStop() != null) return true;
        return !stepName.equals(lastResult.get().getName());
    }
}