Dev/add simulator tests in GitHub workflows (#1337)

* added simulator tests in github workflows * indentation error * typo * debug * Logging for debugging * added more debug lines * more debugging * debug * debug * debug * dont throw if process does not exist * debug * added absolute path to sls_detector commands * some refactoring in test scripts * added absolute path to all slsdet command * typo * ../tests/scripts/test_frame_synchronizer.py * raise exception upon failure for github workflows * removed hidden tags * some refactoring in test scripts * some refactoring * fixed CMakeLists * fixed unsuccesful merge * updated python tests using simulators * debug import error * debug module import * python -m runs module pytest as script - everything in path available * removed integartion tests * enable file write not to log files * run tests without log files * increased sleep time for udp packets * added logg level variable to cmake * added testing policies to documenattion * disabled check for num_frames for jungfrau & xilinx * set log level as cmake cached variable * disable tests for jungfrau and xilinx_ctb * check frames for HDF5 * updated Documentation of Testing * changed withdetectorsimulators to detectorintegration * replaced [.cmdcall] with [.detectorintegration] * check_file_size only disabled for jungfrau - disable for all roi tests * changed time to wait after receive to 5 ms * take into account half modules of eiger * num udp interfaces needs to be consistent across modules * suppressed warning enclosing if * config added 2 udp ports per default for moench and jungfrau * write detector output to console * allow jungfrau to tests num frames, remove unused variable (numinterfaces), add comment for future to handle traceback to know which calling function threw the files unmatched, added documentation for tests (examples for .detectoritnegration and how to disable marked tests, removed addditional argumetns to disable for test_simulator as one can just use ~, removed the check that checks for jungfrau checking number of frames at master attributes and at rx test, removed unused advanced_test_settings in test_simulator script, the num_mods check for multiple modules is removed and default num modules set to 1 for test_simulator (to be increased later), back to raising exception for killprocess * removed integration tests from cmakelists.txt and cmk.sh, modified the tests workflow command to reflect the disable argument and removed xilinx_ctb from test (fix fromdeveloper merge to be done) * filtering by actual name for disable certain tests on github workflow * minor refactor * wip * wip * changes to run on local rh9 runner instead of github workfloa * modified yml to remove some leftover from github workflow * test * fix build_dir in scripts (github workflow) and pytest dir in gitea workflow * making the local machine use python3.13 binary * pythonpath added * changes for build_Dir back * allowing ctb api tests * allowed ctb api tests and set up slsdetname envt variable for shared memory being reserved just for these tests * added rh8 workflow for local runner on gitea * remnants from rh9 local runner * remnants from rh9 local runner * conda env for all shell for local runner * allowing hdf5 to build on local runner * run all tests for both the runners * refactored fixtures a bit and merged some tests that use one session for entire server * test fail * test fix * adding github workflow to test without data file checks and without logs * documentation changes * unnecessary import in conftest * allowing the session_simulator to test for multiple modules and interfaces etc * allow test_simulator script to run for 2 modules for all modules except ctb and xilinx ctb * run upon push * removing the disable file check on github workflow * minor adjustment * testing without synch * reverting to previous * with log file * without the space * summary from file and more error extracts from file to terminal * minor * trying nlf for more details * updated with no log file to print everything to screen also for det and rxr * trying a no throw * stoi was more about indent in yaml * tries * wip * debug * number of frames inconsistent fix=>just take first one, only test xilinx * jungfrau tests without frames caught check * extend the disable file check to everywhere that creates files * specify path for test_simulator * withoutprinting == * wip * back with printing===, but not parsing file for errors anymore * lang? * wip * safe log? * wip2 * wip * dont split error as its streaming live, just raise * with log files * lang? * last resort * wip * test no det with general tests * show tests live * also include hidden integration tests * without extra summary? * revert * last resort again * tsquash on int64_t? * tsquash on int64_t? mroe print * writing to /tmp? * all tests * might be the fix? * write to file * fixed a few quiet mode no log file tests * work on any branch for github tests, work on also release candidates for gitea tests * added frame synchronizer tests to github workflow * moved tests to run_tests.yaml from cmake.yaml * documentation * disabled general tests --------- Co-authored-by: Dhanya Thattil <dhanya.thattil@psi.ch>
2026-02-07 18:38:41 +01:00 · 2026-02-03 11:45:12 +01:00
parent a390e580d2
commit 28b2aa9673
42 changed files with 1243 additions and 1758 deletions
--- a/python/tests/test_free.py
+++ b/python/tests/test_free.py
@@ -0,0 +1,166 @@
+# SPDX-License-Identifier: LGPL-3.0-or-other
+# Copyright (C) 2021 Contributors to the SLS Detector Package
+'''
+This file is used to start up simulators and test for freeing shm and accessing it from python.
+Run this using: pytest -s test_free.py
+'''
+
+import pytest, sys
+
+from pathlib import Path
+
+current_dir = Path(__file__).resolve().parents[2]
+
+scripts_dir = current_dir / "tests" / "scripts"
+
+sys.path.append(str(scripts_dir))
+
+
+from slsdet import Detector, Ctb, freeSharedMemory
+from utils_for_test import (
+    Log,
+    LogLevel,
+    cleanup,
+    startDetectorVirtualServer,
+    connectToVirtualServers,
+    SERVER_START_PORTNO
+)
+
+'''
+scope = module =>Once per test file/module 
+to share expensive setup like startDetectorVirtualServer
+'''
+@pytest.fixture(scope="module")
+def det_config():
+    return {
+        "name": "ctb",
+        "num_mods": 1
+    }
+
+@pytest.fixture(scope="module", autouse=True)
+def setup_simulator(det_config):
+    """Fixture to start the detector server once and clean up at the end."""
+    fp = sys.stdout
+
+    cleanup(fp)
+    startDetectorVirtualServer(det_config["name"], det_config["num_mods"], fp)
+
+    Log(LogLevel.INFOBLUE, f'Waiting for server to start up and connect')
+    connectToVirtualServers(det_config["name"], det_config["num_mods"])
+    Log(LogLevel.INFOBLUE, f'Freeing shm before tests')
+    freeSharedMemory()
+
+    yield  # tests run here
+
+    cleanup(fp)
+
+
+@pytest.mark.detectorintegration
+def test_exptime_after_free_should_raise(setup_simulator):
+    Log(LogLevel.INFOBLUE, f'\nRunning test_exptime_after_free_should_raise')
+
+
+    d = Ctb() # creates multi shm (assuming no shm exists)
+    d.hostname = f"localhost:{SERVER_START_PORTNO}" # hostname command creates mod shm, d maps to it
+
+    d.free() # frees the shm, d should not map to it anymore
+
+    # accessing invalid shm should throw
+    with pytest.raises(Exception) as exc_info:
+        _ = d.exptime
+
+    Log(LogLevel.INFOGREEN, f"✅ Test passed, exception was: {exc_info.value}")
+    assert str(exc_info.value) == "Shared memory is invalid or freed. Close resources before access."
+
+
+def free_and_create_shm():
+    k = Ctb() # opens existing shm if it exists
+    k.hostname = f"localhost:{SERVER_START_PORTNO}" # free and recreate shm, maps to local shm struct
+
+@pytest.mark.detectorintegration
+def test_exptime_after_not_passing_var_should_raise(setup_simulator):
+    Log(LogLevel.INFOBLUE, f'\nRunning test_exptime_after_not_passing_var_should_raise')
+
+
+    d = Ctb() # creates multi shm (assuming no shm exists)
+    d.hostname = f"localhost:{SERVER_START_PORTNO}" # hostname command creates mod shm, d maps to it
+
+    free_and_create_shm() # ctb() opens multi shm, hostname command frees and recreates mod shm but shm struct is local. d still maps to old shm struct
+
+    # accessing invalid shm should throw
+    with pytest.raises(Exception) as exc_info:
+        _ = d.exptime
+
+    Log(LogLevel.INFOGREEN, f"✅ Test passed, exception was: {exc_info.value}")
+    assert str(exc_info.value) == "Shared memory is invalid or freed. Close resources before access."
+
+
+
+
+def free_and_create_shm_passing_ctb_var(k):
+    k = Ctb() # opens existing shm if it exists (disregards k as its new Ctb only local to this function)
+    k.hostname = f"localhost:{SERVER_START_PORTNO}" # free and recreate shm, maps to local shm struct
+
+@pytest.mark.detectorintegration
+def test_exptime_after_passing_ctb_var_should_raise(setup_simulator):
+    Log(LogLevel.INFOBLUE, f'\nRunning test_exptime_after_passing_ctb_var_should_raise')
+
+    d = Ctb() # creates multi shm (assuming no shm exists)
+    d.hostname = f"localhost:{SERVER_START_PORTNO}" # hostname command creates mod shm, d maps to it
+
+    free_and_create_shm_passing_ctb_var(d) # ctb() opens multi shm, hostname command frees and recreates mod shm but shm struct is local. d still maps to old shm struct
+
+    # accessing invalid shm should throw
+    with pytest.raises(Exception) as exc_info:
+        _ = d.exptime
+
+    Log(LogLevel.INFOGREEN, f"✅ Test passed, exception was: {exc_info.value}")
+    assert str(exc_info.value) == "Shared memory is invalid or freed. Close resources before access."
+
+
+
+def free_and_create_shm_returning_ctb():
+    k = Ctb() # opens existing shm if it exists (disregards k as its new Ctb only local to this function)
+    k.hostname = f"localhost:{SERVER_START_PORTNO}" # free and recreate shm, maps to local shm struct
+    return k
+
+@pytest.mark.detectorintegration
+def test_exptime_after_returning_ctb_should_raise(setup_simulator):
+    Log(LogLevel.INFOBLUE, f'\nRunning test_exptime_after_returning_ctb_should_raise')
+
+    d = Ctb() # creates multi shm (assuming no shm exists)
+
+    d = free_and_create_shm_returning_ctb() # ctb() opens multi shm, hostname command frees and recreates mod shm but shm struct is local but returned. d now maps to the new sturct
+
+    # this should not throw 
+    exptime_val = d.exptime
+
+    Log(LogLevel.INFOGREEN, f"✅ Test passed, exptime was: {exptime_val}")
+    assert isinstance(exptime_val, float)
+
+    free_and_create_shm_returning_ctb() # this time d is not updated, it maps to the old shm struct
+
+    # accessing invalid shm should throw
+    with pytest.raises(Exception) as exc_info:
+        _ = d.exptime
+
+    Log(LogLevel.INFOGREEN, f"✅ Test passed, exception was: {exc_info.value}")
+    assert str(exc_info.value) == "Shared memory is invalid or freed. Close resources before access."
+
+@pytest.mark.detectorintegration
+def test_hostname_twice_acess_old_should_raise(setup_simulator):
+    Log(LogLevel.INFOBLUE, f'\nRunning test_hostname_twice_acess_old_should_raise')
+
+    d = Ctb() # creates multi shm (assuming no shm exists)
+    d.hostname = f"localhost:{SERVER_START_PORTNO}" # hostname command creates mod shm, d maps to it
+    d.hostname = f"localhost:{SERVER_START_PORTNO}"  # Freeing and recreating shm while mapping d to it (old shm is out of scope)
+    
+    # this should not throw 
+    exptime_val = d.exptime
+
+    Log(LogLevel.INFOGREEN, f"✅ Test passed, exptime was: {exptime_val}")
+    assert isinstance(exptime_val, float)
+
+
+
+