Add test for the relation widget registry

qgis · Jan 7, 2021 · e786da8 · e786da8
1 parent bb7f411
commit e786da8
Show file tree

Hide file tree

Showing 2 changed files with 135 additions and 0 deletions.
diff --git a/tests/src/python/CMakeLists.txt b/tests/src/python/CMakeLists.txt
@@ -341,6 +341,7 @@ ADD_PYTHON_TEST(PyQgsFieldValidator test_qgsfieldvalidator.py)
 ADD_PYTHON_TEST(PyQgsPluginDependencies test_plugindependencies.py)
 ADD_PYTHON_TEST(PyQgsDBManagerSQLWindow test_db_manager_sql_window.py)
 ADD_PYTHON_TEST(PyQgsSelectiveMasking test_selective_masking.py)
+ADD_PYTHON_TEST(PyQgsRelationEditorWidgetRegistry test_qgsrelationeditorwidgetregistry.py)
 
 if (NOT WIN32)
   ADD_PYTHON_TEST(PyQgsLogger test_qgslogger.py)

diff --git a/tests/src/python/test_qgsrelationeditorwidgetregistry.py b/tests/src/python/test_qgsrelationeditorwidgetregistry.py
@@ -0,0 +1,134 @@
+# -*- coding: utf-8 -*-
+"""QGIS Unit tests for edit widgets.
+
+.. note:: This program is free software; you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation; either version 2 of the License, or
+(at your option) any later version.
+"""
+__author__ = 'Matthias Kuhn'
+__date__ = '28/11/2015'
+__copyright__ = 'Copyright 2015, The QGIS Project'
+
+import qgis  # NOQA
+
+import os
+
+from qgis.core import (
+    QgsRelation,
+    QgsVectorLayerTools,
+)
+
+from qgis.gui import (
+    QgsGui,
+    QgsAbstractRelationEditorWidget,
+    QgsAbstractRelationEditorConfigWidget,
+    QgsAbstractRelationEditorWidgetFactory,
+    QgsRelationEditorWidget,
+    QgsRelationEditorConfigWidget,
+    QgsAttributeEditorContext,
+    QgsAdvancedDigitizingDockWidget
+)
+
+from qgis.PyQt.QtCore import QTimer
+from qgis.PyQt.QtWidgets import (
+    QToolButton,
+    QMessageBox,
+    QDialogButtonBox,
+    QTableView,
+    QDialog,
+    QLabel,
+    QGridLayout,
+    QCheckBox,
+)
+from qgis.testing import start_app, unittest
+
+start_app()
+
+
+class TestQgsRelationEditorWidgetRegistry(unittest.TestCase):
+
+    @classmethod
+    def setUpClass(cls):
+        """
+        Setup the involved layers and relations for a n:m relation
+        :return:
+        """
+        cls.registry = QgsGui.relationWidgetRegistry()
+
+    def test_cannot_delete_relation_editor(self):
+        count_before = len(self.registry.relationWidgetNames())
+        self.registry.removeRelationWidget('relation_editor')
+        count_after = len(self.registry.relationWidgetNames())
+
+        self.assertEqual(count_before, count_after)
+        self.assertIsInstance(self.registry.create('relation_editor', {}), QgsRelationEditorWidget)
+        self.assertIsInstance(self.registry.createConfigWidget('relation_editor', QgsRelation()), QgsRelationEditorConfigWidget)
+
+    def test_returns_none_when_unknown_widget_id(self):
+        self.assertIsNone(self.registry.create('babinatatitrunkina', {}))
+        self.assertIsNone(self.registry.createConfigWidget('babinatatitrunkina', QgsRelation()))
+
+    def test_creates_new_widget(self):
+        # define the widget
+        class QgsExampleRelationEditorWidget(QgsAbstractRelationEditorWidget):
+
+            def __init__(self, config, parent):
+                super().__init__(config, parent)
+
+                self.setLayout(QGridLayout())
+                self.label = QLabel()
+                self.label.setText(f'According to the configuration, the checkboxin state was {str(config.get("checkboxin", "Unknown"))}')
+                self.layout().addWidget(self.label)
+
+            def config(self):
+                return {
+
+                }
+
+            def setConfig(self, config):
+                self.label.setText(f'According to the configuration, the checkboxin state was {str(config.get("checkboxin", "Unknown"))}')
+
+        # define the config widget
+        class QgsExampleRelationEditorConfigWidget(QgsAbstractRelationEditorConfigWidget):
+
+            def __init__(self, relation, parent):
+                super().__init__(relation, parent)
+
+                self.setLayout(QGridLayout())
+                self.checkbox = QCheckBox('Is this checkbox checkboxin?')
+                self.layout().addWidget(self.checkbox)
+
+            def config(self):
+                return {
+                    "checkboxin": self.checkbox.isChecked()
+                }
+
+            def setConfig(self, config):
+                self.checkbox.setChecked(config.get('checkboxin', False))
+
+        # define the widget factory
+        class QgsExampleRelationEditorWidgetFactory(QgsAbstractRelationEditorWidgetFactory):
+            def type(self):
+                return "example"
+
+            def name(self):
+                return "Example Relation Widget"
+
+            def create(self, config, parent):
+                return QgsExampleRelationEditorWidget(config, parent)
+
+            def configWidget(self, relation, parent):
+                return QgsExampleRelationEditorConfigWidget(relation, parent)
+
+        self.assertIsNone(self.registry.create('example', {}))
+        self.assertIsNone(self.registry.createConfigWidget('example', QgsRelation()))
+
+        self.registry.addRelationWidget(QgsExampleRelationEditorWidgetFactory())
+
+        self.assertIsInstance(self.registry.create('example', {}), QgsExampleRelationEditorWidget)
+        self.assertIsInstance(self.registry.createConfigWidget('example', QgsRelation()), QgsExampleRelationEditorConfigWidget)
+
+
+if __name__ == '__main__':
+    unittest.main()