Merge pull request #491 from RachelTucker/5_0_x_API-complete-blob-go-sdk

OTHER: Updating Go SDK generation to include optional checksum and metadata parameters on CompleteBlob request

Author: rpmoore

contracts/5_1_x_1710735_contract.xml

@@ -171,6 +171,9 @@ static RequestModelGenerator<?> getRequestGenerator(final Ds3Request ds3Request)
         if (isMultiFileDeleteRequest(ds3Request)) {
             return new DeleteObjectsRequestGenerator();
         }
+        if (isCompleteBlobRequest(ds3Request)) {
+            return new CompleteBlobRequestGenerator();
+        }
         return new BaseRequestGenerator();
     }
 
@@ -181,7 +184,7 @@ private Template getRequestTemplate(final Ds3Request ds3Request) throws IOExcept
         if (isGetObjectAmazonS3Request(ds3Request)) {
             return config.getTemplate("request/get_object_request.ftl");
         }
-        if (isAmazonCreateObjectRequest(ds3Request)) {
+        if (isAmazonCreateObjectRequest(ds3Request) || isCompleteBlobRequest(ds3Request)) {
             return config.getTemplate("request/put_object_request.ftl");
         }
         if (hasGetObjectsWithLengthOffsetRequestPayload(ds3Request)) {

ds3-autogen-go/src/main/java/com/spectralogic/ds3autogen/go/GoCodeGenerator.java

@@ -72,7 +72,7 @@ open class BaseClientGenerator : ClientModelGenerator<Client> {
     fun getCommandGenerator(ds3Request: Ds3Request): CommandModelGenerator<*> {
         return when {
             isAmazonCreateObjectRequest(ds3Request) -> PutObjectCommandGenerator()
-            isGetObjectAmazonS3Request(ds3Request) -> GetObjectCommandGenerator()
+            isGetObjectAmazonS3Request(ds3Request) || isCompleteBlobRequest(ds3Request) -> GetObjectCommandGenerator()
             isCreateMultiPartUploadPartRequest(ds3Request) -> ReaderPayloadCommandGenerator()
             hasPutObjectsWithSizeRequestPayload(ds3Request) -> Ds3PutObjectPayloadCommandGenerator()
             hasGetObjectsWithLengthOffsetRequestPayload(ds3Request) -> Ds3GetObjectPayloadCommandGenerator()

ds3-autogen-go/src/main/kotlin/com/spectralogic/ds3autogen/go/generators/client/BaseClientGenerator.kt

@@ -20,7 +20,8 @@ import com.spectralogic.ds3autogen.go.models.client.RequestBuildLine
 import java.util.*
 
 /**
- * Generates the Go client command for Amazon GetObject
+ * Generates the Go client command for Amazon GetObject and CompleteBlob.
+ * Adds checksum and metadata to the request construction.
  */
 class GetObjectCommandGenerator : BaseCommandGenerator() {
 

ds3-autogen-go/src/main/kotlin/com/spectralogic/ds3autogen/go/generators/client/command/GetObjectCommandGenerator.kt

@@ -0,0 +1,42 @@
+package com.spectralogic.ds3autogen.go.generators.request
+
+import com.google.common.collect.ImmutableList
+import com.spectralogic.ds3autogen.api.models.Arguments
+import com.spectralogic.ds3autogen.api.models.apispec.Ds3Request
+import com.spectralogic.ds3autogen.go.models.request.Variable
+import com.spectralogic.ds3autogen.go.models.request.VariableInterface
+import com.spectralogic.ds3autogen.utils.comparators.CustomArgumentComparator
+
+/**
+ * Generates the Go request handler for CompleteBlob command.
+ * Special case: include checksum and metadata as optional parameters in request.
+ */
+class CompleteBlobRequestGenerator : BaseRequestGenerator() {
+
+    /**
+     * Creates the list parameters in the request struct.
+     * Include checksum and metadata.
+     */
+    override fun toStructParams(ds3Request: Ds3Request): ImmutableList<Arguments> {
+        val builder = ImmutableList.builder<Arguments>()
+        builder.addAll(structParamsFromRequest(ds3Request))
+        builder.add(Arguments("Checksum", "Checksum"))
+        builder.add(Arguments("map[string]string", "Metadata"))
+
+        // Sort the arguments
+        return ImmutableList.sortedCopyOf(CustomArgumentComparator(), builder.build())
+    }
+
+    /**
+     * Creates the list of parameters assigned in the constructor.
+     * Include empty initialization for checksum and metadata.
+     */
+    override fun toStructAssignmentParams(ds3Request: Ds3Request): ImmutableList<VariableInterface> {
+        val builder = ImmutableList.builder<VariableInterface>()
+        builder.addAll(structAssignmentParamsFromRequest(ds3Request))
+        builder.add(Variable("Checksum", "NewNoneChecksum()"))
+        builder.add(Variable("Metadata", "make(map[string]string)"))
+
+        return builder.build()
+    }
+}

ds3-autogen-go/src/main/kotlin/com/spectralogic/ds3autogen/go/generators/request/CompleteBlobRequestGenerator.kt

@@ -1,4 +1,4 @@
-func (${name?uncap_first} *PutObjectRequest) WithMetaData(key string, values ...string) *${name} {
+func (${name?uncap_first} *${name}) WithMetaData(key string, values ...string) *${name} {
     if strings.HasPrefix(strings.ToLower(key), AMZ_META_HEADER) {
         ${name?uncap_first}.Metadata[key] = strings.Join(values, ",")
     } else {

ds3-autogen-go/src/main/resources/tmpls/go/request/with_headers.ftl

@@ -385,6 +385,17 @@ public static boolean isGetObjectsWithFullDetails(final Ds3Request request) {
                 && paramListContainsParam(request.getRequiredQueryParams(), "FullDetails", "void");
     }
 
+    /**
+     * Determines if a Ds3Request is the AmazonS3 Complete Blob request
+     */
+    public static boolean isCompleteBlobRequest(final Ds3Request request) {
+        return request.getHttpVerb() == HttpVerb.POST
+                && request.getBucketRequirement() == Requirement.REQUIRED
+                && request.getObjectRequirement() == Requirement.REQUIRED
+                && !request.getIncludeInPath()
+                && paramListContainsParam(request.getRequiredQueryParams(), "Blob", "java.util.UUID");
+    }
+
     /**
      * Determines if a Ds3Request supports pagination. This is used to determine
      * which response handlers need to parse pagination headers.