Addon Manager: Add GUI tests for branch change dialog

Further protect utils gui code during testing so the same utils file can be used
for CLI and GUI tests.

src/Mod/AddonManager/AddonManagerTest/gui/test_change_branch.py

@@ -0,0 +1,214 @@
+# SPDX-License-Identifier: LGPL-2.1-or-later
+# ***************************************************************************
+# *                                                                         *
+# *   Copyright (c) 2025 The FreeCAD Project Association AISBL              *
+# *                                                                         *
+# *   This file is part of FreeCAD.                                         *
+# *                                                                         *
+# *   FreeCAD is free software: you can redistribute it and/or modify it    *
+# *   under the terms of the GNU Lesser General Public License as           *
+# *   published by the Free Software Foundation, either version 2.1 of the  *
+# *   License, or (at your option) any later version.                       *
+# *                                                                         *
+# *   FreeCAD is distributed in the hope that it will be useful, but        *
+# *   WITHOUT ANY WARRANTY; without even the implied warranty of            *
+# *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU      *
+# *   Lesser General Public License for more details.                       *
+# *                                                                         *
+# *   You should have received a copy of the GNU Lesser General Public      *
+# *   License along with FreeCAD. If not, see                               *
+# *   <https://www.gnu.org/licenses/>.                                      *
+# *                                                                         *
+# ***************************************************************************
+
+import sys
+import unittest
+from unittest.mock import patch, Mock, MagicMock
+
+# So that when run standalone, the Addon Manager classes imported below are available
+sys.path.append("../..")
+
+from AddonManagerTest.gui.gui_mocks import DialogWatcher, DialogInteractor, AsynchronousMonitor
+
+from change_branch import ChangeBranchDialog
+
+from addonmanager_freecad_interface import translate
+from addonmanager_git import GitFailed
+
+try:
+    from PySide import QtCore, QtWidgets
+except ImportError:
+    try:
+        from PySide6 import QtCore, QtWidgets
+    except ImportError:
+        from PySide2 import QtCore, QtWidgets
+
+
+class MockFilter(QtCore.QSortFilterProxyModel):
+    def mapToSource(self, something):
+        return something
+
+
+class MockChangeBranchDialogModel(QtCore.QAbstractTableModel):
+
+    branches = [
+        {"ref_name": "ref1", "upstream": "us1"},
+        {"ref_name": "ref2", "upstream": "us2"},
+        {"ref_name": "ref3", "upstream": "us3"},
+    ]
+    current_branch = "ref1"
+    DataSortRole = QtCore.Qt.UserRole
+    RefAccessRole = QtCore.Qt.UserRole + 1
+
+    def __init__(self, _: str, parent=None) -> None:
+        super().__init__(parent)
+
+    def rowCount(self, parent: QtCore.QModelIndex = QtCore.QModelIndex()) -> int:
+        if parent.isValid():
+            return 0
+        return len(self.branches)
+
+    def columnCount(self, parent: QtCore.QModelIndex = QtCore.QModelIndex()) -> int:
+        if parent.isValid():
+            return 0
+        return 3  # Local name, remote name, date
+
+    def data(self, index: QtCore.QModelIndex, role: int = QtCore.Qt.DisplayRole):
+        if not index.isValid():
+            return None
+        row = index.row()
+        column = index.column()
+        if role == QtCore.Qt.DisplayRole:
+            if column == 2:
+                return "date"
+            elif column == 0:
+                return "ref_name"
+            elif column == 1:
+                return "upstream"
+            else:
+                return None
+        elif role == MockChangeBranchDialogModel.DataSortRole:
+            return None
+        elif role == MockChangeBranchDialogModel.RefAccessRole:
+            return self.branches[row]
+
+    def headerData(
+        self,
+        section: int,
+        orientation: QtCore.Qt.Orientation,
+        role: int = QtCore.Qt.DisplayRole,
+    ):
+        if orientation == QtCore.Qt.Vertical:
+            return None
+        if role != QtCore.Qt.DisplayRole:
+            return None
+        if section == 0:
+            return "Local"
+        if section == 1:
+            return "Remote tracking"
+        elif section == 2:
+            return "Last Updated"
+        else:
+            return None
+
+    def currentBranch(self) -> str:
+        return self.current_branch
+
+
+class TestChangeBranchGui(unittest.TestCase):
+
+    MODULE = "test_change_branch"  # file name without extension
+
+    def setUp(self):
+        pass
+
+    def tearDown(self):
+        pass
+
+    @patch("change_branch.ChangeBranchDialogModel", new=MockChangeBranchDialogModel)
+    @patch("change_branch.initialize_git", new=Mock(return_value=None))
+    def test_no_git(self):
+        # Arrange
+        gui = ChangeBranchDialog("/some/path")
+        ref = {"ref_name": "foo/bar", "upstream": "us1"}
+        dialog_watcher = DialogWatcher(
+            translate("AddonsInstaller", "Cannot find git"),
+            QtWidgets.QDialogButtonBox.Ok,
+        )
+
+        # Act
+        gui._change_branch("/foo/bar/baz", ref)
+
+        # Assert
+        self.assertTrue(dialog_watcher.dialog_found, "Failed to find the expected dialog box")
+
+    @patch("change_branch.ChangeBranchDialogModel", new=MockChangeBranchDialogModel)
+    @patch("change_branch.initialize_git")
+    def test_git_failed(self, init_git: MagicMock):
+        # Arrange
+        git_manager = MagicMock()
+        git_manager.checkout = MagicMock()
+        git_manager.checkout.side_effect = GitFailed()
+        init_git.return_value = git_manager
+        gui = ChangeBranchDialog("/some/path")
+        ref = {"ref_name": "foo/bar", "upstream": "us1"}
+        dialog_watcher = DialogWatcher(
+            translate("AddonsInstaller", "git operation failed"),
+            QtWidgets.QDialogButtonBox.Ok,
+        )
+
+        # Act
+        gui._change_branch("/foo/bar/baz", ref)
+
+        # Assert
+        self.assertTrue(dialog_watcher.dialog_found, "Failed to find the expected dialog box")
+
+    @patch("change_branch.ChangeBranchDialogModel", new=MockChangeBranchDialogModel)
+    @patch("change_branch.initialize_git", new=MagicMock)
+    def test_branch_change_succeeded(self):
+        # If nothing gets thrown, then the process is assumed to have worked, and the appropriate
+        # signal is emitted.
+
+        # Arrange
+        gui = ChangeBranchDialog("/some/path")
+        ref = {"ref_name": "foo/bar", "upstream": "us1"}
+        monitor = AsynchronousMonitor(gui.branch_changed)
+
+        # Act
+        gui._change_branch("/foo/bar/baz", ref)
+
+        # Assert
+        monitor.wait_for_at_most(10)  # Should be effectively instantaneous
+        self.assertTrue(monitor.good())
+
+    @patch("change_branch.ChangeBranchDialogFilter", new=MockFilter)
+    @patch("change_branch.ChangeBranchDialogModel", new=MockChangeBranchDialogModel)
+    @patch("change_branch.initialize_git", new=MagicMock)
+    def test_warning_is_shown_when_dialog_is_accepted(self):
+        # Arrange
+        gui = ChangeBranchDialog("/some/path")
+        gui.ui.exec = MagicMock()
+        gui.ui.exec.return_value = QtWidgets.QDialog.Accepted
+        gui.ui.tableView.selectedIndexes = MagicMock()
+        gui.ui.tableView.selectedIndexes.return_value = [MagicMock()]
+        gui.ui.tableView.selectedIndexes.return_value[0].isValid = MagicMock()
+        gui.ui.tableView.selectedIndexes.return_value[0].isValid.return_value = True
+        dialog_watcher = DialogWatcher(
+            translate("AddonsInstaller", "DANGER: Developer feature"),
+            QtWidgets.QDialogButtonBox.Cancel,
+        )
+
+        # Act
+        gui.exec()
+
+        # Assert
+        self.assertTrue(dialog_watcher.dialog_found, "Failed to find the expected dialog box")
+
+
+if __name__ == "__main__":
+    app = QtWidgets.QApplication(sys.argv)
+    QtCore.QTimer.singleShot(0, unittest.main)
+    if hasattr(app, "exec"):
+        app.exec()  # PySide6
+    else:
+        app.exec_()  # PySide2

src/Mod/AddonManager/addonmanager_freecad_interface.py

@@ -46,11 +46,13 @@ try:
     getUserMacroDir = FreeCAD.getUserMacroDir
     getUserCachePath = FreeCAD.getUserCachePath
     translate = FreeCAD.Qt.translate
+    loadUi = None
 
     if FreeCAD.GuiUp:
         import FreeCADGui
 
-        loadUi = FreeCADGui.PySideUic.loadUi
+        if hasattr(FreeCADGui, "PySideUic"):
+            loadUi = FreeCADGui.PySideUic.loadUi
     else:
         FreeCADGui = None
 

src/Mod/AddonManager/addonmanager_utilities.py

@@ -72,16 +72,28 @@ else:
 if fci.FreeCADGui:
     loadUi = fci.loadUi
 else:
+    has_loader = False
     try:
         from PySide6.QtUiTools import QUiLoader
-    except ImportError:
-        from PySide2.QtUiTools import QUiLoader
 
-    def loadUi(ui_file: str) -> QtWidgets.QWidget:
-        q_ui_file = QtCore.QFile(ui_file)
-        q_ui_file.open(QtCore.QFile.OpenModeFlag.ReadOnly)
-        loader = QUiLoader()
-        return loader.load(ui_file)
+        has_loader = True
+    except ImportError:
+        try:
+            from PySide2.QtUiTools import QUiLoader
+
+            has_loader = True
+        except ImportError:
+
+            def loadUi(ui_file: str):
+                raise RuntimeError("Cannot use QUiLoader without PySide or FreeCAD")
+
+    if has_loader:
+
+        def loadUi(ui_file: str) -> QtWidgets.QWidget:
+            q_ui_file = QtCore.QFile(ui_file)
+            q_ui_file.open(QtCore.QFile.OpenModeFlag.ReadOnly)
+            loader = QUiLoader()
+            return loader.load(ui_file)
 
 
 #  @package AddonManager_utilities