fix(amazonq): Add AuthUtil test suite and fix unit tests (#7249)

## Problem
Unit tests for `amazonq_backed` and `regionProfileManager` are broken or
disabled, because they are not working with the LSP auth setup

## Solution
* Create a new test util to setup AuthUtil for tests, stubbing the LSP
client methods
* Rework the unit test where necessary to use the AuthUtil on Flare
identity server
* Move `amazonq_backed` to the `amazonq` package, since the AuthUtil
won't instantiate correctly if the unit test runs under `toolkits` test
suite

---

- Treat all work as PUBLIC. Private `feature/x` branches will not be
squash-merged at release time.
- Your code changes must meet the guidelines in
[CONTRIBUTING.md](https://github.com/aws/aws-toolkit-vscode/blob/master/CONTRIBUTING.md#guidelines).
- License: I confirm that my contribution is made under the terms of the
Apache 2.0 license.

Author: opieter-aws

packages/amazonq/test/unit/amazonq/backend_amazonq.test.ts

@@ -0,0 +1,119 @@
+/*!
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+import assert from 'assert'
+import * as sinon from 'sinon'
+import { assertTelemetry, createTestAuthUtil } from 'aws-core-vscode/test'
+import { AuthUtil, awsIdSignIn, getStartUrl } from 'aws-core-vscode/codewhisperer'
+import { backendAmazonQ } from 'aws-core-vscode/login'
+
+describe('Amazon Q Login', async function () {
+    const region = 'fakeRegion'
+    const startUrl = 'fakeUrl'
+
+    let sandbox: sinon.SinonSandbox
+    let backend: backendAmazonQ.AmazonQLoginWebview
+
+    await createTestAuthUtil()
+
+    beforeEach(function () {
+        sandbox = sinon.createSandbox()
+        backend = new backendAmazonQ.AmazonQLoginWebview()
+    })
+
+    afterEach(function () {
+        sandbox.restore()
+    })
+
+    it('signs into builder ID and emits telemetry', async function () {
+        await backend.startBuilderIdSetup()
+
+        assert.ok(AuthUtil.instance.isConnected())
+        assert.ok(AuthUtil.instance.isBuilderIdConnection())
+
+        assertTelemetry('auth_addConnection', {
+            result: 'Succeeded',
+            credentialSourceId: 'awsId',
+            authEnabledFeatures: 'codewhisperer',
+            isReAuth: false,
+            ssoRegistrationExpiresAt: undefined,
+            ssoRegistrationClientId: undefined,
+        })
+    })
+
+    it('signs into IdC and emits telemetry', async function () {
+        await backend.startEnterpriseSetup(startUrl, region)
+
+        assert.ok(AuthUtil.instance.isConnected())
+        assert.ok(AuthUtil.instance.isIdcConnection())
+        assert.ok(AuthUtil.instance.isSsoSession())
+        assert.deepStrictEqual(AuthUtil.instance.connection?.startUrl, startUrl)
+        assert.deepStrictEqual(AuthUtil.instance.connection?.region, region)
+
+        assertTelemetry('auth_addConnection', {
+            result: 'Succeeded',
+            credentialSourceId: 'iamIdentityCenter',
+            authEnabledFeatures: 'codewhisperer',
+            credentialStartUrl: startUrl,
+            awsRegion: region,
+            isReAuth: false,
+            ssoRegistrationExpiresAt: undefined,
+            ssoRegistrationClientId: undefined,
+        })
+    })
+
+    it('reauths builder ID and emits telemetry', async function () {
+        await awsIdSignIn()
+
+        await backend.reauthenticateConnection()
+
+        assert.ok(AuthUtil.instance.isConnected())
+
+        assertTelemetry('auth_addConnection', {
+            result: 'Succeeded',
+            credentialSourceId: 'awsId',
+            authEnabledFeatures: 'codewhisperer',
+            isReAuth: true,
+            ssoRegistrationExpiresAt: undefined,
+            ssoRegistrationClientId: undefined,
+        })
+    })
+
+    it('reauths IdC and emits telemetry', async function () {
+        await getStartUrl.connectToEnterpriseSso(startUrl, region)
+
+        await backend.reauthenticateConnection()
+
+        assert.ok(AuthUtil.instance.isConnected())
+
+        assertTelemetry('auth_addConnection', {
+            result: 'Succeeded',
+            credentialSourceId: 'iamIdentityCenter',
+            authEnabledFeatures: 'codewhisperer',
+            credentialStartUrl: startUrl,
+            awsRegion: region,
+            isReAuth: true,
+            ssoRegistrationExpiresAt: undefined,
+            ssoRegistrationClientId: undefined,
+        })
+    })
+
+    it('signs out of reauth and emits telemetry', async function () {
+        await backend.signout()
+
+        assert.ok(!AuthUtil.instance.isConnected())
+
+        assertTelemetry('auth_addConnection', {
+            result: 'Cancelled',
+            credentialSourceId: 'iamIdentityCenter',
+            authEnabledFeatures: 'codewhisperer',
+            credentialStartUrl: startUrl,
+            awsRegion: region,
+            isReAuth: true,
+            ssoRegistrationExpiresAt: undefined,
+            ssoRegistrationClientId: undefined,
+        })
+    })
+})

packages/amazonq/test/unit/codewhisperer/region/regionProfileManager.test.ts

@@ -8,11 +8,12 @@ import assert, { fail } from 'assert'
 import { AuthUtil, RegionProfile, RegionProfileManager, defaultServiceConfig } from 'aws-core-vscode/codewhisperer'
 import { globals } from 'aws-core-vscode/shared'
 import { constants } from 'aws-core-vscode/auth'
+import { createTestAuthUtil } from 'aws-core-vscode/test'
 
 const enterpriseSsoStartUrl = 'https://enterprise.awsapps.com/start'
 const region = 'us-east-1'
 
-describe('RegionProfileManager', function () {
+describe('RegionProfileManager', async function () {
     let regionProfileManager: RegionProfileManager
 
     const profileFoo: RegionProfile = {
@@ -22,6 +23,8 @@ describe('RegionProfileManager', function () {
         description: 'foo description',
     }
 
+    await createTestAuthUtil()
+
     async function setupConnection(type: 'builderId' | 'idc') {
         if (type === 'builderId') {
             await AuthUtil.instance.login(constants.builderIdStartUrl, region)

packages/amazonq/test/unit/codewhisperer/service/recommendationHandler.test.ts

@@ -9,13 +9,13 @@ import * as sinon from 'sinon'
 import {
     ReferenceInlineProvider,
     session,
-    AuthUtil,
     DefaultCodeWhispererClient,
     RecommendationsList,
     ConfigurationEntry,
     RecommendationHandler,
     CodeWhispererCodeCoverageTracker,
     supplementalContextUtil,
+    AuthUtil,
 } from 'aws-core-vscode/codewhisperer'
 import {
     assertTelemetryCurried,
@@ -39,15 +39,13 @@ describe('recommendationHandler', function () {
     describe('getRecommendations', async function () {
         const mockClient = stub(DefaultCodeWhispererClient)
         const mockEditor = createMockTextEditor()
-        const testStartUrl = 'testStartUrl'
 
         beforeEach(async function () {
             sinon.restore()
             await resetCodeWhispererGlobalVariables()
             mockClient.listRecommendations.resolves({})
             mockClient.generateRecommendations.resolves({})
             RecommendationHandler.instance.clearRecommendations()
-            sinon.stub(AuthUtil.instance.connection!, 'startUrl').value(testStartUrl)
         })
 
         afterEach(function () {
@@ -143,7 +141,7 @@ describe('recommendationHandler', function () {
                 codewhispererLineNumber: 1,
                 codewhispererCursorOffset: 38,
                 codewhispererLanguage: 'python',
-                credentialStartUrl: testStartUrl,
+                credentialStartUrl: AuthUtil.instance.connection?.startUrl,
                 codewhispererSupplementalContextIsUtg: false,
                 codewhispererSupplementalContextTimeout: false,
                 codewhispererSupplementalContextLatency: 0,

packages/amazonq/test/unit/codewhisperer/tracker/codewhispererTracker.test.ts

@@ -82,8 +82,6 @@ describe('codewhispererTracker', function () {
 
     describe('emitTelemetryOnSuggestion', function () {
         it('Should call recordCodewhispererUserModification with suggestion event', async function () {
-            const testStartUrl = 'testStartUrl'
-            sinon.stub(AuthUtil.instance.connection!, 'startUrl').value(testStartUrl)
             const suggestion = createAcceptedSuggestionEntry()
             const assertTelemetry = assertTelemetryCurried('codewhisperer_userModification')
             await CodeWhispererTracker.getTracker().emitTelemetryOnSuggestion(suggestion)
@@ -95,7 +93,7 @@ describe('codewhispererTracker', function () {
                 codewhispererModificationPercentage: 1,
                 codewhispererCompletionType: 'Line',
                 codewhispererLanguage: 'java',
-                credentialStartUrl: testStartUrl,
+                credentialStartUrl: AuthUtil.instance.connection?.startUrl,
                 codewhispererCharactersAccepted: suggestion.originalString.length,
                 codewhispererCharactersModified: 0,
             })

packages/core/src/codewhisperer/index.ts

@@ -93,6 +93,7 @@ export * from './util/commonUtil'
 export * from './util/supplementalContext/codeParsingUtil'
 export * from './util/supplementalContext/supplementalContextUtil'
 export * from './util/codewhispererSettings'
+export * as getStartUrl from './util/getStartUrl'
 export * as supplementalContextUtil from './util/supplementalContext/supplementalContextUtil'
 export * from './service/diagnosticsProvider'
 export * as diagnosticsProvider from './service/diagnosticsProvider'

packages/core/src/login/webview/index.ts

@@ -5,3 +5,4 @@
 
 export { CommonAuthViewProvider } from './commonAuthViewProvider'
 export { CommonAuthWebview } from './vue/backend'
+export * as backendAmazonQ from './vue/amazonq/backend_amazonq'

packages/core/src/login/webview/vue/amazonq/backend_amazonq.ts

@@ -3,7 +3,7 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 import * as vscode from 'vscode'
-import { AwsConnection, SsoConnection, getTelemetryMetadataForConn } from '../../../../auth/connection'
+import { AwsConnection, SsoConnection } from '../../../../auth/connection'
 import { AuthUtil } from '../../../../codewhisperer/util/authUtil'
 import { CommonAuthWebview } from '../backend'
 import { awsIdSignIn } from '../../../../codewhisperer/util/showSsoPrompt'
@@ -114,9 +114,7 @@ export class AmazonQLoginWebview extends CommonAuthWebview {
                     ...(await AuthUtil.instance.getTelemetryMetadata()),
                 })
                 await AuthUtil.instance.reauthenticate()
-                this.storeMetricMetadata({
-                    ...(await AuthUtil.instance.getTelemetryMetadata()),
-                })
+                this.storeMetricMetadata(await AuthUtil.instance.getTelemetryMetadata())
             })
         } finally {
             this.isReauthenticating = false
@@ -178,7 +176,7 @@ export class AmazonQLoginWebview extends CommonAuthWebview {
         this.storeMetricMetadata({
             authEnabledFeatures: 'codewhisperer',
             isReAuth: true,
-            ...(await getTelemetryMetadataForConn()),
+            ...(await AuthUtil.instance.getTelemetryMetadata()),
             result: 'Cancelled',
         })
 

packages/core/src/test/index.ts

@@ -25,3 +25,4 @@ export * from './testUtil'
 export * from './amazonq/utils'
 export * from './fake/mockFeatureConfigData'
 export * from './shared/ui/testUtils'
+export * from './testAuthUtil'