Protocol tests generate suites with request input setting

Author: SergeyRyabinin

tests/testing-resources/include/aws/testing/AwsProtocolTestHelpers.h

@@ -0,0 +1,16 @@
+/**
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0.
+ */
+
+#pragma once
+
+#include <aws/testing/Testing_EXPORTS.h>
+#include <aws/testing/AwsCppSdkGTestSuite.h>s
+#include <aws/testing/AwsTestHelpers.h>
+
+
+#define AWS_PROTOCOL_TEST TEST_F
+#define AWS_PROTOCOL_TEST_SUITE Aws::Testing::AwsCppSdkGTestSuite
+
+using JsonValue = Aws::Utils::Json::JsonValue;

tools/code-generation/generator/src/main/java/com/amazonaws/util/awsclientgenerator/domainmodels/protocol_test/ProtocolTestCase.java

@@ -0,0 +1,90 @@
+/**
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0.
+ */
+
+package com.amazonaws.util.awsclientgenerator.domainmodels.protocol_test;
+
+import com.amazonaws.util.awsclientgenerator.domainmodels.c2j_protocol_test.C2jGiven;
+import com.amazonaws.util.awsclientgenerator.domainmodels.c2j_protocol_test.C2jInputSerialized;
+import com.amazonaws.util.awsclientgenerator.domainmodels.c2j_protocol_test.C2jOutputResponse;
+import com.fasterxml.jackson.databind.JsonNode;
+import lombok.Data;
+
+import java.util.Optional;
+
+@Data
+public class ProtocolTestCase {
+
+    // Smithy test case definitions unlike c2j do not differentiate input/output cases
+    // Using generic, more smithy-like intermediate codegen model.
+    @Data
+    public static class Input {
+        /**
+         * The input parameters a user would provide.
+         */
+        private JsonNode params;
+        /**
+         * The expected serialized HTTP request.
+         */
+        private C2jInputSerialized serialized;
+    }
+
+    @Data
+    public static class Output {
+        @Data
+        public static class SuccessResult {
+            /**
+             * A JSON hash representing the structure of the parsed response. Either this or error (not both) must appear in the test case.
+             */
+            private Optional<JsonNode> result;
+        }
+
+        @Data
+        public static class ErrorResult {
+            /**
+             * A JSON hash representing the structure of the parsed error response. Either this or result (not both) must appear in the test case.
+             */
+            private Optional<JsonNode> error;
+            /**
+             * A string specifying the AWS error code extracted from the response. Corresponds to the error shape to be unmarshalled and
+             * should always be set, even when the shape can not be found. Must be present when the error key is present.
+             */
+            private String errorCode;
+            /**
+             * A string specifying the error message extracted from the response.
+             * Should be able to be extracted even when an error shape is not unmarshalled. May only be present when the error key is present.
+             */
+            private String errorMessage;
+        }
+
+        private boolean isError;
+
+        // Success or error must be present
+        Optional<SuccessResult> successResult;
+        Optional<ErrorResult> errorResult;
+
+        /**
+         * The HTTP response to be parsed
+         */
+        private C2jOutputResponse response;
+    }
+
+    /**
+     * A test case id.
+     */
+    private String id;
+    /**
+     * A test case description.
+     */
+    private String description;
+    /**
+     * This corresponds to the JSON object that would define an operation in the service's JSON model.
+     * Valid keys include http, input, endpoint, and name.
+     */
+    private C2jGiven given;
+
+    // Input or output must be present
+    Optional<Input> input;
+    Optional<Output> output;
+}

tools/code-generation/generator/src/main/java/com/amazonaws/util/awsclientgenerator/domainmodels/protocol_test/ProtocolTestModel.java

@@ -0,0 +1,23 @@
+/**
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0.
+ */
+
+package com.amazonaws.util.awsclientgenerator.domainmodels.protocol_test;
+
+import com.amazonaws.util.awsclientgenerator.domainmodels.c2j_protocol_test.C2jTestSuite;
+import lombok.Data;
+
+import java.util.List;
+
+@Data
+public class ProtocolTestModel {
+    private String name;
+    private String serviceToUse;
+    public enum TestSuiteType {
+        INPUT,
+        OUTPUT
+    }
+    C2jTestSuite.TestSuiteType type;
+    private List<ProtocolTestSuite> testSuites;
+}

tools/code-generation/generator/src/main/java/com/amazonaws/util/awsclientgenerator/domainmodels/protocol_test/ProtocolTestSuite.java

@@ -0,0 +1,41 @@
+/**
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0.
+ */
+
+package com.amazonaws.util.awsclientgenerator.domainmodels.protocol_test;
+
+import com.amazonaws.util.awsclientgenerator.domainmodels.c2j.C2jMetadata;
+import com.amazonaws.util.awsclientgenerator.domainmodels.c2j.C2jShape;
+import lombok.Data;
+
+import java.util.List;
+import java.util.Map;
+
+@Data
+public class ProtocolTestSuite {
+    /**
+     *  A name for the test suite
+     */
+    private String name;
+    /**
+     *  A description of the tests
+     */
+    private String description;
+    /**
+     * The top level metadata that would correspond to the metadata key in the service's JSON model.
+     */
+    private C2jMetadata metadata;
+    /**
+     * A URL string the test cases must use when constructing the request's URL endpoint.
+     */
+    private String clientEndpoint;
+    /**
+     * A JSON object of C2jShapes. This would correspond to the top level C2jShapes key in the service's JSON model.
+     */
+    private Map<String, C2jShape> shapes;
+    /**
+     * a list of test cases
+     */
+    private List<ProtocolTestCase> cases;
+}

tools/code-generation/generator/src/main/java/com/amazonaws/util/awsclientgenerator/generators/MainGenerator.java

@@ -16,11 +16,13 @@
 import com.amazonaws.util.awsclientgenerator.domainmodels.defaults.BaseOption;
 import com.amazonaws.util.awsclientgenerator.domainmodels.defaults.BaseOptionModifier;
 import com.amazonaws.util.awsclientgenerator.domainmodels.defaults.DefaultClientConfigs;
+import com.amazonaws.util.awsclientgenerator.domainmodels.protocol_test.ProtocolTestModel;
 import com.amazonaws.util.awsclientgenerator.generators.cpp.CppDefaultsGenerator;
 import com.amazonaws.util.awsclientgenerator.generators.cpp.CppPartitionsGenerator;
 import com.amazonaws.util.awsclientgenerator.generators.cpp.CppProtocolTestGenerator;
 import com.amazonaws.util.awsclientgenerator.generators.cpp.CppServiceClientTestGenerator;
 import com.amazonaws.util.awsclientgenerator.transform.C2jModelToGeneratorModelTransformer;
+import com.amazonaws.util.awsclientgenerator.transform.C2jProtocolTestToGeneratorModelTransformer;
 
 import java.io.*;
 import java.nio.charset.StandardCharsets;
@@ -108,7 +110,7 @@ public ByteArrayOutputStream generateTestSourceFromModel(C2jServiceModel c2jMode
     }
 
     public ByteArrayOutputStream generateProtocolTestSourceFromModel(C2jServiceModel c2jModel,
-                                                                     C2jTestSuite testSuiteModel) throws Exception {
+                                                                     C2jTestSuite c2jTestModel) throws Exception {
         SdkSpec spec = new SdkSpec("cpp", c2jModel.getServiceName(), null);
         // Transform to intermediate code gen models from input c2j format.
         ServiceModel serviceModel = new C2jModelToGeneratorModelTransformer(c2jModel, false).convert();
@@ -122,9 +124,12 @@ public ByteArrayOutputStream generateProtocolTestSourceFromModel(C2jServiceModel
         spec.setVersion(serviceModel.getMetadata().getApiVersion());
 
         // TODO: Also transform C2j Protocol test model to an intermediate code gen model
-        CppProtocolTestGenerator cppTestGenerator = new CppProtocolTestGenerator(serviceModel, testSuiteModel);
+
+        C2jProtocolTestToGeneratorModelTransformer testTransformer = new C2jProtocolTestToGeneratorModelTransformer();
+        ProtocolTestModel testModel = testTransformer.convert(c2jTestModel);
+        CppProtocolTestGenerator cppTestGenerator = new CppProtocolTestGenerator(serviceModel, testModel);
         SdkFileEntry[] apiFiles = cppTestGenerator.generateSourceFiles(serviceModel);
-        String componentOutputName = String.format("%s", testSuiteModel.getName());
+        String componentOutputName = String.format("%s", testModel.getName());
 
         return compressFilesToZip(apiFiles, componentOutputName);
     }

tools/code-generation/generator/src/main/java/com/amazonaws/util/awsclientgenerator/generators/cpp/CppProtocolTestGenerator.java

@@ -6,10 +6,12 @@
 package com.amazonaws.util.awsclientgenerator.generators.cpp;
 
 import com.amazonaws.util.awsclientgenerator.domainmodels.SdkFileEntry;
-import com.amazonaws.util.awsclientgenerator.domainmodels.c2j.C2jServiceModel;
-import com.amazonaws.util.awsclientgenerator.domainmodels.c2j_protocol_test.C2jTestSuite;
+
 import com.amazonaws.util.awsclientgenerator.domainmodels.codegeneration.ServiceModel;
 
+import com.amazonaws.util.awsclientgenerator.domainmodels.codegeneration.cpp.CppViewHelper;
+import com.amazonaws.util.awsclientgenerator.domainmodels.protocol_test.ProtocolTestModel;
+import com.amazonaws.util.awsclientgenerator.domainmodels.protocol_test.ProtocolTestSuite;
 import com.amazonaws.util.awsclientgenerator.generators.ClientGenerator;
 import com.amazonaws.util.awsclientgenerator.generators.exceptions.SourceGenerationFailedException;
 import org.apache.velocity.Template;
@@ -22,20 +24,21 @@
 import java.io.IOException;
 import java.io.StringWriter;
 import java.nio.charset.StandardCharsets;
-import java.util.ArrayList;
-import java.util.List;
+import java.util.*;
+import java.util.stream.Collectors;
 
 public class CppProtocolTestGenerator implements ClientGenerator {
 
     private static String CMAKE_LISTS_TEMPLATE = "/com/amazonaws/util/awsclientgenerator/velocity/cpp/protocoltests/ProtocolTestsCMakeLists.vm";
-    private static String TEST_DRIVER_TEMPLATE = "/com/amazonaws/util/awsclientgenerator/velocity/cpp/protocoltests/ProtocolTestsSource.vm";
+    private static String RUN_TESTS_TEMPLATE = "/com/amazonaws/util/awsclientgenerator/velocity/cpp/protocoltests/ProtocolTestsRunTestsSrc.vm";
+    private static String TEST_SUITE_TEMPLATE = "/com/amazonaws/util/awsclientgenerator/velocity/cpp/protocoltests/ProtocolTestsTestSuiteSrc.vm";
 
     protected final VelocityEngine velocityEngine;
     private final ServiceModel serviceModel;
-    private final C2jTestSuite testModel;  // TODO: use an intermediate codegen model instead of raw C2J
+    private final ProtocolTestModel testModel;  // TODO: use an intermediate codegen model instead of raw C2J
     private final String projectName;
 
-    public CppProtocolTestGenerator(ServiceModel serviceModel, C2jTestSuite testSuiteModel) throws Exception {
+    public CppProtocolTestGenerator(ServiceModel serviceModel, ProtocolTestModel testSuiteModel) throws Exception {
         this.serviceModel = serviceModel;
         this.testModel = testSuiteModel;
         String prefix = testSuiteModel.getType().toString().toLowerCase();
@@ -52,10 +55,32 @@ public CppProtocolTestGenerator(ServiceModel serviceModel, C2jTestSuite testSuit
         velocityEngine.init();
     }
 
+    protected SdkFileEntry generateTestSuiteSourceFile(ProtocolTestSuite testSuite) throws IOException {
+        VelocityContext context = createContext();
+        context.put("testSuite", testSuite);
+        Template template = velocityEngine.getTemplate(TEST_SUITE_TEMPLATE, StandardCharsets.UTF_8.name());
+        String fileName = String.format("tests/%sTest.cpp", testSuite.getName());
+
+        return makeFile(template, context, fileName, true);
+    }
+
+    protected List<SdkFileEntry> generateTestSuiteSourceFiles() throws IOException {
+        return testModel.getTestSuites().stream()
+                .map(entry -> {
+                    try {
+                        return generateTestSuiteSourceFile(entry);
+                    } catch (IOException e) {
+                        throw new RuntimeException(e);
+                    }
+                })
+                .collect(Collectors.toList());
+    }
+
     public SdkFileEntry[] generateSourceFiles(ServiceModel dummy) throws Exception {
         List<SdkFileEntry> fileList = new ArrayList<>();
         fileList.add(generateCmakeFile());
         fileList.add(generateTestDriver());
+        fileList.addAll(generateTestSuiteSourceFiles());
 
         SdkFileEntry[] retArray = new SdkFileEntry[fileList.size()];
         return fileList.toArray(retArray);
@@ -69,7 +94,7 @@ private SdkFileEntry generateCmakeFile() throws Exception {
 
     protected SdkFileEntry generateTestDriver() throws Exception {
         VelocityContext context = createContext();
-        Template template = velocityEngine.getTemplate(TEST_DRIVER_TEMPLATE, StandardCharsets.UTF_8.name());
+        Template template = velocityEngine.getTemplate(RUN_TESTS_TEMPLATE, StandardCharsets.UTF_8.name());
         return makeFile(template, context, "RunTests.cpp", true);
     }
 
@@ -81,6 +106,8 @@ protected final VelocityContext createContext() {
         context.put("testModel", testModel);
         context.put("input.encoding", StandardCharsets.UTF_8.name());
         context.put("output.encoding", StandardCharsets.UTF_8.name());
+
+        context.put("CppViewHelper", CppViewHelper.class);
         return context;
     }