Add test_ref_clock for all SHF devices

tests/__init__.py

@@ -0,0 +1,5 @@
+# Copyright (C) 2024 Zurich Instruments
+#
+# This software may be modified and distributed under the terms
+# of the MIT license. See the LICENSE file for details.
+"""Pytest tests directory."""

tests/test_shfqa.py

@@ -4,6 +4,7 @@
 
 from zhinst.toolkit import SHFQAChannelMode
 from zhinst.toolkit.driver.devices.shfqa import Generator, QAChannel, Readout, SHFScope
+from tests.utils import shf_test_ref_clock
 
 
 def test_repr(shfqa):
@@ -81,3 +82,7 @@ def test_qa_readout(shfqa):
         "0",
         "readout",
     )
+
+
+def test_ref_clock(mock_connection, shfqa):
+    shf_test_ref_clock(mock_connection, shfqa)

tests/test_shfqc.py

@@ -5,6 +5,7 @@
 from zhinst.toolkit import SHFQAChannelMode
 from zhinst.toolkit.driver.devices.shfqa import Generator, QAChannel, Readout, SHFScope
 from zhinst.toolkit.driver.devices.shfsg import AWG, Node, SGChannel
+from tests.utils import shf_test_ref_clock
 
 
 def test_repr(shfqc):
@@ -250,3 +251,7 @@ def test_configure_sine_generation(mock_connection, shfqc):
             gains=(3.0, -1.0, 5.0, 1.0),
             sine_generator_index=8,
         )
+
+
+def test_ref_clock(mock_connection, shfqc):
+    shf_test_ref_clock(mock_connection, shfqc)

tests/test_shfsg.py

@@ -3,6 +3,7 @@
 import pytest
 
 from zhinst.toolkit.driver.devices.shfsg import AWG, Node, SGChannel
+from tests.utils import shf_test_ref_clock
 
 
 def test_repr(shfsg):
@@ -171,3 +172,7 @@ def test_configure_sine_generation(mock_connection, shfsg):
             gains=(3.0, -1.0, 5.0, 1.0),
             sine_generator_index=8,
         )
+
+
+def test_ref_clock(mock_connection, shfsg):
+    shf_test_ref_clock(mock_connection, shfsg)

tests/utils.py

@@ -0,0 +1,46 @@
+from itertools import cycle
+
+import pytest
+
+
+def shf_test_ref_clock(mock_connection, shf):
+    """Test reference clock logic shared between all SHF devices."""
+    status = cycle([0])
+    source = 0
+    source_actual = 0
+
+    def getInt_side_effect(path):
+        if path == "/dev1234/system/clocks/referenceclock/in/status":
+            return next(status)
+        if path == "/dev1234/system/clocks/referenceclock/in/source":
+            return source
+        if path == "/dev1234/system/clocks/referenceclock/in/sourceactual":
+            return source_actual
+        raise RuntimeError("Invalid Node")
+
+    def get_side_effect(path, **kwargs):
+        value = getInt_side_effect(path)
+        return {path: {"timestamp": [0], "value": [value]}}
+
+    mock_connection.return_value.getInt.side_effect = getInt_side_effect
+    mock_connection.return_value.get.side_effect = get_side_effect
+
+    assert shf.check_ref_clock(sleep_time=0.001)
+    # Locked within time
+    status = iter([2] * 2 + [0] * 10)
+    assert shf.check_ref_clock(sleep_time=0.001)
+    # Locking error but actual_clock == clock
+    status = cycle([1])
+    assert not shf.check_ref_clock(sleep_time=0.001)
+    # Locking error and actual_clock != clock => reset clock to internal
+    source = 1
+    mock_connection.return_value.syncSetString.assert_not_called()
+    assert not shf.check_ref_clock(sleep_time=0.001)
+    mock_connection.return_value.syncSetString.assert_called_with(
+        "/dev1234/system/clocks/referenceclock/in/source", "internal"
+    )
+
+    # timeout
+    status = cycle([2])
+    with pytest.raises(TimeoutError) as e_info:
+        shf.check_ref_clock(timeout=0.01, sleep_time=0.001)