|
| 1 | +# -*- coding: utf-8 -*- |
| 2 | +"""QGIS Unit test utils for offline editing tests. |
| 3 | +
|
| 4 | +.. note:: This program is free software; you can redistribute it and/or modify |
| 5 | +it under the terms of the GNU General Public License as published by |
| 6 | +the Free Software Foundation; either version 2 of the License, or |
| 7 | +(at your option) any later version. |
| 8 | +""" |
| 9 | +from __future__ import print_function |
| 10 | +from builtins import str |
| 11 | +from builtins import object |
| 12 | +__author__ = 'Alessandro Pasotti' |
| 13 | +__date__ = '2016-06-30' |
| 14 | +__copyright__ = 'Copyright 2016, The QGIS Project' |
| 15 | +# This will get replaced with a git SHA1 when you do a git archive |
| 16 | +__revision__ = '$Format:%H$' |
| 17 | + |
| 18 | +from time import sleep |
| 19 | + |
| 20 | +from qgis.core import ( |
| 21 | + QgsFeature, |
| 22 | + QgsGeometry, |
| 23 | + QgsPoint, |
| 24 | + QgsFeatureRequest, |
| 25 | + QgsExpression, |
| 26 | + QgsMapLayerRegistry, |
| 27 | + QgsOfflineEditing, |
| 28 | +) |
| 29 | + |
| 30 | + |
| 31 | +# Tet features, fields: [id, name, geometry] |
| 32 | +# "id" is used as a pk to retriev features by attribute |
| 33 | +TEST_FEATURES = [ |
| 34 | + (1, 'name 1', QgsPoint(9, 45)), |
| 35 | + (2, 'name 2', QgsPoint(9.5, 45.5)), |
| 36 | + (3, 'name 3', QgsPoint(9.5, 46)), |
| 37 | + (4, 'name 4', QgsPoint(10, 46.5)), |
| 38 | +] |
| 39 | + |
| 40 | + |
| 41 | +class OfflineTestBase(object): |
| 42 | + |
| 43 | + """Generic test methods for all online providers""" |
| 44 | + |
| 45 | + def _setUp(self): |
| 46 | + """Called by setUp: run before each test.""" |
| 47 | + # Setup: create some features for the test layer |
| 48 | + features = [] |
| 49 | + layer = self._getLayer('test_point') |
| 50 | + for id, name, geom in TEST_FEATURES: |
| 51 | + f = QgsFeature(layer.pendingFields()) |
| 52 | + f['id'] = id |
| 53 | + f['name'] = name |
| 54 | + f.setGeometry(QgsGeometry.fromPoint(geom)) |
| 55 | + features.append(f) |
| 56 | + layer.dataProvider().addFeatures(features) |
| 57 | + # Add the remote layer |
| 58 | + self.registry = QgsMapLayerRegistry.instance() |
| 59 | + self.registry.removeAllMapLayers() |
| 60 | + assert self.registry.addMapLayer(self._getOnlineLayer('test_point')) is not None |
| 61 | + |
| 62 | + def _tearDown(self): |
| 63 | + """Called by tearDown: run after each test.""" |
| 64 | + # Clear test layers |
| 65 | + self._clearLayer('test_point') |
| 66 | + |
| 67 | + @classmethod |
| 68 | + def _compareFeature(cls, layer, attributes): |
| 69 | + """Compare id, name and geometry""" |
| 70 | + f = cls._getFeatureByAttribute(layer, 'id', attributes[0]) |
| 71 | + return f['name'] == attributes[1] and f.geometry().asPoint().toString() == attributes[2].toString() |
| 72 | + |
| 73 | + @classmethod |
| 74 | + def _clearLayer(cls, layer_name): |
| 75 | + """ |
| 76 | + Delete all features from the backend layer |
| 77 | + """ |
| 78 | + layer = cls._getLayer(layer_name) |
| 79 | + layer.startEditing() |
| 80 | + layer.deleteFeatures([f.id() for f in layer.getFeatures()]) |
| 81 | + layer.commitChanges() |
| 82 | + assert layer.featureCount() == 0 |
| 83 | + |
| 84 | + @classmethod |
| 85 | + def _getLayer(cls, layer_name): |
| 86 | + """ |
| 87 | + Layer factory (return the backend layer), provider specific |
| 88 | + """ |
| 89 | + raise NotImplementedError |
| 90 | + |
| 91 | + @classmethod |
| 92 | + def _getOnlineLayer(cls, type_name, layer_name=None): |
| 93 | + """ |
| 94 | + Layer factory (return the online layer), provider specific |
| 95 | + """ |
| 96 | + raise NotImplementedError |
| 97 | + |
| 98 | + @classmethod |
| 99 | + def _getFeatureByAttribute(cls, layer, attr_name, attr_value): |
| 100 | + """ |
| 101 | + Find the feature and return it, raise exception if not found |
| 102 | + """ |
| 103 | + request = QgsFeatureRequest(QgsExpression("%s=%s" % (attr_name, |
| 104 | + attr_value))) |
| 105 | + try: |
| 106 | + return next(layer.dataProvider().getFeatures(request)) |
| 107 | + except StopIteration: |
| 108 | + raise Exception("Wrong attributes in WFS layer %s" % |
| 109 | + layer.name()) |
| 110 | + |
| 111 | + def test_offlineConversion(self): |
| 112 | + # goes offline |
| 113 | + ol = QgsOfflineEditing() |
| 114 | + online_layer = list(self.registry.mapLayers().values())[0] |
| 115 | + self.assertTrue(online_layer.hasGeometryType()) |
| 116 | + # Check we have 3 features |
| 117 | + self.assertEqual(len([f for f in online_layer.getFeatures()]), len(TEST_FEATURES)) |
| 118 | + self.assertTrue(ol.convertToOfflineProject(self.temp_path, 'offlineDbFile.sqlite', [online_layer.id()])) |
| 119 | + offline_layer = list(self.registry.mapLayers().values())[0] |
| 120 | + self.assertTrue(offline_layer.hasGeometryType()) |
| 121 | + self.assertTrue(offline_layer.isValid()) |
| 122 | + self.assertTrue(offline_layer.name().find('(offline)') > -1) |
| 123 | + self.assertEqual(len([f for f in offline_layer.getFeatures()]), len(TEST_FEATURES)) |
| 124 | + # Edit feature 2 |
| 125 | + feat2 = self._getFeatureByAttribute(offline_layer, 'name', "'name 2'") |
| 126 | + self.assertTrue(offline_layer.startEditing()) |
| 127 | + self.assertTrue(offline_layer.changeAttributeValue(feat2.id(), offline_layer.fieldNameIndex('name'), 'name 2 edited')) |
| 128 | + self.assertTrue(offline_layer.changeGeometry(feat2.id(), QgsGeometry.fromPoint(QgsPoint(33.0, 60.0)))) |
| 129 | + self.assertTrue(offline_layer.commitChanges()) |
| 130 | + feat2 = self._getFeatureByAttribute(offline_layer, 'name', "'name 2 edited'") |
| 131 | + self.assertTrue(ol.isOfflineProject()) |
| 132 | + # Sync |
| 133 | + ol.synchronize() |
| 134 | + # Does anybody know why the sleep is needed? Is that a threaded WFS consequence? |
| 135 | + sleep(1) |
| 136 | + online_layer = list(self.registry.mapLayers().values())[0] |
| 137 | + self.assertTrue(online_layer.isValid()) |
| 138 | + self.assertFalse(online_layer.name().find('(offline)') > -1) |
| 139 | + self.assertEqual(len([f for f in online_layer.getFeatures()]), len(TEST_FEATURES)) |
| 140 | + # Check that data have changed in the backend (raise exception if not found) |
| 141 | + feat2 = self._getFeatureByAttribute(self._getLayer('test_point'), 'name', "'name 2 edited'") |
| 142 | + feat2 = self._getFeatureByAttribute(online_layer, 'name', "'name 2 edited'") |
| 143 | + self.assertEqual(feat2.geometry().asPoint().toString(), QgsPoint(33.0, 60.0).toString()) |
| 144 | + # Check that all other features have not changed |
| 145 | + layer = self._getLayer('test_point') |
| 146 | + self.assertTrue(self._compareFeature(layer, TEST_FEATURES[1 - 1])) |
| 147 | + self.assertTrue(self._compareFeature(layer, TEST_FEATURES[3 - 1])) |
| 148 | + self.assertTrue(self._compareFeature(layer, TEST_FEATURES[4 - 1])) |
| 149 | + |
| 150 | + # Test for regression on double sync (it was a SEGFAULT) |
| 151 | + # goes offline |
| 152 | + ol = QgsOfflineEditing() |
| 153 | + offline_layer = list(self.registry.mapLayers().values())[0] |
| 154 | + # Edit feature 2 |
| 155 | + feat2 = self._getFeatureByAttribute(offline_layer, 'name', "'name 2 edited'") |
| 156 | + self.assertTrue(offline_layer.startEditing()) |
| 157 | + self.assertTrue(offline_layer.changeAttributeValue(feat2.id(), offline_layer.fieldNameIndex('name'), 'name 2')) |
| 158 | + self.assertTrue(offline_layer.changeGeometry(feat2.id(), QgsGeometry.fromPoint(TEST_FEATURES[1][2]))) |
| 159 | + # Edit feat 4 |
| 160 | + feat4 = self._getFeatureByAttribute(offline_layer, 'name', "'name 4'") |
| 161 | + self.assertTrue(offline_layer.changeAttributeValue(feat4.id(), offline_layer.fieldNameIndex('name'), 'name 4 edited')) |
| 162 | + self.assertTrue(offline_layer.commitChanges()) |
| 163 | + # Sync |
| 164 | + ol.synchronize() |
| 165 | + # Does anybody knows why the sleep is needed? Is that a threaded WFS consequence? |
| 166 | + sleep(1) |
| 167 | + online_layer = list(self.registry.mapLayers().values())[0] |
| 168 | + layer = self._getLayer('test_point') |
| 169 | + # Check that data have changed in the backend (raise exception if not found) |
| 170 | + feat4 = self._getFeatureByAttribute(layer, 'name', "'name 4 edited'") |
| 171 | + feat4 = self._getFeatureByAttribute(online_layer, 'name', "'name 4 edited'") |
| 172 | + feat2 = self._getFeatureByAttribute(layer, 'name', "'name 2'") |
| 173 | + feat2 = self._getFeatureByAttribute(online_layer, 'name', "'name 2'") |
| 174 | + # Check that all other features have not changed |
| 175 | + layer = self._getLayer('test_point') |
| 176 | + self.assertTrue(self._compareFeature(layer, TEST_FEATURES[1 - 1])) |
| 177 | + self.assertTrue(self._compareFeature(layer, TEST_FEATURES[2 - 1])) |
| 178 | + self.assertTrue(self._compareFeature(layer, TEST_FEATURES[3 - 1])) |
0 commit comments