Merge pull request #68 from chennes/addTestsForButtons

Add basic test stubs for all widget classes

Author: chennes

.github/workflows/qt5-tests.yml

@@ -8,6 +8,7 @@ on:
 
 jobs:
   test:
+    name: Qt5 Test
     runs-on: ubuntu-22.04
 
     steps:

.github/workflows/qt6-tests.yml

@@ -8,6 +8,7 @@ on:
 
 jobs:
   test:
+    name: Qt6 Test (Python ${{ matrix.python-version }})
     runs-on: ubuntu-latest
 
     strategy:

AddonManagerTest/gui/test_widget_addon_buttons.py

@@ -0,0 +1,36 @@
+# SPDX-License-Identifier: LGPL-2.1-or-later
+# ***************************************************************************
+# *                                                                         *
+# *   Copyright (c) 2025 The FreeCAD project association AISBL              *
+# *                                                                         *
+# *   This file is part of the FreeCAD Addon Manager.                       *
+# *                                                                         *
+# *   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 unittest
+
+from PySideWrapper import QtWidgets
+
+from Widgets.addonmanager_widget_addon_buttons import WidgetAddonButtons
+
+
+class TestWidgetAddonButtons(unittest.TestCase):
+
+    def test_instantiation(self):
+        window = QtWidgets.QDialog()
+        window.setObjectName("Test Widget Addon Buttons")
+        _buttons = WidgetAddonButtons(window)

AddonManagerTest/gui/test_widget_filter_selector.py

@@ -0,0 +1,70 @@
+# SPDX-License-Identifier: LGPL-2.1-or-later
+# ***************************************************************************
+# *                                                                         *
+# *   Copyright (c) 2025 The FreeCAD project association AISBL              *
+# *                                                                         *
+# *   This file is part of the FreeCAD Addon Manager.                       *
+# *                                                                         *
+# *   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 unittest
+
+from PySideWrapper import QtWidgets
+
+from Widgets.addonmanager_widget_filter_selector import (
+    WidgetFilterSelector,
+    StatusFilter,
+    ContentFilter,
+)
+
+
+class TestWidgetFilterSelector(unittest.TestCase):
+
+    def setUp(self):
+        self.window = QtWidgets.QDialog()
+        self.window.setObjectName("Test Widget Filter Selector Window")
+        self.wfs = WidgetFilterSelector(self.window)
+
+    def tearDown(self):
+        self.window.close()
+
+    def test_instantiation(self):
+        self.assertIsInstance(self.wfs, WidgetFilterSelector)
+
+    def test_set_status_filter(self):
+        """Explicitly setting the status filter should not emit a signal"""
+        signal_caught = False
+
+        def signal_handler():
+            nonlocal signal_caught
+            signal_caught = True
+
+        self.wfs.filter_changed.connect(signal_handler)
+        self.wfs.set_status_filter(StatusFilter.ANY)
+        self.assertFalse(signal_caught)
+
+    def test_set_content_filter(self):
+        """Explicitly setting the content filter should not emit a signal"""
+        signal_caught = False
+
+        def signal_handler():
+            nonlocal signal_caught
+            signal_caught = True
+
+        self.wfs.filter_changed.connect(signal_handler)
+        self.wfs.set_contents_filter(ContentFilter.ANY)
+        self.assertFalse(signal_caught)

AddonManagerTest/gui/test_widget_global_buttons.py

@@ -0,0 +1,53 @@
+# SPDX-License-Identifier: LGPL-2.1-or-later
+# ***************************************************************************
+# *                                                                         *
+# *   Copyright (c) 2025 The FreeCAD project association AISBL              *
+# *                                                                         *
+# *   This file is part of the FreeCAD Addon Manager.                       *
+# *                                                                         *
+# *   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 unittest
+
+from PySideWrapper import QtWidgets
+
+from Widgets.addonmanager_widget_global_buttons import WidgetGlobalButtonBar
+
+
+class TestWidgetGlobalButtons(unittest.TestCase):
+
+    def setUp(self):
+        self.window = QtWidgets.QDialog()
+        self.window.setObjectName("Test Widget Button Bar Window")
+        self.wbb = WidgetGlobalButtonBar(self.window)
+
+    def tearDown(self):
+        self.window.close()
+        del self.window
+
+    def test_instantiation(self):
+        self.assertIsInstance(self.wbb, WidgetGlobalButtonBar)
+
+    def test_set_number_of_available_updates_to_zero(self):
+        """The string saying that there are no available updates shouldn't contain the number 0"""
+        self.wbb.set_number_of_available_updates(0)
+        self.assertNotIn("0", self.wbb.update_all_addons.text())
+
+    def test_set_number_of_available_updates_to_nonzero(self):
+        """The string saying that there are available updates should contain the number"""
+        self.wbb.set_number_of_available_updates(42)
+        self.assertIn("42", self.wbb.update_all_addons.text())

AddonManagerTest/gui/test_widget_package_details_view.py

@@ -0,0 +1,141 @@
+# SPDX-License-Identifier: LGPL-2.1-or-later
+# ***************************************************************************
+# *                                                                         *
+# *   Copyright (c) 2025 The FreeCAD project association AISBL              *
+# *                                                                         *
+# *   This file is part of the FreeCAD Addon Manager.                       *
+# *                                                                         *
+# *   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/>.                                      *
+# *                                                                         *
+# ***************************************************************************
+
+"""Tests for the PackageDetailsView widget. Many tests are currently just stubs that ensure the
+code paths are executed so that the CI can find any errors in Python or Qt5/Qt6 compatibility.
+"""
+
+import unittest
+from unittest.mock import patch
+
+from PySideWrapper import QtWidgets
+
+from Widgets.addonmanager_widget_package_details_view import (
+    PackageDetailsView,
+    UpdateInformation,
+    WarningFlags,
+)
+
+
+class TestPackageDetailsView(unittest.TestCase):
+
+    def setUp(self):
+        self.window = QtWidgets.QDialog()
+        self.window.setObjectName("Test Widget Package Details View Window")
+        self.pdv = PackageDetailsView(self.window)
+
+    def tearDown(self):
+        self.window.close()
+        del self.window
+
+    def test_instantiation(self):
+        self.assertIsInstance(self.pdv, PackageDetailsView)
+
+    def test_set_location_to_empty(self):
+        """When location is set empty, the location display is hidden"""
+        self.pdv.set_location(None)
+        self.assertTrue(self.pdv.location_label.isHidden())
+
+    def test_set_location_to_nonempty(self):
+        """When location is set to a string, the display is shown"""
+        self.pdv.set_location("test")
+        self.assertFalse(self.pdv.location_label.isHidden())
+        self.assertIn("test", self.pdv.location_label.text())
+
+    def test_set_url_to_empty(self):
+        """When URL is set empty, the URL display is hidden"""
+        self.pdv.set_url(None)
+        self.assertTrue(self.pdv.url_label.isHidden())
+
+    def test_set_url_to_nonempty(self):
+        """When URL is set to a string, the URL display is shown"""
+        self.pdv.set_url("test")
+        self.assertFalse(self.pdv.url_label.isHidden())
+        self.assertIn("test", self.pdv.url_label.text())
+
+    def test_set_installed_minimal(self):
+        """Exercise the set_installed method with the minimum arguments"""
+        self.pdv.set_installed(True)
+
+    def test_set_installed_full(self):
+        """Exercise the set_installed method with all arguments"""
+        self.pdv.set_installed(True, 1234567.89, "version", "branch")
+
+    @patch("Widgets.addonmanager_widget_package_details_view.PackageDetailsView.set_location")
+    def test_set_installed_false(self, mock_set_location):
+        """When the package is not installed, the location label is un-set"""
+        self.pdv.set_installed(False)
+        mock_set_location.assert_called_with(None)
+
+    def test_set_update_available_true(self):
+        """Not exhaustive, just test the basic call with update available=True"""
+        self.pdv.set_update_available(UpdateInformation(update_available=True))
+
+    def test_set_update_available_false(self):
+        """Not exhaustive, just test the basic call with update_available=False"""
+        self.pdv.set_update_available(UpdateInformation(update_available=False))
+
+    def test_set_disabled_true(self):
+        self.pdv.set_disabled(True)
+
+    def test_set_disabled_false(self):
+        self.pdv.set_disabled(True)
+
+    def test_allow_disabling_true(self):
+        self.pdv.allow_disabling(True)
+
+    def test_allow_disabling_false(self):
+        self.pdv.allow_disabling(False)
+
+    def test_allow_running_true(self):
+        self.pdv.allow_running(True)
+
+    def test_allow_running_false(self):
+        self.pdv.allow_running(False)
+
+    def test_set_warning_flags_obsolete(self):
+        self.pdv.set_warning_flags(WarningFlags(obsolete=True))
+
+    def test_set_warning_flags_py2(self):
+        self.pdv.set_warning_flags(WarningFlags(python2=True))
+
+    def test_set_warning_flags_freecad_version(self):
+        self.pdv.set_warning_flags(WarningFlags(required_freecad_version="99.0"))
+
+    def test_set_warning_flags_non_osi_approved(self):
+        self.pdv.set_warning_flags(WarningFlags(non_osi_approved=True))
+
+    def test_set_warning_flags_non_fsf_libre(self):
+        self.pdv.set_warning_flags(WarningFlags(non_fsf_libre=True))
+
+    def test_set_new_disabled_status_true(self):
+        self.pdv.set_new_disabled_status(True)
+
+    def test_set_new_disabled_status_false(self):
+        self.pdv.set_new_disabled_status(False)
+
+    def test_set_new_branch(self):
+        self.pdv.set_new_branch("test")
+
+    def test_set_updated(self):
+        self.pdv.set_updated()

AddonManagerTest/gui/test_widget_readme_browser.py

@@ -0,0 +1,44 @@
+# SPDX-License-Identifier: LGPL-2.1-or-later
+# ***************************************************************************
+# *                                                                         *
+# *   Copyright (c) 2025 The FreeCAD project association AISBL              *
+# *                                                                         *
+# *   This file is part of the FreeCAD Addon Manager.                       *
+# *                                                                         *
+# *   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 unittest
+from unittest.mock import patch
+
+from PySideWrapper import QtWidgets
+
+from Widgets.addonmanager_widget_readme_browser import WidgetReadmeBrowser
+
+
+class TestWidgetReadmeBrowser(unittest.TestCase):
+    def setUp(self):
+        self.window = QtWidgets.QDialog()
+        self.window.setObjectName("Test Widget Readme Browser Window")
+        self.pdv = WidgetReadmeBrowser(self.window)
+
+    def tearDown(self):
+        self.window.close()
+        del self.window
+
+    def test_instantiation(self):
+        self.assertIsInstance(self.pdv, WidgetReadmeBrowser)