Introduce tests for MacOS

Author: Tanmay Das

.github/workflows/run-tests.yml

@@ -15,14 +15,13 @@ on:
 
 jobs:
   node_tests:
-    # If continue-on-error is set to true then all the queued jobs/steps
-    # are executed regardless of failure
-    # However, the workflow is always marked as passed even if some job
-    # fails inside
-    continue-on-error: ${{ inputs.continue-on-error }}
     strategy:
+      # fail-fast=false runs all the jobs in strategy matrix
+      # irrespective of failures in a particular job, and marks
+      # the entire job as failed even if one job has failed
+      fail-fast: false
       matrix:
-        os: [ubuntu-latest, windows-latest]
+        os: [ubuntu-latest, windows-latest, macos-latest]
     runs-on: ${{ matrix.os }}
     defaults:
       run:
@@ -51,10 +50,10 @@ jobs:
     continue-on-error: ${{ inputs.continue-on-error }}
     strategy:
       matrix:
-        os: [ubuntu-latest, windows-latest]
+        os: [ubuntu-latest, windows-latest, macos-latest]
         python-version: ['3.7', '3.8', '3.9', '3.10']
         exclude:
-        - os: windows-latest
+        - os: [windows-latest]
           # Python 3.7 in Windows does not run successfully
           python-version: '3.7'
     runs-on: ${{ matrix.os }}

tests/util/inf_loop.py

@@ -0,0 +1,28 @@
+# Copyright (c) 2020-2022 The MathWorks, Inc.
+
+import asyncio
+import os
+import sys
+import time
+
+"""This file launches an asynchrnous infinite loop.
+    Used for testing matlab_proxy/util/__init__.py/get_child_processes
+"""
+
+process_no = int(sys.argv[1])
+
+loop = asyncio.get_event_loop()
+
+# Runs infinite loop asynchronously
+async def inf_loop(process_no):
+    process_no += 1
+    inf_loop_file_path = os.path.join(os.path.dirname(__file__), "inf_loop.py")
+    cmd = [f"python {inf_loop_file_path} {process_no}"]
+    _ = await asyncio.create_subprocess_shell(*cmd)
+    while True:
+        time.sleep(1)
+
+
+# Allows only one python process
+if process_no < 2:
+    loop.run_until_complete(inf_loop(process_no))

tests/util/test_mw.py

@@ -510,6 +510,10 @@ def test_range_matlab_connector_ports():
     assert first_port + 1 == second_port
 
 
+@pytest.mark.skipif(
+    system.is_windows() or system.is_mac(),
+    reason="xvfb is not meant for windows and mac machines",
+)
 async def test_create_xvfb_process(loop):
     """Test to check if more than 1 xvfb process can be created with -displayfd flag
 

tests/util/test_util.py

@@ -1,4 +1,7 @@
+# Copyright (c) 2020-2022 The MathWorks, Inc.
+
 import asyncio
+import os
 
 import psutil
 from matlab_proxy import util
@@ -45,7 +48,12 @@ def test_prettify():
 async def test_get_child_processes(loop):
     """Tests if child processes are returned"""
 
-    cmd = ["python"]
+    # Python process exits before validating get_child_processes
+    # in Mac machine, so an asynchronous infinite loop is launched as a
+    # to keep it always running
+    process_no = 1
+    inf_path = os.path.join(os.path.dirname(__file__), "inf_loop.py")
+    cmd = [f"python {inf_path} {process_no}"]
     proc = await asyncio.create_subprocess_shell(*cmd)
 
     children = util.get_child_processes(proc)