software.amazon.smithy.smoketests.traits.SmokeTestCaseValidator Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of smithy-smoke-test-traits Show documentation
Defines smoke test traits.
The newest version!
/*
 * 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.smoketests.traits;

import java.util.ArrayList;
import java.util.List;
import java.util.Optional;
import software.amazon.smithy.model.Model;
import software.amazon.smithy.model.knowledge.OperationIndex;
import software.amazon.smithy.model.node.Node;
import software.amazon.smithy.model.node.ObjectNode;
import software.amazon.smithy.model.shapes.Shape;
import software.amazon.smithy.model.shapes.ShapeId;
import software.amazon.smithy.model.shapes.StructureShape;
import software.amazon.smithy.model.validation.AbstractValidator;
import software.amazon.smithy.model.validation.NodeValidationVisitor;
import software.amazon.smithy.model.validation.ValidationEvent;
import software.amazon.smithy.model.validation.node.TimestampValidationStrategy;

/**
 * Validates the following:
 *
 * 
 *     vendorParamsShape is a valid shape.
 *     vendorParams is compatible with vendorParamsShape.
 *     input is valid for the operation under test.
 * 
 */
public class SmokeTestCaseValidator extends AbstractValidator {

    @Override
    public List validate(Model model) {
        OperationIndex operationIndex = OperationIndex.of(model);
        List events = new ArrayList<>();
        for (Shape shape : model.getShapesWithTrait(SmokeTestsTrait.class)) {
            SmokeTestsTrait trait = shape.expectTrait(SmokeTestsTrait.class);
            List testCases = trait.getTestCases();

            for (SmokeTestCase testCase : testCases) {
                // Validate vendor params shape
                Optional vendorParamsShapeIdOptional = testCase.getVendorParamsShape();
                Optional vendorParamsOptional = testCase.getVendorParams();
                if (vendorParamsShapeIdOptional.isPresent()) {
                    if (!vendorParamsOptional.isPresent()) {
                        events.add(warning(shape, trait, String.format(
                                "Smoke test case with ID `%s` defined a `vendorParamsShape` but no `vendorParams`",
                                testCase.getId())));
                    } else {
                        Optional vendorParamsShapeOptional = model.getShape(vendorParamsShapeIdOptional.get());
                        if (vendorParamsShapeOptional.isPresent()) {
                            Shape vendorParamsShape = vendorParamsShapeOptional.get();
                            NodeValidationVisitor vendorParamsValidator = createVisitor(vendorParamsOptional.get(),
                                    model, shape, testCase.getId(), ".vendorParams");
                            events.addAll(vendorParamsShape.accept(vendorParamsValidator));
                        }

                    }
                } else if (vendorParamsOptional.isPresent()) {
                    events.add(warning(shape, trait, String.format(
                            "Smoke test case with ID `%s` defined `vendorParams` but no `vendorParamsShape`",
                            testCase.getId())));
                }

                // Validate input params
                StructureShape input = operationIndex.expectInputShape(shape);
                if (input != null && testCase.getParams().isPresent()) {
                    NodeValidationVisitor paramsValidator = createVisitor(testCase.getParams().get(), model, shape,
                            testCase.getId(), ".params");
                    events.addAll(input.accept(paramsValidator));
                } else if (testCase.getParams().isPresent()) {
                    events.add(error(shape, trait, String.format(
                            "Smoke test parameters provided for operation with no input: `%s`",
                            Node.printJson(testCase.getParams().get())

                    )));
                }
            }
        }
        return events;
    }

    private NodeValidationVisitor createVisitor(
            ObjectNode node,
            Model model,
            Shape shape,
            String caseId,
            String contextSuffix
    ) {
        return NodeValidationVisitor.builder()
                .model(model)
                .eventShapeId(shape.getId())
                .value(node)
                .startingContext(SmokeTestsTrait.ID + "." + caseId + contextSuffix)
                .eventId(getName())
                .timestampValidationStrategy(TimestampValidationStrategy.EPOCH_SECONDS)
                .addFeature(NodeValidationVisitor.Feature.ALLOW_OPTIONAL_NULLS)
                .build();
    }
}