io.apicurio.datamodels.validation.rules.invalid.value.OasMissingPathParamDefinitionRule Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2019 Red Hat
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License 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 io.apicurio.datamodels.validation.rules.invalid.value;

import java.util.ArrayList;
import java.util.List;

import io.apicurio.datamodels.models.Operation;
import io.apicurio.datamodels.models.openapi.OpenApiOperation;
import io.apicurio.datamodels.models.openapi.OpenApiParameter;
import io.apicurio.datamodels.models.openapi.OpenApiPathItem;
import io.apicurio.datamodels.validation.ValidationRuleMetaData;

/**
 * @author [email protected]
 */
public class OasMissingPathParamDefinitionRule extends AbstractInvalidPropertyValueRule {

    private List pathItemsWithError = new ArrayList<>();
    private String pathItemTemplate;

    /**
     * Constructor.
     * @param ruleInfo
     */
    public OasMissingPathParamDefinitionRule(ValidationRuleMetaData ruleInfo) {
        super(ruleInfo);
    }

    /**
     * Returns true if the list of parameters includes a path param with the given name.
     * @param paramName
     * @param parameters
     */
    private boolean hasPathParameter(String paramName, List parameters) {
        for (OpenApiParameter parameter : parameters) {
            if (equals(parameter.getIn(), "path") && equals(parameter.getName(), paramName)) {
                return true;
            }
        }
        return false;
    }

    /**
     * @see io.apicurio.datamodels.models.visitors.CombinedVisitorAdapter#visitPathItem(io.apicurio.datamodels.models.openapi.OpenApiPathItem)
     */
    @Override
    public void visitPathItem(OpenApiPathItem node) {
        pathItemTemplate = getPathTemplate(node);
        if (!isPathWellFormed(pathItemTemplate)) {
            this.pathItemsWithError.add(pathItemTemplate);
        }
    }

    /**
     * @see io.apicurio.datamodels.models.visitors.CombinedVisitorAdapter#visitOperation(io.apicurio.datamodels.models.Operation)
     */
    @Override
    public void visitOperation(Operation node) {
        String method = getOperationMethod(node);

        // Perform operation level checks only if there are no issues at the pathItem level.
        if (this.pathItemsWithError.indexOf(pathItemTemplate) != -1) {
            return;
        }

        // Check parameters are unique within operation
        List mergedParameters = mergeParameters((OpenApiOperation) node);
        List pathSegs = getPathSegments(pathItemTemplate);
        // Report all the path segments that don't have an associated parameter definition
        for (PathSegment pathSeg : pathSegs) {
            if (!hasValue(pathSeg.formalName)) { continue; }
            boolean valid = hasPathParameter(pathSeg.formalName, mergedParameters);
            this.reportIfInvalid(valid, node,null, map(
                    "param", pathSeg.formalName,
                    "path", pathItemTemplate,
                    "method", method.toUpperCase()
                    ));
        }
    }

}