chore: Remove unused code, refactor in protocol tests (#776)

Author: jbelkins

smithy-swift-codegen/src/main/kotlin/software/amazon/smithy/swift/codegen/integration/HttpProtocolTestGenerator.kt

@@ -13,12 +13,6 @@ import software.amazon.smithy.protocoltests.traits.HttpMessageTestCase
 import software.amazon.smithy.protocoltests.traits.HttpRequestTestsTrait
 import software.amazon.smithy.protocoltests.traits.HttpResponseTestsTrait
 import software.amazon.smithy.swift.codegen.SwiftDependency
-import software.amazon.smithy.swift.codegen.integration.middlewares.OperationInputUrlHostMiddleware
-import software.amazon.smithy.swift.codegen.integration.middlewares.OperationInputUrlPathMiddleware
-import software.amazon.smithy.swift.codegen.integration.middlewares.RequestTestEndpointResolverMiddleware
-import software.amazon.smithy.swift.codegen.middleware.MiddlewareStep
-import software.amazon.smithy.swift.codegen.middleware.OperationMiddleware
-import software.amazon.smithy.swift.codegen.model.hasTrait
 import software.amazon.smithy.swift.codegen.model.toUpperCamelCase
 import software.amazon.smithy.swift.codegen.testModuleName
 import java.util.TreeSet
@@ -33,7 +27,6 @@ class HttpProtocolTestGenerator(
     private val responseTestBuilder: HttpProtocolUnitTestResponseGenerator.Builder,
     private val errorTestBuilder: HttpProtocolUnitTestErrorGenerator.Builder,
     private val httpProtocolCustomizable: HTTPProtocolCustomizable,
-    private val operationMiddleware: OperationMiddleware,
     private val httpBindingResolver: HttpBindingResolver,
     // list of test IDs to ignore/skip
     private val testsToIgnore: Set<String> = setOf(),
@@ -46,48 +39,16 @@ class HttpProtocolTestGenerator(
      */
     fun generateProtocolTests(): Int {
         val topDownIndex: TopDownIndex = TopDownIndex.of(ctx.model)
-        val operationMiddleware = updateRequestTestMiddleware()
         var numTests = 0
         for (operation in TreeSet(topDownIndex.getContainedOperations(ctx.service).filterNot(::serverOnly))) {
-            numTests += renderRequestTests(operation, operationMiddleware)
+            numTests += renderRequestTests(operation)
             numTests += renderResponseTests(operation)
             numTests += renderErrorTestCases(operation)
         }
         return numTests
     }
 
-    private fun updateRequestTestMiddleware(): OperationMiddleware {
-        val topDownIndex: TopDownIndex = TopDownIndex.of(ctx.model)
-        val requestTestOperations = TreeSet(
-            topDownIndex.getContainedOperations(ctx.service)
-                .filter { it.hasTrait<HttpRequestTestsTrait>() }
-                .filterNot(::serverOnly)
-        )
-        val cloned = operationMiddleware.clone()
-
-        for (operation in requestTestOperations) {
-            cloned.removeMiddleware(operation, MiddlewareStep.INITIALIZESTEP, "OperationInputUrlPathMiddleware")
-            cloned.removeMiddleware(operation, MiddlewareStep.INITIALIZESTEP, "OperationInputUrlHostMiddleware")
-            cloned.removeMiddleware(operation, MiddlewareStep.BUILDSTEP, "EndpointResolverMiddleware")
-            cloned.removeMiddleware(operation, MiddlewareStep.BUILDSTEP, "UserAgentMiddleware")
-            cloned.removeMiddleware(operation, MiddlewareStep.BUILDSTEP, "AuthSchemeMiddleware")
-            cloned.removeMiddleware(operation, MiddlewareStep.FINALIZESTEP, "RetryMiddleware")
-            cloned.removeMiddleware(operation, MiddlewareStep.FINALIZESTEP, "SignerMiddleware")
-            cloned.removeMiddleware(operation, MiddlewareStep.DESERIALIZESTEP, "DeserializeMiddleware")
-            cloned.removeMiddleware(operation, MiddlewareStep.DESERIALIZESTEP, "LoggingMiddleware")
-
-            cloned.appendMiddleware(operation, RequestTestEndpointResolverMiddleware(ctx.model, ctx.symbolProvider))
-            cloned.appendMiddleware(operation, OperationInputUrlPathMiddleware(ctx.model, ctx.symbolProvider, "urlPrefix: urlPrefix"))
-            val hostMiddlewares = cloned.middlewares(operation, MiddlewareStep.INITIALIZESTEP)
-                .filter { it.name.contains("HostMiddleware") }
-            if (hostMiddlewares.isEmpty()) {
-                cloned.appendMiddleware(operation, OperationInputUrlHostMiddleware(ctx.model, ctx.symbolProvider, operation, true))
-            }
-        }
-        return cloned
-    }
-
-    private fun renderRequestTests(operation: OperationShape, operationMiddleware: OperationMiddleware): Int {
+    private fun renderRequestTests(operation: OperationShape): Int {
         val serviceSymbol = ctx.symbolProvider.toSymbol(ctx.service)
         val tempTestCases = operation.getTrait(HttpRequestTestsTrait::class.java)
             .orElse(null)
@@ -112,7 +73,6 @@ class HttpProtocolTestGenerator(
                     .serviceName(serviceSymbol.name)
                     .testCases(requestTestCases)
                     .httpProtocolCustomizable(httpProtocolCustomizable)
-                    .operationMiddleware(operationMiddleware)
                     .httpBindingResolver(httpBindingResolver)
                     .build()
                     .renderTestClass(testClassName)
@@ -146,7 +106,6 @@ class HttpProtocolTestGenerator(
                     .serviceName(serviceSymbol.name)
                     .testCases(responseTestCases)
                     .httpProtocolCustomizable(httpProtocolCustomizable)
-                    .operationMiddleware(operationMiddleware)
                     .httpBindingResolver(httpBindingResolver)
                     .build()
                     .renderTestClass(testClassName)
@@ -188,7 +147,6 @@ class HttpProtocolTestGenerator(
                         .serviceName(serviceSymbol.name)
                         .testCases(testCases)
                         .httpProtocolCustomizable(httpProtocolCustomizable)
-                        .operationMiddleware(operationMiddleware)
                         .httpBindingResolver(httpBindingResolver)
                         .build()
                         .renderTestClass(testClassName)

smithy-swift-codegen/src/main/kotlin/software/amazon/smithy/swift/codegen/integration/HttpProtocolUnitTestErrorGenerator.kt

@@ -22,7 +22,7 @@ open class HttpProtocolUnitTestErrorGenerator protected constructor(builder: Bui
             writer.openBlock("do {", "} catch {") {
                 renderBuildHttpResponse(test)
                 writer.write("")
-                renderInitOperationError(test, operationErrorType)
+                renderInitOperationError(operationErrorType)
                 writer.write("")
                 renderCompareActualAndExpectedErrors(test, it, operationErrorType)
                 writer.write("")
@@ -34,8 +34,8 @@ open class HttpProtocolUnitTestErrorGenerator protected constructor(builder: Bui
         }
     }
 
-    private fun renderInitOperationError(test: HttpResponseTestCase, operationErrorType: String) {
-        val operationErrorVariableName = operationErrorType.decapitalize()
+    private fun renderInitOperationError(operationErrorType: String) {
+        val operationErrorVariableName = operationErrorType.replaceFirstChar { it.lowercase() }
         val responseErrorClosure = ResponseErrorClosureUtils(ctx, writer, operation).render()
         writer.addImport(SwiftDependency.SMITHY_READ_WRITE.target)
         writer.write(
@@ -50,9 +50,8 @@ open class HttpProtocolUnitTestErrorGenerator protected constructor(builder: Bui
         errorShape: Shape,
         operationErrorType: String
     ) {
-        val operationErrorVariableName = operationErrorType.decapitalize()
+        val operationErrorVariableName = operationErrorType.replaceFirstChar { it.lowercase() }
         val errorType = symbolProvider.toSymbol(errorShape).name
-        val errorVariableName = errorType.decapitalize()
 
         writer.openBlock("if let actual = \$L as? \$L {", "} else {", operationErrorVariableName, errorType) {
             renderExpectedOutput(test, errorShape)

smithy-swift-codegen/src/main/kotlin/software/amazon/smithy/swift/codegen/integration/HttpProtocolUnitTestGenerator.kt

@@ -10,7 +10,6 @@ import software.amazon.smithy.model.shapes.OperationShape
 import software.amazon.smithy.model.shapes.ServiceShape
 import software.amazon.smithy.protocoltests.traits.HttpMessageTestCase
 import software.amazon.smithy.swift.codegen.SwiftWriter
-import software.amazon.smithy.swift.codegen.middleware.OperationMiddleware
 
 /**
  * Abstract base implementation for protocol test generators to extend in order to generate HttpMessageTestCase
@@ -28,7 +27,6 @@ protected constructor(builder: Builder<T>) {
     protected val operation: OperationShape = builder.operation!!
     protected val writer: SwiftWriter = builder.writer!!
     protected val httpProtocolCustomizable = builder.httpProtocolCustomizable!!
-    protected val operationMiddleware = builder.operationMiddleware!!
     protected val httpBindingResolver = builder.httpBindingResolver!!
     protected val serviceName: String = builder.serviceName!!
     abstract val baseTestClassName: String
@@ -75,7 +73,6 @@ protected constructor(builder: Builder<T>) {
         var writer: SwiftWriter? = null
         var serviceName: String? = null
         var httpProtocolCustomizable: HTTPProtocolCustomizable? = null
-        var operationMiddleware: OperationMiddleware? = null
         var httpBindingResolver: HttpBindingResolver? = null
 
         fun symbolProvider(provider: SymbolProvider): Builder<T> = apply { this.symbolProvider = provider }
@@ -86,7 +83,6 @@ protected constructor(builder: Builder<T>) {
         fun writer(writer: SwiftWriter): Builder<T> = apply { this.writer = writer }
         fun serviceName(serviceName: String): Builder<T> = apply { this.serviceName = serviceName }
         fun httpProtocolCustomizable(httpProtocolCustomizable: HTTPProtocolCustomizable): Builder<T> = apply { this.httpProtocolCustomizable = httpProtocolCustomizable }
-        fun operationMiddleware(operationMiddleware: OperationMiddleware): Builder<T> = apply { this.operationMiddleware = operationMiddleware }
         fun httpBindingResolver(httpBindingResolver: HttpBindingResolver): Builder<T> = apply { this.httpBindingResolver = httpBindingResolver }
         abstract fun build(): HttpProtocolUnitTestGenerator<T>
     }

smithy-swift-codegen/src/main/kotlin/software/amazon/smithy/swift/codegen/integration/HttpProtocolUnitTestRequestGenerator.kt

@@ -4,9 +4,6 @@
  */
 package software.amazon.smithy.swift.codegen.integration
 
-import software.amazon.smithy.codegen.core.Symbol
-import software.amazon.smithy.model.shapes.OperationShape
-import software.amazon.smithy.model.shapes.Shape
 import software.amazon.smithy.model.shapes.StructureShape
 import software.amazon.smithy.protocoltests.traits.HttpRequestTestCase
 import software.amazon.smithy.rulesengine.traits.EndpointRuleSetTrait
@@ -17,7 +14,6 @@ import software.amazon.smithy.swift.codegen.integration.serde.readwrite.WireProt
 import software.amazon.smithy.swift.codegen.integration.serde.readwrite.requestWireProtocol
 import software.amazon.smithy.swift.codegen.model.RecursiveShapeBoxer
 import software.amazon.smithy.swift.codegen.model.toLowerCamelCase
-import software.amazon.smithy.swift.codegen.model.toUpperCamelCase
 import software.amazon.smithy.swift.codegen.swiftmodules.SmithyHTTPAPITypes
 import software.amazon.smithy.swift.codegen.swiftmodules.SmithyStreamsTypes
 
@@ -33,8 +29,8 @@ open class HttpProtocolUnitTestRequestGenerator protected constructor(builder: B
     }
 
     private fun renderExpectedBlock(test: HttpRequestTestCase) {
-        var resolvedHostValue = if (test.resolvedHost.isPresent && test.resolvedHost.get() != "") test.resolvedHost.get() else "example.com"
-        var hostValue = if (test.host.isPresent && test.host.get() != "") test.host.get() else "example.com"
+        val resolvedHostValue = if (test.resolvedHost.isPresent && test.resolvedHost.get() != "") test.resolvedHost.get() else "example.com"
+        val hostValue = if (test.host.isPresent && test.host.get() != "") test.host.get() else "example.com"
 
         // Normalize the URI
         val normalizedUri = when {
@@ -46,10 +42,8 @@ open class HttpProtocolUnitTestRequestGenerator protected constructor(builder: B
             }
         }
 
-        writer.write("let urlPrefix = urlPrefixFromHost(host: \$S)", test.host)
-        writer.write("let hostOnly = hostOnlyFromHost(host: \$S)", test.host)
         writer.openBlock("let expected = buildExpectedHttpRequest(")
-            .write("method: .${test.method.toLowerCase()},")
+            .write("method: .${test.method.lowercase()},")
             .write("path: \$S,", normalizedUri)
             .call { renderExpectedHeaders(test) }
             .call { renderExpectedQueryParams(test) }
@@ -86,7 +80,7 @@ open class HttpProtocolUnitTestRequestGenerator protected constructor(builder: B
 
         if (!serviceShape.getTrait(EndpointRuleSetTrait::class.java).isPresent) {
             val host: String? = test.host.orElse(null)
-            val url: String = "http://${host ?: "example.com"}"
+            val url = "http://${host ?: "example.com"}"
             writer.write("\nlet config = try await $clientName.${clientName}Configuration(endpointResolver: StaticEndpointResolver(endpoint: try \$N(urlString: \$S)))", SmithyHTTPAPITypes.Endpoint, url)
         } else {
             writer.write("\nlet config = try await $clientName.${clientName}Configuration()")
@@ -98,21 +92,14 @@ open class HttpProtocolUnitTestRequestGenerator protected constructor(builder: B
     }
 
     private fun renderOperationBlock(test: HttpRequestTestCase) {
-        operation.input.ifPresent { it ->
-            val clientName = "${ctx.settings.sdkId}Client"
+        operation.input.ifPresent {
             val inputShape = model.expectShape(it)
             model = RecursiveShapeBoxer.transform(model)
             writer.writeInline("\nlet input = ")
                 .call {
                     ShapeValueGenerator(model, symbolProvider).writeShapeValueInline(writer, inputShape, test.params)
                 }
                 .write("")
-            val inputSymbol = symbolProvider.toSymbol(inputShape)
-            val outputShapeId = operation.output.get()
-            val outputShape = model.expectShape(outputShapeId)
-            val outputSymbol = symbolProvider.toSymbol(outputShape)
-            val outputErrorName = "${operation.toUpperCamelCase()}OutputError"
-            writer.addImport(SwiftDependency.SMITHY.target)
             writer.addImport(SwiftDependency.SMITHY.target)
             writer.write(
                 """
@@ -122,17 +109,12 @@ open class HttpProtocolUnitTestRequestGenerator protected constructor(builder: B
                     ${'$'}{C|}
                 }
                 """.trimIndent(),
-                Runnable { renderBodyAssert(test, inputSymbol, inputShape) },
+                Runnable { renderBodyAssert(test) },
             )
         }
     }
 
-    private fun resolveHttpMethod(op: OperationShape): String {
-        val httpTrait = httpBindingResolver.httpTrait(op)
-        return httpTrait.method.toLowerCase()
-    }
-
-    private fun renderBodyAssert(test: HttpRequestTestCase, inputSymbol: Symbol, inputShape: Shape) {
+    private fun renderBodyAssert(test: HttpRequestTestCase) {
         if (test.body.isPresent && test.body.get().isNotBlank()) {
             writer.openBlock(
                 "try await self.assertEqual(expected, actual, { (expectedHttpBody, actualHttpBody) -> Void in",
@@ -193,39 +175,26 @@ open class HttpProtocolUnitTestRequestGenerator protected constructor(builder: B
     }
 
     private fun renderExpectedHeaders(test: HttpRequestTestCase) {
-        if (test.headers.isNotEmpty()) {
-            writer.openBlock("headers: [")
-                .call {
-                    for ((idx, hdr) in test.headers.entries.withIndex()) {
-                        val suffix = if (idx < test.headers.size - 1) "," else ""
-                        writer.write("\$S: \$S$suffix", hdr.key, hdr.value)
-                    }
-                }
-                .closeBlock("],")
-        }
+        writeHeaders("headers", test.headers)
+        writeHeaders("forbiddenHeaders", test.forbidHeaders)
+        writeHeaders("requiredHeaders", test.requireHeaders)
+    }
 
-        if (test.forbidHeaders.isNotEmpty()) {
-            val forbiddenHeaders = test.forbidHeaders
-            writer.openBlock("forbiddenHeaders: [")
-                .call {
-                    forbiddenHeaders.forEachIndexed { idx, value ->
-                        val suffix = if (idx < forbiddenHeaders.size - 1) "," else ""
-                        writer.write("\$S$suffix", value)
-                    }
-                }
-                .closeBlock("],")
+    private fun writeHeaders(name: String, headers: Map<String, String>) {
+        if (headers.isEmpty()) return
+        writer.openBlock("\$L: [", "],", name) {
+            val contents = headers.entries.joinToString(",\n") {
+                writer.format("\$S: \$S", it.key, it.value)
+            }
+            writer.write(contents)
         }
+    }
 
-        if (test.requireHeaders.isNotEmpty()) {
-            val requiredHeaders = test.requireHeaders
-            writer.openBlock("requiredHeaders: [")
-                .call {
-                    requiredHeaders.forEachIndexed { idx, value ->
-                        val suffix = if (idx < requiredHeaders.size - 1) "," else ""
-                        writer.write("\$S$suffix", value)
-                    }
-                }
-                .closeBlock("],")
+    private fun writeHeaders(name: String, headers: List<String>) {
+        if (headers.isEmpty()) return
+        writer.openBlock("\$L: [", "],", name) {
+            val contents = headers.joinToString(",\n") { writer.format("\$S", it) }
+            writer.write(contents)
         }
     }
 

smithy-swift-codegen/src/main/kotlin/software/amazon/smithy/swift/codegen/integration/HttpProtocolUnitTestResponseGenerator.kt

@@ -44,7 +44,7 @@ open class HttpProtocolUnitTestResponseGenerator protected constructor(builder:
             val symbol = symbolProvider.toSymbol(it)
             renderBuildHttpResponse(test)
             writer.write("")
-            renderActualOutput(test, symbol)
+            renderActualOutput(symbol)
             writer.write("")
             renderExpectedOutput(test, it)
             writer.write("")
@@ -103,7 +103,7 @@ open class HttpProtocolUnitTestResponseGenerator protected constructor(builder:
         }
     }
 
-    private fun renderActualOutput(test: HttpResponseTestCase, outputStruct: Symbol) {
+    private fun renderActualOutput(outputStruct: Symbol) {
         val responseClosure = ResponseClosureUtils(ctx, writer, operation).render()
         writer.write("let actual: \$N = try await \$L(httpResponse)", outputStruct, responseClosure)
     }

smithy-swift-codegen/src/test/kotlin/mocks/MockHTTPAWSJson11ProtocolGenerator.kt

@@ -59,7 +59,6 @@ class MockHTTPAWSJson11ProtocolGenerator() : HTTPBindingProtocolGenerator(MockAW
             responseTestBuilder,
             errorTestBuilder,
             customizations,
-            operationMiddleware,
             getProtocolHttpBindingResolver(ctx, defaultContentType),
         ).generateProtocolTests()
     }

smithy-swift-codegen/src/test/kotlin/mocks/MockHTTPEC2QueryProtocolGenerator.kt

@@ -62,7 +62,6 @@ class MockHTTPEC2QueryProtocolGenerator : HTTPBindingProtocolGenerator(MockEC2Qu
             responseTestBuilder,
             errorTestBuilder,
             customizations,
-            operationMiddleware,
             getProtocolHttpBindingResolver(ctx, defaultContentType),
         ).generateProtocolTests()
     }

smithy-swift-codegen/src/test/kotlin/mocks/MockHTTPRestJsonProtocolGenerator.kt

@@ -36,7 +36,6 @@ class MockHTTPRestJsonProtocolGenerator : HTTPBindingProtocolGenerator(MockRestJ
             responseTestBuilder,
             errorTestBuilder,
             customizations,
-            operationMiddleware,
             getProtocolHttpBindingResolver(ctx, defaultContentType),
         ).generateProtocolTests()
     }

smithy-swift-codegen/src/test/kotlin/mocks/MockHTTPRestXMLProtocolGenerator.kt

@@ -37,7 +37,6 @@ class MockHTTPRestXMLProtocolGenerator : HTTPBindingProtocolGenerator(MockRestXM
             responseTestBuilder,
             errorTestBuilder,
             customizations,
-            operationMiddleware,
             getProtocolHttpBindingResolver(ctx, defaultContentType),
         ).generateProtocolTests()
     }