test: remove duplicated code for user-agent tests

Organize the new tests a bit

Author: valerena

packages/core/src/test/lambda/remoteDebugging/ldkClient.test.ts

@@ -6,6 +6,7 @@
 import assert from 'assert'
 import sinon from 'sinon'
 import { FunctionConfiguration } from '@aws-sdk/client-lambda'
+import type { UserAgent } from '@aws-sdk/types'
 import { LdkClient, getRegionFromArn, isTunnelInfo } from '../../../lambda/remoteDebugging/ldkClient'
 import { LocalProxy } from '../../../lambda/remoteDebugging/localProxy'
 import * as utils from '../../../lambda/remoteDebugging/utils'
@@ -524,6 +525,20 @@ describe('LdkClient', () => {
     })
 
     describe('Client User-Agent', () => {
+        let expectedUserAgentPairs: UserAgent
+        before(() => {
+            // Stub getUserAgentPairs at the telemetryUtil level to return known pairs
+            const getUserAgentPairsStub = sandbox.stub(telemetryUtil, 'getUserAgentPairs')
+            const generalUserAgents: UserAgent = [
+                ['AWS-Toolkit-For-VSCode', 'testVersion'],
+                ['Visual-Studio-Code', '1.0.0'],
+                ['ClientId', 'test-client-id'],
+            ]
+            getUserAgentPairsStub.returns(generalUserAgents)
+            const lambdaDebugUserAgent: UserAgent = [['LAMBDA-DEBUG', '1.0.0']]
+            expectedUserAgentPairs = lambdaDebugUserAgent.concat(generalUserAgents)
+        })
+
         it('should create Lambda client with correct user-agent', async () => {
             // Restore the existing stub and create a new one to track calls
             const existingStub = (utils.getLambdaClientWithAgent as any).restore
@@ -533,18 +548,10 @@ describe('LdkClient', () => {
                 existingStub.restore()
             }
 
-            // Stub getUserAgentPairs at the telemetryUtil level to return known pairs
-            const getUserAgentPairsStub = sandbox.stub(telemetryUtil, 'getUserAgentPairs')
-            getUserAgentPairsStub.returns([
-                ['AWS-Toolkit-For-VSCode', 'testVersion'],
-                ['Visual-Studio-Code', '1.0.0'],
-                ['ClientId', 'test-client-id'],
-            ])
-
-            // Stub the sdkClientBuilderV3 to capture the client options
+            // Stub the Lambda sdkClientBuilderV3 to capture the client options
             let capturedClientOptions: any
-            const createAwsServiceStub = sandbox.stub(globals.sdkClientBuilderV3, 'createAwsService')
-            createAwsServiceStub.callsFake((options: any) => {
+            const createAwsServiceStubLambda = sandbox.stub(globals.sdkClientBuilderV3, 'createAwsService')
+            createAwsServiceStubLambda.callsFake((options: any) => {
                 capturedClientOptions = options
                 // Return a mock Lambda client that has the required methods
                 return {
@@ -564,16 +571,11 @@ describe('LdkClient', () => {
 
             await ldkClient.getFunctionDetail(mockFunctionConfig.FunctionArn!)
 
-            assert(createAwsServiceStub.called, 'Should call createAwsService')
+            assert(createAwsServiceStubLambda.called, 'Should call createAwsService')
             assert.strictEqual(capturedClientOptions.clientOptions.region, 'us-east-1', 'Should use correct region')
             assert.deepStrictEqual(
                 capturedClientOptions.clientOptions.customUserAgent,
-                [
-                    ['LAMBDA-DEBUG', '1.0.0'],
-                    ['AWS-Toolkit-For-VSCode', 'testVersion'],
-                    ['Visual-Studio-Code', '1.0.0'],
-                    ['ClientId', 'test-client-id'],
-                ],
+                expectedUserAgentPairs,
                 'Should include correct customUserAgent pairs with LAMBDA-DEBUG prefix in Lambda API calls'
             )
         })
@@ -586,19 +588,10 @@ describe('LdkClient', () => {
             if (existingStub) {
                 existingStub.restore()
             }
-
-            // Stub getUserAgentPairs to return known pairs
-            const getUserAgentPairsStub = sandbox.stub(telemetryUtil, 'getUserAgentPairs')
-            getUserAgentPairsStub.returns([
-                ['AWS-Toolkit-For-VSCode', 'testVersion'],
-                ['Visual-Studio-Code', '1.0.0'],
-                ['ClientId', 'test-client-id'],
-            ])
-
             // Stub the sdkClientBuilderV3 to capture the client options
             let capturedClientOptions: any
-            const createAwsServiceStub = sandbox.stub(globals.sdkClientBuilderV3, 'createAwsService')
-            createAwsServiceStub.callsFake((options: any) => {
+            const createAwsServiceStubIoT = sandbox.stub(globals.sdkClientBuilderV3, 'createAwsService')
+            createAwsServiceStubIoT.callsFake((options: any) => {
                 capturedClientOptions = options
                 return mockIoTSTClient as any
             })
@@ -612,16 +605,11 @@ describe('LdkClient', () => {
 
             await ldkClient.createOrReuseTunnel('us-east-1')
 
-            assert(createAwsServiceStub.calledOnce, 'Should call createAwsService once')
+            assert(createAwsServiceStubIoT.calledOnce, 'Should call createAwsService once')
             assert.strictEqual(capturedClientOptions.clientOptions.region, 'us-east-1', 'Should use correct region')
             assert.deepStrictEqual(
                 capturedClientOptions.clientOptions.customUserAgent,
-                [
-                    ['LAMBDA-DEBUG', '1.0.0'],
-                    ['AWS-Toolkit-For-VSCode', 'testVersion'],
-                    ['Visual-Studio-Code', '1.0.0'],
-                    ['ClientId', 'test-client-id'],
-                ],
+                expectedUserAgentPairs,
                 'Should include correct customUserAgent pairs with LAMBDA-DEBUG prefix'
             )
         })