Cleanup, Clarity changes to test code in src

awslabs · Sep 25, 2024 · 5687f7e · 5687f7e
1 parent 8aae6e4
commit 5687f7e
Show file tree

Hide file tree

Showing 6 changed files with 32 additions and 26 deletions.
diff --git a/codegen/aws-sdk-codegen/src/main/kotlin/aws/sdk/kotlin/codegen/GradleGenerator.kt b/codegen/aws-sdk-codegen/src/main/kotlin/aws/sdk/kotlin/codegen/GradleGenerator.kt
@@ -4,8 +4,8 @@
  */
 package aws.sdk.kotlin.codegen
 
-import aws.sdk.kotlin.codegen.model.traits.FailedResponseTrait
-import aws.sdk.kotlin.codegen.model.traits.SuccessResponseTrait
+import aws.sdk.kotlin.codegen.model.traits.testing.TestFailedResponseTrait
+import aws.sdk.kotlin.codegen.model.traits.testing.TestSuccessResponseTrait
 import aws.sdk.kotlin.codegen.smoketests.smokeTestDenyList
 import software.amazon.smithy.kotlin.codegen.core.*
 import software.amazon.smithy.kotlin.codegen.integration.KotlinIntegration
@@ -119,8 +119,8 @@ class GradleGenerator : KotlinIntegration {
      * 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(SuccessResponseTrait.ID)
-        val hasFailedResponseTrait = ctx.model.expectShape<ServiceShape>(ctx.settings.service).hasTrait(FailedResponseTrait.ID)
+        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
 
         /**

diff --git a/...n/codegen/model/traits/SmokeTestTraits.kt → ...n/model/traits/testing/SmokeTestTraits.kt b/...n/codegen/model/traits/SmokeTestTraits.kt → ...n/model/traits/testing/SmokeTestTraits.kt
@@ -1,22 +1,26 @@
-package aws.sdk.kotlin.codegen.model.traits
+package aws.sdk.kotlin.codegen.model.traits.testing
 
 import software.amazon.smithy.model.node.ObjectNode
 import software.amazon.smithy.model.shapes.ShapeId
 import software.amazon.smithy.model.traits.AnnotationTrait
 
 /**
  * Indicates the annotated service should always return a failed response.
+ * IMPORTANT: This trait is intended for use in integration or E2E tests only, not in real-life smoke tests that run
+ * against a service endpoint.
  */
-class FailedResponseTrait(node: ObjectNode) : AnnotationTrait(ID, node) {
+class TestFailedResponseTrait(node: ObjectNode) : AnnotationTrait(ID, node) {
     companion object {
         val ID: ShapeId = ShapeId.from("smithy.kotlin.traits#failedResponseTrait")
     }
 }
 
 /**
  * Indicates the annotated service should always return a success response.
+ * IMPORTANT: This trait is intended for use in integration or E2E tests only, not in real-life smoke tests that run
+ * against a service endpoint.
  */
-class SuccessResponseTrait(node: ObjectNode) : AnnotationTrait(ID, node) {
+class TestSuccessResponseTrait(node: ObjectNode) : AnnotationTrait(ID, node) {
     companion object {
         val ID: ShapeId = ShapeId.from("smithy.kotlin.traits#successResponseTrait")
     }

diff --git a/...n/src/main/kotlin/aws/sdk/kotlin/codegen/smoketests/SmokeTestsCodegenRegionIntegration.kt b/...n/src/main/kotlin/aws/sdk/kotlin/codegen/smoketests/SmokeTestsCodegenRegionIntegration.kt
@@ -18,7 +18,7 @@ import software.amazon.smithy.smoketests.traits.SmokeTestsTrait
  */
 class SmokeTestsCodegenRegionIntegration : KotlinIntegration {
     override fun enabledForService(model: Model, settings: KotlinSettings): Boolean =
-        model.topDownOperations(settings.service).any { it.hasTrait<SmokeTestsTrait>() } && settings.sdkId !in smokeTestDenyList
+        model.topDownOperations(settings.service).any { it.hasTrait<SmokeTestsTrait>() }
 
     override val sectionWriters: List<SectionWriterBinding>
         get() = listOf(
@@ -29,8 +29,8 @@ class SmokeTestsCodegenRegionIntegration : KotlinIntegration {
 
     private val envVars = SectionWriter { writer, _ ->
         writer.write(
-            "private val regionOverride = #T(#S)",
-            RuntimeTypes.Core.SmokeTests.getEnv,
+            "private val regionOverride = #T.System.getenv(#S)",
+            RuntimeTypes.Core.Utils.PlatformProvider,
             "AWS_SMOKE_TEST_REGION",
         )
     }

diff --git a/...sts/SmokeTestFailHttpEngineIntegration.kt → ...ing/SmokeTestFailHttpEngineIntegration.kt b/...sts/SmokeTestFailHttpEngineIntegration.kt → ...ing/SmokeTestFailHttpEngineIntegration.kt
@@ -1,7 +1,7 @@
-package aws.sdk.kotlin.codegen.smoketests
+package aws.sdk.kotlin.codegen.smoketests.testing
 
-import aws.sdk.kotlin.codegen.model.traits.FailedResponseTrait
-import aws.sdk.kotlin.codegen.model.traits.SuccessResponseTrait
+import aws.sdk.kotlin.codegen.model.traits.testing.TestFailedResponseTrait
+import aws.sdk.kotlin.codegen.model.traits.testing.TestSuccessResponseTrait
 import software.amazon.smithy.kotlin.codegen.KotlinSettings
 import software.amazon.smithy.kotlin.codegen.core.RuntimeTypes
 import software.amazon.smithy.kotlin.codegen.core.withBlock
@@ -17,14 +17,15 @@ import software.amazon.smithy.model.shapes.ServiceShape
 import software.amazon.smithy.smoketests.traits.SmokeTestsTrait
 
 /**
- * Adds [FailedResponseTrait] support to smoke tests
+ * Adds [TestFailedResponseTrait] support to smoke tests
+ * IMPORTANT: This integration is intended for use in integration or E2E tests only, not in real-life smoke tests that run
+ * against a service endpoint.
  */
 class SmokeTestFailHttpEngineIntegration : KotlinIntegration {
     override fun enabledForService(model: Model, settings: KotlinSettings): Boolean =
         model.topDownOperations(settings.service).any { it.hasTrait<SmokeTestsTrait>() } &&
-            settings.sdkId !in smokeTestDenyList &&
-            !model.expectShape<ServiceShape>(settings.service).hasTrait(SuccessResponseTrait.ID) &&
-            model.expectShape<ServiceShape>(settings.service).hasTrait(FailedResponseTrait.ID)
+            !model.expectShape<ServiceShape>(settings.service).hasTrait(TestSuccessResponseTrait.ID) &&
+            model.expectShape<ServiceShape>(settings.service).hasTrait(TestFailedResponseTrait.ID)
 
     override val sectionWriters: List<SectionWriterBinding>
         get() = listOf(

diff --git a/.../SmokeTestSuccessHttpEngineIntegration.kt → .../SmokeTestSuccessHttpEngineIntegration.kt b/.../SmokeTestSuccessHttpEngineIntegration.kt → .../SmokeTestSuccessHttpEngineIntegration.kt
@@ -1,7 +1,7 @@
-package aws.sdk.kotlin.codegen.smoketests
+package aws.sdk.kotlin.codegen.smoketests.testing
 
-import aws.sdk.kotlin.codegen.model.traits.FailedResponseTrait
-import aws.sdk.kotlin.codegen.model.traits.SuccessResponseTrait
+import aws.sdk.kotlin.codegen.model.traits.testing.TestFailedResponseTrait
+import aws.sdk.kotlin.codegen.model.traits.testing.TestSuccessResponseTrait
 import software.amazon.smithy.kotlin.codegen.KotlinSettings
 import software.amazon.smithy.kotlin.codegen.core.RuntimeTypes
 import software.amazon.smithy.kotlin.codegen.integration.KotlinIntegration
@@ -16,14 +16,15 @@ import software.amazon.smithy.model.shapes.ServiceShape
 import software.amazon.smithy.smoketests.traits.SmokeTestsTrait
 
 /**
- * Adds [SuccessResponseTrait] support to smoke tests
+ * Adds [TestSuccessResponseTrait] support to smoke tests
+ * IMPORTANT: This integration is intended for use in integration or E2E tests only, not in real-life smoke tests that run
+ * against a service endpoint.
  */
 class SmokeTestSuccessHttpEngineIntegration : KotlinIntegration {
     override fun enabledForService(model: Model, settings: KotlinSettings): Boolean =
         model.topDownOperations(settings.service).any { it.hasTrait<SmokeTestsTrait>() } &&
-            settings.sdkId !in smokeTestDenyList &&
-            model.expectShape<ServiceShape>(settings.service).hasTrait(SuccessResponseTrait.ID) &&
-            !model.expectShape<ServiceShape>(settings.service).hasTrait(FailedResponseTrait.ID)
+            model.expectShape<ServiceShape>(settings.service).hasTrait(TestSuccessResponseTrait.ID) &&
+            !model.expectShape<ServiceShape>(settings.service).hasTrait(TestFailedResponseTrait.ID)
 
     override val sectionWriters: List<SectionWriterBinding>
         get() = listOf(

diff --git a/...ces/META-INF/services/software.amazon.smithy.kotlin.codegen.integration.KotlinIntegration b/...ces/META-INF/services/software.amazon.smithy.kotlin.codegen.integration.KotlinIntegration
@@ -45,5 +45,5 @@ aws.sdk.kotlin.codegen.customization.s3.S3ExpiresIntegration
 aws.sdk.kotlin.codegen.BusinessMetricsIntegration
 aws.sdk.kotlin.codegen.smoketests.SmokeTestsDenyListIntegration
 aws.sdk.kotlin.codegen.smoketests.SmokeTestsCodegenRegionIntegration
-aws.sdk.kotlin.codegen.smoketests.SmokeTestSuccessHttpEngineIntegration
-aws.sdk.kotlin.codegen.smoketests.SmokeTestFailHttpEngineIntegration
+aws.sdk.kotlin.codegen.smoketests.testing.SmokeTestSuccessHttpEngineIntegration
+aws.sdk.kotlin.codegen.smoketests.testing.SmokeTestFailHttpEngineIntegration