Improves test logging infrastructure.

Author: pranaverma92

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

@@ -3,6 +3,9 @@
 # Workflow to run MATLAB-Proxy integration tests
 name: Integration testing for MATLAB Proxy
 
+env:
+  MWI_INTEG_TESTS_LOG_FILE_PATH: '${{ github.workspace }}/tests/integration/integ_test_logs.log'
+
 on:
   # Reusable workflow
   # Trigger on workflow call
@@ -26,20 +29,20 @@ jobs:
 
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: Setup MATLAB ${{ matrix.matlab-release }}
-        uses: matlab-actions/setup-matlab@v2-beta
+        uses: matlab-actions/setup-matlab@v2
         with:
           release: ${{ matrix.matlab-release }}
 
       - name: Setup nodejs
-        uses: actions/setup-node@v3
+        uses: actions/setup-node@v4
         with:
           node-version: 18
 
       - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v4
+        uses: actions/setup-python@v5
         with:
           python-version: ${{ matrix.python-version }}
 
@@ -57,3 +60,16 @@ jobs:
         env:
           TEST_USERNAME: ${{secrets.TEST_USERNAME}}
           TEST_PASSWORD: ${{secrets.TEST_PASSWORD}}
+
+      - name: Copy Log File
+        if: ${{ always() }}
+        run: |
+          cp ${{ github.workspace }}/tests/integration/integ_test_logs.log ${{ matrix.os }}${{ matrix.matlab-release }}${{ matrix.python-version }}.log
+
+      - name: Make logs files available for downloading
+        if: ${{ always() }}
+        uses: actions/upload-artifact@v4
+        with:
+          name: MATLAB Proxy Integration Tests Log File ${{ matrix.os }}${{ matrix.matlab-release }}${{ matrix.python-version }}
+          path: ${{ matrix.os }}${{ matrix.matlab-release }}${{ matrix.python-version }}.log
+          retention-days: 7

tests/README.md

@@ -72,7 +72,16 @@ Python package.
         ```powershell
         $env:TEST_USERNAME="some-username"; $env:TEST_PASSWORD="some-password"
         ```
-
+* If you need the tests logs to be available in a file, set MWI_INTEG_TESTS_LOG_FILE_PATH
+  to the intended path of the log file.
+    - Bash (Linux/macOS):
+        ```bash
+        export MWI_INTEG_TESTS_LOG_FILE_PATH="Path intended"
+        ```
+    - Powershell (Windows):
+        ```powershell
+        $env:MWI_INTEG_TESTS_LOG_FILE_PATH="Path intended"
+        ```
 * Run the following command from the root directory of the project:
     ```
     python3 -m pytest tests/integration -vs

tests/integration/integration_tests_utils.py

@@ -8,6 +8,9 @@
 import urllib3
 import requests
 import json
+from logging_util import create_test_logger
+
+_logger = create_test_logger(__name__, log_file_path = os.getenv("MWI_INTEG_TESTS_LOG_FILE_PATH"))
 
 
 def perform_basic_checks():
@@ -114,13 +117,13 @@ def wait_matlab_proxy_ready(matlab_proxy_url):
     ):
         time.sleep(1)
 
-    print("MATLAB PROXY IS READY...")
-
     try:
         if not os.path.exists(str(get_matlab_config_file())):
             raise FileNotFoundError("Config file is not present on the path")
-    except FileNotFoundError:
-        print("File does not exist")
+
+    except FileNotFoundError as e:
+        _logger.exception("Config file does not exist")
+        _logger.exception(e)
 
 
 def get_random_free_port() -> str:
@@ -151,8 +154,6 @@ def wait_server_info_ready(port_number):
     config_folder = settings.get_mwi_config_folder()
     _path = config_folder / "ports" / port_number / "mwi_server.info"
 
-    print("_path in wait_server_info_ready ", _path)
-
     while time.time() - start_time < timeout_value:
         if _path.exists():
             return True
@@ -287,7 +288,7 @@ def get_connection_string(port_number):
             conn_string = _file.readline().rstrip()
 
     except FileNotFoundError:
-        print(f"{_path} does not exist")
+        _logger.exception(f"{_path} does not exist")
 
     return conn_string
 

tests/integration/integration_tests_with_license/conftest.py

@@ -7,6 +7,9 @@
 import shutil
 from matlab_proxy.util import system
 from matlab_proxy.util.mwi import environment_variables as mwi_env
+from logging_util import create_test_logger
+
+_logger = create_test_logger(__name__, log_file_path = os.getenv("MWI_INTEG_TESTS_LOG_FILE_PATH"))
 
 
 @pytest.fixture(scope="module", name="module_monkeypatch")
@@ -88,9 +91,10 @@ def matlab_proxy_fixture(module_monkeypatch, request):
 
     # Run matlab-proxy in the background in an event loop
     proc = loop.run_until_complete(utils.start_matlab_proxy_app(input_env=input_env))
+    _logger.info("Started MATLAB Proxy process")
 
     utils.wait_server_info_ready(mwi_app_port)
-    print("Server file is available")
+    _logger.info("Server file is available")
 
     matlab_proxy_url = utils.get_connection_string(mwi_app_port)
 
@@ -104,14 +108,15 @@ def matlab_proxy_fixture(module_monkeypatch, request):
             requests.exceptions.SSLError,
         ),
     )
-    print("In matlab_proxy_fixture MATLAB proxy URL responded")
+    _logger.info("MATLAB proxy URL responded")
 
     # License matlab-proxy using playwright UI automation
     utils.license_matlab_proxy(matlab_proxy_url)
-    print("In matlab_proxy_fixture Proxy is licensed")
+    _logger.info("Successfully licensed MATLAB Proxy")
 
     # Wait for matlab-proxy to be up and running
     utils.wait_matlab_proxy_ready(matlab_proxy_url)
+    _logger.info("MATLAB Proxy is ready")
 
     # Get the location of ".matlab"
     matlab_config_file = str(

tests/integration/integration_tests_with_license/test_http_end_points.py

@@ -11,6 +11,9 @@
 import re
 from requests.adapters import HTTPAdapter, Retry
 from urllib.parse import urlparse
+from logging_util import create_test_logger
+
+_logger = create_test_logger(__name__, log_file_path = os.getenv("MWI_INTEG_TESTS_LOG_FILE_PATH"))
 
 # Timeout for polling the matlab-proxy http endpoints
 # matlab proxy in Mac machines takes more time to be 'up'
@@ -80,7 +83,8 @@ def _move(source, destination):
     try:
         shutil.move(source, destination)
     except shutil.Error as err:
-        print(f"Error in moving {source}", err)
+        _logger.error(f"Error in moving {source}")
+        _logger.exception(err)
 
 
 def _send_http_get_request(uri, connection_scheme, http_endpoint=""):
@@ -156,6 +160,7 @@ def test_stop_matlab(matlab_proxy_app_fixture):
         matlab_proxy_app_fixture: A pytest fixture which yields a real matlab server to be used by tests.
     """
 
+    _logger.info("Testing stopping")
     status = _check_matlab_status(
         matlab_proxy_app_fixture.connection_scheme,
         "up",
@@ -180,6 +185,7 @@ def test_stop_matlab(matlab_proxy_app_fixture):
         matlab_proxy_app_fixture.url,
     )
     assert status == "down"
+    _logger.info("stop_matlab test passed")
 
 
 async def test_print_message(matlab_proxy_app_fixture):

tests/integration/integration_tests_without_license/conftest.py

@@ -3,6 +3,10 @@
 import pytest
 from integration import integration_tests_utils as utils
 import requests
+from logging_util import create_test_logger
+import os
+
+_logger = create_test_logger(__name__, log_file_path = os.getenv("MWI_INTEG_TESTS_LOG_FILE_PATH"))
 
 
 @pytest.fixture(scope="module", name="module_monkeypatch")
@@ -42,6 +46,7 @@ def start_matlab_proxy_fixture(module_monkeypatch):
 
     # Run matlab-proxy in the background in an event loop
     proc = loop.run_until_complete(utils.start_matlab_proxy_app(input_env=input_env))
+    _logger.info("Started MATLAB Proxy process")
 
     # Wait for mwi_server.info file to be ready
     utils.wait_server_info_ready(mwi_app_port)

tests/logging_util.py

@@ -0,0 +1,55 @@
+# Copyright 2024 The MathWorks, Inc.
+
+import logging
+from pathlib import Path
+
+
+def create_test_logger(log_name, log_level=logging.INFO, log_file_path=None):
+    """
+    Returns a logger with specified name and level
+
+    Args:
+        log_file_path (string): Log file path to which the logs should be written
+        log_level (logger level attribute): Log level to be set for the logger
+        log_name (string): Name of the logger to be used
+    """
+
+    # Create a logger with the name 'TEST'
+    logger = logging.getLogger("TEST - " + log_name)
+
+    # Create a formatter
+    formatter = logging.Formatter(
+        "%(asctime)s - %(name)s - %(levelname)s - %(message)s"
+    )
+
+    # Set the logging level (e.g., DEBUG, INFO, WARNING, ERROR, CRITICAL)
+    logger.setLevel(log_level)
+
+    if log_file_path:
+        file_path = Path(log_file_path)
+
+        # Create a file handler
+        file_handler = logging.FileHandler(filename=file_path, mode="a")
+
+        # Set a logging level for the file
+        file_handler.setLevel(log_level)
+
+        # Set the formatter for the console handler
+        file_handler.setFormatter(formatter)
+
+        # Add the console handler to the logger
+        logger.addHandler(file_handler)
+
+    # Create a console handler
+    console_handler = logging.StreamHandler()
+
+    # Set a logging level for the console handler
+    console_handler.setLevel(log_level)
+
+    # Set the formatter for the console handler
+    console_handler.setFormatter(formatter)
+
+    # Add the console handler to the logger
+    logger.addHandler(console_handler)
+
+    return logger