Add test to verify user agent is passed (#2726)

Author: abrooksv

core/src/software/aws/toolkits/core/ToolkitClientManager.kt

@@ -84,11 +84,19 @@ abstract class ToolkitClientManager {
      * Creates a new client for the requested [AwsClientKey]
      */
     @Suppress("UNCHECKED_CAST")
-    protected open fun <T : SdkClient> createNewClient(
+    open fun <T : SdkClient> createNewClient(
         sdkClass: KClass<T>,
         region: AwsRegion,
-        credProvider: ToolkitCredentialsProvider
-    ): T = createNewClient(sdkClass, sdkHttpClient(), Region.of(region.id), credProvider, userAgent)
+        credProvider: ToolkitCredentialsProvider,
+        endpointOverride: String? = null
+    ): T = createNewClient(
+        sdkClass = sdkClass,
+        httpClient = sdkHttpClient(),
+        region = Region.of(region.id),
+        credProvider = credProvider,
+        userAgent = userAgent,
+        endpointOverride = endpointOverride
+    )
 
     companion object {
         private val GLOBAL_SERVICE_DENY_LIST = setOf(

jetbrains-core/tst/software/aws/toolkits/jetbrains/core/AwsClientManagerTest.kt

@@ -3,6 +3,15 @@
 
 package software.aws.toolkits.jetbrains.core
 
+import com.github.tomakehurst.wiremock.WireMockServer
+import com.github.tomakehurst.wiremock.client.WireMock.aResponse
+import com.github.tomakehurst.wiremock.client.WireMock.any
+import com.github.tomakehurst.wiremock.client.WireMock.anyRequestedFor
+import com.github.tomakehurst.wiremock.client.WireMock.anyUrl
+import com.github.tomakehurst.wiremock.client.WireMock.stubFor
+import com.github.tomakehurst.wiremock.client.WireMock.verify
+import com.github.tomakehurst.wiremock.core.WireMockConfiguration
+import com.github.tomakehurst.wiremock.matching.ContainsPattern
 import com.intellij.openapi.application.ApplicationManager
 import com.intellij.openapi.util.Disposer
 import com.intellij.openapi.util.use
@@ -20,6 +29,7 @@ import software.amazon.awssdk.core.client.config.SdkAdvancedClientOption
 import software.amazon.awssdk.core.client.config.SdkClientOption
 import software.amazon.awssdk.core.signer.Signer
 import software.amazon.awssdk.http.SdkHttpClient
+import software.amazon.awssdk.services.lambda.LambdaClient
 import software.aws.toolkits.core.region.Endpoint
 import software.aws.toolkits.core.region.Service
 import software.aws.toolkits.core.region.anAwsRegion
@@ -173,6 +183,29 @@ class AwsClientManagerTest {
         assertThat(second).isSameAs(first)
     }
 
+    @Test
+    fun userAgentIsPassed() {
+        val wireMockServer = WireMockServer(WireMockConfiguration.wireMockConfig())
+        try {
+            wireMockServer.start()
+
+            stubFor(any(anyUrl()).willReturn(aResponse().withStatus(200)))
+
+            val sut = getClientManager().createNewClient(
+                LambdaClient::class,
+                regionProvider.createAwsRegion(),
+                credentialManager.createCredentialProvider(),
+                endpointOverride = wireMockServer.baseUrl()
+            )
+
+            sut.listFunctions()
+
+            verify(anyRequestedFor(anyUrl()).withHeader("User-Agent", ContainsPattern("AWS-Toolkit-For-JetBrains/")))
+        } finally {
+            wireMockServer.stop()
+        }
+    }
+
     // Test against real version so bypass ServiceManager for the client manager
     private fun getClientManager() = AwsClientManager()
 

jetbrains-core/tst/software/aws/toolkits/jetbrains/core/MockClientManager.kt

@@ -30,10 +30,14 @@ class MockClientManager : AwsClientManager() {
     private val mockClients = mutableMapOf<Key, SdkClient>()
 
     @Suppress("UNCHECKED_CAST")
-    override fun <T : SdkClient> createNewClient(sdkClass: KClass<T>, region: AwsRegion, credProvider: ToolkitCredentialsProvider): T =
-        mockClients[Key(sdkClass, region, credProvider.id)] as? T
-            ?: mockClients[Key(sdkClass)] as? T
-            ?: throw IllegalStateException("No mock registered for $sdkClass")
+    override fun <T : SdkClient> createNewClient(
+        sdkClass: KClass<T>,
+        region: AwsRegion,
+        credProvider: ToolkitCredentialsProvider,
+        endpointOverride: String?
+    ): T = mockClients[Key(sdkClass, region, credProvider.id)] as? T
+        ?: mockClients[Key(sdkClass)] as? T
+        ?: throw IllegalStateException("No mock registered for $sdkClass")
 
     override fun dispose() {
         super.dispose()