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

Go to download
/*
 * Copyright 2023 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.List;
import java.util.stream.Collectors;
import software.amazon.smithy.model.Model;
import software.amazon.smithy.model.knowledge.ServiceIndex;
import software.amazon.smithy.model.shapes.ServiceShape;
import software.amazon.smithy.model.traits.AuthTrait;
import software.amazon.smithy.model.validation.AbstractValidator;
import software.amazon.smithy.model.validation.ValidationEvent;

/**
 * Validates the @authDefinition traits applied to service shapes.
 */
public class ServiceAuthDefinitionsValidator extends AbstractValidator {

    @Override
    public List validate(Model model) {
        List events = new ArrayList<>();
        ServiceIndex index = ServiceIndex.of(model);

        List services = model.getServiceShapes().stream()
                .filter(serviceShape -> !serviceShape.hasTrait(AuthTrait.ID))
                .filter(serviceShape -> index.getAuthSchemes(serviceShape).size() > 1)
                .collect(Collectors.toList());

        for (ServiceShape service : services) {
            events.add(warning(service, "This service uses multiple authentication schemes but does not have "
                                        + "the `@auth` trait applied. The `@auth` trait defines a priority ordering "
                                        + "of auth schemes for a client to use. Without it, the ordering of auth "
                                        + "schemes is alphabetical based on the absolute shape ID of the auth "
                                        + "schemes."));

        }
        return events;
    }
}