Merge branch 'dev' into fix-exception-handling-and-logging

Author: Sahil-u07

.github/workflows/tests.yml

@@ -0,0 +1,32 @@
+name: Tests
+
+on:
+  push:
+    branches: [main, dev]
+  pull_request:
+    branches: [main, dev]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ['3.9', '3.10', '3.11', '3.12']
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -r requirements-dev.txt
+          pip install pyzmq
+
+      - name: Run tests
+        run: pytest -v

.gitignore

@@ -1 +1,21 @@
-**/.DS_Store
+# Python
+__pycache__/
+*.py[cod]
+*.class
+*.so
+.Python
+venv/
+env/
+ENV/
+
+# IDE
+.vscode/
+.idea/
+
+# Testing
+.pytest_cache/
+htmlcov/
+.coverage
+
+# Concore specific
+concorekill.bat

concore.py

@@ -105,6 +105,24 @@ def terminate_zmq():
             logging.error(f"Error while terminating ZMQ port {port.address}: {e}")
 # --- ZeroMQ Integration End ---
 
+
+# NumPy Type Conversion Helper
+def convert_numpy_to_python(obj):
+    #Recursively convert numpy types to native Python types.
+    #This is necessary because literal_eval cannot parse numpy representations
+    #like np.float64(1.0), but can parse native Python types like 1.0.
+    if isinstance(obj, np.generic):
+        # Convert numpy scalar types to Python native types
+        return obj.item()
+    elif isinstance(obj, list):
+        return [convert_numpy_to_python(item) for item in obj]
+    elif isinstance(obj, tuple):
+        return tuple(convert_numpy_to_python(item) for item in obj)
+    elif isinstance(obj, dict):
+        return {key: convert_numpy_to_python(value) for key, value in obj.items()}
+    else:
+        return obj
+
 # ===================================================================
 # File & Parameter Handling
 # ===================================================================
@@ -130,13 +148,15 @@ def safe_literal_eval(filename, defaultValue):
 inpath = "./in" #must be rel path for local
 outpath = "./out"
 simtime = 0
+concore_params_file = os.path.join(inpath + "1", "concore.params")
+concore_maxtime_file = os.path.join(inpath + "1", "concore.maxtime")
 
 #9/21/22
 # ===================================================================
 # Parameter Parsing
 # ===================================================================
 try:
-    sparams_path = os.path.join(inpath + "1", "concore.params")
+    sparams_path = concore_params_file
     if os.path.exists(sparams_path):
         with open(sparams_path, "r") as f:
             sparams = f.read()
@@ -176,8 +196,7 @@ def tryparam(n, i):
 def default_maxtime(default):
     """Read maximum simulation time from file or use default."""
     global maxtime
-    maxtime_path = os.path.join(inpath + "1", "concore.maxtime")
-    maxtime = safe_literal_eval(maxtime_path, default)
+    maxtime = safe_literal_eval(concore_maxtime_file, default)
 
 default_maxtime(100)
 
@@ -225,14 +244,15 @@ def read(port_identifier, name, initstr_val):
         return default_return_val
 
     time.sleep(delay) 
-    file_path = os.path.join(inpath+str(file_port_num), name)
+    file_path = os.path.join(inpath + str(file_port_num), name)
     ins = ""
 
     try:
         with open(file_path, "r") as infile:
             ins = infile.read()
     except FileNotFoundError:
         ins = str(initstr_val) 
+        s += ins  # Update s to break unchanged() loop
     except Exception as e:
         logging.error(f"Error reading {file_path}: {e}. Using default value.")
         return default_return_val 
@@ -291,11 +311,8 @@ def write(port_identifier, name, val, delta=0):
 
     # Case 2: File-based port
     try:
-        if isinstance(port_identifier, str) and port_identifier in zmq_ports:
-            file_path = os.path.join("../"+port_identifier, name)
-        else:
-            file_port_num = int(port_identifier)
-            file_path = os.path.join(outpath+str(file_port_num), name) 
+        file_port_num = int(port_identifier)
+        file_path = os.path.join(outpath + str(file_port_num), name) 
     except ValueError:
         logging.error(f"Error: Invalid port identifier '{port_identifier}' for file operation. Must be integer or ZMQ name.")
         return
@@ -310,7 +327,9 @@ def write(port_identifier, name, val, delta=0):
     try:
         with open(file_path, "w") as outfile:
             if isinstance(val, list):
-                data_to_write = [simtime + delta] + val
+                # Convert numpy types to native Python types
+                val_converted = convert_numpy_to_python(val)
+                data_to_write = [simtime + delta] + val_converted
                 outfile.write(str(data_to_write))
                 simtime += delta 
             else: 

concoredocker.py

@@ -21,10 +21,12 @@ def safe_literal_eval(filename, defaultValue):
 inpath = os.path.abspath("/in")
 outpath = os.path.abspath("/out")
 simtime = 0
+concore_params_file = os.path.join(inpath, "1", "concore.params")
+concore_maxtime_file = os.path.join(inpath, "1", "concore.maxtime")
 
 #9/21/22
 try:
-    sparams = open(inpath+"1/concore.params").read()
+    sparams = open(concore_params_file).read()
     if sparams[0] == '"':  #windows keeps "" need to remove
         sparams = sparams[1:]
         sparams = sparams[0:sparams.find('"')]
@@ -46,7 +48,7 @@ def tryparam(n, i):
 #9/12/21
 def default_maxtime(default):
     global maxtime
-    maxtime = safe_literal_eval(os.path.join(inpath, "1", "concore.maxtime"), default)
+    maxtime = safe_literal_eval(concore_maxtime_file, default)
 
 default_maxtime(100)
 
@@ -62,7 +64,7 @@ def read(port, name, initstr):
     global s, simtime, retrycount
     max_retries=5
     time.sleep(delay)
-    file_path = os.path.join(inpath+str(port), name)
+    file_path = os.path.join(inpath, str(port), name)
 
     try:
         with open(file_path, "r") as infile:
@@ -101,7 +103,7 @@ def read(port, name, initstr):
 
 def write(port, name, val, delta=0):
     global simtime
-    file_path = os.path.join(outpath+str(port), name)
+    file_path = os.path.join(outpath, str(port), name)
 
     if isinstance(val, str):
         time.sleep(2 * delay)

pytest.ini

@@ -0,0 +1,6 @@
+[pytest]
+testpaths = tests
+python_files = test_*.py
+python_classes = Test*
+python_functions = test_*
+addopts = -v --tb=short

requirements-dev.txt

@@ -0,0 +1,2 @@
+pytest>=7.0.0
+pytest-cov>=4.0.0

tests/__init__.py

@@ -0,0 +1,15 @@
+import pytest
+import os
+import sys
+import tempfile
+import shutil
+
+sys.path.insert(0, os.path.dirname(os.path.dirname(os.path.abspath(__file__))))
+
+
+@pytest.fixture
+def temp_dir():
+    dirpath = tempfile.mkdtemp()
+    yield dirpath
+    if os.path.exists(dirpath):
+        shutil.rmtree(dirpath)

tests/conftest.py

@@ -0,0 +1,87 @@
+import pytest
+import os
+
+class TestSafeLiteralEval:
+
+    def test_reads_dictionary_from_file(self, temp_dir):
+        test_file = os.path.join(temp_dir, "config.txt")
+        with open(test_file, "w") as f:
+            f.write("{'name': 'test', 'value': 123}")
+        
+        from concore import safe_literal_eval
+        result = safe_literal_eval(test_file, {})
+        
+        assert result == {'name': 'test', 'value': 123}
+
+    def test_returns_default_when_file_missing(self):
+        from concore import safe_literal_eval
+        result = safe_literal_eval("nonexistent_file.txt", "fallback")
+        
+        assert result == "fallback"
+
+    def test_returns_default_for_empty_file(self, temp_dir):
+        test_file = os.path.join(temp_dir, "empty.txt")
+        with open(test_file, "w") as f:
+            pass
+        
+        from concore import safe_literal_eval
+        result = safe_literal_eval(test_file, "default")
+        
+        assert result == "default"
+
+
+class TestTryparam:
+
+    @pytest.fixture(autouse=True)
+    def reset_params(self):
+        from concore import params
+        original_params = params.copy()
+        yield
+        params.clear()
+        params.update(original_params)
+
+    def test_returns_existing_parameter(self):
+        from concore import tryparam, params
+        params['my_setting'] = 'custom_value'
+        
+        result = tryparam('my_setting', 'default_value')
+        
+        assert result == 'custom_value'
+
+    def test_returns_default_for_missing_parameter(self):
+        from concore import tryparam
+        result = tryparam('missing_param', 'fallback')
+        
+        assert result == 'fallback'
+
+
+class TestZeroMQPort:
+
+    def test_class_is_defined(self):
+        from concore import ZeroMQPort
+        assert ZeroMQPort is not None
+
+
+class TestDefaultConfiguration:
+
+    def test_default_input_path(self):
+        from concore import inpath
+        assert inpath == "./in"
+
+    def test_default_output_path(self):
+        from concore import outpath
+        assert outpath == "./out"
+
+
+class TestPublicAPI:
+
+    def test_module_imports_successfully(self):
+        from concore import safe_literal_eval
+        assert safe_literal_eval is not None
+
+    def test_core_functions_exist(self):
+        from concore import safe_literal_eval, tryparam, default_maxtime
+        
+        assert callable(safe_literal_eval)
+        assert callable(tryparam)
+        assert callable(default_maxtime)