org.neo4j.test.extension.guard.JUnitUsageGuardExtension 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
A set of utilities used by tests.
There is a newer version: 5.25.1
/*
 * Copyright (c) "Neo4j"
 * Neo4j Sweden AB [https://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.test.extension.guard;

import static java.lang.String.format;
import static java.util.stream.Collectors.toSet;
import static org.objectweb.asm.ClassReader.SKIP_DEBUG;
import static org.objectweb.asm.ClassReader.SKIP_FRAMES;

import java.io.IOException;
import java.util.ArrayDeque;
import java.util.ArrayList;
import java.util.Collections;
import java.util.Deque;
import java.util.List;
import java.util.Set;
import org.junit.jupiter.api.extension.BeforeAllCallback;
import org.junit.jupiter.api.extension.ExtensionContext;
import org.junit.platform.commons.JUnitException;
import org.objectweb.asm.ClassReader;

public class JUnitUsageGuardExtension implements BeforeAllCallback {
    @Override
    public void beforeAll(ExtensionContext context) throws Exception {
        Class testClazz = context.getRequiredTestClass();
        Set testClasses = collectUsedTestClasses(testClazz);

        // we do not want to check platform or model classes so far
        testClasses.removeIf(s -> s.startsWith("org.junit.platform"));
        testClasses.removeIf(s -> s.startsWith("org.junit.runners.model"));

        // Description is required while we still have some junit 4 dependencies
        testClasses.removeIf(s -> s.equals("org.junit.runner.Description"));

        Set newJunitClasses = testClasses.stream()
                .filter(s -> s.startsWith("org.junit.jupiter"))
                .collect(toSet());
        if (newJunitClasses.isEmpty() || noOldJunitUsages(testClasses, newJunitClasses)) {
            return;
        }
        // now testClasses should contain only old junit classes.
        testClasses.removeAll(newJunitClasses);
        throw new JUnitException(format(
                "Detect usage of classes from multiple junit versions in the single test class: %s.%n"
                        + "Detected JUnit 5 classes: %s.%n"
                        + "Detected Junit 4 classes: %s.",
                testClazz.getName(), sortedClasses(newJunitClasses), sortedClasses(testClasses)));
    }

    private static List sortedClasses(Set newJunitClasses) {
        List strings = new ArrayList<>(newJunitClasses);
        Collections.sort(strings);
        return strings;
    }

    private static boolean noOldJunitUsages(Set testClasses, Set newJunitClasses) {
        return newJunitClasses.size() == testClasses.size();
    }

    private static Set collectUsedTestClasses(Class clazz) {
        Deque classes = new ArrayDeque<>();
        classes.push(clazz.getName());

        DependenciesCollector dependenciesCollector = new DependenciesCollector(classes);

        while (!classes.isEmpty()) {
            try {
                ClassReader classReader = new ClassReader(classes.pop());
                classReader.accept(dependenciesCollector, SKIP_DEBUG | SKIP_FRAMES);
            } catch (IOException ignored) {
                // Some classes will not be able to load, e.g. org.junit.platform.testkit.engine.*, just ignore
            }
        }

        return dependenciesCollector.getJunitTestClasses();
    }
}