Update e2e tests & testing frameworks.

# Main Changes
* Update NodeJS packages to use a version greater or equal to 5.3.0 of @jupyterlab/galata
* Update the tests to leverage the Galata tools for interacting with notebooks.
* Remove all unused utility functions.

Author: pauldruce

.github/workflows/run-e2e-tests.yml

@@ -71,8 +71,8 @@ jobs:
         run: |
           python3 -m pip install --upgrade pip
           python3 -m pip install pytest-playwright
-          python3 -m playwright install --with-deps
-          (cd tests/utils && mkdir licensing-logs && python3 -c "from licensing import *; license_with_online_licensing(log_dir=\"./licensing-logs\")")
+          python3 -m playwright install chromium --with-deps
+          (cd tests/utils && python3 -c "from licensing import *; license_with_online_licensing(log_dir=\"./licensing-logs\")")
 
       - name: Run playwright tests
         env:

tests/e2e/package-lock.json

@@ -11,10 +11,10 @@
     "stop":"npm run stop-jlab",
     "start-jlab": "nohup python3 -m jupyter lab --config ./jupyter_server_test_config.py > ./jupyterlab.log 2>&1 & echo $! > ./jlab.pid",
     "stop-jlab": "kill $(cat ./jlab.pid) && rm -rf ./jlab.pid",
-    "print-jlab-url": "echo \"JupyterLab URLs:\"; sleep 1; grep -oP 'ServerApp]\\s*http[s]?://[^ ]+' ./jupyterlab.log || echo \"Error: No JupyterLab url found, please check log file ./jupyterlab.log\""
+    "print-jlab-url": "echo \"JupyterLab URLs:\"; sleep 2; grep -oP 'ServerApp]\\s*http[s]?://[^ ]+' ./jupyterlab.log || echo \"Error: No JupyterLab url found, please check log file ./jupyterlab.log\""
   },
   "devDependencies": {
-    "@jupyterlab/galata": "^5.0.0",
+    "@jupyterlab/galata": "^5.3.0",
     "@playwright/test": "^1.34.0",
     "@types/node": "^20.0.0",
     "@typescript-eslint/eslint-plugin": "^6.0.0",

tests/e2e/package.json

@@ -1,71 +1,22 @@
 // Copyright 2023-2024 The MathWorks, Inc.
 
 import { expect, test } from '@jupyterlab/galata';
-import { Locator, Page } from '@playwright/test';
-import config from '../playwright.config';
-
-import {
-    openMatlabKernelFromLauncher,
-    waitForKernelToBeIdle,
-    waitUntilEditorReady
-} from './utils/matlab_notebook';
 
 test.describe('MATLAB code execution tests', () => {
     test.beforeEach(async ({ page }) => {
-        // Open MATLAB Kernel from Jupyter Lab Launcher
-        await openMatlabKernelFromLauncher(page);
-
-        // Wait for kernel to be idle
-        await waitForKernelToBeIdle(page);
-
-        // Wait until the editor is ready to be filled.
-        await waitUntilEditorReady(page);
+        const notebookName = 'matlab-code-execution.ipynb';
+        await page.notebook.createNew(notebookName, { kernel: 'jupyter_matlab_kernel' });
+        await page.notebook.isOpen(notebookName);
+        await page.notebook.isActive(notebookName);
     });
 
     test('Calling "ver" produces correct output', async ({ page }) => {
-        await enterInputInCell(page, ['ver']);
-        // wait for kernel to be idle
-        await waitForKernelToBeIdle(page);
+        test.setTimeout(90 * 1000);
+        await page.notebook.setCell(0, 'code', 'ver');
+        await page.notebook.runCell(0);
 
-        const assertTimeout = 90 * 1000; // 90 seconds
-        await assertCellOutputContainsText(
-            page,
-            'MATLAB License Number',
-            assertTimeout);
+        const cellOutput = await page.notebook.getCellTextOutput(0) ?? [''];
+        expect(cellOutput.length).toBeGreaterThan(0);
+        expect(cellOutput[0]).toContain('MATLAB License Number');
     });
-
-    async function enterInputInCell (page: Page, inputArray: Array<string>) {
-        const cellTextbox = await getCellTextBox(page);
-        for (const input of inputArray) {
-            await cellTextbox.fill(input);
-            await cellTextbox.press('Enter');
-        }
-        await cellTextbox.press('Shift+Enter');
-    }
-
-    async function getCellTextBox (page: Page): Promise<Locator> {
-        // Get the text box area to interact with.
-        const notebookContent = page.getByRole(
-            'region',
-            { name: 'notebook content' });
-        await expect(notebookContent).toBeVisible();
-
-        const cellTextbox = notebookContent.getByRole('textbox').nth(0);
-        await expect(cellTextbox).toBeEditable();
-        await expect(cellTextbox).toBeVisible();
-        return cellTextbox;
-    }
-
-    // Use only for Text Outputs
-    async function assertCellOutputContainsText (
-        page: Page,
-        outputString: string,
-        timeout: number = config.expect.timeout) {
-        const outputArea = page.locator('.jp-OutputArea').nth(0);
-        const outputAreaOutput = outputArea
-            .locator('.jp-OutputArea-output')
-            .first();
-        await expect(outputAreaOutput).toBeVisible();
-        await expect(outputAreaOutput).toContainText(outputString, { timeout });
-    }
 });

tests/e2e/tests/matlab_execution.test.ts

@@ -1,25 +1,20 @@
 // Copyright 2023-2024 The MathWorks, Inc.
 
 import { expect, test } from '@jupyterlab/galata';
+import { Locator } from '@playwright/test';
 
 test.describe('MATLAB File button', () => {
+    let MATLABFileButton: Locator;
     test.beforeEach(async ({ page }) => {
-        await page.waitForLoadState();
+        await page.launcher.waitFor({ state: 'visible' });
+        MATLABFileButton = page.getByText('MATLAB File', { exact: true });
     });
 
     test('is visible on Launcher', async ({ page }) => {
-        const MATLABFileButton = page.getByRole(
-            'region',
-            { name: 'notebook content' })
-            .getByText('MATLAB File');
         await expect(MATLABFileButton).toBeVisible();
     });
 
     test('takes you to .m file', async ({ page }) => {
-        const MATLABFileButton = page.getByRole(
-            'region',
-            { name: 'notebook content' })
-            .getByText('MATLAB File');
         await MATLABFileButton.click();
 
         // Expect a new untitled file ending in .m to be made, with optional