io.bootique.junit5.handler.app.ClassAppRegistry Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of bootique-junit5 Show documentation

Provides a test framework on top of Bootique.

There is a newer version: 3.0.M2

/*
 * Licensed to ObjectStyle LLC under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ObjectStyle LLC licenses
 * this file to you 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.bootique.junit5.handler.app;

import io.bootique.BQRuntime;
import io.bootique.junit5.BQApp;
import org.junit.jupiter.api.extension.ExtensionContext;
import org.junit.platform.commons.JUnitException;
import org.junit.platform.commons.util.ReflectionUtils;

import java.lang.reflect.Field;

/**
 * @since 2.0
 */
public class ClassAppRegistry extends BQAppRegistry {

    @Override
    public void beforeContext(ExtensionContext context) {
        Class testType = context.getRequiredTestClass();
        ReflectionUtils
                .findFields(testType, this::supportsApp, ReflectionUtils.HierarchyTraversalMode.TOP_DOWN)
                .forEach(f -> onAppFieldFound(null, f));
    }

    protected boolean supportsApp(Field appField) {

        BQApp a = appField.getAnnotation(BQApp.class);
        if (a == null) {
            return false;
        }

        if (!BQRuntime.class.isAssignableFrom(appField.getType())) {
            throw new JUnitException("Field '" + appField.getDeclaringClass().getName() + "." + appField.getName() +
                    "' is annotated with @BQApp but is not a BQRuntime.");
        }

        boolean isStatic = ReflectionUtils.isStatic(appField);
        switch (a.value()) {
            case TEST_CLASS:
                if (!isStatic) {
                    throw new JUnitException("@BQApp field '"
                            + appField.getDeclaringClass().getName() + "." + appField.getName()
                            + "' must be static to be used in TEST_CLASS scope");
                }
                return true;
            case IMPLIED:
                // static fields with no explicit scope should be treated as TEST_CLASS
                return isStatic;
            default:
                return false;
        }
    }
}