software.amazon.smithy.diff.evaluators.AbstractLengthAndRangeValidator Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of smithy-diff Show documentation

This module detects differences between two Smithy models, identifying changes that are safe and changes that are backward incompatible.

There is a newer version: 1.53.0

Show newest version

/*
 * Copyright 2019 Amazon.com, Inc. or its affiliates. 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.
 * A copy of the License is located at
 *
 *  http://aws.amazon.com/apache2.0
 *
 * or in the "license" file accompanying this file. This file 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 software.amazon.smithy.diff.evaluators;

import java.math.BigDecimal;
import java.util.ArrayList;
import java.util.List;
import java.util.Optional;
import java.util.stream.Collectors;
import java.util.stream.Stream;
import software.amazon.smithy.diff.ChangedShape;
import software.amazon.smithy.diff.Differences;
import software.amazon.smithy.model.shapes.Shape;
import software.amazon.smithy.model.traits.Trait;
import software.amazon.smithy.model.validation.ValidationEvent;
import software.amazon.smithy.utils.Pair;

/**
 * Implements the shared logic for length and range trait validation.
 *
 * @param  LengthTrait or RangeTrait types to validate.
 */
abstract class AbstractLengthAndRangeValidator extends AbstractDiffEvaluator {
    @Override
    public final List evaluate(Differences differences) {
        return differences.changedShapes()
                .flatMap(change -> {
                    Pair pair = change.getChangedTrait(getTraitType()).orElse(null);
                    return pair == null
                           ? Stream.empty()
                           : validateTrait(change, pair).stream();
                })
                .collect(Collectors.toList());
    }

    abstract Class getTraitType();

    abstract Optional getMin(T trait);

    abstract Optional getMax(T trait);

    private List validateTrait(ChangedShape change, Pair changedTrait) {
        List events = new ArrayList<>();
        T oldTrait = changedTrait.getLeft();
        T newTrait = changedTrait.getRight();
        BigDecimal oldMin = getMin(oldTrait).orElse(BigDecimal.ZERO);
        BigDecimal newMin = getMin(newTrait).orElse(BigDecimal.ZERO);
        BigDecimal oldMax = getMax(oldTrait).orElse(null);
        BigDecimal newMax = getMax(newTrait).orElse(null);

        if (newMin.compareTo(oldMin) > 0) {
            events.add(error(change.getNewShape(), String.format(
                    "%s trait value `min` was made more restrictive by raising from %s to %s",
                    newTrait.toShapeId(), oldMin, newMin)));
        }

        if (newMax != null && (oldMax == null || oldMax.compareTo(newMax) > 0)) {
            events.add(error(change.getNewShape(), String.format(
                    "%s trait value `max` was made more restrictive by lowering from %s to %s",
                    newTrait.toShapeId(), oldMax, newMax)));
        }

        return events;
    }
}