Merge branch 'Add_tests' into 'main'

Modified settings.py to return test specific settings. Added tests to test_app.py

See merge request cit/mathworks/jupyter-matlab-proxy!20

Author: Prabhakar Kumar

jupyter_matlab_proxy/app_state.py

@@ -294,7 +294,7 @@ def reserve_matlab_port(self):
         # FIXME Because of https://github.com/http-party/node-http-proxy/issues/1342 the
         # node application in development mode always uses port 31515 to bypass the
         # reverse proxy. Once this is addressed, remove this special case.
-        if os.getenv("DEV") == "true":
+        if os.getenv("DEV") == "true" and os.getenv("TEST", "false").lower() != "true":
             self.matlab_port = 31515
         else:
 

jupyter_matlab_proxy/settings.py

@@ -26,51 +26,91 @@ def get_matlab_version(matlab_path):
     return root.find("release").text
 
 
-def get(dev=False):
-    devel_file = Path(__file__).resolve().parent / "./devel.py"
-    matlab_startup_file = str(Path(__file__).resolve().parent / "matlab" / "startup.m")
-    matlab_ready_file = Path(tempfile.mkstemp()[1])
+def get_ws_env_settings():
     ws_env = (os.getenv("WS_ENV") or "").lower()
     ws_env_suffix = f"-{ws_env}" if "integ" in ws_env else ""
 
+    return ws_env, ws_env_suffix
+
+
+def get_dev_settings():
+    devel_file = Path(__file__).resolve().parent / "./devel.py"
+    matlab_ready_file = Path(tempfile.mkstemp()[1])
+    ws_env, ws_env_suffix = get_ws_env_settings()
+
+    return {
+        "matlab_path": Path(),
+        "matlab_version": "R2020b",
+        "matlab_cmd": [
+            "python",
+            "-u",
+            str(devel_file),
+            "matlab",
+            "--ready-file",
+            str(matlab_ready_file),
+        ],
+        "xvfb_cmd": [
+            "python",
+            "-u",
+            str(devel_file),
+            "xvfb",
+            "--ready-file",
+            str(Path(tempfile.gettempdir()) / ".X11-unix" / "X1"),
+        ],
+        "matlab_ready_file": matlab_ready_file,
+        "base_url": os.environ.get("BASE_URL", ""),
+        "app_port": os.environ.get("APP_PORT", 8000),
+        "host_interface": os.environ.get("APP_HOST", "127.0.0.1"),
+        "mwapikey": str(uuid.uuid4()),
+        "matlab_protocol": "http",
+        "matlab_display": ":1",
+        "nlm_conn_str": os.environ.get("MLM_LICENSE_FILE"),
+        "matlab_config_file": Path(tempfile.gettempdir())
+        / ".matlab"
+        / "proxy_app_config.json",
+        "ws_env": ws_env,
+        "mwa_api_endpoint": f"https://login{ws_env_suffix}.mathworks.com/authenticationws/service/v4",
+        "mhlm_api_endpoint": f"https://licensing{ws_env_suffix}.mathworks.com/mls/service/v1/entitlement/list",
+        "mwa_login": f"https://login{ws_env_suffix}.mathworks.com",
+    }
+
+
+def get(dev=False):
+    """Method which returns the settings specific to the environment in which the server is running in
+    If the environment variable 'TEST' is set  to true, will make some changes to the dev settings.
+
+    Args:
+        dev (bool, optional): development environment. Defaults to False.
+
+    Returns:
+        Dict: Containing data on how to start MATLAB among other information.
+    """
+
     if dev:
-        return {
-            "matlab_path": Path(),
-            "matlab_version": "R2020b",
-            "matlab_cmd": [
-                "python",
-                "-u",
-                str(devel_file),
-                "matlab",
-                "--ready-file",
-                str(matlab_ready_file),
-            ],
-            "xvfb_cmd": [
-                "python",
-                "-u",
-                str(devel_file),
-                "xvfb",
-                "--ready-file",
-                str(Path(tempfile.gettempdir()) / ".X11-unix" / "X1"),
-            ],
-            "matlab_ready_file": matlab_ready_file,
-            "base_url": os.environ.get("BASE_URL", ""),
-            "app_port": os.environ.get("APP_PORT", 8000),
-            "host_interface": os.environ.get("APP_HOST", "127.0.0.1"),
-            "mwapikey": str(uuid.uuid4()),
-            "matlab_protocol": "http",
-            "matlab_display": ":1",
-            "nlm_conn_str": os.environ.get("MLM_LICENSE_FILE"),
-            "matlab_config_file": Path(tempfile.gettempdir())
-            / ".matlab"
-            / "proxy_app_config.json",
-            "ws_env": ws_env,
-            "mwa_api_endpoint": f"https://login{ws_env_suffix}.mathworks.com/authenticationws/service/v4",
-            "mhlm_api_endpoint": f"https://licensing{ws_env_suffix}.mathworks.com/mls/service/v1/entitlement/list",
-            "mwa_login": f"https://login{ws_env_suffix}.mathworks.com",
-        }
+        settings = get_dev_settings()
+
+        # If running tests using Pytest, it will set environment variable TEST to true before running tests.
+        # Will make test env specific changes before returning the settings.
+        if os.environ.get("TEST", "False").lower() == "true":
+
+            # Set ready_delay value to 0 for faster fake MATLAB startup.
+            ready_delay = ["--ready-delay", "0"]
+            matlab_cmd = settings["matlab_cmd"]
+            matlab_cmd[4:4] = ready_delay
+            settings["matlab_cmd"] = matlab_cmd
+
+            # Set NLM Connection string. Server will start using this connection string for licensing
+            settings["nlm_conn_str"] = "abc@nlm"
+
+        return settings
+
     else:
+        matlab_startup_file = str(
+            Path(__file__).resolve().parent / "matlab" / "startup.m"
+        )
         matlab_path = get_matlab_path()
+        ws_env, ws_env_suffix = get_ws_env_settings()
+
         return {
             "matlab_path": matlab_path,
             "matlab_version": get_matlab_version(matlab_path),
@@ -102,7 +142,8 @@ def get(dev=False):
             "host_interface": os.environ.get("APP_HOST"),
             "mwapikey": str(uuid.uuid4()),
             "matlab_protocol": "https",
-            "matlab_display": ":1",
+            # TODO: Uncomment this ?
+            # "matlab_display": ":1",
             "nlm_conn_str": os.environ.get("MLM_LICENSE_FILE"),
             "matlab_config_file": Path.home() / ".matlab" / "proxy_app_config.json",
             "ws_env": ws_env,

pytest.ini

@@ -1,6 +1,7 @@
 [pytest]
 env =
     D:DEV=true
+    D:TEST=true
 testpaths =
     tests
 

tests/conftest.py

@@ -22,36 +22,3 @@ def pre_test_cleanup():
         os.remove(matlab_config_file)
     except:
         pass
-
-
-@pytest.fixture(name="mock_settings_get_custom_ready_delay")
-def mock_settings_get_custom_ready_delay_fixture(mocker):
-    """A pytest fixture which mocks settings.get() method.
-
-    The ready_delay for the fake_matlab_process is 10 (by default)
-    The 'matlab_cmd' returned within settings.get() method does not
-    contain a --ready-delay option for running the command. So it defaults to 10.
-
-    This fixture mocks the settings.get() method and then modifies only the
-    'matlab_cmd' key.
-
-    It adds the --ready-delay param and sets its value to 0.
-
-    Args:
-        mocker : A built in pytest fixture
-        dev_settings (Dict): A Dict which contains dev-mode settings
-    """
-
-    # Grab the settings:
-    custom_settings = settings.get(dev=True)
-
-    # Add the --ready-delay param with value 0
-    ready_delay = ["--ready-delay", "0"]
-    matlab_cmd = custom_settings["matlab_cmd"]
-    matlab_cmd[4:4] = ready_delay
-
-    # Update the matlab_cmd key
-    custom_settings["matlab_cmd"] = matlab_cmd
-
-    # Patch it to return the custom settings.
-    mocker.patch("jupyter_matlab_proxy.settings.get", return_value=custom_settings)