add CI env vars for CL config

Author: JLBegin

pytissueoptics/rayscattering/opencl/config/CLConfig.py

@@ -174,6 +174,26 @@ def _load(self):
         with open(OPENCL_CONFIG_PATH, "r") as f:
             self._config = json.load(f)
 
+        if os.getenv("PTO_DEVICE_INDEX") is not None:
+            try:
+                self.DEVICE_INDEX = int(os.getenv("PTO_DEVICE_INDEX"))
+            except ValueError:
+                raise ValueError(f"Invalid value for PTO_DEVICE_INDEX: {os.getenv('PTO_DEVICE_INDEX')}. Must be an "
+                                 f"integer.")
+        if os.getenv("PTO_N_WORK_UNITS") is not None:
+            try:
+                self.N_WORK_UNITS = int(os.getenv("PTO_N_WORK_UNITS"))
+            except ValueError:
+                raise ValueError(f"Invalid value for PTO_N_WORK_UNITS: {os.getenv('PTO_N_WORK_UNITS')}. Must be an "
+                                    f"integer.")
+
+        if os.getenv("PTO_MAX_MEMORY_MB") is not None:
+            try:
+                self.MAX_MEMORY_MB = int(os.getenv("PTO_MAX_MEMORY_MB"))
+            except ValueError:
+                raise ValueError(f"Invalid value for PTO_MAX_MEMORY_MB: {os.getenv('PTO_MAX_MEMORY_MB')}. Must be an "
+                                 f"integer.")
+
     def _assertExists(self):
         if not os.path.exists(OPENCL_CONFIG_PATH):
             warnings.warn("No OpenCL config file found. Creating a new one.")
@@ -183,6 +203,8 @@ def _assertExists(self):
     def save(self):
         if not self.AUTO_SAVE:
             return
+
+        os.makedirs(os.path.dirname(OPENCL_CONFIG_PATH), exist_ok=True)
         with open(OPENCL_CONFIG_PATH, "w") as f:
             json.dump(self._config, f, indent=4)
 

pytissueoptics/rayscattering/tests/opencl/config/testCLConfig.py

@@ -1,6 +1,7 @@
 import os
 import tempfile
 import unittest
+from unittest.mock import patch
 
 from pytissueoptics.rayscattering.opencl.config import CLConfig as clc
 
@@ -23,11 +24,11 @@ def testGivenNoConfigFile_shouldWarnAndCreateANewOne(self):
         self.assertTrue(os.path.exists(clc.OPENCL_CONFIG_PATH))
 
     @tempConfigPath
-    def testGivenNewConfigFile_shouldHaveDefaultValues(self):
+    def testGivenNewConfigFile_shouldHaveDefaultsFromEnvironment(self):
         with self.assertWarns(UserWarning):
             config = clc.CLConfig()
-        self.assertEqual(None, config.N_WORK_UNITS)
-        self.assertEqual(None, config.MAX_MEMORY_MB)
+        self.assertEqual(str(os.getenv("PTO_N_WORK_UNITS")), str(config.N_WORK_UNITS))
+        self.assertEqual(str(os.getenv("PTO_MAX_MEMORY_MB")), str(config.MAX_MEMORY_MB))
         self.assertEqual(1000, config.IPP_TEST_N_PHOTONS)
         self.assertEqual(0.20, config.BATCH_LOAD_FACTOR)
 
@@ -44,7 +45,8 @@ def testGivenMaxMemoryNotSet_whenValidate_shouldWarnAndSetMaxMemory(self):
         with open(clc.OPENCL_CONFIG_PATH, "w") as f:
             f.write('{"DEVICE_INDEX": 0, "N_WORK_UNITS": 100, "MAX_MEMORY_MB": null, '
                     '"IPP_TEST_N_PHOTONS": 1000, "BATCH_LOAD_FACTOR": 0.2}')
-        config = clc.CLConfig()
+        with patch("os.getenv", return_value=None):
+            config = clc.CLConfig()
         with self.assertWarns(UserWarning):
             config.validate()
         self.assertIsNotNone(config.MAX_MEMORY_MB)
@@ -66,8 +68,10 @@ def testGivenFileWithAParameterBelowOrEqualToZero_whenValidate_shouldResetDefaul
         with open(clc.OPENCL_CONFIG_PATH, "w") as f:
             f.write('{"DEVICE_INDEX": 0, "N_WORK_UNITS": 100, "MAX_MEMORY_MB": 0, '
                     '"IPP_TEST_N_PHOTONS": 1000, "BATCH_LOAD_FACTOR": 0.2}')
-        config = clc.CLConfig()
-        with self.assertRaises(ValueError):
-            config.validate()
-        config = clc.CLConfig()
-        self.assertIsNone(config.MAX_MEMORY_MB)
+
+        with patch("os.getenv", return_value=None):
+            config = clc.CLConfig()
+            with self.assertRaises(ValueError):
+                config.validate()
+            config = clc.CLConfig()
+            self.assertIsNone(config.MAX_MEMORY_MB)

tox.ini

@@ -4,6 +4,9 @@ envlist = py39, py310, py311, py312
 [testenv]
 setenv =
     QT_QPA_PLATFORM = offscreen
+    PTO_DEVICE_INDEX = 0
+    PTO_N_WORK_UNITS = 128
+    PTO_MAX_MEMORY_MB = 1024
 deps =
     git+https://github.com/enthought/mayavi.git@main
 commands =