Start on placement test suite for labeling

Sponsored by City of Uster

tests/src/python/CMakeLists.txt

@@ -41,6 +41,7 @@ ADD_PYTHON_TEST(PyQgsExpression test_qgsexpression.py)
 ADD_PYTHON_TEST(PyQgsPalLabelingBase test_qgspallabeling_base.py)
 ADD_PYTHON_TEST(PyQgsPalLabelingCanvas test_qgspallabeling_canvas.py)
 ADD_PYTHON_TEST(PyQgsPalLabelingComposer test_qgspallabeling_composer.py)
+ADD_PYTHON_TEST(PyQgsPalLabelingPlacement test_qgspallabeling_placement.py)
 ADD_PYTHON_TEST(PyQgsVectorFileWriter test_qgsvectorfilewriter.py)
 ADD_PYTHON_TEST(PyQgsZonalStatistics test_qgszonalstatistics.py)
 ADD_PYTHON_TEST(PyQgsDistanceArea test_qgsdistancearea.py)

tests/src/python/test_qgspallabeling_placement.py

@@ -0,0 +1,131 @@
+# -*- coding: utf-8 -*-
+"""QGIS Unit tests for QgsPalLabeling: base suite of render check tests
+
+Class is meant to be inherited by classes that test different labeling outputs
+
+See <qgis-src-dir>/tests/testdata/labeling/README.rst for description.
+
+.. 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__ = 'Nyall Dawson'
+__date__ = '2015-08-24'
+__copyright__ = 'Copyright 2015, The QGIS Project'
+# This will get replaced with a git SHA1 when you do a git archive
+__revision__ = '$Format:%H$'
+
+import qgis
+import os
+import sys
+
+from PyQt4.QtCore import Qt, QPointF, QThreadPool
+from PyQt4.QtGui import QFont
+
+from qgis.core import QgsPalLayerSettings
+
+from utilities import (
+    svgSymbolsPath,
+    getTempfilePath,
+    renderMapToImage,
+    mapSettingsString
+)
+
+from test_qgspallabeling_base import TestQgsPalLabeling, runSuite
+
+
+# noinspection PyPep8Naming
+class TestPlacementBase(TestQgsPalLabeling):
+
+    @classmethod
+    def setUpClass(cls):
+        if not cls._BaseSetup:
+            TestQgsPalLabeling.setUpClass()
+        cls._Pal.setDrawLabelRectOnly(True)
+        cls._Pal.saveEngineSettings()
+
+    @classmethod
+    def tearDownClass(cls):
+        TestQgsPalLabeling.tearDownClass()
+        #avoid crash on finish, probably related to https://bugreports.qt.io/browse/QTBUG-35760
+        QThreadPool.globalInstance().waitForDone()
+
+    def setUp(self):
+        """Run before each test."""
+        super(TestPlacementBase, self).setUp()
+        self.configTest('pal_placement', 'sp')
+        self._TestImage = ''
+        # ensure per test map settings stay encapsulated
+        self._TestMapSettings = self.cloneMapSettings(self._MapSettings)
+        self._Mismatch = 0
+        self._ColorTol = 0
+        self._Mismatches.clear()
+        self._ColorTols.clear()
+
+    def checkTest(self, **kwargs):
+        self.lyr.writeToLayer(self.layer)
+
+        ms = self._MapSettings  # class settings
+        settings_type = 'Class'
+        if self._TestMapSettings is not None:
+            ms = self._TestMapSettings  # per test settings
+            settings_type = 'Test'
+        if 'PAL_VERBOSE' in os.environ:
+            qDebug('MapSettings type: {0}'.format(settings_type))
+            qDebug(mapSettingsString(ms))
+
+        img = renderMapToImage(ms, parallel=False)
+        self._TestImage = getTempfilePath('png')
+        if not img.save(self._TestImage, 'png'):
+            os.unlink(self._TestImage)
+            raise OSError('Failed to save output from map render job')
+        self.saveControlImage(self._TestImage)
+
+        mismatch = 0
+        if 'PAL_NO_MISMATCH' not in os.environ:
+            # some mismatch expected
+            mismatch = self._Mismatch if self._Mismatch else 0
+            if self._TestGroup in self._Mismatches:
+                mismatch = self._Mismatches[self._TestGroup]
+        colortol = 0
+        if 'PAL_NO_COLORTOL' not in os.environ:
+            colortol = self._ColorTol if self._ColorTol else 0
+            if self._TestGroup in self._ColorTols:
+                colortol = self._ColorTols[self._TestGroup]
+        self.assertTrue(*self.renderCheck(mismatch=mismatch,
+                                          colortol=colortol,
+                                          imgpath=self._TestImage))
+
+# noinspection PyPep8Naming
+
+
+class TestPointPlacement(TestPlacementBase):
+
+    @classmethod
+    def setUpClass(cls):
+        TestPlacementBase.setUpClass()
+        cls.layer = None
+
+    def test_point_placement_around(self):
+        # Default point label placement
+        self.layer = TestQgsPalLabeling.loadFeatureLayer('point')
+        self._TestMapSettings = self.cloneMapSettings(self._MapSettings)
+        self.checkTest()
+        self.removeMapLayer(self.layer)
+        self.layer = None
+
+    def test_point_placement_around_obstacle(self):
+        # Default point label placement with obstacle
+        self.layer = TestQgsPalLabeling.loadFeatureLayer('point2')
+        self._TestMapSettings = self.cloneMapSettings(self._MapSettings)
+        self.checkTest()
+        self.removeMapLayer(self.layer)
+        self.layer = None
+
+if __name__ == '__main__':
+    # NOTE: unless PAL_SUITE env var is set all test class methods will be run
+    # SEE: test_qgspallabeling_tests.suiteTests() to define suite
+    suite = ('TestPointPlacement')
+    res = runSuite(sys.modules[__name__], suite)
+    sys.exit(not res.wasSuccessful())