updated tests and joss_tests.yml

Author: prathameshnium

.github/workflows/joss_tests.yml

@@ -15,19 +15,30 @@ jobs:
     # PHASE 1: SETUP
     # ------------------------------------------------------------------------
     - name: Checkout repository
-      uses: actions/checkout@v3
+      uses: actions/checkout@v4
 
     - name: Set up Python 3.10
-      uses: actions/setup-python@v4
+      uses: actions/setup-python@v5
       with:
         python-version: "3.10"
 
+    - name: Cache pip dependencies
+      id: cache-pip
+      uses: actions/cache@v4
+      with:
+        path: ~/.cache/pip
+        # The key invalidates the cache if requirements change
+        key: ${{ runner.os }}-pip-${{ hashFiles('pyproject.toml') }}
+        restore-keys: |
+          ${{ runner.os }}-pip-
+
     - name: Install Dependencies
+      # Use a dedicated step for installing dependencies.
+      # The 'if' condition prevents re-installing if the cache was restored.
+      if: steps.cache-pip.outputs.cache-hit != 'true'
       run: |
         python -m pip install --upgrade pip
-        # Install PICA in editable mode
         pip install -e .
-        # Install Testing, Linting, and Coverage tools
         pip install pytest flake8 pytest-cov
 
     # ------------------------------------------------------------------------
@@ -56,14 +67,14 @@ jobs:
     # PHASE 4: CODECOV UPLOADS
     # ------------------------------------------------------------------------
     - name: Upload Coverage Report (XML)
-      uses: codecov/codecov-action@v3
+      uses: codecov/codecov-action@v4
       with:
         token: ${{ secrets.CODECOV_TOKEN }}
         files: ./coverage.xml
-        fail_ci_if_error: false
+        fail_ci_if_error: true # It's good practice to fail if coverage upload fails.
 
     - name: Upload Test Results to Codecov (JUnit)
-      if: ${{ !cancelled() }}
+      if: always() # This ensures test results are uploaded even if previous steps fail.
       uses: codecov/test-results-action@v1
       with:
         token: ${{ secrets.CODECOV_TOKEN }}

tests/test_deep_simulation.py

@@ -110,10 +110,11 @@ def side_effect(*args, **kwargs):
 
     def test_01_k2400_iv_backend(self):
         # GLOBAL PATCH for sleep is critical here
+        mock_sleep = patch('time.sleep', side_effect=self.get_circuit_breaker(5))
+        mock_sleep.start()
+        self.addCleanup(mock_sleep.stop)
+
         with patch('pymeasure.instruments.keithley.Keithley2400') as MockInst:
-            mock_sleep = patch('time.sleep', side_effect=self.get_circuit_breaker(5))
-            mock_sleep.start()
-            self.addCleanup(mock_sleep.stop)
 
             spy = MockInst.return_value
             with patch('builtins.input', side_effect=['100', '10', 'test_file']), \
@@ -123,12 +124,12 @@ def test_01_k2400_iv_backend(self):
                 spy.enable_source.assert_called()
 
     def test_02_lakeshore_backend(self):
+        mock_sleep = patch('time.sleep', side_effect=self.get_circuit_breaker(15))
+        mock_sleep.start()
+        self.addCleanup(mock_sleep.stop)
         with patch('pyvisa.ResourceManager') as MockRM, \
              patch('tkinter.Tk'), \
              patch('tkinter.filedialog.asksaveasfilename', return_value="test.csv"):
-            mock_sleep = patch('time.sleep', side_effect=self.get_circuit_breaker(15))
-            mock_sleep.start()
-            self.addCleanup(mock_sleep.stop)
 
             spy = MockRM.return_value.open_resource.return_value
             spy.query.side_effect = [
@@ -146,10 +147,10 @@ def test_02_lakeshore_backend(self):
                     "Lakeshore_350_340.Backends.T_Control_L350_Simple_Backend_v10")
 
     def test_03_k6517b_pyro_backend(self):
+        mock_sleep = patch('time.sleep', side_effect=self.get_circuit_breaker(10))
+        mock_sleep.start()
+        self.addCleanup(mock_sleep.stop)
         with patch('pymeasure.instruments.keithley.Keithley6517B') as MockInst:
-            mock_sleep = patch('time.sleep', side_effect=self.get_circuit_breaker(10))
-            mock_sleep.start()
-            self.addCleanup(mock_sleep.stop)
 
             spy = MockInst.return_value
             spy.current = 1.23e-9
@@ -171,10 +172,10 @@ def test_04_lcr_keysight_backend(self):
                     "LCR_Keysight_E4980A.Backends.CV_KE4980A_Simple_Backend_v10")
 
     def test_05_delta_simple(self):
+        mock_sleep = patch('time.sleep', side_effect=self.get_circuit_breaker(10))
+        mock_sleep.start()
+        self.addCleanup(mock_sleep.stop)
         with patch('pyvisa.ResourceManager') as MockRM:
-            mock_sleep = patch('time.sleep', side_effect=self.get_circuit_breaker(10))
-            mock_sleep.start()
-            self.addCleanup(mock_sleep.stop)
 
             MockRM.return_value.open_resource.return_value
             inputs = ['0', '1e-5', '1e-6', 'test_file', 'y', 'y']
@@ -201,11 +202,11 @@ def test_06_delta_sensing(self):
                     print("   [SKIP] Module not found, skipping.")
 
     def test_07_lockin_backend(self):
+        mock_sleep = patch('time.sleep', side_effect=self.get_circuit_breaker(5))
+        mock_sleep.start()
+        self.addCleanup(mock_sleep.stop)
         with patch('pyvisa.ResourceManager') as MockRM:
-            mock_sleep = patch('time.sleep', side_effect=self.get_circuit_breaker(5))
             spy = MockRM.return_value.open_resource.return_value
-            mock_sleep.start()
-            self.addCleanup(mock_sleep.stop)
 
             spy.query.side_effect = [
                 "SRS,SR830,s/n12345,ver1.07",  # *IDN?
@@ -218,11 +219,12 @@ def test_07_lockin_backend(self):
     def test_08_combined_2400_2182(self):
         # THIS WAS THE TEST CAUSING THE HANG
         # We suspect input mismatch or resource opening hang.
+        mock_sleep = patch('time.sleep', side_effect=self.get_circuit_breaker(10))
+        mock_sleep.start()
+        self.addCleanup(mock_sleep.stop)
         with patch('pyvisa.ResourceManager') as MockRM:
-            mock_sleep = patch('time.sleep', side_effect=self.get_circuit_breaker(10))
             mock_pymeasure = patch('pymeasure.instruments.keithley.Keithley2400')
             mock_pymeasure.start()
-            self.addCleanup(mock_sleep.stop)
 
             rm = MockRM.return_value
             k2182_spy = MagicMock()
@@ -232,18 +234,17 @@ def test_08_combined_2400_2182(self):
             # Add extra inputs just in case the script asks for more than
             # expected
             inputs = ['10', '1', 'test_file', 'y', 'y', 'y', 'y']
-            mock_sleep.start()
             with patch('builtins.input', side_effect=inputs), \
                     patch('pandas.DataFrame.to_csv'):
                 self.run_module_safely(
                     "Keithley_2400_Keithley_2182.Backends.IV_K2400_K2182_Backend_v1")
             mock_pymeasure.stop()
 
     def test_09_poling(self):
+        mock_sleep = patch('time.sleep', side_effect=self.get_circuit_breaker(5))
+        mock_sleep.start()
+        self.addCleanup(mock_sleep.stop)
         with patch('pymeasure.instruments.keithley.Keithley6517B'):
-            mock_sleep = patch('time.sleep', side_effect=self.get_circuit_breaker(5))
-            mock_sleep.start()
-            self.addCleanup(mock_sleep.stop)
 
             inputs = ['100', '10', 'y']
             with patch('builtins.input', side_effect=inputs):

tests/test_gui_iv_k2400.py

@@ -23,8 +23,8 @@ def tearDown(self):
         self.root.destroy()
 
     @patch('Keithley_2400.IV_K2400_GUI_v5.Keithley2400_IV_Backend')
-    @patch('matplotlib.pyplot.subplots')
-    def test_start_measurement_logic(self, mock_subplots, MockBackend):
+    @patch('matplotlib.figure.Figure.subplots')
+    def test_start_measurement_logic(self, mock_fig_subplots, MockBackend):
         """
         Tests the core logic of the 'Start' button click.
         Verifies that parameters are read from the UI and passed to the backend correctly.
@@ -33,7 +33,7 @@ def test_start_measurement_logic(self, mock_subplots, MockBackend):
         # Configure the mock for subplots to return two mock axes
         mock_ax_vi = MagicMock()
         mock_ax_ri = MagicMock()
-        mock_subplots.return_value = (MagicMock(), (mock_ax_vi, mock_ax_ri))
+        mock_fig_subplots.return_value = (mock_ax_vi, mock_ax_ri)
 
         # Instantiate the GUI. This also creates all the tk widgets.
         app = MeasurementAppGUI(self.root)

tests/test_iv_k2400_loop_backend.py

@@ -9,7 +9,7 @@
 class TestIVK2400LoopBackend(unittest.TestCase):
 
     @patch('builtins.input', side_effect=['10', '2', 'test_output'])
-    @patch('Keithley_2400.Backends.IV_K2400_Loop_Backend_v10.Keithley2400')
+    @patch('pymeasure.instruments.keithley.Keithley2400')
     @patch('matplotlib.pyplot.show')
     @patch('pandas.DataFrame.to_csv')
     def test_main_full_run(self, mock_to_csv, mock_plt_show, mock_keithley_class, mock_input):
@@ -47,7 +47,7 @@ def ramp_side_effect(current):
 
         # --- ASSERTIONS ---
         # 1. Check instrument initialization
-        mock_keithley_class.assert_called_with("GPIB::4")
+        mock_keithley_class.assert_called_with("GPIB::4", adapter_args={"py_library": "@sim"})
         mock_keithley_instance.disable_buffer.assert_called_once()
 
         # 2. Check instrument configuration

tests/test_iv_k6517b_simple_backend.py

@@ -8,7 +8,7 @@
 class TestIVK6517BSimpleBackend(unittest.TestCase):
     @patch('time.sleep', MagicMock())
     @patch('builtins.input', side_effect=['-10', '10', '5', '0.1', 'test_iv_simple.csv'])
-    @patch('Keithley_6517B.High_Resistance.Backends.IV_K6517B_Simple_Backend_v10.Keithley6517B')
+    @patch('pymeasure.instruments.keithley.Keithley6517B')
     @patch('builtins.open', new_callable=mock_open)
     @patch('matplotlib.pyplot.show')
     def test_full_run(self, mock_show, mock_file, mock_keithley_class, mock_input):
@@ -33,7 +33,7 @@ def test_full_run(self, mock_show, mock_file, mock_keithley_class, mock_input):
 
         # --- Assertions ---
         # 1. Was the instrument initialized correctly?
-        mock_keithley_class.assert_called_once_with("GPIB1::27::INSTR")
+        mock_keithley_class.assert_called_once_with("GPIB1::27::INSTR", adapter_args={"py_library": "@sim"})
 
         # 2. Was the zero-check and correction sequence performed?
         mock_instrument.reset.assert_called_once()

tests/test_t_control_l350_backend.py

@@ -116,7 +116,7 @@ def test_main_runs_and_completes(self, mock_time, mock_open_file,
 
         # --- ASSERTIONS ---
         # Check initialization
-        mock_ls_class.assert_called_once()
+        mock_ls_class.assert_called_once_with("GPIB0::12::INSTR", adapter_args={"py_library": "@sim"})
         mock_controller.reset_and_clear.assert_called_once()
         mock_controller.setup_heater.assert_called_once()