E2e extension tests refactor

- Refactor to be in accordance to the ICommandResult interface
- Adds the executeScript function
- Adds the getLastScriptResult function
- Refactors other functions
- Fixes a flaky test on FE
- Adds new attributes to the CommandExecuter class

Change-Id: I172a5f4e5eafd80c3aa798b1e7118617f76ad710

Author: Guilherme Saraiva

gui/extension/tests/e2e/lib/cmdExecutor.ts

@@ -38,6 +38,24 @@ export const ociTreeSection = "ORACLE CLOUD INFRASTRUCTURE";
 export const openEditorsTreeSection = "OPEN EDITORS";
 export const tasksTreeSection = "MYSQL SHELL TASKS";
 
+// OCI
+export const ociConfigProfile = {
+    name: "E2ETESTS",
+    user: "ocid1.user.oc1..aaaaaaaan67cojwa52khe44xtpqsygzxlk4te6gqs7nkmyabcju2w5wlxcpq",
+    fingerprint: "15:cd:e2:11:ed:0b:97:c4:e4:41:c5:44:18:66:72:80",
+    tenancy: "ocid1.tenancy.oc1..aaaaaaaaasur3qcs245czbgrlyshd7u5joblbvmxddigtubzqcfo5mmi2z3a",
+    region: "us-ashburn-1",
+    // eslint-disable-next-line @typescript-eslint/naming-convention
+    key_file: `${process.env.MYSQLSH_OCI_CONFIG_FILE.replace("config", "")}id_rsa_e2e.pem`,
+};
+export const e2eTestsCompartment = "MySQLShellTesting";
+export const dbSystemType = "ociDbSystem";
+export const bastionType = "ociBastion";
+
+// OCI E2E TESTS BASTION CREDENTIALS
+export const bastionUsername = "dba";
+export const bastionPassword = "MySQLR0cks!";
+
 // TIMEOUTS
 export const wait150MiliSeconds = 150;
 export const wait2seconds = 2000;
@@ -354,3 +372,5 @@ export const openEditCtxMenu = new Map([
 export const miscCtxMenu = new Map([
     [openNotebookWithConn, 5],
 ]);
+
+

gui/extension/tests/e2e/lib/constants.ts

@@ -35,7 +35,6 @@ import * as constants from "./constants";
 import * as interfaces from "./interfaces";
 import * as locator from "./locators";
 import { keyboard, Key as nutKey } from "@nut-tree/nut-js";
-import { CommandExecutor } from "./cmdExecutor";
 
 export class Database {
 
@@ -1473,16 +1472,6 @@ export class Database {
         return result;
     };
 
-    public static execScript = async (cmd: string, timeout?: number): Promise<string> => {
-
-        const textArea = await driver?.findElement(locator.notebook.codeEditor.textArea);
-        await textArea.sendKeys(cmd);
-        await CommandExecutor.exec();
-        timeout = timeout ?? 5000;
-
-        return Database.getScriptResult(timeout);
-    };
-
     public static getAutoCompleteMenuItems = async (): Promise<string[]> => {
         const els = [];
         let items = await driver.wait(until.elementsLocated(locator.notebook.codeEditor.editor.autoCompleteListItem),
@@ -1513,28 +1502,6 @@ export class Database {
         return height > 0;
     };
 
-    public static getScriptResult = async (timeout = constants.wait5seconds): Promise<string> => {
-        let toReturn = "";
-        await driver.wait(async () => {
-            const resultHost = await driver.findElements(locator.notebook.codeEditor.editor.result.host);
-            if (resultHost.length > 0) {
-                const status = await resultHost[resultHost.length - 1]
-                    .findElements(locator.notebook.codeEditor.editor.result.status.text);
-                const output = await resultHost[resultHost.length - 1]
-                    .findElements(locator.shellSession.result.outputText);
-                if (status.length > 0) {
-                    toReturn = await status[status.length - 1].getAttribute("innerHTML");
-                } else if (output.length > 0) {
-                    toReturn = await output[output.length - 1].getAttribute("innerHTML");
-                }
-
-                return true;
-            }
-        }, timeout, `No results were found`);
-
-        return toReturn;
-    };
-
     public static clearInputField = async (el: WebElement): Promise<void> => {
         await driver.wait(async () => {
             await el.click();
@@ -1550,10 +1517,6 @@ export class Database {
 
     };
 
-    public static isResultTabMaximized = async (): Promise<boolean> => {
-        return (await driver.findElements(locator.notebook.codeEditor.editor.result.status.normalize)).length > 0;
-    };
-
     public static selectCurrentEditor = async (editorName: string, editorType: string): Promise<void> => {
         const selector = await driver.findElement(locator.notebook.toolbar.editorSelector.exists);
         await driver.executeScript("arguments[0].click()", selector);

gui/extension/tests/e2e/lib/db.ts

@@ -210,13 +210,17 @@ export interface ITreeDBConnection {
 }
 
 export interface ICommandResult {
-    id: string;
-    message: string;
-    content: WebElement | ICommandTabResult[];
-    toolbar: WebElement;
+    message?: string;
+    content?: WebElement | ICommandTabResult[];
+    toolbar?: WebElement;
 }
 
 export interface ICommandTabResult {
     tabName: string;
     content: string;
 }
+
+export interface ICommandResultIdHolder {
+    id?: string;
+    suite?: string
+}

gui/extension/tests/e2e/lib/interfaces.ts

@@ -94,14 +94,22 @@ export const notebook = {
             currentLine: By.className("current-line"),
             statementStart: By.className("statementStart"),
             autoCompleteListItem: By.css(".monaco-list .monaco-highlighted-label span"),
+            scrollBar: By.className("editor-scrollable"),
             result: {
                 exists: By.className("zoneHost"),
                 hasContent: By.className("content"),
                 existsById: (view: string): By => {
-                    return By.xpath(`//div[@class='zoneHost' and @monaco-view-zone='${view}']`);
+                    let xpath = `//div[@class='zoneHost' and (`;
+                    xpath += `
+                        @monaco-view-zone='b${view}' or
+                        @monaco-view-zone='c${view}' or
+                        @monaco-view-zone='d${view}' or
+                        @monaco-view-zone='e${view}')]
+                    `;
+
+                    return By.xpath(xpath);
                 },
                 host: By.className("resultHost"),
-
                 table: By.className("tabulator"),
                 tableRows: By.css(".tabulator-selectable.tabulator-row-odd"),
                 tableHeaders: By.className("tabulator-headers"),
@@ -130,6 +138,8 @@ export const notebook = {
                     field: By.css(".jsonView span > span"),
                 },
                 singleOutput: By.className("outputHost"),
+                script: By.className("standaloneScriptHost"),
+                textOutput: By.css(".actionOutput span > span"),
             },
         },
         prompt: {

gui/extension/tests/e2e/lib/locators.ts

@@ -20,6 +20,7 @@
  * along with this program; if not, write to the Free Software Foundation, Inc.,
  * 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
  */
+
 import { spawnSync, execSync } from "child_process";
 import clipboard from "clipboardy";
 import fs from "fs/promises";
@@ -32,7 +33,6 @@ import {
     WebDriver, ModalDialog,
     WebElement, Workbench, Button, Notification,
 } from "vscode-extension-tester";
-import { Database } from "./db";
 import * as constants from "./constants";
 import { keyboard, Key as nutKey } from "@nut-tree/nut-js";
 import * as Until from "./until";
@@ -745,30 +745,6 @@ export class Misc {
         }
     };
 
-    public static cleanEditor = async (): Promise<void> => {
-        await driver.wait(async () => {
-            try {
-                const textArea = await driver.findElement(locator.notebook.codeEditor.textArea);
-                if (Misc.isMacOs()) {
-                    await textArea.sendKeys(Key.chord(Key.COMMAND, "a", "a"));
-                } else {
-                    await textArea.sendKeys(Key.chord(Key.CONTROL, "a", "a"));
-                }
-
-                await textArea.sendKeys(Key.BACK_SPACE);
-                await driver.wait(async () => {
-                    return await Database.getPromptLastTextLine() === "";
-                }, 3000, "Prompt was not cleaned");
-
-                return true;
-            } catch (e) {
-                if (!(e instanceof error.StaleElementReferenceError)) {
-                    throw e;
-                }
-            }
-        }, constants.wait5seconds, "Editor was not cleaned");
-    };
-
     public static getResultTabs = async (resultHost: WebElement): Promise<string[]> => {
 
         const result: string[] = [];
@@ -1059,6 +1035,21 @@ export class Misc {
         return el;
     };
 
+    public static getTreeElementByType = async (section: string, type: string): Promise<TreeItem> => {
+
+        const sectionTree = await Misc.getSection(section);
+        const treeItems = await sectionTree.getVisibleItems();
+        for (const treeItem of treeItems) {
+            const el = await treeItem.findElement(locator.section.itemIcon);
+            const backImage = await el.getCssValue("background-image");
+            if (backImage.match(new RegExp(type)) !== null) {
+                return treeItem;
+            }
+        }
+
+        throw new Error(`Could not find the item type ${type} on section ${section}`);
+    };
+
     public static existsTreeElement = async (section: string, itemName: string | RegExp): Promise<boolean> => {
         let reloadLabel: string;
         const sectionTree = await Misc.getSection(section);

gui/extension/tests/e2e/lib/misc.ts

@@ -20,7 +20,8 @@
  * along with this program; if not, write to the Free Software Foundation, Inc.,
  * 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
  */
-import { until, Condition } from "vscode-extension-tester";
+
+import { Condition } from "vscode-extension-tester";
 import { driver } from "./misc";
 import * as locator from "./locators";
 
@@ -36,21 +37,4 @@ export class Shell {
             });
     };
 
-    public static changeSchemaOnTab = async (schema: string): Promise<void> => {
-        const tabSchema = await driver.findElement(locator.shellConsole.connectionTab.schema);
-        await tabSchema.click();
-        const menu = await driver.wait(until.elementLocated(locator.shellConsole.connectionTab.schemaMenu),
-            3000, "Schema list was not displayed");
-        const items = await menu.findElements(locator.shellConsole.connectionTab.schemaItem);
-        for (const item of items) {
-            if ((await item.getAttribute("innerHTML")).includes(schema)) {
-                await item.click();
-                break;
-            }
-        }
-
-        await driver.wait(async () => {
-            return (await driver.findElement(locator.shellConsole.connectionTab.schema).getText()).includes(schema);
-        }, 3000, `${schema} was not selected`);
-    };
 }

gui/extension/tests/e2e/lib/shell.ts

@@ -190,6 +190,27 @@ export const toolbarButtonIsEnabled = (button: string): Condition<boolean> => {
     });
 };
 
+export const resultTabIsMaximized = (): Condition<boolean> => {
+    return new Condition(`for result tab to be maximezed`, async () => {
+        return (await driver.findElements(locator.notebook.codeEditor.editor.result.status.normalize)).length > 0;
+    });
+};
+
+export const resultTabIsNormalized = (): Condition<boolean> => {
+    return new Condition(`for result tab to be maximezed`, async () => {
+        return (await driver.findElements(locator.notebook.codeEditor.editor.result.status.normalize)).length === 0;
+    });
+};
+
+export const editorHasNewPrompt = (): Condition<boolean> => {
+    return new Condition(`for editor to have a new prompt`, async () => {
+        const editorSentences = await driver.findElements(locator.notebook.codeEditor.editor.sentence);
+
+        return (await (editorSentences[editorSentences.length - 1]).getAttribute("innerHTML"))
+            .match(/<span><\/span>/) !== null;
+    });
+};
+
 export const routerIsRunning = (): Condition<boolean> => {
     return new Condition("for Router to be running", () => {
         if (Misc.isWindows()) {

gui/extension/tests/e2e/lib/until.ts

@@ -300,10 +300,11 @@ try {
             writeMsg "DONE"
         } else {
             if ($isLinux) {
-                $link = Join-Path $config "plugin_data" "gui_plugin" "web_certs"
-                writeMsg "Re-creating the symbolic link for $link ..." "-NoNewLine"
-                Remove-Item -Path $link -Force
-                New-Item -ItemType SymbolicLink -Path $link -Target $targetWebCerts
+                $webCerts = Join-Path $config "plugin_data" "gui_plugin" "web_certs"
+                $destination = Join-Path $config "plugin_data" "gui_plugin"
+                writeMsg "Copying web certs to $destination ..." "-NoNewLine"
+                Remove-Item -Path $webCerts -Force -Recurse
+                Copy-Item -Path $targetWebCerts -Destination $destination -Force -Recurse
                 writeMsg "DONE"
             }
         }