Merge pull request #4268 from alexbruy/scripts-tests

[processing] support for scripts in the test suite
qgis · Mar 16, 2017 · e950b7b · e950b7b
2 parents 3bcf287 + e1b1465
commit e950b7b
Show file tree

Hide file tree

Showing 10 changed files with 196 additions and 2 deletions.
diff --git a/python/plugins/processing/tests/AlgorithmsTestBase.py b/python/plugins/processing/tests/AlgorithmsTestBase.py
@@ -45,6 +45,9 @@
 from numpy import nan_to_num
 
 import processing
+
+from processing.script.ScriptAlgorithm import ScriptAlgorithm  # NOQA
+
 from processing.modeler.ModelerAlgorithmProvider import ModelerAlgorithmProvider  # NOQA
 from processing.algs.qgis.QGISAlgorithmProvider import QGISAlgorithmProvider  # NOQA
 from processing.algs.grass7.Grass7AlgorithmProvider import Grass7AlgorithmProvider  # NOQA
@@ -90,7 +93,11 @@ def check_algorithm(self, name, defs):
 
         params = self.load_params(defs['params'])
 
-        alg = processing.Processing.getAlgorithm(defs['algorithm']).getCopy()
+        if defs['algorithm'].startswith('script:'):
+            filePath = os.path.join(processingTestDataPath(), 'scripts', '{}.py'.format(defs['algorithm'][len('script:'):]))
+            alg = ScriptAlgorithm(filePath)
+        else:
+            alg = processing.Processing.getAlgorithm(defs['algorithm']).getCopy()
 
         if isinstance(params, list):
             for param in zip(alg.parameters, params):

diff --git a/python/plugins/processing/tests/CMakeLists.txt b/python/plugins/processing/tests/CMakeLists.txt
@@ -11,6 +11,7 @@ IF(ENABLE_TESTS)
   ADD_PYTHON_TEST(ProcessingToolsTest ToolsTest.py)
   ADD_PYTHON_TEST(ProcessingQgisAlgorithmsTest QgisAlgorithmsTest.py)
   ADD_PYTHON_TEST(ProcessingGdalAlgorithmsTest GdalAlgorithmsTest.py)
+  ADD_PYTHON_TEST(ProcessingScriptAlgorithmsTest ScriptAlgorithmsTest.py)
   ADD_PYTHON_TEST(ProcessingGrass7AlgorithmsImageryTest Grass7AlgorithmsImageryTest.py)
   ADD_PYTHON_TEST(ProcessingGrass7AlgorithmsRasterTest Grass7AlgorithmsRasterTest.py)
 ENDIF(ENABLE_TESTS)
diff --git a/python/plugins/processing/tests/README.md b/python/plugins/processing/tests/README.md
@@ -54,6 +54,11 @@ The above translates to
       name: expected/polys_densify.gml
 ```
 
+It is also possible to create tests for Processing scripts. Scripts
+should be placed in the `scrips` subdirectory in the test data directory
+`python/plugins/processing/tests/testdata/`. Script file name
+should match script algorithm name.
+
 Params and results
 ------------------
 
@@ -163,7 +168,7 @@ OUTPUT:
   type: rasterhash
   hash: f1fedeb6782f9389cf43590d4c85ada9155ab61fef6dc285aaeb54d6
 ```
-      
+
 #### Files
 
 You can compare the content of an output file by an expected result reference file

diff --git a/python/plugins/processing/tests/ScriptAlgorithmsTest.py b/python/plugins/processing/tests/ScriptAlgorithmsTest.py
@@ -0,0 +1,55 @@
+# -*- coding: utf-8 -*-
+
+"""
+***************************************************************************
+    ScriptAlgorithmsTests.py
+    ---------------------
+    Date                 : March 2017
+    Copyright            : (C) 2017 by Alexander Bruy
+    Email                : alexander dot bruy at gmail dot com
+***************************************************************************
+*                                                                         *
+*   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__ = 'Alexander Bruy'
+__date__ = 'March 2017'
+__copyright__ = '(C) 2017, Alexander Bruy'
+
+# This will get replaced with a git SHA1 when you do a git archive
+
+__revision__ = ':%H$'
+
+import AlgorithmsTestBase
+
+import nose2
+import shutil
+
+from qgis.testing import start_app, unittest
+
+
+class TestScriptAlgorithms(unittest.TestCase, AlgorithmsTestBase.AlgorithmsTest):
+
+    @classmethod
+    def setUpClass(cls):
+        start_app()
+        from processing.core.Processing import Processing
+        Processing.initialize()
+        cls.cleanup_paths = []
+
+    @classmethod
+    def tearDownClass(cls):
+        for path in cls.cleanup_paths:
+            shutil.rmtree(path)
+
+    def test_definition_file(self):
+        return 'script_algorithm_tests.yaml'
+
+
+if __name__ == '__main__':
+    nose2.main()
diff --git a/python/plugins/processing/tests/testdata/expected/selected_points.gfs b/python/plugins/processing/tests/testdata/expected/selected_points.gfs
@@ -0,0 +1,26 @@
+<GMLFeatureClassList>
+  <GMLFeatureClass>
+    <Name>selected_points</Name>
+    <ElementPath>selected_points</ElementPath>
+    <!--POINT-->
+    <GeometryType>1</GeometryType>
+    <SRSName>EPSG:4326</SRSName>
+    <DatasetSpecificInfo>
+      <FeatureCount>2</FeatureCount>
+      <ExtentXMin>1.00000</ExtentXMin>
+      <ExtentXMax>5.00000</ExtentXMax>
+      <ExtentYMin>1.00000</ExtentYMin>
+      <ExtentYMax>2.00000</ExtentYMax>
+    </DatasetSpecificInfo>
+    <PropertyDefn>
+      <Name>id</Name>
+      <ElementPath>id</ElementPath>
+      <Type>Integer</Type>
+    </PropertyDefn>
+    <PropertyDefn>
+      <Name>id2</Name>
+      <ElementPath>id2</ElementPath>
+      <Type>Integer</Type>
+    </PropertyDefn>
+  </GMLFeatureClass>
+</GMLFeatureClassList>
diff --git a/python/plugins/processing/tests/testdata/expected/selected_points.gml b/python/plugins/processing/tests/testdata/expected/selected_points.gml
@@ -0,0 +1,28 @@
+<?xml version="1.0" encoding="utf-8" ?>
+<ogr:FeatureCollection
+     xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+     xsi:schemaLocation=""
+     xmlns:ogr="http://ogr.maptools.org/"
+     xmlns:gml="http://www.opengis.net/gml">
+  <gml:boundedBy>
+    <gml:Box>
+      <gml:coord><gml:X>1</gml:X><gml:Y>1</gml:Y></gml:coord>
+      <gml:coord><gml:X>5</gml:X><gml:Y>2</gml:Y></gml:coord>
+    </gml:Box>
+  </gml:boundedBy>
+
+  <gml:featureMember>
+    <ogr:selected_points fid="points.0">
+      <ogr:geometryProperty><gml:Point srsName="EPSG:4326"><gml:coordinates>1,1</gml:coordinates></gml:Point></ogr:geometryProperty>
+      <ogr:id>1</ogr:id>
+      <ogr:id2>2</ogr:id2>
+    </ogr:selected_points>
+  </gml:featureMember>
+  <gml:featureMember>
+    <ogr:selected_points fid="points.3">
+      <ogr:geometryProperty><gml:Point srsName="EPSG:4326"><gml:coordinates>5,2</gml:coordinates></gml:Point></ogr:geometryProperty>
+      <ogr:id>4</ogr:id>
+      <ogr:id2>2</ogr:id2>
+    </ogr:selected_points>
+  </gml:featureMember>
+</ogr:FeatureCollection>
diff --git a/python/plugins/processing/tests/testdata/qgis_algorithm_tests.yaml b/python/plugins/processing/tests/testdata/qgis_algorithm_tests.yaml
@@ -2514,3 +2514,14 @@ tests:
       MIN_DISTANCE: 0.0
       POINT_NUMBER: 5
     results: {}
+
+  - algorithm: script:selectbyattribute
+    name: Select by attribute
+    params:
+      INPUT_LAYER:
+        name: points.gml
+        type: vector
+    results:
+      OUTPUT_LAYER:
+        name: expected/selected_points.gml
+        type: vector
diff --git a/python/plugins/processing/tests/testdata/script_algorithm_tests.yaml b/python/plugins/processing/tests/testdata/script_algorithm_tests.yaml
@@ -0,0 +1,16 @@
+# See ../README.md for a description of the file format
+
+tests:
+  - algorithm: script:centroids
+    name: Centroids script test
+    params:
+      INPUT_LAYER:
+        name: polys.gml
+        type: vector
+    results:
+      OUTPUT_LAYER:
+        name: expected/centroid_polys.gml
+        type: vector
+        compare:
+          geometry:
+            precision: 7
diff --git a/python/plugins/processing/tests/testdata/scripts/centroids.py b/python/plugins/processing/tests/testdata/scripts/centroids.py
@@ -0,0 +1,29 @@
+##Centroids=name
+##Geometry=group
+##INPUT_LAYER=vector
+##OUTPUT_LAYER=output vector
+
+from qgis.core import QgsWkbTypes, QgsGeometry
+
+from processing.tools.vector import VectorWriter
+
+layer = processing.getObject(INPUT_LAYER)
+fields = layer.fields()
+
+writer = VectorWriter(OUTPUT_LAYER, 'utf-8', fields, QgsWkbTypes.Point, layer.crs())
+
+features = processing.features(layer)
+count = len(features)
+if count == 0:
+    raise GeoAlgorithmExecutionException('Input layer contains no features.')
+
+total = 100.0 / len(features)
+
+for count, f in enumerate(features):
+    outputFeature = f
+    if f.hasGeometry():
+        outputGeometry = f.geometry().centroid()
+        outputFeature.setGeometry(outputGeometry)
+
+    writer.addFeature(outputFeature)
+    feedback.setProgress(int(count * total))
diff --git a/python/plugins/processing/tests/testdata/scripts/selectbyattribute.py b/python/plugins/processing/tests/testdata/scripts/selectbyattribute.py
@@ -0,0 +1,16 @@
+##Select by attribute=name
+##Tests=group
+##INPUT_LAYER=vector
+##OUTPUT_LAYER=output vector
+
+import processing
+
+result = processing.runalg("qgis:selectbyattribute",
+                           INPUT_LAYER,
+                           "id2",
+                           0,
+                           "2")
+
+processing.runalg("qgis:saveselectedfeatures",
+                  result["OUTPUT"],
+                  OUTPUT_LAYER)