feat(amazonq): UI Tests Baseline Framework Complete Set Up

packages/amazonq/test/e2e_new/amazonq/auth/authHelper.ts

@@ -0,0 +1,58 @@
+/*!
+ * 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 { findItemByText, sleep, waitForElements } from '../utils/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 signInToAmazonQ is not fully autonomous as we ran into a blocker when the browser window pops up */
+export async function signInToAmazonQ(): Promise<void> {
+    const workbench = new Workbench()
+    await workbench.executeCommand('Amazon Q: Open Chat')
+
+    await sleep(5000)
+    let webviewView = new WebviewView()
+    await webviewView.switchToFrame()
+
+    const selectableItems = await waitForElements(webviewView, By.css('.selectable-item'))
+    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 sleep(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
+}
+
+/* NOTE: The workbench and webviewView is grabbed directly from testContext because we are under the assumption that if you want to log out
+you've already logged in before. */
+export async function signOutFromAmazonQ(workbench: Workbench): Promise<void> {
+    await workbench.executeCommand('Amazon Q: Sign Out')
+}

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

@@ -0,0 +1,36 @@
+/*!
+ * 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 { testContext } from '../utils/testContext'
+import { clearChat, waitForChatResponse, writeToChat } from './chatHelper'
+import { closeAllTabs } from '../utils/cleanupHelper'
+
+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
+    })
+
+    after(async function () {
+        await closeAllTabs(webviewView)
+    })
+
+    afterEach(async () => {
+        await clearChat(webviewView)
+    })
+
+    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/chat/chatHelper.ts

@@ -0,0 +1,71 @@
+/*!
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { By, WebviewView } from 'vscode-extension-tester'
+import { sleep, waitForElement } from '../utils/generalHelper'
+
+/**
+ * Writes text to the chat input and optionally sends it
+ * @param prompt The text to write in the chat input
+ * @param webview The WebviewView instance
+ * @param send Whether to click the send button (defaults to true)
+ * @returns Promise<boolean> True if successful
+ */
+export async function writeToChat(prompt: string, webview: WebviewView, send = true): Promise<boolean> {
+    const chatInput = await waitForElement(webview, By.css('.mynah-chat-prompt-input'))
+    await chatInput.sendKeys(prompt)
+    if (send === true) {
+        const sendButton = await waitForElement(webview, By.css('.mynah-chat-prompt-button'))
+        await sendButton.click()
+    }
+    return true
+}
+
+/**
+ * Waits for a chat response to be generated
+ * @param webview The WebviewView instance
+ * @param timeout The timeout in milliseconds
+ * @returns Promise<boolean> True if a response was detected, false if timeout occurred
+ */
+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 sleep(500)
+    }
+
+    return false
+}
+
+/**
+ * Clears the text in the chat input field
+ * @param webview The WebviewView instance
+ * @returns Promise<boolean> True if successful, false if an error occurred
+ */
+export async function clearChat(webview: WebviewView): Promise<boolean> {
+    try {
+        const chatInput = await waitForElement(webview, By.css('.mynah-chat-prompt-input'))
+        await chatInput.sendKeys(
+            process.platform === 'darwin'
+                ? '\uE03D\u0061' // Command+A on macOS
+                : '\uE009\u0061' // Ctrl+A on Windows/Linux
+        )
+        await chatInput.sendKeys('\uE003') // Backspace
+        return true
+    } catch (e) {
+        console.error('Error clearing chat input:', e)
+        return false
+    }
+}

packages/amazonq/test/e2e_new/amazonq/pinContext/pinContext.test.ts

@@ -0,0 +1,35 @@
+/*!
+ * 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, dismissOverlayIfPresent } from '../utils/cleanupHelper'
+import { testContext } from '../utils/testContext'
+import { clickPinContextButton, getPinContextMenuItems, clickPinContextMenuItem } from './pinContextHelper'
+import { clearChat } from '../chat/chatHelper'
+
+describe('Amazon Q Pin Context 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
+    })
+
+    after(async function () {
+        await closeAllTabs(webviewView)
+    })
+
+    afterEach(async () => {
+        await dismissOverlayIfPresent(webviewView)
+        await clearChat(webviewView)
+    })
+
+    it('Pin Context Test', async () => {
+        await clickPinContextButton(webviewView)
+        await getPinContextMenuItems(webviewView)
+        await clickPinContextMenuItem(webviewView, '@workspace')
+    })
+})