added doc strings to test and test name change to automated test

Author: prathameshnium

.github/workflows/joss_tests.yml

@@ -8,6 +8,7 @@ on:
 
 jobs:
   test:
+    name: automated test
     runs-on: ubuntu-latest
 
     steps:

.github/workflows/python-app.yml

@@ -49,6 +49,6 @@ jobs:
     # 6. Run Tests (The "Logic" Check)
     # We ignore the visual GUI rendering tests if they are too heavy, 
     # but since we mocked them, they should run fast!
-    - name: Test with pytest
+    - name: automated test
       run: |
         python -m pytest tests/

tests/test_backends_logic.py

@@ -1,8 +1,7 @@
 """
-tests/test_backends_logic.py
+Purpose: Structure verification for control scripts.
 
-This file tests the LOGIC of the backends without connecting to hardware.
-It is designed to handle Classes, Scripts with main(), or loose Procedural Scripts.
+What it does: Analyzes your backend files to determine if they are classes, procedural scripts, or functions, and attempts to run them in a "dry" mode to verify their logic structure.
 """
 
 import pytest

tests/test_deep_simulation.py

@@ -1,3 +1,8 @@
+"""
+Purpose: Robustness and loop safety (Circuit Breakers).
+
+What it does: Runs full measurement scripts while mocking time.sleep to prevent infinite loops. It acts as a "watchdog," forcing scripts to exit if they run too long, ensuring your while True loops don't freeze the test server.
+"""
 import unittest
 import sys
 import os
@@ -94,7 +99,7 @@ def test_01_k2400_iv_backend(self):
 
         with patch('pymeasure.instruments.keithley.Keithley2400') as MockInst:
             spy = MockInst.return_value
-            with patch('builtins.input', side_effect=['100', '10', 'test_file']), \
+            with patch('builtins.input', side_effect=['100', '10', 'test_file']),
                     patch('pandas.DataFrame.to_csv'):
                 self.run_module_safely(
                     "Keithley_2400.Backends.IV_K2400_Loop_Backend_v10", {})
@@ -110,7 +115,7 @@ def test_02_lakeshore_backend(self):
             spy.query.side_effect = [
                 "LSCI,MODEL350,0,0"] + ["10.0", "300.0"] * 20
 
-            with patch('builtins.input', side_effect=['10', '300', '10', '350']), \
+            with patch('builtins.input', side_effect=['10', '300', '10', '350']),
                     patch('builtins.open', mock_open()):
                 self.run_module_safely("Lakeshore_350_340.Backends.T_Control_L350_Simple_Backend_v10", {})
 
@@ -149,7 +154,7 @@ def test_05_delta_simple(self):
         with patch('pyvisa.ResourceManager') as MockRM:
             MockRM.return_value.open_resource.return_value
             inputs = ['0', '1e-5', '1e-6', 'test_file', 'y', 'y']
-            with patch('builtins.input', side_effect=inputs), \
+            with patch('builtins.input', side_effect=inputs),
                     patch('pandas.DataFrame.to_csv'):
                 self.run_module_safely("Delta_mode_Keithley_6221_2182.Backends.Delta_K6221_K2182_Simple_v7", {})
 
@@ -163,7 +168,7 @@ def test_06_delta_sensing(self):
             inst = MockRM.return_value.open_resource.return_value
             inst.query.return_value = "+1.23E-5"
             inputs = ['10', '300', '10', 'test_file', 'y']
-            with patch('builtins.input', side_effect=inputs), \
+            with patch('builtins.input', side_effect=inputs),
                     patch('pandas.DataFrame.to_csv'):
                 try:
                     self.run_module_safely(
@@ -206,7 +211,7 @@ 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']
-            with patch('builtins.input', side_effect=inputs), \
+            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", {})
@@ -237,7 +242,7 @@ def test_10_high_resistance(self):
             # Correct inputs for: start_v, stop_v, steps, delay, filename
             inputs = ['-10', '10', '5', '0.1', 'test_file']
 
-            with patch('builtins.input', side_effect=inputs), \
+            with patch('builtins.input', side_effect=inputs),
                     patch('builtins.open', mock_open()):
                 self.run_module_safely("Keithley_6517B.High_Resistance.Backends.IV_K6517B_Simple_Backend_v10", {}) # noqa
 
@@ -261,10 +266,10 @@ def test_12_gpib_rescue(self):
             self.addCleanup(mock_sleep.stop)
 
             rm = MockRM.return_value
-            rm.list_resources.return_value = ('GPIB0::1::INSTR',)
+            rm.list_.resources.return_value = ('GPIB0::1::INSTR',)
             self.run_module_safely(
                 "Utilities.GPIB_Interface_Rescue_Simple_Backened_v2_", {})
 
 
 if __name__ == '__main__':
-    unittest.main()
+    unittest.main()

tests/test_full_stack_simulation.py

@@ -1,3 +1,8 @@
+"""
+Purpose: End-to-end protocol verification.
+
+What it does: Simulates specific instrument responses (e.g., feeding fake temperature data like "10.0, 50.0" to the Lakeshore script) and verifies that the script sends the correct commands back (e.g., "HTRSET").
+"""
 import unittest
 
 import os
@@ -153,4 +158,4 @@ def test_gpib_scanner_loop(self):
 
 
 if __name__ == '__main__':
-    unittest.main()
+    unittest.main()

tests/test_gui_layouts.py

@@ -1,6 +1,7 @@
 """
-tests/test_gui_layouts.py
-Tests GUI instantiation by deeply patching the Matplotlib Figure class.
+Purpose: GUI instantiation stability.
+
+What it does: Attempts to build the GUI windows in memory. It uses a "Safe" mock for Matplotlib to prevent graphing errors from crashing the test, ensuring the layout logic is sound.
 """
 import pytest
 import os

tests/test_gui_modules_initialization.py

@@ -1,3 +1,8 @@
+"""
+Purpose: Module-level GUI smoke tests.
+
+What it does: Dynamically finds all files ending in _GUI.py, imports them, and tries to initialize their main class to ensure they don't crash on startup.
+"""
 import pytest
 import os
 import sys
@@ -64,4 +69,4 @@ def test_gui_module_initialization(module_path):
         assert app_instance is not None, "GUI class failed to instantiate."
 
     except (ImportError, AttributeError, Exception) as e:
-        pytest.fail(f"Failed to initialize GUI module '{module_path}'.\nError: {e}")
+        pytest.fail(f"Failed to initialize GUI module '{module_path}'.\nError: {e}")

tests/test_package_integrity.py

@@ -1,3 +1,8 @@
+"""
+Purpose: Basic code health checks.
+
+What it does: Compiles every Python file to catch syntax errors and checks if every file has a top-level docstring (a JOSS requirement).
+"""
 import pytest
 import os
 import ast
@@ -71,11 +76,12 @@ def test_has_docstring(file_path):
         tree = ast.parse(source)
         # Check if the first node in the file is a Docstring (Expression -> Constant string)
         if not (tree.body and isinstance(tree.body[0], ast.Expr) and 
-                isinstance(tree.body[0].value, (ast.Str, ast.Constant))):            
+                isinstance(tree.body[0].value, (ast.Str, ast.Constant))):
+            
             # This is a 'Warning' - it won't break code, but it fails JOSS standards
             warnings.warn(f"JOSS STANDARD MISSING: {os.path.basename(file_path)} has no top-level docstring. "
-                          "Please add a description at the top of the file using '\"\"\" ... \"\"\"'.", UserWarning)
+                          "Please add a description at the top of the file using '""" ... """'.", UserWarning)
 
     except SyntaxError:
         # Syntax errors are handled by the other test
-        pass
+        pass

tests/test_pica_launcher.py

@@ -1,3 +1,8 @@
+"""
+Purpose: Entry-point testing.
+
+What it does: Tests the main PICALauncherApp, mocking heavy dependencies like Pillow (images) and fonts to ensure the main menu launches correctly.
+"""
 import pytest
 import os
 import sys
@@ -45,4 +50,4 @@ def test_pica_launcher_initialization(mock_app_dependencies):
         assert app.root == mock_root
         assert app is not None
 
-        print("\n[SUCCESS] PICALauncherApp initialized safely with Mock Tk and Mock Font.")
+        print("\n[SUCCESS] PICALauncherApp initialized safely with Mock Tk and Mock Font.")

tests/test_utilities_logic.py

@@ -1,7 +1,7 @@
 """
-tests/test_utilities_logic.py
-Tests the logic inside the Utilities folder (Plotters, Formatters)
-without needing a GUI or Hardware.
+Purpose: Logic checks for helper tools.
+
+What it does: Verifies that the LivePlotter correctly appends data to arrays and that formatting utilities define the correct fonts/styles.
 """
 import pytest
 from unittest.mock import MagicMock, patch