com.hazelcast.test.archunit.MixTestAnnotationsCondition Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of hazelcast-archunit-rules Show documentation
The newest version!
/*
 * Copyright (c) 2008-2024, Hazelcast, Inc. All Rights Reserved.
 *
 * 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 com.hazelcast.test.archunit;

import com.tngtech.archunit.core.domain.JavaClass;
import com.tngtech.archunit.lang.ArchCondition;
import com.tngtech.archunit.lang.ConditionEvents;
import com.tngtech.archunit.lang.SimpleConditionEvent;
import org.junit.After;
import org.junit.AfterClass;
import org.junit.Before;
import org.junit.BeforeClass;
import org.junit.Test;

import java.lang.annotation.Annotation;
import java.util.Set;

public class MixTestAnnotationsCondition extends ArchCondition {
    private static final Set> JUNIT_4_ANNOTATION_CLASSES = Set.of(
            Test.class,
            Before.class,
            After.class,
            BeforeClass.class,
            AfterClass.class);
    private static final Set> JUNIT_5_ANNOTATION_CLASSES = Set.of(
            org.junit.jupiter.api.Test.class,
            org.junit.jupiter.api.BeforeEach.class,
            org.junit.jupiter.api.AfterEach.class,
            org.junit.jupiter.api.BeforeAll.class,
            org.junit.jupiter.api.AfterAll.class
    );

    public MixTestAnnotationsCondition() {
        super("Do not mix Junit4 and Junit5 annotations");
    }


    @Override
    public void check(JavaClass item, ConditionEvents events) {
        boolean hasJUnit4Annotation = item.getMethods().stream()
                .anyMatch(method -> JUNIT_4_ANNOTATION_CLASSES.stream()
                        .anyMatch(method::isAnnotatedWith));

        boolean hasJUnit5Annotation = item.getMethods().stream()
                .anyMatch(method -> JUNIT_5_ANNOTATION_CLASSES.stream()
                        .anyMatch(method::isAnnotatedWith));

        if (hasJUnit4Annotation && hasJUnit5Annotation) {
            String message = String.format("Class %s mixes JUnit 4 and JUnit 5 annotations.", item.getName());
            events.add(SimpleConditionEvent.violated(item, message));
        }
    }

    public static ArchCondition notMixJUnit4AndJUnit5Annotations() {
        return new MixTestAnnotationsCondition();
    }
}