Merge branch 'main' of https://github.com/awslabs/aws-sdk-kotlin into jmespath-flatten

Author: 0marperez

.gitignore

@@ -12,8 +12,11 @@ build/
 .idea/
 __pycache__/
 local.properties
+
 # ignore generated files
 services/*/generated-src
 services/*/build.gradle.kts
 .kotest/
-*.klib
+*.klib
+tests/codegen/smoke-tests/services/*/generated-src
+tests/codegen/smoke-tests/services/*/build.gradle.kts

CHANGELOG.md

@@ -16,11 +16,11 @@ AWS service clients are generated from [Smithy](https://awslabs.github.io/smithy
 As such the code in `aws-sdk-kotlin` is a layer on top of generic Smithy based code generation tooling.
 
 
-2. Smithy Kotlin Codegen repo ([awslabs/smithy-kotlin](https://github.com/awslabs/smithy-kotlin))
+2. Smithy Kotlin Codegen repo ([smithy-lang/smithy-kotlin](https://github.com/smithy-lang/smithy-kotlin))
 
 The `smithy-kotlin` repository contains the generic Smithy code generation tools for Kotlin.
 
-If you want to contribute by diving into the codegen machinery and helping develop the SDK please refer to the [contributing guide](https://github.com/awslabs/smithy-kotlin/blob/main/CONTRIBUTING.md) in that repo.
+If you want to contribute by diving into the codegen machinery and helping develop the SDK please refer to the [contributing guide](https://github.com/smithy-lang/smithy-kotlin/blob/main/CONTRIBUTING.md) in that repo.
 
 
 ## Reporting Bugs/Feature Requests
@@ -78,7 +78,7 @@ following fields:
 | `id`                       | `string`   | yes      |                                              | A unique identifier for this entry. We recommend you generate a UUID for this field.                                                                                                                                                                                                                                                            |
 | `type`                     | `string`   | yes      | `bugfix`, `feature`, `documentation`, `misc` | The type of change being made.                                                                                                                                                                                                                                                                                                                  |
 | `description`              | `string`   | yes      |                                              | A description of the change being made.<ul><li>Prefix with `**Breaking**:` if the change is breaking</li><li>Use the imperative present tense (e.g., "change" not "changed" nor "changes")</li><li>Capitalize first letter</li><li>No dot (.) at the end unless there are multiple sentences</li></ul>                                          |
-| `issues`                   | `string[]` | no       |                                              | A list of references to any related issues in the relevant repositories. A reference can be specified in several ways:<ul><li>The issue number, if local to this repository (eg. `#12345`)</li><li>A fully-qualified issue ID (eg.`awslabs/smithy-kotlin#12345`)</li><li>A fully-qualified URL (eg. `https://issuetracker.com/12345`)</li></ul> |
+| `issues`                   | `string[]` | no       |                                              | A list of references to any related issues in the relevant repositories. A reference can be specified in several ways:<ul><li>The issue number, if local to this repository (eg. `#12345`)</li><li>A fully-qualified issue ID (eg.`smithy-lang/smithy-kotlin#12345`)</li><li>A fully-qualified URL (eg. `https://issuetracker.com/12345`)</li></ul> |
 | `module`                   | `string`   | no       |                                              | The area of the code affected by your changes. If unsure, leave this value unset.                                                                                                                                                                                                                                                               |
 | `requiresMinorVersionBump` | `boolean`  | no       |                                              | Indicates the change will require a new minor version. This is usually the case after a breaking change. Defaults to false if flag is not included.                                                                                                                                                                                             |
 

CONTRIBUTING.md

@@ -145,6 +145,7 @@ public final class aws/sdk/kotlin/runtime/http/interceptors/AwsBusinessMetric :
 	public static final field S3_EXPRESS_BUCKET Laws/sdk/kotlin/runtime/http/interceptors/AwsBusinessMetric;
 	public static fun getEntries ()Lkotlin/enums/EnumEntries;
 	public fun getIdentifier ()Ljava/lang/String;
+	public fun toString ()Ljava/lang/String;
 	public static fun valueOf (Ljava/lang/String;)Laws/sdk/kotlin/runtime/http/interceptors/AwsBusinessMetric;
 	public static fun values ()[Laws/sdk/kotlin/runtime/http/interceptors/AwsBusinessMetric;
 }

aws-runtime/aws-http/api/aws-http.api

@@ -13,14 +13,19 @@ import aws.smithy.kotlin.runtime.client.ProtocolRequestInterceptorContext
 import aws.smithy.kotlin.runtime.http.interceptors.HttpInterceptor
 import aws.smithy.kotlin.runtime.http.request.HttpRequest
 import aws.smithy.kotlin.runtime.http.request.toBuilder
+import aws.smithy.kotlin.runtime.telemetry.logging.Logger
+import aws.smithy.kotlin.runtime.telemetry.logging.logger
+import kotlin.coroutines.coroutineContext
 
 /**
  * Appends business metrics to the `User-Agent` header.
  */
 public class BusinessMetricsInterceptor : HttpInterceptor {
     override suspend fun modifyBeforeTransmit(context: ProtocolRequestInterceptorContext<Any, HttpRequest>): HttpRequest {
+        val logger = coroutineContext.logger<BusinessMetricsInterceptor>()
+
         context.executionContext.getOrNull(BusinessMetrics)?.let { metrics ->
-            val metricsString = formatMetrics(metrics)
+            val metricsString = formatMetrics(metrics, logger)
             val currentUserAgentHeader = context.protocolRequest.headers[USER_AGENT]
             val modifiedRequest = context.protocolRequest.toBuilder()
 
@@ -34,10 +39,22 @@ public class BusinessMetricsInterceptor : HttpInterceptor {
 
 /**
  * Makes sure the metrics do not exceed the maximum size and truncates them if so.
+ * Makes sure that metric identifiers are not > 2 chars in length. Skips them if so.
  */
-private fun formatMetrics(metrics: MutableSet<BusinessMetric>): String {
-    if (metrics.isEmpty()) return ""
-    val metricsString = metrics.joinToString(",", "m/") { it.identifier }
+private fun formatMetrics(metrics: MutableSet<BusinessMetric>, logger: Logger): String {
+    val allowedMetrics = metrics.filter {
+        if (it.identifier.length > 2) {
+            logger.warn {
+                "Business metric '${it.identifier}' will be skipped due to length being > 2. " +
+                    "This is likely a bug. Please raise an issue at https://github.com/awslabs/aws-sdk-kotlin/issues/new/choose"
+            }
+            false
+        } else {
+            true
+        }
+    }
+    if (allowedMetrics.isEmpty()) return ""
+    val metricsString = allowedMetrics.joinToString(",", "m/") { it.identifier }
     val metricsByteArray = metricsString.encodeToByteArray()
 
     if (metricsByteArray.size <= BUSINESS_METRICS_MAX_LENGTH) return metricsString
@@ -65,4 +82,7 @@ private fun formatMetrics(metrics: MutableSet<BusinessMetric>): String {
 public enum class AwsBusinessMetric(public override val identifier: String) : BusinessMetric {
     S3_EXPRESS_BUCKET("J"),
     DDB_MAPPER("d"),
+    ;
+
+    override fun toString(): String = identifier
 }

aws-runtime/aws-http/common/src/aws/sdk/kotlin/runtime/http/interceptors/BusinessMetricsInterceptor.kt

@@ -44,7 +44,7 @@ public class UserAgent(
 
         // NOTE: Due to legacy issues with processing the user agent, the original content for
         // x-amz-user-agent and User-Agent is swapped here.  See top note in the
-        // sdk-user-agent-header SEP and https://github.com/awslabs/smithy-kotlin/issues/373
+        // sdk-user-agent-header SEP and https://github.com/smithy-lang/smithy-kotlin/issues/373
         // for further details.
         req.subject.headers[USER_AGENT] = requestMetadata.xAmzUserAgent
         req.subject.headers[X_AMZ_USER_AGENT] = requestMetadata.userAgent

aws-runtime/aws-http/common/src/aws/sdk/kotlin/runtime/http/middleware/UserAgent.kt

@@ -10,16 +10,12 @@ import aws.smithy.kotlin.runtime.businessmetrics.BusinessMetric
 import aws.smithy.kotlin.runtime.businessmetrics.SmithyBusinessMetric
 import aws.smithy.kotlin.runtime.businessmetrics.emitBusinessMetric
 import aws.smithy.kotlin.runtime.client.ProtocolRequestInterceptorContext
-import aws.smithy.kotlin.runtime.collections.get
 import aws.smithy.kotlin.runtime.http.*
 import aws.smithy.kotlin.runtime.http.request.HttpRequest
 import aws.smithy.kotlin.runtime.net.url.Url
 import aws.smithy.kotlin.runtime.operation.ExecutionContext
 import kotlinx.coroutines.test.runTest
-import kotlin.test.Test
-import kotlin.test.assertFailsWith
-import kotlin.test.assertFalse
-import kotlin.test.assertTrue
+import kotlin.test.*
 
 class BusinessMetricsInterceptorTest {
     @Test
@@ -32,6 +28,23 @@ class BusinessMetricsInterceptorTest {
         assertFalse(userAgentHeader.endsWith("m/"))
     }
 
+    @Test
+    fun noValidBusinessMetrics() = runTest {
+        val executionContext = ExecutionContext()
+
+        val invalidBusinessMetric = object : BusinessMetric {
+            override val identifier: String = "All work and no play makes Jack a dull boy".repeat(1000)
+        }
+
+        executionContext.emitBusinessMetric(invalidBusinessMetric)
+
+        val interceptor = BusinessMetricsInterceptor()
+        val request = interceptor.modifyBeforeTransmit(interceptorContext(executionContext))
+        val userAgentHeader = request.headers[USER_AGENT]!!
+
+        assertFalse(userAgentHeader.endsWith("m/"))
+    }
+
     @Test
     fun businessMetrics() = runTest {
         val executionContext = ExecutionContext()
@@ -66,49 +79,57 @@ class BusinessMetricsInterceptorTest {
     }
 
     @Test
-    fun truncateBusinessMetrics() = runTest {
+    fun businessMetricsMaxLength() = runTest {
         val executionContext = ExecutionContext()
         executionContext.attributes[aws.smithy.kotlin.runtime.businessmetrics.BusinessMetrics] = mutableSetOf()
 
-        for (i in 0..1024) {
+        for (i in 0..BUSINESS_METRICS_MAX_LENGTH) {
             executionContext.emitBusinessMetric(
                 object : BusinessMetric {
                     override val identifier: String = i.toString()
                 },
             )
         }
 
-        val rawMetrics = executionContext[aws.smithy.kotlin.runtime.businessmetrics.BusinessMetrics]
-        val rawMetricsString = rawMetrics.joinToString(",", "m/")
-        val rawMetricsByteArray = rawMetricsString.encodeToByteArray()
-
-        assertTrue(rawMetricsByteArray.size >= BUSINESS_METRICS_MAX_LENGTH)
-
         val interceptor = BusinessMetricsInterceptor()
         val request = interceptor.modifyBeforeTransmit(interceptorContext(executionContext))
         val userAgentHeader = request.headers[USER_AGENT]!!
-        val truncatedMetrics = "m/" + userAgentHeader.substringAfter("m/")
+        val metrics = "m/" + userAgentHeader.substringAfter("m/")
 
-        assertTrue(truncatedMetrics.encodeToByteArray().size <= BUSINESS_METRICS_MAX_LENGTH)
-        assertFalse(truncatedMetrics.endsWith(","))
+        assertTrue(metrics.encodeToByteArray().size <= BUSINESS_METRICS_MAX_LENGTH)
+        assertFalse(metrics.endsWith(","))
     }
 
     @Test
-    fun malformedBusinessMetrics() = runTest {
+    fun invalidBusinessMetric() = runTest {
         val executionContext = ExecutionContext()
-        val reallyLongMetric = "All work and no play makes Jack a dull boy".repeat(1000)
 
-        executionContext.attributes.emitBusinessMetric(
-            object : BusinessMetric {
-                override val identifier: String = reallyLongMetric
-            },
-        )
+        val validMetric = AwsBusinessMetric.S3_EXPRESS_BUCKET
+        val invalidMetric = object : BusinessMetric {
+            override val identifier: String = "All work and no play makes Jack a dull boy".repeat(1000)
+        }
+
+        executionContext.attributes.emitBusinessMetric(validMetric)
+        executionContext.attributes.emitBusinessMetric(invalidMetric)
 
         val interceptor = BusinessMetricsInterceptor()
+        val request = interceptor.modifyBeforeTransmit(interceptorContext(executionContext))
+        val userAgentHeader = request.headers[USER_AGENT]!!
 
-        assertFailsWith<IllegalStateException>("Business metrics are incorrectly formatted:") {
-            interceptor.modifyBeforeTransmit(interceptorContext(executionContext))
-        }
+        assertTrue(
+            userAgentHeader.contains(validMetric.identifier),
+        )
+        assertFalse(
+            userAgentHeader.contains(invalidMetric.identifier),
+        )
+    }
+
+    @Test
+    fun businessMetricToString() {
+        val businessMetricToString = AwsBusinessMetric.S3_EXPRESS_BUCKET.toString()
+        val businessMetricIdentifier = AwsBusinessMetric.S3_EXPRESS_BUCKET.identifier
+
+        assertEquals(businessMetricIdentifier, businessMetricToString)
     }
 }
 

aws-runtime/aws-http/common/test/aws/sdk/kotlin/runtime/http/interceptors/BusinessMetricsInterceptorTest.kt

@@ -54,6 +54,11 @@ fun createBomConstraintsAndVersionCatalog() {
         }
     }
 
+    // Add the BOM itself to the version catalog
+    catalogExt.versionCatalog {
+        library("bom", "aws.sdk.kotlin:bom:$version")
+    }
+
     val ignoredSmithyKotlin = setOf(
         "smithy.kotlin.codegen",
         "smithy.kotlin.http.test",

bom/build.gradle.kts

@@ -29,6 +29,7 @@ dependencies {
     api(libs.smithy.aws.cloudformation.traits)
     api(libs.smithy.protocol.test.traits)
     implementation(libs.smithy.aws.endpoints)
+    implementation(libs.smithy.smoke.test.traits)
 
     testImplementation(libs.junit.jupiter)
     testImplementation(libs.junit.jupiter.params)

codegen/aws-sdk-codegen/build.gradle.kts

@@ -4,9 +4,16 @@
  */
 package aws.sdk.kotlin.codegen
 
+import aws.sdk.kotlin.codegen.model.traits.testing.TestFailedResponseTrait
+import aws.sdk.kotlin.codegen.model.traits.testing.TestSuccessResponseTrait
 import software.amazon.smithy.kotlin.codegen.core.*
 import software.amazon.smithy.kotlin.codegen.integration.KotlinIntegration
+import software.amazon.smithy.kotlin.codegen.model.expectShape
+import software.amazon.smithy.kotlin.codegen.model.hasTrait
 import software.amazon.smithy.kotlin.codegen.rendering.GradleWriter
+import software.amazon.smithy.kotlin.codegen.utils.topDownOperations
+import software.amazon.smithy.model.shapes.ServiceShape
+import software.amazon.smithy.smoketests.traits.SmokeTestsTrait
 
 // TODO - would be nice to allow integrations to define custom settings in the plugin
 // e.g. we could then more consistently apply this integration if we could define a property like: `build.isAwsSdk: true`
@@ -64,9 +71,72 @@ class GradleGenerator : KotlinIntegration {
                             }
                         }
                 }
+                if (ctx.model.topDownOperations(ctx.settings.service).any { it.hasTrait<SmokeTestsTrait>() }) {
+                    write("")
+                    generateSmokeTestConfig(writer, ctx)
+                }
             }
 
         val contents = writer.toString()
         delegator.fileManifest.writeFile("build.gradle.kts", contents)
     }
+
+    private fun generateSmokeTestConfig(writer: GradleWriter, ctx: CodegenContext) {
+        generateSmokeTestJarTask(writer, ctx)
+        writer.write("")
+        generateSmokeTestTask(writer, ctx)
+    }
+
+    /**
+     * Generates a gradle task to create smoke test runner JARs
+     */
+    private fun generateSmokeTestJarTask(writer: GradleWriter, ctx: CodegenContext) {
+        writer.withBlock("jvm {", "}") {
+            withBlock("compilations {", "}") {
+                write("val mainPath = getByName(#S).output.classesDirs", "main")
+                write("val testPath = getByName(#S).output.classesDirs", "test")
+                withBlock("tasks {", "}") {
+                    withBlock("register<Jar>(#S) {", "}", "smokeTestJar") {
+                        write("description = #S", "Creates smoke tests jar")
+                        write("group = #S", "application")
+                        write("dependsOn(build)")
+                        write("mustRunAfter(build)")
+                        withBlock("manifest {", "}") {
+                            write("attributes[#S] = #S", "Main-Class", "${ctx.settings.pkg.name}.smoketests.SmokeTestsKt")
+                        }
+                        write("val runtimePath = configurations.getByName(#S).map { if (it.isDirectory) it else zipTree(it) }", "jvmRuntimeClasspath")
+                        write("duplicatesStrategy = DuplicatesStrategy.EXCLUDE")
+                        write("from(runtimePath, mainPath, testPath)")
+                        write("archiveBaseName.set(#S)", "\${project.name}-smoketests")
+                    }
+                }
+            }
+        }
+    }
+
+    /**
+     * Generates a gradle task to run smoke tests
+     */
+    private fun generateSmokeTestTask(writer: GradleWriter, ctx: CodegenContext) {
+        val hasSuccessResponseTrait = ctx.model.expectShape<ServiceShape>(ctx.settings.service).hasTrait(TestSuccessResponseTrait.ID)
+        val hasFailedResponseTrait = ctx.model.expectShape<ServiceShape>(ctx.settings.service).hasTrait(TestFailedResponseTrait.ID)
+        val inTestingEnvironment = hasFailedResponseTrait || hasSuccessResponseTrait
+
+        /**
+         * E2E tests don't have sdkVersion in jar names. They're added later for publishing.
+         * @see SmokeTestE2ETest
+         */
+        val jarName = if (inTestingEnvironment) "\${project.name}-smoketests.jar" else "\${project.name}-smoketests-\$sdkVersion.jar"
+
+        writer.withBlock("tasks.register<JavaExec>(#S) {", "}", "smokeTest") {
+            write("description = #S", "Runs smoke tests jar")
+            write("group = #S", "verification")
+            write("dependsOn(tasks.getByName(#S))", "smokeTestJar")
+            write("mustRunAfter(tasks.getByName(#S))", "smokeTestJar")
+            write("")
+            write("val sdkVersion: String by project")
+            write("val jarFile = file(#S)", "build/libs/$jarName")
+            write("classpath = files(jarFile)")
+        }
+    }
 }