software.amazon.smithy.model.validation.validators.JsonNameValidator Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2022 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.model.validation.validators;

import java.util.ArrayList;
import java.util.HashSet;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.TreeMap;
import java.util.TreeSet;
import java.util.stream.Collectors;
import software.amazon.smithy.model.Model;
import software.amazon.smithy.model.shapes.MemberShape;
import software.amazon.smithy.model.shapes.Shape;
import software.amazon.smithy.model.shapes.ShapeId;
import software.amazon.smithy.model.traits.JsonNameTrait;
import software.amazon.smithy.model.validation.AbstractValidator;
import software.amazon.smithy.model.validation.ValidationEvent;

public final class JsonNameValidator extends AbstractValidator {
    @Override
    public List validate(Model model) {
        List events = new ArrayList<>();
        Set visitedContainers = new HashSet<>();

        // Find every member marked with a jsonName trait. The containing shapes of these members are
        // the only structure/union shapes that need to be validated.
        for (MemberShape member : model.getMemberShapesWithTrait(JsonNameTrait.class)) {
            // If the container hasn't been visited yet, then validate it's members.
            if (visitedContainers.add(member.getContainer())) {
                validateMembersOfContainer(model.expectShape(member.getContainer()), events);
            }
        }
        return events;
    }

    private void validateMembersOfContainer(Shape container, List events) {
        Map> memberMappings = new TreeMap<>();
        for (MemberShape m : container.members()) {
            String jsonName = m.getTrait(JsonNameTrait.class)
                    .map(JsonNameTrait::getValue)
                    .orElseGet(m::getMemberName);
            memberMappings.computeIfAbsent(jsonName, n -> new TreeSet<>()).add(m);
        }

        for (Map.Entry> entry : memberMappings.entrySet()) {
            if (entry.getValue().size() > 1) {
                events.add(error(container, String.format(
                        "This shape contains members with conflicting JSON names that resolve to '%s': %s",
                        entry.getKey(),
                        entry.getValue().stream().map(MemberShape::getMemberName).collect(Collectors.joining(", ")))));
            }
        }
    }
}