Merge pull request #61833 from nyalldawson/conformance

Add conformance tests for algorithm descriptions

Author: troopa81

python/plugins/processing/algs/qgis/ImportIntoSpatialite.py

@@ -141,7 +141,7 @@ def displayName(self):
         return self.tr("Export to SpatiaLite")
 
     def shortDescription(self):
-        return self.tr("Exports a vector layer to a SpatiaLite database")
+        return self.tr("Exports a vector layer to a SpatiaLite database.")
 
     def tags(self):
         return self.tr("import,table,layer,into,copy").split(",")

python/plugins/processing/algs/qgis/PostGISExecuteAndLoadSQL.py

@@ -97,7 +97,7 @@ def displayName(self):
 
     def shortDescription(self):
         return self.tr(
-            "Executes a SQL command on a PostgreSQL database and loads the result as a table"
+            "Executes a SQL command on a PostgreSQL database and loads the result as a table."
         )
 
     def tags(self):

python/plugins/processing/tests/AlgorithmsTestBase.py

@@ -555,6 +555,235 @@ def check_algorithm(self, alg):
         # check that calling helpUrl() works without error
         alg.helpUrl()
 
+        if alg.provider().id() in ("qgis", "native", "3d"):
+            if alg.id() not in ("qgis:rectanglesovalsdiamondsvariable",):
+                self.assertTrue(
+                    alg.shortHelpString(),
+                    f"Algorithm {alg.id()} has not shortHelpString!",
+                )
+
+            if alg.id() not in (
+                "native:addhistorymetadata",
+                "native:adduniquevalueindexfield",
+                "native:bufferbym",
+                "native:convertgpsdata",
+                "native:convertgpxfeaturetype",
+                "native:converttocurves",
+                "native:copylayermetadata",
+                "native:creategrid",
+                "native:createpointslayerfromtable",
+                "native:createrandombinomialrasterlayer",
+                "native:createrandomexponentialrasterlayer",
+                "native:createrandomgammarasterlayer",
+                "native:createrandomgeometricrasterlayer",
+                "native:createrandomnegativebinomialrasterlayer",
+                "native:createrandomnormalrasterlayer",
+                "native:createrandompoissonrasterlayer",
+                "native:createrandomuniformrasterlayer",
+                "native:createspatialindex",
+                "native:deleteholes",
+                "native:downloadgpsdata",
+                "native:dtmslopebasedfilter",
+                "native:equaltofrequency",
+                "native:explodehstorefield",
+                "native:exportaddgeometrycolumns",
+                "native:exportlayermetadata",
+                "native:exportlayersinformation",
+                "native:exporttospreadsheet",
+                "native:extenttolayer",
+                "native:extractbyattribute",
+                "native:extractbyexpression",
+                "native:extractbyextent",
+                "native:extractbylocation",
+                "native:extractspecificvertices",
+                "native:extractvertices",
+                "native:fieldcalculator",
+                "native:fillnodata",
+                "native:fillsinkswangliu",
+                "native:filter",
+                "native:filterverticesbym",
+                "native:filterverticesbyz",
+                "native:fixgeometries",
+                "native:fuzzifyrastergaussianmembership",
+                "native:fuzzifyrasterlargemembership",
+                "native:fuzzifyrasterlinearmembership",
+                "native:fuzzifyrasternearmembership",
+                "native:fuzzifyrasterpowermembership",
+                "native:fuzzifyrastersmallmembership",
+                "native:generateelevationprofileimage",
+                "native:generatepointspixelcentroidsinsidepolygons",
+                "native:geometrybyexpression",
+                "native:gltftovector",
+                "native:greaterthanfrequency",
+                "native:highestpositioninrasterstack",
+                "native:hillshade",
+                "native:importphotos",
+                "native:intersection",
+                "native:joinattributestable",
+                "native:keepnbiggestparts",
+                "native:kmeansclustering",
+                "native:lessthanfrequency",
+                "native:linedensity",
+                "native:lineintersections",
+                "native:loadlayer",
+                "native:lowestpositioninrasterstack",
+                "native:meancoordinates",
+                "native:mergelines",
+                "native:minimumenclosingcircle",
+                "native:modelerrastercalc",
+                "native:modelervirtualrastercalc",
+                "native:multidifference",
+                "native:multiintersection",
+                "native:multiparttosingleparts",
+                "native:multiringconstantbuffer",
+                "native:multiunion",
+                "native:nearestneighbouranalysis",
+                "native:orderbyexpression",
+                "native:orientedminimumboundingbox",
+                "native:orthogonalize",
+                "native:package",
+                "native:pointonsurface",
+                "native:pointstopath",
+                "native:pointtolayer",
+                "native:poleofinaccessibility",
+                "native:polygonfromlayerextent",
+                "native:polygonize",
+                "native:projectpointcartesian",
+                "native:promotetomulti",
+                "native:randomextract",
+                "native:randompointsinextent",
+                "native:randompointsinpolygons",
+                "native:randompointsonlines",
+                "native:rastercalc",
+                "native:rasterlayerproperties",
+                "native:rasterlayerstatistics",
+                "native:rasterlayeruniquevaluesreport",
+                "native:rasterrank",
+                "native:reclassifybylayer",
+                "native:reclassifybytable",
+                "native:rectanglesovalsdiamonds",
+                "native:refactorfields",
+                "native:removeduplicatevertices",
+                "native:removenullgeometries",
+                "native:renamelayer",
+                "native:reprojectlayer",
+                "native:rescaleraster",
+                "native:rotatefeatures",
+                "native:roundrastervalues",
+                "native:ruggednessindex",
+                "native:savefeatures",
+                "native:saveselectedfeatures",
+                "native:segmentizebymaxangle",
+                "native:segmentizebymaxdistance",
+                "native:selectbylocation",
+                "native:serviceareafromlayer",
+                "native:serviceareafrompoint",
+                "native:setlayermetadata",
+                "native:setmetadatafields",
+                "native:setmvalue",
+                "native:setzvalue",
+                "native:shortestline",
+                "native:shortestpathlayertopoint",
+                "native:shortestpathpointtolayer",
+                "native:shortestpathpointtopoint",
+                "native:simplifygeometries",
+                "native:singlesidedbuffer",
+                "native:slope",
+                "native:smoothgeometry",
+                "native:snapgeometries",
+                "native:snappointstogrid",
+                "native:spatialiteexecutesqlregistered",
+                "native:splitvectorlayer",
+                "native:splitwithlines",
+                "native:stringconcatenation",
+                "native:subdivide",
+                "native:sumlinelengths",
+                "native:surfacetopolygon",
+                "native:swapxy",
+                "native:symmetricaldifference",
+                "native:taperedbuffer",
+                "native:tilesxyzdirectory",
+                "native:tilesxyzmbtiles",
+                "native:transect",
+                "native:translategeometry",
+                "native:truncatetable",
+                "native:union",
+                "native:updatelayermetadata",
+                "native:uploadgpsdata",
+                "native:virtualrastercalc",
+                "native:voronoipolygons",
+                "native:wedgebuffers",
+                "native:writevectortiles_mbtiles",
+                "native:writevectortiles_xyz",
+                "native:zonalhistogram",
+                "native:zonalstatisticsfb",
+                "qgis:advancedpythonfieldcalculator",
+                "qgis:barplot",
+                "qgis:boxplot",
+                "qgis:distancematrix",
+                "qgis:distancetonearesthublinetohub",
+                "qgis:distancetonearesthubpoints",
+                "qgis:eliminateselectedpolygons",
+                "qgis:executesql",
+                "qgis:findprojection",
+                "qgis:generatepointspixelcentroidsalongline",
+                "qgis:heatmapkerneldensityestimation",
+                "qgis:hypsometriccurves",
+                "qgis:idwinterpolation",
+                "qgis:linestopolygons",
+                "qgis:listuniquevalues",
+                "qgis:meanandstandarddeviationplot",
+                "qgis:minimumboundinggeometry",
+                "qgis:pointsdisplacement",
+                "qgis:polarplot",
+                "qgis:randomextractwithinsubsets",
+                "qgis:randompointsalongline",
+                "qgis:randompointsinlayerbounds",
+                "qgis:randompointsinsidepolygons",
+                "qgis:randomselection",
+                "qgis:randomselectionwithinsubsets",
+                "qgis:rastercalculator",
+                "qgis:rasterlayerhistogram",
+                "qgis:rectanglesovalsdiamondsvariable",
+                "qgis:regularpoints",
+                "qgis:relief",
+                "qgis:scatter3dplot",
+                "qgis:selectbyattribute",
+                "qgis:selectbyexpression",
+                "qgis:setstyleforrasterlayer",
+                "qgis:setstyleforvectorlayer",
+                "qgis:statisticsbycategories",
+                "qgis:texttofloat",
+                "qgis:tininterpolation",
+                "qgis:topologicalcoloring",
+                "qgis:variabledistancebuffer",
+                "qgis:vectorlayerhistogram",
+                "qgis:vectorlayerscatterplot",
+            ):
+                self.assertTrue(
+                    alg.shortDescription(),
+                    f"Algorithm {alg.id()} has not shortDescription!",
+                )
+                self.assertTrue(
+                    alg.shortDescription()[0].isupper(),
+                    f'Algorithm {alg.id()} shortDescription does not start with capital! "{alg.shortDescription()}"',
+                )
+                self.assertEqual(
+                    alg.shortDescription()[-1],
+                    ".",
+                    f'Algorithm {alg.id()} shortDescription does not end with full stop "{alg.shortDescription()}"',
+                )
+                first_word = alg.shortDescription().split(" ")[0]
+                self.assertEqual(
+                    first_word[-1],
+                    "s",
+                    f'Algorithm {alg.id()} shortDescription should start with a verb ending in s, eg "Combines", "Creates",... "{alg.shortDescription()}"',
+                )
+                self.assertFalse(
+                    "</" in alg.shortDescription(),
+                    f'Algorithm {alg.id()} shortDescription should not contain any HTML formatting "{alg.shortDescription()}"',
+                )
+
 
 if __name__ == "__main__":
     nose2.main()

src/analysis/processing/qgsalgorithmcheckgeometryangle.cpp

@@ -37,7 +37,7 @@ QString QgsGeometryCheckAngleAlgorithm::displayName() const
 
 QString QgsGeometryCheckAngleAlgorithm::shortDescription() const
 {
-  return QObject::tr( "Detect angles smaller than a given angle" );
+  return QObject::tr( "Detects angles smaller than a given angle." );
 }
 
 QStringList QgsGeometryCheckAngleAlgorithm::tags() const

src/analysis/processing/qgsalgorithmcheckgeometryarea.cpp

@@ -37,10 +37,9 @@ QString QgsGeometryCheckAreaAlgorithm::displayName() const
 
 QString QgsGeometryCheckAreaAlgorithm::shortDescription() const
 {
-  return QObject::tr( "Detect polygons smaller than a given area" );
+  return QObject::tr( "Detects polygons smaller than a given area." );
 }
 
-
 QStringList QgsGeometryCheckAreaAlgorithm::tags() const
 {
   return QObject::tr( "check,geometry,area" ).split( ',' );

src/analysis/processing/qgsalgorithmcheckgeometrycontained.cpp

@@ -37,7 +37,7 @@ QString QgsGeometryCheckContainedAlgorithm::displayName() const
 
 QString QgsGeometryCheckContainedAlgorithm::shortDescription() const
 {
-  return QObject::tr( "Detect features contained inside polygons from a list of polygon layers" );
+  return QObject::tr( "Detects features contained inside polygons from a list of polygon layers." );
 }
 
 QStringList QgsGeometryCheckContainedAlgorithm::tags() const

src/analysis/processing/qgsalgorithmcheckgeometrydangle.cpp

@@ -37,7 +37,7 @@ QString QgsGeometryCheckDangleAlgorithm::displayName() const
 
 QString QgsGeometryCheckDangleAlgorithm::shortDescription() const
 {
-  return QObject::tr( "Detect lines with a dangle end" );
+  return QObject::tr( "Detects lines with a dangle end." );
 }
 
 QStringList QgsGeometryCheckDangleAlgorithm::tags() const

src/analysis/processing/qgsalgorithmcheckgeometrydegeneratepolygon.cpp

@@ -36,7 +36,7 @@ QString QgsGeometryCheckDegeneratePolygonAlgorithm::displayName() const
 
 QString QgsGeometryCheckDegeneratePolygonAlgorithm::shortDescription() const
 {
-  return QObject::tr( "Detect polygons with less than 3 points" );
+  return QObject::tr( "Detects polygons with less than 3 points." );
 }
 
 QStringList QgsGeometryCheckDegeneratePolygonAlgorithm::tags() const

src/analysis/processing/qgsalgorithmcheckgeometryduplicate.cpp

@@ -37,7 +37,7 @@ QString QgsGeometryCheckDuplicateAlgorithm::displayName() const
 
 QString QgsGeometryCheckDuplicateAlgorithm::shortDescription() const
 {
-  return QObject::tr( "Detect duplicate geometries" );
+  return QObject::tr( "Detects duplicate geometries." );
 }
 
 QStringList QgsGeometryCheckDuplicateAlgorithm::tags() const

src/analysis/processing/qgsalgorithmcheckgeometryduplicatenodes.cpp

@@ -37,7 +37,7 @@ QString QgsGeometryCheckDuplicateNodesAlgorithm::displayName() const
 
 QString QgsGeometryCheckDuplicateNodesAlgorithm::shortDescription() const
 {
-  return QObject::tr( "Detect duplicated vertices in line and polygon geometries" );
+  return QObject::tr( "Detects duplicated vertices in line and polygon geometries." );
 }
 
 QStringList QgsGeometryCheckDuplicateNodesAlgorithm::tags() const

src/analysis/processing/qgsalgorithmcheckgeometryfollowboundaries.cpp

@@ -37,7 +37,7 @@ QString QgsGeometryCheckFollowBoundariesAlgorithm::displayName() const
 
 QString QgsGeometryCheckFollowBoundariesAlgorithm::shortDescription() const
 {
-  return QObject::tr( "Detect polygons that do not follow boundaries defined by a reference polygon layer" );
+  return QObject::tr( "Detects polygons that do not follow boundaries defined by a reference polygon layer." );
 }
 
 QStringList QgsGeometryCheckFollowBoundariesAlgorithm::tags() const

src/analysis/processing/qgsalgorithmcheckgeometrygap.cpp

@@ -37,7 +37,7 @@ QString QgsGeometryCheckGapAlgorithm::displayName() const
 
 QString QgsGeometryCheckGapAlgorithm::shortDescription() const
 {
-  return QObject::tr( "Detect gaps between polygons smaller than a given area" );
+  return QObject::tr( "Detects gaps between polygons smaller than a given area." );
 }
 
 QStringList QgsGeometryCheckGapAlgorithm::tags() const

src/analysis/processing/qgsalgorithmcheckgeometryhole.cpp

@@ -37,7 +37,7 @@ QString QgsGeometryCheckHoleAlgorithm::displayName() const
 
 QString QgsGeometryCheckHoleAlgorithm::shortDescription() const
 {
-  return QObject::tr( "Detect holes inside polygons" );
+  return QObject::tr( "Detects holes inside polygons." );
 }
 
 QStringList QgsGeometryCheckHoleAlgorithm::tags() const

src/analysis/processing/qgsalgorithmcheckgeometrylineintersection.cpp

@@ -37,7 +37,7 @@ QString QgsGeometryCheckLineIntersectionAlgorithm::displayName() const
 
 QString QgsGeometryCheckLineIntersectionAlgorithm::shortDescription() const
 {
-  return QObject::tr( "Detect intersections between different lines" );
+  return QObject::tr( "Detects intersections between different lines." );
 }
 
 QStringList QgsGeometryCheckLineIntersectionAlgorithm::tags() const

src/analysis/processing/qgsalgorithmcheckgeometrylinelayerintersection.cpp

@@ -37,7 +37,7 @@ QString QgsGeometryCheckLineLayerIntersectionAlgorithm::displayName() const
 
 QString QgsGeometryCheckLineLayerIntersectionAlgorithm::shortDescription() const
 {
-  return QObject::tr( "Detect lines intersecting features from another layer" );
+  return QObject::tr( "Detects lines intersecting features from another layer." );
 }
 
 QStringList QgsGeometryCheckLineLayerIntersectionAlgorithm::tags() const

src/analysis/processing/qgsalgorithmcheckgeometrymissingvertex.cpp

@@ -37,7 +37,7 @@ QString QgsGeometryCheckMissingVertexAlgorithm::displayName() const
 
 QString QgsGeometryCheckMissingVertexAlgorithm::shortDescription() const
 {
-  return QObject::tr( "Detect missing vertices along polygon borders for topology compliance" );
+  return QObject::tr( "Detects missing vertices along polygon borders for topology compliance." );
 }
 
 QStringList QgsGeometryCheckMissingVertexAlgorithm::tags() const

src/analysis/processing/qgsalgorithmcheckgeometrymultipart.cpp

@@ -37,7 +37,7 @@ QString QgsGeometryCheckMultipartAlgorithm::displayName() const
 
 QString QgsGeometryCheckMultipartAlgorithm::shortDescription() const
 {
-  return QObject::tr( "Detect multipart features containing only one part" );
+  return QObject::tr( "Detects multipart features containing only one part." );
 }
 
 QStringList QgsGeometryCheckMultipartAlgorithm::tags() const

src/analysis/processing/qgsalgorithmcheckgeometryoverlap.cpp

@@ -37,7 +37,7 @@ QString QgsGeometryCheckOverlapAlgorithm::displayName() const
 
 QString QgsGeometryCheckOverlapAlgorithm::shortDescription() const
 {
-  return QObject::tr( "Detect overlaps between polygons, smaller than a given area" );
+  return QObject::tr( "Detects overlaps between polygons smaller than a given area." );
 }
 
 QStringList QgsGeometryCheckOverlapAlgorithm::tags() const