Move layout checking to base class

python/testing/__init__.py

@@ -35,7 +35,8 @@
     QDateTime,
     QDate,
     QDir,
-    QUrl
+    QUrl,
+    QSize
 )
 from qgis.PyQt.QtGui import (
     QImage,
@@ -49,8 +50,10 @@
     QgsVectorLayer,
     QgsRenderChecker,
     QgsMultiRenderChecker,
-    QgsMapSettings
+    QgsMapSettings,
+    QgsLayout
 )
+from qgslayoutchecker import QgsLayoutChecker
 
 import unittest
 
@@ -113,7 +116,7 @@ def image_check(cls,
                     image: QImage,
                     control_name=None,
                     color_tolerance: int = 2,
-                    allowed_mismatch: int = 20):
+                    allowed_mismatch: int = 20) -> bool:
         temp_dir = QDir.tempPath() + '/'
         file_name = temp_dir + name + ".png"
         image.save(file_name, "PNG")
@@ -136,7 +139,7 @@ def render_map_settings_check(cls,
                                   reference_image: str,
                                   map_settings: QgsMapSettings,
                                   color_tolerance: Optional[int] = None,
-                                  allowed_mismatch: Optional[int] = None):
+                                  allowed_mismatch: Optional[int] = None) -> bool:
         checker = QgsMultiRenderChecker()
         checker.setMapSettings(map_settings)
 
@@ -152,6 +155,23 @@ def render_map_settings_check(cls,
 
         return result
 
+    @classmethod
+    def render_layout_check(cls,
+                            name: str,
+                            layout: QgsLayout,
+                            size: QSize,
+                            dpi: Optional[float] = 192) -> bool:
+        checker = QgsLayoutChecker(name, layout)
+        checker.dots_per_meter = dpi / 25.4 * 1000
+        checker.size = size
+        if cls.control_path_prefix():
+            checker.setControlPathPrefix(cls.control_path_prefix())
+        result, message = checker.testLayout()
+        if not result:
+            cls.report += "<h2>Render {}</h2>\n".format(name)
+            cls.report += checker.report()
+        return result
+
     def assertLayersEqual(self, layer_expected, layer_result, **kwargs):
         """
         :param layer_expected: The first layer to compare

tests/src/python/test_qgsannotation.py

@@ -36,7 +36,6 @@
 from qgis.gui import QgsFormAnnotation
 from qgis.testing import start_app, unittest
 
-from qgslayoutchecker import QgsLayoutChecker
 from utilities import unitTestDataPath
 
 start_app()
@@ -307,14 +306,12 @@ def renderAnnotationInLayout(self, test_name, annotation):
         annotation.setHasFixedMapPosition(True)
         pr.annotationManager().addAnnotation(annotation)
 
-        checker = QgsLayoutChecker(
-            test_name, l)
-        checker.dots_per_meter = 2 * 96 / 25.4 * 1000
-        checker.size = QSize(1122 * 2, 794 * 2)
-        checker.setControlPathPrefix("annotations")
-        result, message = checker.testLayout()
-        self.report += checker.report()
-        return result
+        return self.render_layout_check(
+            test_name,
+            layout=l,
+            size=QSize(1122 * 2, 794 * 2),
+            dpi=192
+        )
 
 
 if __name__ == '__main__':