software.amazon.smithy.aws.iam.traits.IamResourceTraitValidator Maven / Gradle / Ivy

Go to download
/*
 * Copyright 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.aws.iam.traits;

import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;
import software.amazon.smithy.aws.traits.ArnTrait;
import software.amazon.smithy.model.Model;
import software.amazon.smithy.model.shapes.ResourceShape;
import software.amazon.smithy.model.validation.AbstractValidator;
import software.amazon.smithy.model.validation.ValidationEvent;
import software.amazon.smithy.utils.SmithyInternalApi;
import software.amazon.smithy.utils.StringUtils;

/**
 * Ensures that any resource name defined in the {@link IamResourceTrait} is
 * consistent with the resource name used in any {@link ArnTrait} definition
 * applied to the resource.
 */
@SmithyInternalApi
public class IamResourceTraitValidator extends AbstractValidator {
    @Override
    public List validate(Model model) {
        List results = new ArrayList<>();
        for (ResourceShape resource : model.getResourceShapesWithTrait(IamResourceTrait.class)) {
            // If the resource has both the IamResourceTrait and Arn trait,
            // check that the resource name is consistent between the two traits
            if (resource.hasTrait(ArnTrait.class)) {
                String resourceName = resource.expectTrait(IamResourceTrait.class).getName()
                    .orElseGet(() -> StringUtils.lowerCase(resource.getId().getName()));
                ArnTrait arnTrait = resource.expectTrait(ArnTrait.class);
                List arnComponents = parseArnComponents(arnTrait.getTemplate());

                // Do not check for a matching resource name when the arn is marked as absolute
                if (!arnComponents.contains(resourceName) && !arnTrait.isAbsolute()) {
                    results.add(danger(resource, String.format(
                            "The `@aws.iam#iamResource` trait applied to the resource "
                            + "defines an IAM resource name, `%s`, that does not match the `@arn` template, "
                            + "`%s`, of the resource.",
                            resourceName, arnTrait.getTemplate())));
                }
            }
        }
        return results;
    }

    private List parseArnComponents(String arnTemplate) {
        return Arrays.asList(arnTemplate.split("/"));
    }
}