app.getxray.xray.junit.customjunitxml.DefaultXrayTestMetadataReader Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of xray-junit-extensions Show documentation
Improvements for JUnit that allow you to take better advantage of JUnit 5 (jupiter engine) whenever using it together with Xray Test Management.
The newest version!
/*
 * Copyright 2024-2024 the original author or authors.
 *
 * All rights reserved. This program and the accompanying materials are
 * made available under the terms of the Eclipse Public License v2.0 which
 * accompanies this distribution and is available at
 *
 * https://www.eclipse.org/legal/epl-v20.html
 */

package app.getxray.xray.junit.customjunitxml;

import app.getxray.xray.junit.customjunitxml.annotations.Requirement;
import app.getxray.xray.junit.customjunitxml.annotations.XrayTest;
import org.junit.jupiter.api.DisplayName;
import org.junit.jupiter.api.DisplayNameGeneration;
import org.junit.jupiter.api.TestFactory;
import org.junit.platform.commons.support.AnnotationSupport;
import org.junit.platform.engine.support.descriptor.MethodSource;
import org.junit.platform.launcher.TestIdentifier;

import java.lang.annotation.Annotation;
import java.util.Arrays;
import java.util.Collections;
import java.util.List;
import java.util.Optional;

public class DefaultXrayTestMetadataReader implements XrayTestMetadataReader {

    @Override
    public Optional getId(TestIdentifier testIdentifier) {
        return getTestMethodAnnotation(testIdentifier, XrayTest.class)
                .map(XrayTest::id)
                .filter(s -> !s.isEmpty());
    }

    @Override
    public Optional getKey(TestIdentifier testIdentifier) {
        return getTestMethodAnnotation(testIdentifier, XrayTest.class)
                .map(XrayTest::key)
                .filter(s -> !s.isEmpty());
    }

    @Override
    public Optional getSummary(TestIdentifier testIdentifier) {
        Optional testSummary = getTestMethodAnnotation(testIdentifier, XrayTest.class)
                .map(XrayTest::summary)
                .filter(s -> !s.isEmpty());
        if (testSummary.isPresent()) {
            return testSummary;
        }

        Optional displayName = getTestMethodAnnotation(testIdentifier, DisplayName.class);
        if (displayName.isPresent()) {
            return Optional.of(displayName.get().value());
        }


        Optional dynamicTest = getTestMethodAnnotation(testIdentifier, TestFactory.class);
        Optional displayNameGenerator = getTestClassAnnotation(testIdentifier, DisplayNameGeneration.class);
        if (dynamicTest.isPresent() || displayNameGenerator.isPresent()) {
            return Optional.of(testIdentifier.getDisplayName());
        }

        return Optional.empty();
    }

    @Override
    public Optional getDescription(TestIdentifier testIdentifier) {
        return getTestMethodAnnotation(testIdentifier, XrayTest.class)
                .map(XrayTest::description)
                .filter(s -> !s.isEmpty());
    }

    @Override
    public List getRequirements(TestIdentifier testIdentifier) {
        return getTestMethodAnnotation(testIdentifier, Requirement.class)
                .map(Requirement::value)
                .map(arr -> Collections.unmodifiableList(Arrays.asList(arr)))
                .orElse(Collections.emptyList());
    }

    protected  Optional getTestMethodAnnotation(TestIdentifier testIdentifier, Class aClass) {
        return testIdentifier.getSource()
                .filter(a -> a instanceof MethodSource)
                .map(MethodSource.class::cast)
                .map(MethodSource::getJavaMethod)
                .flatMap(a -> AnnotationSupport.findAnnotation(a, aClass));
    }

    protected  Optional getTestClassAnnotation(TestIdentifier testIdentifier, Class aClass) {
        return testIdentifier.getSource()
                .filter(a -> a instanceof MethodSource)
                .map(MethodSource.class::cast)
                .map(MethodSource::getJavaClass)
                .flatMap(a -> AnnotationSupport.findAnnotation(a, aClass));
    }
}
Related Artifacts