org.neo4j.gds.junit.annotation.DisableForNeo4jVersionCondition Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of test-utils Show documentation
Neo4j Graph Data Science :: Test Utils
There is a newer version: 2.11.0
/*
 * Copyright (c) "Neo4j"
 * Neo4j Sweden AB [http://neo4j.com]
 *
 * This file is part of Neo4j.
 *
 * Neo4j is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see .
 */
package org.neo4j.gds.junit.annotation;

import org.junit.jupiter.api.extension.ConditionEvaluationResult;
import org.junit.jupiter.api.extension.ExecutionCondition;
import org.junit.jupiter.api.extension.ExtensionContext;
import org.neo4j.gds.compat.GraphDatabaseApiProxy;

import java.lang.reflect.AnnotatedElement;
import java.util.Arrays;

import static org.junit.jupiter.api.extension.ConditionEvaluationResult.disabled;
import static org.junit.jupiter.params.shadow.com.univocity.parsers.annotations.helpers.AnnotationHelper.findAnnotation;
import static org.neo4j.gds.utils.StringFormatting.formatWithLocale;

public class DisableForNeo4jVersionCondition implements ExecutionCondition {

    private static final ConditionEvaluationResult ENABLED_BY_DEFAULT =
        ConditionEvaluationResult.enabled("@DisableForNeo4jVersion is not present");

    @Override
    public ConditionEvaluationResult evaluateExecutionCondition(ExtensionContext context) {
        var element = context
            .getElement()
            .orElseThrow(IllegalStateException::new);

        DisableForNeo4jVersion[] annotations;

        var single = findAnnotation(element, DisableForNeo4jVersion.class);
        if (single != null) {
            annotations = new DisableForNeo4jVersion[]{single};
        } else {
            var repeated = findAnnotation(element, DisableForNeo4jVersions.class);
            annotations = repeated != null ? repeated.value() : new DisableForNeo4jVersion[0];
        }

        return shouldDisableForNeo4jVersion(
            Arrays.asList(annotations),
            element
        );
    }

    private ConditionEvaluationResult shouldDisableForNeo4jVersion(
        Iterable annotations,
        AnnotatedElement element
    ) {
        var currentNeo4jVersion = GraphDatabaseApiProxy.neo4jVersion();

        for (var annotation : annotations) {
            var excludedNeo4jVersion = annotation.value();
            if (excludedNeo4jVersion.matches(currentNeo4jVersion)) {
                var message = annotation.message();
                if (message.isBlank()) {
                    message = formatWithLocale(
                        "%s should be disabled for Neo4j %s",
                        element,
                        excludedNeo4jVersion
                    );
                }
                return disabled(message);
            }
        }

        return ENABLED_BY_DEFAULT;
    }
}