Export the FE logs

- This patch prepares the FE logs to be exported on jenkins for the Extension tests
- When the extension is not loaded, instead of using the UI to open the OUTPUT tab and select the extension channel, we read and export directly the FE log file, which is a less costly operation

Change-Id: I26501a4b3e09fdb2972d51aa97cedbe0c8096536

Author: Guilherme Saraiva

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

@@ -25,6 +25,7 @@ import { join } from "path";
 
 // EXTENSION NAME
 export const extensionName = "MySQL Shell for VS Code";
+export const feLogFile = "1-MySQL Shell for VS Code.log";
 
 // BASE PATH
 export const basePath = process.env.USERPROFILE ?? process.env.HOME;

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

@@ -385,6 +385,66 @@ export class Misc {
         spawnSync(mysqlsh, params);
     };
 
+    public static getExtentionOutputLogsFolder = async (): Promise<string> => {
+        let testResources: string;
+        if (Misc.isMacOs()) {
+            testResources = "test-resources";
+        } else {
+            testResources = `test-resources-${process.env.TEST_SUITE}`;
+        }
+        const today = new Date();
+        const month = (`0${(today.getMonth() + 1)}`).slice(-2);
+        const day = (`0${today.getDate()}`).slice(-2);
+        const todaysDate = `${today.getFullYear()}${month}${day}`;
+
+        let pathToLog = join(
+            constants.basePath,
+            testResources,
+            "settings",
+            "logs",
+        );
+        const variableFolder = await fs.readdir(pathToLog);
+        pathToLog = join(
+            constants.basePath,
+            testResources,
+            "settings",
+            "logs",
+            variableFolder[0],
+            "window1",
+            "exthost",
+        );
+        const folders = await fs.readdir(pathToLog);
+        let outputLogging: string;
+        for (const folder of folders) {
+            if (folder.startsWith(`output_logging_${todaysDate}`)) {
+                outputLogging = folder;
+                break;
+            }
+        }
+        pathToLog = join(
+            constants.basePath,
+            testResources,
+            "settings",
+            "logs",
+            variableFolder[0],
+            "window1",
+            "exthost",
+            outputLogging,
+        );
+
+        return pathToLog;
+    };
+
+    public static prepareExtensionLogsForExport = async (testSuite: string): Promise<void> => {
+        const logPathFolder = await Misc.getExtentionOutputLogsFolder();
+        // rename the file
+        await fs.rename(join(logPathFolder, constants.feLogFile),
+            join(logPathFolder, `${testSuite}_output_tab.log`));
+        // copy to workspace
+        await fs.copyFile(join(logPathFolder, `${testSuite}_output_tab.log`),
+            join(constants.workspace, `${testSuite}_output_tab.log`));
+    };
+
     public static killRouterFromTerminal = (): void => {
         if (Misc.isWindows()) {
             try {
@@ -430,7 +490,6 @@ export class Misc {
         await fs.writeFile(imgPath, img, "base64");
 
         addContext(testContext, { title: "Failure", value: `../screenshots/${String(testName)}_screenshot.png` });
-
     };
 
     public static expandDBConnectionTree = async (conn: TreeItem, password: string): Promise<void> => {

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

@@ -24,12 +24,12 @@ import {
     Condition,
     ActivityBar,
     EditorView,
-    BottomBarPanel,
     logging,
     WebElement,
     Locator,
 } from "vscode-extension-tester";
 import { execSync } from "child_process";
+import { join } from "path";
 import fs from "fs/promises";
 import * as constants from "./constants";
 import { Misc, driver } from "./misc";
@@ -266,18 +266,15 @@ export const extensionIsReady = (): Condition<boolean> => {
         if (feWasLoaded === false) {
             console.log("<<<<MYSQLSH Logs>>>>");
             await Misc.writeMySQLshLogs();
-            const bottomBar = new BottomBarPanel();
-            await bottomBar.maximize();
-            await (await bottomBar.openOutputView()).selectChannel(constants.extensionName);
-            const output = await (await bottomBar.openOutputView()).getText();
-            console.log("<<<<OUTPUT Tab Logs>>>>");
-            console.log(output);
             const logs = driver.manage().logs();
             console.log("<<<<<DEV TOOLS Console log>>>>");
             console.log(await logs.get(logging.Type.BROWSER));
 
             let text = `Extension was not loaded successfully after ${feLoadTries} tries. Check the logs. `;
             // one last try to recover
+            const path = join(await Misc.getExtentionOutputLogsFolder(), constants.feLogFile);
+            const output = (await fs.readFile(path)).toString();
+
             if (output.match(/(ERROR|error)/) !== null) {
                 console.log("An error was found on the OUTPUT tab, removing Internal DB");
                 await Misc.removeInternalDB();

gui/extension/tests/e2e/settings.json

@@ -2,6 +2,6 @@
     "terminal.integrated.copyOnSelection": true,
     "terminal.integrated.sendKeybindingsToShell": true,
     "window.dialogStyle": "custom",
-    "msg.debugLog.level": "DEBUG3",
+    "msg.debugLog.level": "DEBUG2",
     "terminal.integrated.gpuAcceleration": "off"
 }

gui/extension/tests/e2e/tests/ui-db.ts

@@ -95,12 +95,14 @@ describe("DATABASE CONNECTIONS", () => {
             }
         } catch (e) {
             await Misc.processFailure(this);
+            await Misc.prepareExtensionLogsForExport(process.env.TEST_SUITE);
             throw e;
         }
     });
 
     after(async function () {
         try {
+            await Misc.prepareExtensionLogsForExport(process.env.TEST_SUITE);
             const dbConnections = await Misc.getDBConnections();
             for (const dbConnection of dbConnections) {
                 await Misc.deleteConnection(dbConnection.name, dbConnection.isMySQL, false);

gui/extension/tests/e2e/tests/ui-notebook.ts

@@ -98,6 +98,7 @@ describe("NOTEBOOKS", () => {
 
     after(async function () {
         try {
+            await Misc.prepareExtensionLogsForExport(process.env.TEST_SUITE);
             const dbConnections = await Misc.getDBConnections();
             for (const dbConnection of dbConnections) {
                 await Misc.deleteConnection(dbConnection.name, dbConnection.isMySQL, false);

gui/extension/tests/e2e/tests/ui-oci.ts

@@ -98,6 +98,15 @@ describe("ORACLE CLOUD INFRASTRUCTURE", () => {
 
     });
 
+    after(async function () {
+        try {
+            await Misc.prepareExtensionLogsForExport(process.env.TEST_SUITE);
+        } catch (e) {
+            await Misc.processFailure(this);
+            throw e;
+        }
+    });
+
     describe("Profile", () => {
 
         beforeEach(async function () {

gui/extension/tests/e2e/tests/ui-open-editors.ts

@@ -95,6 +95,7 @@ describe("OPEN EDITORS", () => {
 
     after(async function () {
         try {
+            await Misc.prepareExtensionLogsForExport(process.env.TEST_SUITE);
             const dbConnections = await Misc.getDBConnections();
             for (const dbConnection of dbConnections) {
                 await Misc.deleteConnection(dbConnection.name, dbConnection.isMySQL, false);

gui/extension/tests/e2e/tests/ui-rest.ts

@@ -123,6 +123,7 @@ describe("MySQL REST Service", () => {
 
     after(async function () {
         try {
+            await Misc.prepareExtensionLogsForExport(process.env.TEST_SUITE);
             const dbConnections = await Misc.getDBConnections();
             for (const dbConnection of dbConnections) {
                 await Misc.deleteConnection(dbConnection.name, dbConnection.isMySQL, false);

gui/extension/tests/e2e/tests/ui-shell.ts

@@ -91,7 +91,16 @@ describe("MYSQL SHELL CONSOLES", () => {
 
     });
 
-    describe("Shell generic operations", () => {
+    after(async function () {
+        try {
+            await Misc.prepareExtensionLogsForExport(process.env.TEST_SUITE);
+        } catch (e) {
+            await Misc.processFailure(this);
+            throw e;
+        }
+    });
+
+    describe.only("Shell generic operations", () => {
 
         beforeEach(async function () {
             try {