Fixing stalls in integration tests.

Author: pauldruce

.gitignore

@@ -12,4 +12,5 @@ htmlcov/
 .python-version
 coverage.xml
 .ipynb_checkpoints/
-*.ipynb
+*.ipynb
+.env

gui/package-lock.json

@@ -53,6 +53,7 @@ def run(self):
     "pytest",
     "pytest-env",
     "pytest-cov",
+    "pytest-timeout",
     "pytest-mock",
     "pytest-aiohttp",
     "psutil",

setup.py

@@ -8,11 +8,9 @@
 import urllib3
 import requests
 import json
-from logging_util import create_test_logger
+from logging_util import create_integ_test_logger
 
-_logger = create_test_logger(
-    __name__, log_file_path=os.getenv("MWI_INTEG_TESTS_LOG_FILE_PATH")
-)
+_logger = create_integ_test_logger(__name__)
 
 
 def perform_basic_checks():
@@ -22,6 +20,7 @@ def perform_basic_checks():
     """
     import matlab_proxy.settings
 
+    _logger.info("Performing basic checks for matlab-proxy")
     # Validate MATLAB before testing
     _, matlab_path = matlab_proxy.settings.get_matlab_executable_and_root_path()
 
@@ -63,6 +62,7 @@ async def start_matlab_proxy_app(out=asyncio.subprocess.PIPE, input_env={}):
     """
     from matlab_proxy.util import system
 
+    _logger.info("Starting MATLAB Proxy app")
     cmd = matlab_proxy_cmd_for_testing()
     matlab_proxy_env = os.environ.copy()
     matlab_proxy_env.update(input_env)
@@ -73,7 +73,7 @@ async def start_matlab_proxy_app(out=asyncio.subprocess.PIPE, input_env={}):
         stdout=out,
         stderr=out,
     )
-
+    _logger.debug("MATLAB Proxy App started")
     return proc
 
 
@@ -110,6 +110,7 @@ def wait_matlab_proxy_ready(matlab_proxy_url):
     from matlab_proxy.util import system
     import matlab_proxy.settings as settings
 
+    _logger.info("Wait for MATLAB Proxy to start")
     # Wait until the matlab config file is created
     MAX_TIMEOUT = settings.get_process_startup_timeout()
     start_time = time.time()
@@ -175,6 +176,7 @@ def license_matlab_proxy(matlab_proxy_url):
     """
     from playwright.sync_api import sync_playwright, expect
 
+    _logger.info("Licensing MATLAB using matlab-proxy")
     # These are MathWorks Account credentials to license MATLAB
     # Throws 'KeyError' if the following environment variables are not set
     TEST_USERNAME = os.environ["TEST_USERNAME"]
@@ -221,7 +223,7 @@ def license_matlab_proxy(matlab_proxy_url):
             status_info,
             "Verify if Licensing is successful. This might fail if incorrect credentials are provided",
         ).to_be_visible(timeout=60000)
-
+        _logger.debug("Succeeded in licensing MATLAB using matlab-proxy")
         browser.close()
 
 
@@ -234,6 +236,7 @@ def unlicense_matlab_proxy(matlab_proxy_url):
     """
     import warnings
 
+    _logger.info("Unlicensing matlab-proxy")
     max_retries = 3  # Max retries for unlicensing matlab-proxy
     retries = 0
 
@@ -257,6 +260,7 @@ def unlicense_matlab_proxy(matlab_proxy_url):
                         f"matlab-proxy is unlicensed but with error: {data['error']}",
                         UserWarning,
                     )
+                _logger.debug("Succeeded in unlicensing matlab-proxy")
                 break
             else:
                 resp.raise_for_status()

tests/integration/integration_tests_utils.py

@@ -7,11 +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
+from logging_util import create_integ_test_logger
 
-_logger = create_test_logger(
-    __name__, log_file_path=os.getenv("MWI_INTEG_TESTS_LOG_FILE_PATH")
-)
+_logger = create_integ_test_logger(__name__)
 
 
 @pytest.fixture(scope="module", name="module_monkeypatch")
@@ -40,9 +38,11 @@ def matlab_config_cleanup_fixture(request):
     """
 
     def delete_matlab_test_dir():
+        _logger.debug("Cleaning up matlab config file")
         # Delete matlab_config_file & its owning directory
         matlab_config_file = utils.get_matlab_config_file()
         matlab_config_dir = os.path.dirname(matlab_config_file)
+        _logger.debug("Deleting matlab test dir: " + matlab_config_dir)
         try:
             shutil.rmtree(matlab_config_dir)
         except FileNotFoundError:
@@ -73,6 +73,7 @@ def matlab_proxy_fixture(module_monkeypatch, request):
     import matlab_proxy.util
     from urllib.parse import urlparse
 
+    _logger.info("Starting MATLAB Proxy fixture")
     utils.perform_basic_checks()
 
     # Select a random free port to serve matlab-proxy for testing
@@ -92,10 +93,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")
+    _logger.debug("Started MATLAB Proxy process")
 
     utils.wait_server_info_ready(mwi_app_port)
-    _logger.info("Server file is available")
+    _logger.debug("Server file is available")
 
     matlab_proxy_url = utils.get_connection_string(mwi_app_port)
 
@@ -109,30 +110,34 @@ def matlab_proxy_fixture(module_monkeypatch, request):
             requests.exceptions.SSLError,
         ),
     )
-    _logger.info("MATLAB proxy URL responded")
+    _logger.debug("MATLAB proxy URL responded")
 
     # License matlab-proxy using playwright UI automation
     utils.license_matlab_proxy(matlab_proxy_url)
-    _logger.info("Successfully licensed MATLAB Proxy")
+    _logger.debug("Successfully licensed MATLAB via MATLAB Proxy")
 
+    # TODO: this is this block required?
     # Wait for matlab-proxy to be up and running
     utils.wait_matlab_proxy_ready(matlab_proxy_url)
-    _logger.info("MATLAB Proxy is ready")
+    _logger.debug("MATLAB Proxy is up and running")
 
+    _logger.debug("Copying matlab proxy config for reuse in tests")
     # Get the location of ".matlab"
     matlab_config_file = str(
         utils.get_matlab_config_file()
     )  # ~/.matlab/MWI/proxy_app_config.json
-
     dotmatlab_dir_path = os.path.dirname(os.path.dirname(matlab_config_file))
-
     # Create a temporary location in .matlab directory
     temp_dir_path = os.path.join(dotmatlab_dir_path, "temp_dir")
     os.mkdir(temp_dir_path)  # delete this folder after the test execution
     shutil.move(matlab_config_file, temp_dir_path)
 
+    _logger.debug("Terminating the setup+licensing matlab-proxy process")
     proc.terminate()
     loop.run_until_complete(proc.wait())
 
     # Run the matlab proxy tests
+    _logger.info("Finished licensing MATLAB for use in integration tests")
     yield
+
+    _logger.debug("Deleting matlab test directory")