Enhances the integration test framework to prevent stalling during the teardown phase.

Author: pauldruce

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

@@ -1,11 +1,10 @@
-# Copyright 2020-2023 The MathWorks, Inc.
+# Copyright 2023-2024 The MathWorks, Inc.
 
 # Workflow that contains jobs to test MATLAB Jupyter Integration
 name: Integration testing MATLAB Jupyter Integration
 
 on:
   # Reusable workflow
-  # Trigger on workflow call
   workflow_call:
 
 jobs:
@@ -56,15 +55,11 @@ jobs:
           TEST_USERNAME: ${{secrets.TEST_USERNAME}}
           TEST_PASSWORD: ${{secrets.TEST_PASSWORD}}
 
-      - name: Copy Log File
+      - name: Preserve test logs
         if: ${{ always() }}
-        run: |
-          cp ${{ github.workspace }}/tests/integration/integ_logs.log ${{ matrix.os }}${{ matrix.matlab-release }}${{ matrix.python-version }}.log
-
-      - name: Make logs files available for downloading
-        if: ${{ always() }}
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         with:
-          name: MATLAB Proxy Integration Test Log File
-          path: ${{ matrix.os }}${{ matrix.matlab-release }}${{ matrix.python-version }}.log
-          retention-days: 7
+          name: MATLAB Proxy Integration Test Log File ${{ matrix.os }} matlab-${{ matrix.matlab-release }} python-${{ matrix.python-version }}
+          path: |
+            tests/integration/integ_logs.log
+            licensing-screenshot-failed.png

tests/integration/conftest.py

@@ -1,7 +1,10 @@
-# Copyright 2023 The MathWorks, Inc.
+# Copyright 2023-2024 The MathWorks, Inc.
 
+import asyncio
 import os
 import shutil
+
+import psutil
 import integration_test_utils
 import pytest
 import requests
@@ -49,6 +52,7 @@ def matlab_proxy_fixture(module_monkeypatch):
         "MWI_APP_PORT": mwi_app_port,
         "MWI_BASE_URL": mwi_base_url,
         "MWI_LOG_FILE": str(matlab_proxy_logs_path),
+        "MWI_ENABLE_TOKEN_AUTH": "false",
     }
 
     # Get event loop to start matlab-proxy in background
@@ -83,8 +87,20 @@ def matlab_proxy_fixture(module_monkeypatch):
     yield
 
     # Terminate matlab-proxy
-    proc.terminate()
-    loop.run_until_complete(proc.wait())
+    timeout = 120
+    child_process = psutil.Process(proc.pid).children(recursive=True)
+    for process in child_process:
+        try:
+            process.terminate()
+            process.wait()
+        except Exception:
+            pass
+
+    try:
+        proc.terminate()
+        loop.run_until_complete(asyncio.wait_for(proc.wait(), timeout=timeout))
+    except Exception:
+        proc.kill()
 
 
 @pytest.fixture(scope="module", autouse=True)

tests/integration/integration_test_utils.py

@@ -1,4 +1,4 @@
-# Copyright 2023 The MathWorks, Inc.
+# Copyright 2023-2024 The MathWorks, Inc.
 # Utility functions for integration testing of jupyter-matlab-proxy
 
 import asyncio
@@ -148,45 +148,54 @@ def license_matlab_proxy(matlab_proxy_url):
     TEST_PASSWORD = os.environ["TEST_PASSWORD"]
 
     with sync_playwright() as playwright:
-        browser = playwright.chromium.launch(headless=True)
-        page = browser.new_page()
-        page.goto(matlab_proxy_url)
-
-        # Find the MHLM licensing windows in matlab-proxy
-        mhlm_div = page.locator("#MHLM")
-        expect(
-            mhlm_div,
-            "Wait for MHLM licensing window to appear. This might fail if the MATLAB is already licensed",
-        ).to_be_visible(timeout=60000)
-
-        # The login iframe is present within the MHLM Div
-        login_iframe = mhlm_div.frame_locator("#loginframe")
-
-        # Fills in the username textbox
-        email_text_box = login_iframe.locator("#userId")
-        expect(
-            email_text_box,
-            "Wait for email ID textbox to appear",
-        ).to_be_visible(timeout=20000)
-        email_text_box.fill(TEST_USERNAME)
-        email_text_box.press("Enter")
-
-        # Fills in the password textbox
-        password_text_box = login_iframe.locator("#password")
-        expect(password_text_box, "Wait for password textbox to appear").to_be_visible(
-            timeout=20000
-        )
-        password_text_box.fill(TEST_PASSWORD)
-        password_text_box.press("Enter")
-        password_text_box.press("Enter")
-
-        # Verifies if licensing is successful by checking the status information
-        status_info = page.get_by_text("Status Information")
-        expect(
-            status_info,
-            "Verify if Licensing is successful. This might fail if incorrect credentials are provided",
-        ).to_be_visible(timeout=60000)
-        browser.close()
+        try:
+            browser = playwright.chromium.launch(headless=True)
+            page = browser.new_page()
+            page.goto(matlab_proxy_url)
+
+            # Find the MHLM licensing windows in matlab-proxy
+            mhlm_div = page.locator("#MHLM")
+            expect(
+                mhlm_div,
+                "Wait for MHLM licensing window to appear. This might fail if the MATLAB is already licensed",
+            ).to_be_visible(timeout=60000)
+
+            # The login iframe is present within the MHLM Div
+            login_iframe = mhlm_div.frame_locator("#loginframe")
+
+            # Fills in the username textbox
+            email_text_box = login_iframe.locator("#userId")
+            expect(
+                email_text_box,
+                "Wait for email ID textbox to appear",
+            ).to_be_visible(timeout=20000)
+            email_text_box.fill(TEST_USERNAME)
+            email_text_box.press("Enter")
+
+            # Fills in the password textbox
+            password_text_box = login_iframe.locator("#password")
+            expect(
+                password_text_box, "Wait for password textbox to appear"
+            ).to_be_visible(timeout=20000)
+            password_text_box.fill(TEST_PASSWORD)
+            password_text_box.press("Enter")
+            password_text_box.press("Enter")
+
+            # Verifies if licensing is successful by checking the status information
+            status_info = page.get_by_text("Status Information")
+            expect(
+                status_info,
+                "Verify if Licensing is successful. This might fail if incorrect credentials are provided",
+            ).to_be_visible(timeout=60000)
+        except:
+            # Grab screenshots
+            log_dir = "./"
+            file_name = "licensing-screenshot-failed.png"
+            file_path = os.path.join(log_dir, file_name)
+            os.makedirs(log_dir, exist_ok=True)
+            page.screenshot(path=file_path)
+        finally:
+            browser.close()
 
 
 def unlicense_matlab_proxy(matlab_proxy_url):