Adds e2e smoke test which starts jupyter, starts a kernel, and verifies that it can connect and run a MATLAB command. This runs on every commit to main.

Author: pauldruce

.github/workflows/release.yml

@@ -1,4 +1,4 @@
-# Copyright 2020-2023 The MathWorks, Inc
+# Copyright 2020-2023 The MathWorks, Inc.
 
 # Workflow to release MATLAB Jupyter Integration to PyPi
 name: Release to PyPI

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

@@ -0,0 +1,86 @@
+# Copyright 2023 The MathWorks, Inc.
+
+name: End-to-End Tests for Jupyter Integration for MATLAB
+on:
+  workflow_call:
+
+jobs:
+  playwright_e2e_tests:
+    runs-on: ubuntu-latest
+    env:
+      NODE_VERSION: 18
+      PYTHON_VERSION: 3.8
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+
+      - uses: actions/setup-node@v3
+        with:
+          node-version: ${{ env.NODE_VERSION }}
+
+      - name: Install xvfb
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y xvfb
+
+      - name: Install node dependencies
+        working-directory: ./tests/e2e
+        run: npm ci
+
+      - name: Run the linter
+        working-directory: ./tests/e2e
+        run: npm run lint
+
+      - name: Set up MATLAB
+        # Use MATLAB Actions to get running MATLAB in GitHub Actions
+        uses: matlab-actions/setup-matlab@v2-beta
+        with:
+          products: MATLAB Symbolic_Math_Toolbox
+
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: ${{ env.PYTHON_VERSION }}
+
+      - name: Install jupyterlab and jupyter-matlab-proxy
+        run: |
+          python3 -m pip install --upgrade pip
+          pip install ".[dev]"
+          pip install "jupyterlab>3.1.0,<4.0.0"
+
+      - name: Install playwright browsers
+        working-directory: ./tests/e2e
+        run: npx playwright install --with-deps
+
+      - name: Find an available port
+        run: |
+          FREE_PORT=$(python -c 'import socket; s=socket.socket(); s.bind(("", 0)); print(s.getsockname()[1]); s.close()');
+          echo "Using port = ${FREE_PORT}"
+          echo "TEST_JMP_PORT=$FREE_PORT" >> "$GITHUB_ENV"
+
+      # Playwright will start and stop the JupyterLab server, so we need
+      # to activate the Python venv. The command that is executed by Playwright
+      # is set by the webServer setting in the file playwright.config.ts
+      - name: Run playwright tests
+        working-directory: tests/e2e
+        env:
+          TEST_USERNAME: ${{ secrets.TEST_USERNAME }}
+          TEST_PASSWORD: ${{ secrets.TEST_PASSWORD }}
+          TEST_JMP_PORT: ${{ env.TEST_JMP_PORT }}
+        run: |
+          echo "Playwright version: $(npx playwright -V)"
+          npx playwright test
+
+      - name: Zip test results
+        if: always()
+        working-directory: tests/e2e
+        run: |
+          zip -r zipped-e2e-test-results.zip ./playwright-report ./test-results
+
+      - name: Preserve test results after the job has finished
+        if: always()
+        uses: actions/upload-artifact@v3
+        with:
+          name: e2e_test_results
+          path: ./tests/e2e/zipped-e2e-test-results.zip
+          retention-days: 5

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

@@ -1,4 +1,4 @@
-# Copyright 2020-2023 The MathWorks, Inc
+# Copyright 2020-2023 The MathWorks, Inc.
 
 # Workflow that contains jobs to test MATLAB Jupyter Integration
 name: Integration testing MATLAB Jupyter Integration

.github/workflows/run-tests.yml

@@ -1,4 +1,4 @@
-# Copyright 2020-2023 The MathWorks, Inc
+# Copyright 2020-2023 The MathWorks, Inc.
 
 # Workflow that contains jobs to test MATLAB Jupyter Integration
 name: Testing MATLAB Jupyter Integration
@@ -13,8 +13,14 @@ jobs:
   call-unit-tests:
     # Runs unit tests
     uses: ./.github/workflows/run-unit-tests.yml
+    secrets: inherit
 
   call-integration-tests:
     # Runs integration tests
     uses: ./.github/workflows/run-integration-tests.yml
+    secrets: inherit
+
+  call-e2e-tests:
+    # Runs the end-to-end tests
+    uses: ./.github/workflows/run-e2e-tests.yml
     secrets: inherit

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

@@ -1,4 +1,4 @@
-# Copyright 2020-2023 The MathWorks, Inc
+# Copyright 2020-2023 The MathWorks, Inc.
 
 # Workflow that contains jobs to test MATLAB Jupyter Integration
 name: Unit Testing MATLAB Jupyter Integration

.gitignore

@@ -1,16 +1,16 @@
-*.egg-info/
-.eggs/
-__pycache__/
-build/
-dist/
-.venv/
-.vscode/
-htmlcov/
+*.egg-info
+.eggs
+__pycache__
+build
+dist
+.venv
+.vscode
+htmlcov
 .coverage
 coverage.xml
 cov_html
+node_modules
+playwright-report
+test-results
+.env
 .python-version
-*.env
-*node_modules
-*playwright-report
-*test-results

README.md

@@ -6,14 +6,14 @@
 Run MATLAB® code in Jupyter® environments such as Jupyter notebooks, JupyterLab, and JupyterHub.
 
 
-## Table of Contents  
+## Table of Contents
 1. [Features of MATLAB Integration _for Jupyter_](#features-of-matlab-integration-for-jupyter)
-2. [Requirements](#requirements)  
+2. [Requirements](#requirements)
 3. [Install](#install)
 4. [Get Started](#get-started)
     1. [Run MATLAB Code in a Jupyter Notebook](#run-matlab-code-in-a-jupyter-notebook)
     2. [Open MATLAB in a Browser](#open-matlab-in-a-browser)
-    3. [Edit MATLAB Files in JupyterLab](#edit-matlab-files-in-jupyterlab) 
+    3. [Edit MATLAB Files in JupyterLab](#edit-matlab-files-in-jupyterlab)
 5. [Limitations](#limitations)
 
 
@@ -22,9 +22,9 @@ Run MATLAB® code in Jupyter® environments such as Jupyter notebooks, JupyterLa
 You can use this package to run MATLAB code in Jupyter notebooks and JupyterLab.
 
 <p><img width="600" src="https://github.com/mathworks/jupyter-matlab-proxy/raw/main/img/JupyterKernel.gif"></p>
-  
+
 From your Jupyter notebook or JupyterLab, you can also open the MATLAB development environment in your browser to access more MATLAB features.
-  
+
 <p><img width="600" src="https://github.com/mathworks/jupyter-matlab-proxy/raw/main/img/JupyterMATLABDesktop.gif"></p>
 
 ## Requirements
@@ -41,7 +41,7 @@ From your Jupyter notebook or JupyterLab, you can also open the MATLAB developme
   # Confirm MATLAB is on the PATH
   which matlab
   ```
-  Note: You only need MATLAB installed if you want to execute MATLAB code. You can open Jupyter notebooks containing MATLAB code without having MATLAB installed.  
+  Note: You only need MATLAB installed if you want to execute MATLAB code. You can open Jupyter notebooks containing MATLAB code without having MATLAB installed.
 
 * System dependencies required to run MATLAB:
   - The [MATLAB Dependencies](https://github.com/mathworks-ref-arch/container-images/tree/master/matlab-deps) repository contains `base-dependencies.txt` files that list the libraries required to run each release of MATLAB on a given operating system. To see how to use these files, refer to the Dockerfiles in the same folder.
@@ -51,16 +51,16 @@ From your Jupyter notebook or JupyterLab, you can also open the MATLAB developme
   ```bash
   # On a Debian/Ubuntu based system:
   $ sudo apt install xvfb
- 
+
   # On a RHEL based system:
   $ yum search Xvfb
   xorg-x11-server-Xvfb.x86_64 : A X Windows System virtual framebuffer X server.
   $ sudo yum install xorg-x11-server-Xvfb
-  ``` 
+  ```
 
 ## Install
 
-Install this Python package from the Python Package Index (PyPI) or build it from the source. 
+Install this Python package from the Python Package Index (PyPI) or build it from the source.
 
 ### Install from PyPI
 
@@ -69,7 +69,7 @@ python3 -m pip install jupyter-matlab-proxy
 ```
 Installing this package will not install MATLAB. To execute MATLAB code in Jupyter, you must have [MATLAB installed](https://www.mathworks.com/help/install/install-products.html) separately.
 
-The package lets you execute MATLAB code in both JupyterLab 3 and JupyterLab 4, but syntax highlighting and autoindentation are currently only supported on JupyterLab 3. Install JupyterLab 3 using:
+The package lets you execute MATLAB code in both JupyterLab 3 and JupyterLab 4, but syntax highlighting and auto indentation are currently only supported on JupyterLab 3. Install JupyterLab 3 using:
 ```bash
 python3 -m pip install 'jupyterlab>=3.0.0,<4.0.0a0'
 ```
@@ -111,12 +111,12 @@ Open your Jupyter environment by starting Jupyter Notebook or JupyterLab.
   jupyter notebook
 
   # For JupyterLab
-  jupyter lab 
+  jupyter lab
   ```
 
-If you are prompted for a token, click the link shown in your terminal to access your Jupyter environment. 
+If you are prompted for a token, click the link shown in your terminal to access your Jupyter environment.
 
-After installing this package, you see new MATLAB options in your Jupyter environments. 
+After installing this package, you see new MATLAB options in your Jupyter environments.
 
 
 | Classic Notebook Interface | JupyterLab |
@@ -126,7 +126,7 @@ After installing this package, you see new MATLAB options in your Jupyter enviro
 
 ## Run MATLAB Code in a Jupyter Notebook
 
-To open a Jupyter notebook where you can run MATLAB code, click `MATLAB Kernel` in your notebook or JupyterLab. 
+To open a Jupyter notebook where you can run MATLAB code, click `MATLAB Kernel` in your notebook or JupyterLab.
 
 
 | Classic Notebook Interface | JupyterLab |
@@ -139,7 +139,7 @@ This opens a Jupyter notebook that supports MATLAB.
 
 
 - When you execute MATLAB code in a notebook for the first time, enter your MATLAB license information in the dialog box that appears. See [Licensing](https://github.com/mathworks/matlab-proxy/blob/main/MATLAB-Licensing-Info.md) for details. The MATLAB session can take a few minutes to start.
-- Multiple notebooks running on a Jupyter server share the underlying MATLAB process, so executing code in one notebook affects the workspace in others. If you work in several notebooks simultaneously, be aware that they share a workspace. 
+- Multiple notebooks running on a Jupyter server share the underlying MATLAB process, so executing code in one notebook affects the workspace in others. If you work in several notebooks simultaneously, be aware that they share a workspace.
 - With MATLAB R2022b and later, you can define a local function at the end of the cell where you want to call it:
     <p><img width="350" src="https://github.com/mathworks/jupyter-matlab-proxy/raw/main/img/local_functions.png"></p>
 For technical details about how the MATLAB kernel works, see [MATLAB Kernel for Jupyter](https://github.com/mathworks/jupyter-matlab-proxy/blob/main/src/jupyter_matlab_kernel/README.md).
@@ -153,15 +153,15 @@ To access more MATLAB features, you can open the MATLAB development environment
 | :---: | :---: |
 |<img width="200" src="https://github.com/mathworks/jupyter-matlab-proxy/raw/main/img/open_matlab_notebook.png"> | <img width="300" src="https://github.com/mathworks/jupyter-matlab-proxy/raw/main/img/open_matlab_jupyterlab.png"> |
 
-Notebooks in JupyterLab also have a `Open MATLAB` button on the toolbar: 
+Notebooks in JupyterLab also have a `Open MATLAB` button on the toolbar:
 
 <img width="300" src="https://github.com/mathworks/jupyter-matlab-proxy/raw/main/img/open-matlab-button.png">
 
 Clicking `Open MATLAB` opens the MATLAB development environment in a new browser tab.
 
 <p align="center"><img width="600" src="https://github.com/mathworks/jupyter-matlab-proxy/raw/main/img/jupyter_matlab_desktop.png"></p>
 
-When you use the package for the first time, enter your MATLAB license information in the dialog box that appears. See [Licensing](https://github.com/mathworks/matlab-proxy/blob/main/MATLAB-Licensing-Info.md) for details. 
+When you use the package for the first time, enter your MATLAB license information in the dialog box that appears. See [Licensing](https://github.com/mathworks/matlab-proxy/blob/main/MATLAB-Licensing-Info.md) for details.
 
 For technical details about this MATLAB development environment, see [MATLAB in a Browser](https://github.com/mathworks/jupyter-matlab-proxy/blob/main/src/jupyter_matlab_proxy/README.md).
 
@@ -172,7 +172,7 @@ You can also edit MATLAB `.m` files in JupyterLab. Click the `MATLAB File` butto
 
 <p align="center"><img width="300" src="https://github.com/mathworks/jupyter-matlab-proxy/raw/main/img/matlabfile-icon.png"></p>
 
-This opens an untitled `.m` file where you can write MATLAB code with syntax highlighting and autoindentation.
+This opens an untitled `.m` file where you can write MATLAB code with syntax highlighting and auto indentation.
 
 <p align="center"><img width="600" src="https://github.com/mathworks/jupyter-matlab-proxy/raw/main/img/new-matlab-file.png"></p>
 

src/jupyter_matlab_labextension/package.json

@@ -70,7 +70,8 @@
     "prettier": "^2.1.1",
     "rimraf": "^3.0.2",
     "semver": ">=5.7.2",
-    "typescript": "~4.1.3"
+    "typescript": "~4.1.3",
+    "yarn-audit-fix": "^10.0.1"
   },
   "sideEffects": [
     "style/*.css",