modules/configuration/src/main/java/org/apache/ignite/internal/configuration/validation/ValidationUtil.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF 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 org.apache.ignite.internal.configuration.validation;

import java.lang.annotation.Annotation;
import java.lang.reflect.Field;
import java.lang.reflect.ParameterizedType;
import java.lang.reflect.Type;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.function.Function;
import org.apache.ignite.configuration.RootKey;
import org.apache.ignite.configuration.validation.ValidationIssue;
import org.apache.ignite.configuration.validation.Validator;
import org.apache.ignite.internal.configuration.SuperRoot;
import org.apache.ignite.internal.configuration.tree.InnerNode;
import org.apache.ignite.internal.configuration.util.AnyNodeConfigurationVisitor;
import org.apache.ignite.internal.configuration.util.KeysTrackingConfigurationVisitor;

import static java.util.Collections.emptySet;
import static org.apache.ignite.internal.configuration.util.ConfigurationUtil.appendKey;

/** */
public class ValidationUtil {
    /**
     * Validate configuration changes.
     *
     * @param oldRoots Old known roots.
     * @param newRoots New roots.
     * @param otherRoots Provider for arbitrary roots that might not be accociated with the same storage.
     * @param memberAnnotationsCache Mutable map that contains annotations associated with corresponding member keys.
     * @param validators Current validators map to look into.
     * @return List of validation results.
     */
    public static List<ValidationIssue> validate(
        SuperRoot oldRoots,
        SuperRoot newRoots,
        Function<RootKey<?, ?>, InnerNode> otherRoots,
        Map<MemberKey, Annotation[]> memberAnnotationsCache,
        Map<Class<? extends Annotation>, Set<Validator<?, ?>>> validators
    ) {
        List<ValidationIssue> issues = new ArrayList<>();

        newRoots.traverseChildren(new KeysTrackingConfigurationVisitor<>() {
            /** {@inheritDoc} */
            @Override protected Object doVisitInnerNode(String key, InnerNode innerNode) {
                assert innerNode != null;

                innerNode.traverseChildren(new AnyNodeConfigurationVisitor<Void>() {
                    @Override protected Void visitNode(String key, Object node) {
                        validate(innerNode, key, node);

                        return null;
                    }
                }, true);

                return super.doVisitInnerNode(key, innerNode);
            }

            /**
             * Perform validation on the node's subnode.
             *
             * @param lastInnerNode Inner node that contains validated field.
             * @param fieldName Name of the field.
             * @param val Value of the field.
             */
            private void validate(InnerNode lastInnerNode, String fieldName, Object val) {
                if (val == null) {
                    String message = "'" + (currentKey() + fieldName) + "' configuration value is not initialized.";

                    issues.add(new ValidationIssue(message));

                    return;
                }

                MemberKey memberKey = new MemberKey(lastInnerNode.getClass(), fieldName);

                Annotation[] fieldAnnotations = memberAnnotationsCache.computeIfAbsent(memberKey, k -> {
                    try {
                        Field field = lastInnerNode.schemaType().getDeclaredField(fieldName);

                        return field.getDeclaredAnnotations();
                    }
                    catch (NoSuchFieldException e) {
                        // Should be impossible.
                        return new Annotation[0];
                    }
                });

                if (fieldAnnotations.length == 0)
                    return;

                String currentKey = currentKey() + fieldName;
                List<String> currentPath = appendKey(currentPath(), fieldName);

                for (Annotation annotation : fieldAnnotations) {
                    for (Validator<?, ?> validator : validators.getOrDefault(annotation.annotationType(), emptySet())) {
                        // Making this a compile-time check would be too expensive to implement.
                        assert assertValidatorTypesCoherence(validator.getClass(), annotation.annotationType(), val)
                            : "Validator coherence is violated [" +
                            "class=" + lastInnerNode.getClass().getCanonicalName() + ", " +
                            "field=" + fieldName + ", " +
                            "annotation=" + annotation.annotationType().getCanonicalName() + ", " +
                            "validator=" + validator.getClass().getName() + ']';

                        ValidationContextImpl<Object> ctx = new ValidationContextImpl<>(
                            oldRoots,
                            newRoots,
                            otherRoots,
                            val,
                            currentKey,
                            currentPath,
                            issues
                        );

                        ((Validator<Annotation, Object>)validator).validate(annotation, ctx);
                    }
                }
            }
        }, true);

        return issues;
    }

    /** */
    private static boolean assertValidatorTypesCoherence(
        Class<?> validatorClass,
        Class<? extends Annotation> annotationType,
        Object val
    ) {
        // Find superclass that directly extends Validator.
        if (!Arrays.asList(validatorClass.getInterfaces()).contains(Validator.class))
            return assertValidatorTypesCoherence(validatorClass.getSuperclass(), annotationType, val);

        Type genericSuperClass = Arrays.stream(validatorClass.getGenericInterfaces())
            .filter(i -> i instanceof ParameterizedType && ((ParameterizedType)i).getRawType() == Validator.class)
            .findAny()
            .get();

        if (!(genericSuperClass instanceof ParameterizedType))
            return false;

        ParameterizedType parameterizedSuperClass = (ParameterizedType)genericSuperClass;

        Type[] actualTypeParameters = parameterizedSuperClass.getActualTypeArguments();

        if (actualTypeParameters.length != 2)
            return false;

        if (actualTypeParameters[0] != annotationType)
            return false;

        Type sndParam = actualTypeParameters[1];

        if (sndParam instanceof ParameterizedType)
            sndParam = ((ParameterizedType)sndParam).getRawType();

        return (sndParam instanceof Class) && (val == null || ((Class<?>)sndParam).isInstance(val));
    }
}