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

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

import java.util.ArrayList;
import java.util.HashSet;
import java.util.List;
import java.util.Set;
import java.util.stream.Collectors;
import software.amazon.smithy.model.Model;
import software.amazon.smithy.model.knowledge.TopDownIndex;
import software.amazon.smithy.model.shapes.OperationShape;
import software.amazon.smithy.model.shapes.ResourceShape;
import software.amazon.smithy.model.shapes.ServiceShape;
import software.amazon.smithy.model.shapes.Shape;
import software.amazon.smithy.model.shapes.ShapeId;
import software.amazon.smithy.model.validation.AbstractValidator;
import software.amazon.smithy.model.validation.ValidationEvent;

/**
 * Validates that an operation is only bound to once in an entire
 * service closure.
 */
public final class SingleOperationBindingValidator extends AbstractValidator {

    @Override
    public List validate(Model model) {
        TopDownIndex topDownIndex = TopDownIndex.of(model);
        return model.shapes(ServiceShape.class)
                .flatMap(shape -> validateService(topDownIndex, shape).stream())
                .collect(Collectors.toList());
    }

    private List validateService(TopDownIndex topDownIndex, ServiceShape service) {
        List events = new ArrayList<>();

        for (OperationShape operation : topDownIndex.getContainedOperations(service)) {
            ShapeId id = operation.getId();
            Set containers = new HashSet<>();
            if (service.getOperations().contains(id)) {
                containers.add(service);
            }

            for (ResourceShape resource : topDownIndex.getContainedResources(service.getId())) {
                if (resource.getAllOperations().contains(id)) {
                    containers.add(resource);
                }
            }

            if (containers.size() > 1) {
                events.add(error(operation, String.format(
                        "An operation can appear only once in an entire service closure. This operation is "
                        + "illegally bound into the `%s` service closure from multiple shapes: %s",
                        service.getId(),
                        containers.stream().map(Object::toString).sorted().collect(Collectors.joining(", ")))));
            }
        }

        return events;
    }
}