feat(amazonq): Initializing E2E UI Testing Framework

P261194666.md

@@ -537,6 +537,7 @@ Based on our investigation of the language-server-runtimes repository and the pr
     ```
 
 5. **Ensure Auto-login Happens Early** (`packages/amazonq/src/lsp/activation.ts`):
+
     ```typescript
     export async function activate(ctx: vscode.ExtensionContext): Promise<void> {
         try {

packages/amazonq/test/e2e_new/amazonq/chat.test.ts

@@ -0,0 +1,37 @@
+/*!
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import '../utils/setup'
+import { WebviewView } from 'vscode-extension-tester'
+import { closeAllTabs } from './framework/cleanupHelper'
+import { testContext } from './utils/testContext'
+import { waitForChatResponse, writeToChat } from './framework/chatHelper'
+import assert from 'assert'
+
+describe('Amazon Q Chat Basic Functionality', function () {
+    // this timeout is the general timeout for the entire test suite
+    this.timeout(150000)
+    let webviewView: WebviewView
+
+    before(async function () {
+        webviewView = testContext.webviewView!
+    })
+
+    afterEach(async () => {
+        try {
+            await closeAllTabs(webviewView)
+        } catch (e) {
+            assert.fail(`Failed to clean up tabs: ${e}`)
+        }
+    })
+
+    it('Chat Prompt Test', async () => {
+        await writeToChat('Hello, Amazon Q!', webviewView)
+        const responseReceived = await waitForChatResponse(webviewView)
+        if (!responseReceived) {
+            throw new Error('Chat response not received within timeout')
+        }
+        console.log('Chat response detected successfully')
+    })
+})

packages/amazonq/test/e2e_new/amazonq/framework/chatHelper.ts

@@ -0,0 +1,35 @@
+/*!
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { By, WebviewView } from 'vscode-extension-tester'
+import { waitForElement } from './generalHelper'
+
+export async function writeToChat(prompt: string, webview: WebviewView): Promise<boolean> {
+    const chatInput = await waitForElement(webview, By.css('.mynah-chat-prompt-input'))
+    await chatInput.sendKeys(prompt)
+    const sendButton = await waitForElement(webview, By.css('.mynah-chat-prompt-button'))
+    await sendButton.click()
+    return true
+}
+
+export async function waitForChatResponse(webview: WebviewView, timeout = 15000): Promise<boolean> {
+    const startTime = Date.now()
+
+    while (Date.now() - startTime < timeout) {
+        const conversationContainers = await webview.findWebElements(By.css('.mynah-chat-items-conversation-container'))
+
+        if (conversationContainers.length > 0) {
+            const latestContainer = conversationContainers[conversationContainers.length - 1]
+
+            const chatItems = await latestContainer.findElements(By.css('*'))
+
+            if (chatItems.length >= 2) {
+                return true
+            }
+        }
+        await new Promise((resolve) => setTimeout(resolve, 500))
+    }
+
+    return false
+}

packages/amazonq/test/e2e_new/amazonq/framework/cleanupHelper.ts

@@ -0,0 +1,31 @@
+/*!
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { By, WebviewView } from 'vscode-extension-tester'
+
+export async function closeAllTabs(webview: WebviewView): Promise<boolean> {
+    try {
+        const closeButtons = await webview.findWebElements(By.css('.mynah-tabs-close-button'))
+
+        for (const button of closeButtons) {
+            await button.click()
+            await new Promise((resolve) => setTimeout(resolve, 500))
+        }
+
+        const tabsContainer = await webview.findWebElements(By.css('.mynah-tabs-container'))
+        const allClosed =
+            tabsContainer.length === 0 ||
+            (await tabsContainer[0].findElements(By.css('.mynah-tab-item-label'))).length === 0
+
+        if (allClosed) {
+            console.log('All chat tabs successfully closed')
+            return true
+        } else {
+            throw new Error('Failed to close all tabs')
+        }
+    } catch (error) {
+        console.error('Error closing tabs:', error)
+        throw error
+    }
+}

packages/amazonq/test/e2e_new/amazonq/framework/generalHelper.ts

@@ -0,0 +1,43 @@
+/*!
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { By, WebviewView, WebElement } from 'vscode-extension-tester'
+import { until } from 'selenium-webdriver'
+
+/* Note: If multiple is set to False, then it will return the first element it finds that matches the Locator*/
+export async function waitForElement(
+    webview: WebviewView,
+    locator: By,
+    multiple: true,
+    timeout?: number
+): Promise<WebElement[]>
+export async function waitForElement(
+    webview: WebviewView,
+    locator: By,
+    multiple?: false,
+    timeout?: number
+): Promise<WebElement>
+export async function waitForElement(
+    webview: WebviewView,
+    locator: By,
+    multiple = false,
+    timeout = 15000
+): Promise<WebElement | WebElement[]> {
+    const driver = webview.getDriver()
+    await driver.wait(until.elementsLocated(locator), timeout)
+    return multiple ? await webview.findWebElements(locator) : await webview.findWebElement(locator)
+}
+
+export async function findItemByText(items: WebElement[], text: string) {
+    for (const item of items) {
+        const titleDivs = await item.findElements(By.css('.title'))
+        for (const titleDiv of titleDivs) {
+            const titleText = await titleDiv.getText()
+            if (titleText?.trim().startsWith(text)) {
+                return item
+            }
+        }
+    }
+    throw new Error(`Item with text "${text}" not found`)
+}

packages/amazonq/test/e2e_new/amazonq/framework/loginHelper.ts

@@ -0,0 +1,52 @@
+/*!
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { Workbench, By, WebviewView } from 'vscode-extension-tester'
+import { waitForElement, findItemByText } from './generalHelper'
+import { testContext } from '../utils/testContext'
+/* Completes the entire Amazon Q login flow
+
+Currently, the function will
+1. Open AmazonQ
+2. Clicks Company Account
+3. Inputs the Start URL
+4. IMPORTANT: you must click manually open yourself when the popup window asks to open the browser and complete the authentication in the browser** 
+
+TO-DO: Currently this loginToAmazonQ is not fully autonomous as we ran into a blocker when the browser window pops up */
+
+export async function loginToAmazonQ(): Promise<void> {
+    const workbench = new Workbench()
+    await workbench.executeCommand('Amazon Q: Open Chat')
+
+    await new Promise((resolve) => setTimeout(resolve, 5000))
+    let webviewView = new WebviewView()
+    await webviewView.switchToFrame()
+
+    const selectableItems = await waitForElement(webviewView, By.css('.selectable-item'), true)
+    if (selectableItems.length === 0) {
+        throw new Error('No selectable login options found')
+    }
+
+    const companyItem = await findItemByText(selectableItems, 'Company account')
+    await companyItem.click()
+    const signInContinue = await webviewView.findWebElement(By.css('#connection-selection-continue-button'))
+    await signInContinue.click()
+    const startUrlInput = await webviewView.findWebElement(By.id('startUrl'))
+    await startUrlInput.clear()
+    await startUrlInput.sendKeys('https://amzn.awsapps.com/start')
+    const UrlContinue = await webviewView.findWebElement(By.css('button.continue-button.topMargin'))
+    await UrlContinue.click()
+    console.log('Waiting for manual authentication...')
+    await new Promise((resolve) => setTimeout(resolve, 12000))
+    console.log('Manual authentication should be done')
+    await webviewView.switchBack()
+
+    const editorView = workbench.getEditorView()
+    await editorView.closeAllEditors()
+    webviewView = new WebviewView()
+    await webviewView.switchToFrame()
+
+    testContext.workbench = workbench
+    testContext.webviewView = webviewView
+}

packages/amazonq/test/e2e_new/amazonq/utils/setup.ts

@@ -0,0 +1,13 @@
+/*!
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { loginToAmazonQ } from '../framework/loginHelper'
+
+before(async function () {
+    this.timeout(60000)
+    console.log('\n\n*** MANUAL INTERVENTION REQUIRED ***')
+    console.log('When prompted, you must manually click to open the browser and complete authentication')
+    console.log('You have 60 seconds to complete this step\n\n')
+    await loginToAmazonQ()
+})