fixing the comments and adding the signout functionality

Author: laura-codess

packages/amazonq/test/e2e/amazonq/test-ids.ts

@@ -0,0 +1,172 @@
+/*!
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+export default {
+    selector: 'data-testid',
+    prompt: {
+        wrapper: 'prompt-input-wrapper',
+        attachmentWrapper: 'prompt-input-attachment-wrapper',
+        attachment: 'prompt-input-attachment',
+        options: 'prompt-input-options',
+        attachmentRemove: 'prompt-input-attachment-remove-button',
+        send: 'prompt-input-send-button',
+        input: 'prompt-input-textarea',
+        inputWrapper: 'prompt-input-input-wrapper',
+        remainingCharsIndicator: 'prompt-input-remaining-chars-indicator',
+        contextTooltip: 'prompt-input-context-tooltip',
+        selectedCommand: 'prompt-input-selected-command',
+        quickPicksWrapper: 'prompt-input-quick-picks-wrapper',
+        quickPicksGroup: 'prompt-input-quick-picks-group',
+        quickPicksGroupTitle: 'prompt-input-quick-picks-group-title',
+        quickPickItem: 'prompt-input-quick-pick-item',
+        footerInfo: 'prompt-input-footer-info',
+        footerInfoBody: 'prompt-input-footer-info-body',
+        stickyCard: 'prompt-input-sticky-card',
+        progress: 'prompt-input-progress-wrapper',
+        label: 'prompt-input-label',
+        topBar: 'prompt-input-top-bar',
+        topBarButton: 'prompt-input-top-bar-button',
+        topBarContextPill: 'prompt-input-top-bar-context-pill',
+        topBarContextTooltip: 'prompt-input-top-bar-context-tooltip',
+        tobBarOverflowPill: 'prompt-input-top-bar-overflow-pill',
+        tobBarOverflowOverlay: 'prompt-input-top-bar-overflow-overlay',
+        tobBarActionOverlay: 'prompt-input-top-bar-action-overlay',
+    },
+    chat: {
+        wrapper: 'chat-wrapper',
+        chatItemsContainer: 'chat-chat-items-container',
+        conversationContainer: 'chat-chat-items-conversation-container',
+        middleBlockWrapper: 'chat-middle-block-wrapper',
+        stopButton: 'chat-middle-block-stop-button',
+        header: 'chat-wrapper-header-details',
+        moreContentIndicator: 'chat-wrapper-more-content-available-indicator',
+        moreContentIndicatorButton: 'chat-wrapper-more-content-available-indicator-button',
+    },
+    chatItem: {
+        type: {
+            any: 'chat-item',
+            answer: 'chat-item-answer',
+            answerStream: 'chat-item-answer-stream',
+            prompt: 'chat-item-prompt',
+            aiPrompt: 'chat-item-ai-prompt',
+            systemPrompt: 'chat-item-system-prompt',
+        },
+        moreContentIndicator: 'chat-item-card-more-content-indicator',
+        card: 'chat-item-card',
+        cardBody: 'chat-item-card-body',
+        buttons: {
+            wrapper: 'chat-item-buttons-wrapper',
+            button: 'chat-item-action-button',
+        },
+        dismissButton: 'chat-item-dismiss-button',
+        chatItemFollowup: {
+            optionsWrapper: 'chat-item-followup-options-wrapper',
+            optionButton: 'chat-item-followup-option',
+            title: 'chat-item-followup-title',
+            wrapper: 'chat-item-followup-wrapper',
+        },
+        syntaxHighlighter: {
+            wrapper: 'chat-item-syntax-highlighter-wrapper',
+            codeBlock: 'chat-item-syntax-highlighter-code-block',
+            lineNumbers: 'chat-item-syntax-highlighter-line-numbers',
+            language: 'chat-item-syntax-highlighter-language',
+            buttonsWrapper: 'chat-item-syntax-highlighter-buttons-wrapper',
+            button: 'chat-item-syntax-highlighter-button',
+        },
+        chatItemForm: {
+            wrapper: 'chat-item-form-wrapper',
+            title: 'chat-item-form-title',
+            description: 'chat-item-form-description',
+            itemSelectWrapper: 'chat-item-form-item-select-wrapper',
+            itemSelect: 'chat-item-form-item-select',
+            itemRadioWrapper: 'chat-item-form-item-radio-wrapper',
+            itemRadio: 'chat-item-form-item-radio',
+            itemInput: 'chat-item-form-item-text-input',
+            itemList: 'chat-item-form-item-list',
+            itemStarsWrapper: 'chat-item-form-item-stars-wrapper',
+            itemStars: 'chat-item-form-item-stars',
+            itemTextArea: 'chat-item-form-item-textarea',
+            itemToggleWrapper: 'chat-item-form-item-toggle-wrapper',
+            itemToggleOption: 'chat-item-form-item-toggle-option',
+            itemSwitch: 'chat-item-form-item-switch',
+        },
+        vote: {
+            wrapper: 'chat-item-vote-wrapper',
+            upvote: 'chat-item-upvote',
+            upvoteLabel: 'chat-item-upvote-label',
+            downvote: 'chat-item-downvote',
+            downvoteLabel: 'chat-item-downvote-label',
+            reportButton: 'chat-item-vote-report',
+            thanks: 'chat-item-vote-thanks',
+        },
+        relatedLinks: {
+            showMore: 'chat-item-related-links-show-more',
+            wrapper: 'chat-item-related-links-wrapper',
+            title: 'chat-item-related-links-title',
+            linkWrapper: 'chat-item-related-link-wrapper',
+            link: 'chat-item-related-link',
+            linkPreviewOverlay: 'chat-item-related-link-preview-overlay',
+            linkPreviewOverlayCard: 'chat-item-related-link-preview-overlay-card',
+        },
+        fileTree: {
+            wrapper: 'chat-item-file-tree-wrapper',
+            title: 'chat-item-file-tree-title',
+            license: 'chat-item-file-tree-license',
+            folder: 'chat-item-file-tree-folder',
+            file: 'chat-item-file-tree-file',
+            fileAction: 'chat-item-file-tree-file-action',
+            fileTooltipWrapper: 'chat-item-file-tree-file-tooltip-wrapper',
+        },
+        tabbedCard: {
+            tabs: 'chat-item-tabbed-card-tabs',
+        },
+    },
+    feedbackForm: {
+        optionsSelectWrapper: 'feedback-form-options-select-wrapper',
+        optionsSelect: 'feedback-form-options-select',
+        comment: 'feedback-form-comment-text-area',
+        cancelButton: 'feedback-form-cancel-button',
+        submitButton: 'feedback-form-submit-button',
+    },
+    sheet: {
+        wrapper: 'sheet-wrapper',
+        header: 'sheet-header',
+        title: 'sheet-title',
+        description: 'sheet-description',
+        closeButton: 'sheet-close-button',
+    },
+    detailedList: {
+        action: 'detailed-list-action',
+        actionMenu: 'detailed-list-action-menu',
+        status: 'detailed-list-status',
+    },
+    tabBar: {
+        wrapper: 'tab-bar-wrapper',
+        buttonsWrapper: 'tab-bar-buttons-wrapper',
+        button: 'tab-bar-button',
+        menuButton: 'tab-bar-menu-button',
+        menuOption: 'tab-bar-menu-option',
+        tabsWrapper: 'tab-bar-tabs',
+        tabOptionWrapper: 'tab-bar-tabs-option-wrapper',
+        tabOption: 'tab-bar-tabs-option',
+        tabOptionLabel: 'tab-bar-tabs-option-label',
+        tabOptionCloseButton: 'tab-bar-tabs-option-close-button',
+        tabAddButton: 'tab-bar-tab-add-button',
+        maxTabsReachedOverlay: 'tab-bar-max-tabs-reached-overlay',
+        tabCloseConfirmationOverlay: 'tab-bar-tab-close-confirmation-overlay',
+        tabCloseConfirmationBody: 'tab-bar-tab-close-confirmation-body',
+        tabCloseConfirmationCancelButton: 'tab-bar-tab-close-confirmation-cancel-button',
+        tabCloseConfirmationAcceptButton: 'tab-bar-tab-close-confirmation-accept-button',
+    },
+    noTabs: {
+        wrapper: 'no-tabs-wrapper',
+        newTabButton: 'no-tabs-new-tab-button',
+    },
+    notification: {
+        wrapper: 'notification-wrapper',
+        title: 'notification-title',
+        content: 'notification-content',
+    },
+}

packages/amazonq/test/e2e_new/amazonq/framework/loginHelper.ts renamed to packages/amazonq/test/e2e_new/amazonq/framework/authHelper.ts

@@ -5,6 +5,7 @@
 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
@@ -14,8 +15,7 @@ Currently, the function will
 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> {
+export async function signInToAmazonQ(): Promise<void> {
     const workbench = new Workbench()
     await workbench.executeCommand('Amazon Q: Open Chat')
 
@@ -50,3 +50,9 @@ export async function loginToAmazonQ(): Promise<void> {
     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/framework/chatHelper.ts

@@ -5,6 +5,13 @@
 import { By, WebviewView } from 'vscode-extension-tester'
 import { waitForElement } from './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)
@@ -15,6 +22,12 @@ export async function writeToChat(prompt: string, webview: WebviewView, send = t
     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()
 

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

@@ -4,6 +4,12 @@
  */
 import { By, WebviewView } from 'vscode-extension-tester'
 
+/**
+ * Closes all open chat tabs
+ * @param webview The WebviewView instance
+ * @returns Promise<boolean> True if all tabs were successfully closed
+ * @throws Error if tabs could not be closed
+ */
 export async function closeAllTabs(webview: WebviewView): Promise<boolean> {
     try {
         const closeButtons = await webview.findWebElements(By.css('.mynah-tabs-close-button'))
@@ -30,6 +36,11 @@ export async function closeAllTabs(webview: WebviewView): Promise<boolean> {
     }
 }
 
+/**
+ * Attempts to dismiss any open overlays
+ * @param webview The WebviewView instance
+ * @returns Promise<boolean> True if overlay was dismissed or none was present, false if dismissal failed
+ */
 export async function dismissOverlayIfPresent(webview: WebviewView): Promise<boolean> {
     try {
         const overlays = await webview.findWebElements(By.css('.mynah-overlay.mynah-overlay-open'))

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

@@ -5,7 +5,14 @@
 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*/
+/**
+ * Waits for an element to be located
+ * @param webview The WebviewView instance
+ * @param locator The selenium locator
+ * @param multiple Whether to return multiple elements (Note: If multiple is set to False, then it will return the first element it finds that matches the Locator)
+ * @param timeout The timeout in milliseconds
+ * @returns Promise<WebElement | WebElement[]> Returns the element or multiple elements that were found
+ */
 export async function waitForElement(
     webview: WebviewView,
     locator: By,
@@ -29,6 +36,13 @@ export async function waitForElement(
     return multiple ? await webview.findWebElements(locator) : await webview.findWebElement(locator)
 }
 
+/**
+ * Finds an item based on the text
+ * @param items WebElement array to search
+ * @param text The text of the item
+ * @returns Promise<WebElement> The first element that contains the specified text
+ * TO-DO: Make this function more general by eliminated the By.css('.title')
+ */
 export async function findItemByText(items: WebElement[], text: string) {
     for (const item of items) {
         const titleDivs = await item.findElements(By.css('.title'))

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

@@ -78,11 +78,9 @@ export async function getPinContextMenuItems(webview: WebviewView): Promise<{ it
  */
 export async function clickPinContextMenuItem(webview: WebviewView, itemName: string): Promise<boolean> {
     try {
-        // Find the menu list independently
         const menuList = await waitForElement(webview, By.css('.mynah-detailed-list-items-block'))
         await new Promise((resolve) => setTimeout(resolve, 3000))
         const menuListItems = await menuList.findElements(By.css('.mynah-detailed-list-item.mynah-ui-clickable-item'))
-        // Iterate through items to find the one with matching text
         for (const item of menuListItems) {
             try {
                 const textWrapper = await item.findElement(By.css('.mynah-detailed-list-item-text'))
@@ -95,7 +93,6 @@ export async function clickPinContextMenuItem(webview: WebviewView, itemName: st
                     return true
                 }
             } catch (e) {
-                // Continue to next item if this one has issues
                 continue
             }
         }

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

@@ -2,12 +2,12 @@
  * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
  * SPDX-License-Identifier: Apache-2.0
  */
-import { loginToAmazonQ } from '../framework/loginHelper'
+import { signInToAmazonQ } 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()
+    await signInToAmazonQ()
 })