test: unit tests moved to separate folder; scope of autouse bec_dispatcher fixture reduced only for unit tests; ci adjusted

tests/unit_tests/test_yaml_dialog.py

@@ -0,0 +1,163 @@
+# pylint: disable = no-name-in-module,missing-class-docstring, missing-module-docstring
+import os
+import tempfile
+from unittest.mock import patch
+
+import pytest
+import yaml
+from qtpy.QtWidgets import QPushButton, QVBoxLayout, QWidget
+
+from bec_widgets.utils.yaml_dialog import load_yaml, save_yaml
+
+
+@pytest.fixture(scope="function")
+def example_widget(qtbot):
+    main_widget = QWidget()
+    layout = QVBoxLayout(main_widget)
+    main_widget.import_button = QPushButton("Import", main_widget)
+    main_widget.export_button = QPushButton("Export", main_widget)
+    layout.addWidget(main_widget.import_button)
+    layout.addWidget(main_widget.export_button)
+
+    main_widget.config = {}  # Dictionary to store the loaded configuration
+    main_widget.saved_config = None  # To store the saved configuration
+
+    qtbot.addWidget(main_widget)
+    qtbot.waitExposed(main_widget)
+    yield main_widget
+
+
+def test_load_yaml(qtbot, example_widget):
+    # Create a temporary file with YAML content
+    with tempfile.NamedTemporaryFile(delete=False, suffix=".yaml") as temp_file:
+        temp_file.write(b"name: test\nvalue: 42")
+
+    def load_yaml_wrapper():
+        config = load_yaml(example_widget)
+        if config:
+            example_widget.config.update(config)
+
+    example_widget.import_button.clicked.connect(load_yaml_wrapper)
+
+    # Mock user selecting the file in the dialog
+    with patch("qtpy.QtWidgets.QFileDialog.getOpenFileName", return_value=(temp_file.name, "")):
+        example_widget.import_button.click()
+
+    assert example_widget.config == {"name": "test", "value": 42}
+    os.remove(temp_file.name)  # Clean up
+
+
+def test_load_yaml_file_not_found(qtbot, example_widget, capsys):
+    def load_yaml_wrapper():
+        config = load_yaml(example_widget)
+        if config:
+            example_widget.config.update(config)
+
+    example_widget.import_button.clicked.connect(load_yaml_wrapper)
+
+    # Mock user selecting a non-existent file in the dialog
+    with patch(
+        "qtpy.QtWidgets.QFileDialog.getOpenFileName", return_value=("non_existent_file.yaml", "")
+    ):
+        example_widget.import_button.click()
+
+    # Catch the print output
+    captured = capsys.readouterr()
+    assert "The file non_existent_file.yaml was not found." in captured.out
+
+    assert example_widget.config == {}  # No update should happen
+
+
+def test_load_yaml_general_exception(qtbot, example_widget, capsys, monkeypatch):
+    # Mock the open function to raise a general exception
+    def mock_open(*args, **kwargs):
+        raise Exception("General error")
+
+    monkeypatch.setattr("builtins.open", mock_open)
+
+    def load_yaml_wrapper():
+        config = load_yaml(example_widget)
+        if config:
+            example_widget.config.update(config)
+
+    example_widget.import_button.clicked.connect(load_yaml_wrapper)
+
+    # Mock user selecting a file in the dialog
+    with patch("qtpy.QtWidgets.QFileDialog.getOpenFileName", return_value=("somefile.yaml", "")):
+        example_widget.import_button.click()
+
+    assert example_widget.config == {}
+
+
+def test_load_yaml_permission_error(qtbot, example_widget, monkeypatch, capsys):
+    # Create a temporary file and remove read permissions
+    with tempfile.NamedTemporaryFile(delete=False, suffix=".yaml") as temp_file:
+        temp_file_path = temp_file.name
+    os.chmod(temp_file_path, 0o000)  # Remove permissions
+
+    def load_yaml_wrapper():
+        config = load_yaml(example_widget)
+        if config:
+            example_widget.config.update(config)
+
+    example_widget.import_button.clicked.connect(load_yaml_wrapper)
+
+    # Mock user selecting the file in the dialog
+    with patch("qtpy.QtWidgets.QFileDialog.getOpenFileName", return_value=(temp_file_path, "")):
+        example_widget.import_button.click()
+
+    # # Catch the print output
+    # captured = capsys.readouterr()
+    # assert "Permission denied for file" in captured.out
+
+    assert example_widget.config == {}  # No update should happen
+    os.remove(temp_file_path)  # Clean up
+
+
+def test_load_yaml_invalid_yaml(qtbot, example_widget, capsys):
+    # Create a temporary file with invalid YAML content
+    with tempfile.NamedTemporaryFile(delete=False, suffix=".yaml") as temp_file:
+        temp_file.write(b"\tinvalid_yaml: [unbalanced_brackets: ]")
+
+    def load_yaml_wrapper():
+        config = load_yaml(example_widget)
+        if config:
+            example_widget.config.update(config)
+
+    example_widget.import_button.clicked.connect(load_yaml_wrapper)
+
+    # Mock user selecting the file in the dialog
+    with patch("qtpy.QtWidgets.QFileDialog.getOpenFileName", return_value=(temp_file.name, "")):
+        example_widget.import_button.click()
+
+    # Catch the print output
+    captured = capsys.readouterr()
+    assert "Error parsing YAML file" in captured.out
+
+    assert example_widget.config == {}  # No update should happen
+    os.remove(temp_file.name)  # Clean up
+
+
+def test_save_yaml(qtbot, example_widget):
+    # Create a temporary file
+    with tempfile.NamedTemporaryFile(delete=False, suffix=".yaml") as temp_file:
+        temp_file_path = temp_file.name
+
+    # Prepare data to be saved
+    example_widget.saved_config = {"name": "test", "value": 42}
+
+    def save_yaml_wrapper():
+        save_yaml(example_widget, example_widget.saved_config)
+
+    example_widget.export_button.clicked.connect(save_yaml_wrapper)
+
+    # Mock user selecting the file in the dialog
+    with patch("qtpy.QtWidgets.QFileDialog.getSaveFileName", return_value=(temp_file_path, "")):
+        example_widget.export_button.click()
+
+    # Check if the data was saved correctly
+    with open(temp_file_path, "r") as file:
+        saved_config = yaml.safe_load(file)
+    assert saved_config == {"name": "test", "value": 42}
+
+    os.remove(temp_file_path)  # Clean up