Add a CI run for Qt5 and cleanup CI runs

Author: chennes

.github/workflows/qt5-tests.yml

@@ -0,0 +1,49 @@
+name: Run Qt5 tests
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  test:
+    runs-on: ubuntu-22.04
+
+    steps:
+      - name: Checkout repo
+        uses: actions/checkout@v3
+
+      - name: Install dependencies
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y \
+            qtbase5-dev \
+            qtbase5-dev-tools \
+            python3-pyside2.* \
+            libegl1 \
+            libglib2.0-0 \
+            libx11-xcb1 \
+            libxrender1 \
+            libxkbcommon-x11-0 \
+            libxcb-icccm4 \
+            libxcb-image0 \
+            libxcb-keysyms1 \
+            libxcb-randr0 \
+            libxcb-render-util0 \
+            libxcb-xinerama0 \
+            libxcb-xkb1 \
+            xvfb
+
+      - name: Install Python dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install vermin || true
+
+      - name: Run App tests
+        run: |
+          python AddonManagerTest/run_app_tests.py
+
+      - name: Run GUI tests
+        run: |
+          xvfb-run -s "-screen 0 1920x1080x24" python3 AddonManagerTest/run_gui_tests.py

.github/workflows/app-tests.yml renamed to .github/workflows/qt6-tests.yml

@@ -1,4 +1,4 @@
-name: Run app tests
+name: Run Qt6 tests
 
 on:
   push:
@@ -23,7 +23,7 @@ jobs:
         with:
           python-version: ${{ matrix.python-version }}
 
-      - name: Install Qt dependencies
+      - name: Install dependencies
         run: |
           sudo apt-get update
           sudo apt-get install -y \
@@ -32,16 +32,30 @@ jobs:
             libx11-xcb1 \
             libxrender1 \
             libxkbcommon-x11-0 \
+            libxcb-cursor0 \
             libxcb-icccm4 \
             libxcb-image0 \
             libxcb-keysyms1 \
             libxcb-randr0 \
             libxcb-render-util0 \
+            libxcb-shape0 \
             libxcb-xinerama0 \
             libxcb-xkb1 \
-            libopengl0
+            libopengl0 \
+            libxcomposite1 \
+            libxdamage1 \
+            libxi6 \
+            libxtst6 \
+            libnss3 \
+            libxss1 \
+            libdbus-1-3 \
+            libatk1.0-0 \
+            libatk-bridge2.0-0 \
+            libxrandr2 \
+            libgtk-3-0 \
+            xvfb
 
-      - name: Install dependencies
+      - name: Install Python dependencies
         run: |
           python -m pip install --upgrade pip
           pip install -r requirements.txt || true
@@ -51,5 +65,8 @@ jobs:
           python AddonManagerTest/run_app_tests.py
 
       - name: Run GUI tests
+        env:
+          QT_QPA_PLATFORM: xcb
+          QT_DEBUG_PLUGINS: 1
         run: |
-          python AddonManagerTest/run_gui_tests.py
+          xvfb-run -s "-screen 0 1920x1080x24" python3 AddonManagerTest/run_gui_tests.py

AddonManagerTest/gui/test_gui.py

@@ -56,7 +56,7 @@ def test_call_pip(self, mock_run_subprocess: MagicMock):
         args = mock_run_subprocess.call_args[0][0]
         self.assertTrue("pip" in args)
 
-    @patch("addonmanager_python_deps_gui.get_python_exe")
+    @patch("addonmanager_python_deps_gui.utils.fci.get_python_exe")
     def test_call_pip_no_python(self, mock_get_python_exe: MagicMock):
         mock_get_python_exe.return_value = None
         with self.assertRaises(PipFailed):

AddonManagerTest/gui/test_python_deps_gui.py

@@ -12,83 +12,83 @@ def test_toolbar_adapter_outside_freecad(self):
         with self.assertRaises(RuntimeError):
             ToolbarAdapter()
 
-    @patch("addonmanager_toolbar_adapter.fci.ParamGet")
+    @patch("addonmanager_toolbar_adapter.fci.FreeCAD")
     def test_toolbar_adapter_inside_freecad(self, _):
         """When run inside FreeCAD, this class should instantiate correctly"""
         ToolbarAdapter()
 
-    @patch("addonmanager_toolbar_adapter.fci.ParamGet")
-    def test_get_toolbars(self, mock_param_get):
+    @patch("addonmanager_toolbar_adapter.fci.FreeCAD")
+    def test_get_toolbars(self, mock_freecad: MagicMock):
         """Get a list of toolbars out of the FreeCAD preferences system"""
-        mock_param_get().GetGroups = Mock(return_value=["A", "B", "C"])
-        mock_param_get().GetGroup = Mock(
+        mock_freecad.ParamGet().GetGroups = Mock(return_value=["A", "B", "C"])
+        mock_freecad.ParamGet().GetGroup = Mock(
             side_effect=["Toolbar1", "Toolbar2", "Toolbar3", "Toolbar4"]
         )
         toolbars = ToolbarAdapter().get_toolbars()
         self.assertEqual(["Toolbar1", "Toolbar2", "Toolbar3"], toolbars)
 
-    @patch("addonmanager_toolbar_adapter.fci.ParamGet")
-    def test_get_toolbar_with_name_good(self, mock_param_get):
+    @patch("addonmanager_toolbar_adapter.fci.FreeCAD")
+    def test_get_toolbar_with_name_good(self, mock_freecad: MagicMock):
         """Find a specific toolbar with a given name"""
-        mock_param_get().GetGroups = Mock(return_value=["A", "B", "C"])
-        mock_param_get().GetGroup = MagicMock()
-        mock_param_get().GetGroup().GetString = MagicMock(
+        mock_freecad.ParamGet().GetGroups = Mock(return_value=["A", "B", "C"])
+        mock_freecad.ParamGet().GetGroup = MagicMock()
+        mock_freecad.ParamGet().GetGroup().GetString = MagicMock(
             side_effect=["Toolbar1", "Toolbar2", "Toolbar3"]
         )
         toolbars = ToolbarAdapter().get_toolbar_with_name("Toolbar2")
         self.assertIsNotNone(toolbars)
 
-    @patch("addonmanager_toolbar_adapter.fci.ParamGet")
-    def test_get_toolbar_with_name_no_match(self, mock_param_get):
+    @patch("addonmanager_toolbar_adapter.fci.FreeCAD")
+    def test_get_toolbar_with_name_no_match(self, mock_freecad: MagicMock):
         """Don't find a toolbar that doesn't match the name"""
-        mock_param_get().GetGroups = Mock(return_value=["A", "B", "C"])
-        mock_param_get().GetGroup = MagicMock()
-        mock_param_get().GetGroup().GetString = MagicMock(
+        mock_freecad.ParamGet().GetGroups = Mock(return_value=["A", "B", "C"])
+        mock_freecad.ParamGet().GetGroup = MagicMock()
+        mock_freecad.ParamGet().GetGroup().GetString = MagicMock(
             side_effect=["Toolbar1", "Toolbar2", "Toolbar3"]
         )
         toolbars = ToolbarAdapter().get_toolbar_with_name("Toolbar4")
         self.assertIsNone(toolbars)
 
-    @patch("addonmanager_toolbar_adapter.fci.ParamGet")
-    def test_check_for_toolbar_with_match(self, mock_param_get):
-        mock_param_get().GetGroups = Mock(return_value=["A", "B", "C"])
-        mock_param_get().GetGroup = MagicMock()
-        mock_param_get().GetGroup().GetString = MagicMock(
+    @patch("addonmanager_toolbar_adapter.fci.FreeCAD")
+    def test_check_for_toolbar_with_match(self, mock_freecad: MagicMock):
+        mock_freecad.ParamGet().GetGroups = Mock(return_value=["A", "B", "C"])
+        mock_freecad.ParamGet().GetGroup = MagicMock()
+        mock_freecad.ParamGet().GetGroup().GetString = MagicMock(
             side_effect=["Toolbar1", "Toolbar2", "Toolbar3"]
         )
         self.assertTrue(ToolbarAdapter().check_for_toolbar("Toolbar2"))
 
-    @patch("addonmanager_toolbar_adapter.fci.ParamGet")
-    def test_check_for_toolbar_without_match(self, mock_param_get):
-        mock_param_get().GetGroups = Mock(return_value=["A", "B", "C"])
-        mock_param_get().GetGroup = MagicMock()
-        mock_param_get().GetGroup().GetString = MagicMock(
+    @patch("addonmanager_toolbar_adapter.fci.FreeCAD")
+    def test_check_for_toolbar_without_match(self, mock_freecad: MagicMock):
+        mock_freecad.ParamGet().GetGroups = Mock(return_value=["A", "B", "C"])
+        mock_freecad.ParamGet().GetGroup = MagicMock()
+        mock_freecad.ParamGet().GetGroup().GetString = MagicMock(
             side_effect=["Toolbar1", "Toolbar2", "Toolbar3"]
         )
         self.assertFalse(ToolbarAdapter().check_for_toolbar("Toolbar4"))
 
-    @patch("addonmanager_toolbar_adapter.fci.ParamGet")
-    def test_create_new_custom_toolbar_basic_name(self, mock_param_get):
+    @patch("addonmanager_toolbar_adapter.fci.FreeCAD")
+    def test_create_new_custom_toolbar_basic_name(self, mock_freecad: MagicMock):
         """If no custom toolbar exists yet, then the new toolbar uses the most basic name form"""
         toolbar = ToolbarAdapter().create_new_custom_toolbar()
         toolbar.SetString.assert_called_with("Name", "Auto-Created Macro Toolbar")
-        mock_param_get().GetGroup.assert_called_with("Custom_1")
+        mock_freecad.ParamGet().GetGroup.assert_called_with("Custom_1")
 
-    @patch("addonmanager_toolbar_adapter.fci.ParamGet")
-    def test_create_new_custom_toolbar_name_taken(self, mock_param_get):
+    @patch("addonmanager_toolbar_adapter.fci.FreeCAD")
+    def test_create_new_custom_toolbar_name_taken(self, mock_freecad: MagicMock):
         """If no custom toolbar exists yet, then the new toolbar uses the most basic name form"""
         with patch(
             "addonmanager_toolbar_adapter.ToolbarAdapter.check_for_toolbar"
         ) as mock_check_for_toolbar:
             mock_check_for_toolbar.side_effect = [True, True, False]
             toolbar = ToolbarAdapter().create_new_custom_toolbar()
         toolbar.SetString.assert_called_with("Name", "Auto-Created Macro Toolbar (3)")
-        mock_param_get().GetGroup.assert_called_with("Custom_1")
+        mock_freecad.ParamGet().GetGroup.assert_called_with("Custom_1")
 
-    @patch("addonmanager_toolbar_adapter.fci.ParamGet")
-    def test_create_new_custom_toolbar_group_name_taken(self, mock_param_get):
+    @patch("addonmanager_toolbar_adapter.fci.FreeCAD")
+    def test_create_new_custom_toolbar_group_name_taken(self, mock_freecad: MagicMock):
         """If no custom toolbar exists yet, then the new toolbar uses the most basic name form"""
-        mock_param_get().GetGroups = Mock(return_value=["Custom_1", "Custom_2", "Custom_3"])
+        mock_freecad.ParamGet().GetGroups = Mock(return_value=["Custom_1", "Custom_2", "Custom_3"])
         toolbar = ToolbarAdapter().create_new_custom_toolbar()
         toolbar.SetString.assert_called_with("Name", "Auto-Created Macro Toolbar")
-        mock_param_get().GetGroup.assert_called_with("Custom_4")
+        mock_freecad.ParamGet().GetGroup.assert_called_with("Custom_4")

AddonManagerTest/gui/test_toolbar_adapter.py

@@ -12,10 +12,14 @@
 try:
     from PySide6 import QtCore, QtWidgets
     from PySide6.QtWidgets import QApplication, QWidget
+
+    pyside_version = 6
 except ImportError:
     from PySide2 import QtCore, QtWidgets
     from PySide2.QtWidgets import QApplication
 
+    pyside_version = 2
+
 app = None
 if QApplication:
     # Ensure there is only one QApplication instance
@@ -49,5 +53,8 @@ def run_suite(runner: unittest.TextTestRunner, suite: unittest.TestSuite):
     s = loader.discover(start_dir="gui", pattern="test_*.py")
     r = unittest.TextTestRunner(verbosity=2)
     QtCore.QTimer.singleShot(0, lambda: run_suite(r, s))
-    app.exec()
+    if pyside_version == 6:
+        app.exec()
+    else:
+        app.exec_()
     sys.exit(not suite_result)

AddonManagerTest/run_gui_tests.py

@@ -189,7 +189,6 @@ SET(AddonManagerTestsApp_SRCS
 SET(AddonManagerTestsGui_SRCS
     AddonManagerTest/gui/__init__.py
     AddonManagerTest/gui/gui_mocks.py
-    AddonManagerTest/gui/test_gui.py
     AddonManagerTest/gui/test_installer_gui.py
     AddonManagerTest/gui/test_python_deps_gui.py
     AddonManagerTest/gui/test_toolbar_adapter.py

CMakeLists.txt

@@ -23,9 +23,6 @@
 
 import addonmanager_freecad_interface as fci
 
-# Unit test for the Addon Manager module GUI
-from AddonManagerTest.gui.test_gui import TestGui as AddonManagerTestGui
-
 from AddonManagerTest.gui.test_workers_utility import (
     TestWorkersUtility as AddonManagerTestWorkersUtility,
 )

TestAddonManagerGui.py

@@ -25,13 +25,18 @@
 
 # Check if PySide6 is used
 QApplication = None
+pyside_version = 0
 try:
     from PySide6 import QtCore, QtWidgets
     from PySide6.QtWidgets import QApplication, QWidget
+
+    pyside_version = 6
 except ImportError:
     from PySide2 import QtCore, QtWidgets
     from PySide2.QtWidgets import QApplication, QWidget
 
+    pyside_version = 2
+
 app = None
 if QApplication:
     # Ensure there is only one QApplication instance
@@ -64,4 +69,7 @@ def run_addon_manager():
     QtCore.QTimer.singleShot(0, run_addon_manager)
     app.setQuitOnLastWindowClosed(False)
     setup_translations()
-    app.exec()
+    if pyside_version == 6:
+        app.exec()
+    else:
+        app.exec_()