GeoAlchemy2-0.9.4/tests/test_functions.py

import re

from sqlalchemy.sql import func

#
# Importing geoalchemy2 actually registers the GeoAlchemy generic
# functions in SQLAlchemy's function registry.
#

import geoalchemy2.functions  # NOQA
from geoalchemy2.types import Raster  # NOQA


def eq_sql(a, b):
    a = re.sub(r'[\n\t]', '', str(a))
    assert a == b


def _test_simple_func(name):
    eq_sql(getattr(func, name)(1).select(),
           'SELECT %(name)s(:%(name)s_2) AS "%(name)s_1"' %
           dict(name=name))


def _test_geometry_returning_func(name):
    eq_sql(getattr(func, name)(1).select(),
           'SELECT ST_AsEWKB(%(name)s(:%(name)s_2)) AS "%(name)s_1"' %
           dict(name=name))


def _test_geography_returning_func(name):
    eq_sql(getattr(func, name)(1).select(),
           'SELECT ST_AsBinary(%(name)s(:%(name)s_2)) AS "%(name)s_1"' %
           dict(name=name))


def _test_raster_returning_func(name, *args, **kwargs):
    eq_sql(getattr(func, name)(1, *args, **kwargs).select(),
           'SELECT raster(%(name)s(:%(name)s_2)) AS "%(name)s_1"' %
           dict(name=name))


#
# Geometry Constructors
#
def test_ST_Collect():
    _test_geometry_returning_func('ST_Collect')


def test_ST_BdPolyFromText():
    _test_geometry_returning_func('ST_BdPolyFromText')


def test_ST_BdMPolyFromText():
    _test_geometry_returning_func('ST_BdMPolyFromText')


def test_ST_Box2dFromGeoHash():
    _test_geometry_returning_func('ST_Box2dFromGeoHash')


def test_ST_GeogFromText():
    _test_geography_returning_func('ST_GeogFromText')


def test_ST_GeographyFromText():
    _test_geography_returning_func('ST_GeographyFromText')


def test_ST_GeogFromWKB():
    _test_geography_returning_func('ST_GeogFromWKB')


def test_ST_GeomFromTWKB():
    _test_geometry_returning_func('ST_GeomFromTWKB')


def test_ST_GeomCollFromText():
    _test_geometry_returning_func('ST_GeomCollFromText')


def test_ST_GeomFromEWKB():
    _test_geometry_returning_func('ST_GeomFromEWKB')


def test_ST_GeomFromEWKT():
    _test_geometry_returning_func('ST_GeomFromEWKT')


def test_ST_GeometryFromText():
    _test_geometry_returning_func('ST_GeometryFromText')


def test_ST_GeomFromGeoHash():
    _test_geometry_returning_func('ST_GeomFromGeoHash')


def test_ST_GeomFromGML():
    _test_geometry_returning_func('ST_GeomFromGML')


def test_ST_GeomFromGeoJSON():
    _test_geometry_returning_func('ST_GeomFromGeoJSON')


def test_ST_GeomFromKML():
    _test_geometry_returning_func('ST_GeomFromKML')


def test_ST_GMLToSQL():
    _test_geometry_returning_func('ST_GMLToSQL')


def test_ST_GeomFromText():
    _test_geometry_returning_func('ST_GeomFromText')


def test_ST_GeomFromWKB():
    _test_geometry_returning_func('ST_GeomFromWKB')


def test_ST_LineFromEncodedPolyline():
    _test_geometry_returning_func('ST_LineFromEncodedPolyline')


def test_ST_LineFromMultiPoint():
    _test_geometry_returning_func('ST_LineFromMultiPoint')


def test_ST_LineFromText():
    _test_geometry_returning_func('ST_LineFromText')


def test_ST_LineFromWKB():
    _test_geometry_returning_func('ST_LineFromWKB')


def test_ST_LinestringFromWKB():
    _test_geometry_returning_func('ST_LinestringFromWKB')


def test_ST_MakeBox2D():
    _test_geometry_returning_func('ST_MakeBox2D')


def test_ST_3DMakeBox():
    _test_geometry_returning_func('ST_3DMakeBox')


def test_ST_MakeLine():
    _test_geometry_returning_func('ST_MakeLine')


def test_ST_MakeEnvelope():
    _test_geometry_returning_func('ST_MakeEnvelope')


def test_ST_MakePolygon():
    _test_geometry_returning_func('ST_MakePolygon')


def test_ST_MakePoint():
    _test_geometry_returning_func('ST_MakePoint')


def test_ST_MakePointM():
    _test_geometry_returning_func('ST_MakePointM')


def test_ST_MLineFromText():
    _test_geometry_returning_func('ST_MLineFromText')


def test_ST_MPointFromText():
    _test_geometry_returning_func('ST_MPointFromText')


def test_ST_MPolyFromText():
    _test_geometry_returning_func('ST_MPolyFromText')


def test_ST_Point():
    _test_geometry_returning_func('ST_Point')


def test_ST_PointFromGeoHash():
    _test_geometry_returning_func('ST_PointFromGeoHash')


def test_ST_PointFromText():
    _test_geometry_returning_func('ST_PointFromText')


def test_ST_PointFromWKB():
    _test_geometry_returning_func('ST_PointFromWKB')


def test_ST_Polygon():
    _test_geometry_returning_func('ST_Polygon')


def test_ST_PolygonFromText():
    _test_geometry_returning_func('ST_PolygonFromText')


def test_ST_TileEnvelope():
    _test_geometry_returning_func('ST_TileEnvelope')


def test_ST_WKBToSQL():
    _test_geometry_returning_func('ST_WKBToSQL')


def test_ST_WKTToSQL():
    _test_geometry_returning_func('ST_WKTToSQL')


#
# Geometry Accessors
#
def test_ST_Boundary():
    _test_geometry_returning_func('ST_Boundary')


def test_ST_BoundingDiagonal():
    _test_geometry_returning_func('ST_BoundingDiagonal')


def test_ST_EndPoint():
    _test_geometry_returning_func('ST_EndPoint')


def test_ST_Envelope():
    _test_geometry_returning_func('ST_Envelope')


def test_ST_GeometryN():
    _test_geometry_returning_func('ST_GeometryN')


def test_ST_GeometryType():
    _test_simple_func('ST_GeometryType')


def test_ST_InteriorRingN():
    _test_geometry_returning_func('ST_InteriorRingN')


def test_ST_IsValid():
    _test_simple_func('ST_IsValid')


def test_ST_NPoints():
    _test_simple_func('ST_NPoints')


def test_ST_PatchN():
    _test_geometry_returning_func('ST_PatchN')


def test_ST_PointN():
    _test_geometry_returning_func('ST_PointN')


def test_ST_Points():
    _test_geometry_returning_func('ST_Points')


def test_ST_SRID():
    _test_simple_func('ST_SRID')


def test_ST_StartPoint():
    _test_geometry_returning_func('ST_StartPoint')


def test_ST_X():
    _test_simple_func('ST_X')


def test_ST_Y():
    _test_simple_func('ST_Y')


def test_ST_Z():
    _test_simple_func('ST_Z')


#
# Geometry Editors
#
def test_ST_AddPoint():
    _test_geometry_returning_func('ST_AddPoint')


def test_ST_Affine():
    _test_geometry_returning_func('ST_Affine')


def test_ST_CollectionExtract():
    _test_geometry_returning_func('ST_CollectionExtract')


def test_ST_CollectionHomogenize():
    _test_geometry_returning_func('ST_CollectionHomogenize')


def test_ST_ExteriorRing():
    _test_geometry_returning_func('ST_ExteriorRing')


def test_ST_Force2D():
    _test_geometry_returning_func('ST_Force2D')


def test_ST_Force3D():
    _test_geometry_returning_func('ST_Force3D')


def test_ST_Force3DM():
    _test_geometry_returning_func('ST_Force3DM')


def test_ST_Force3DZ():
    _test_geometry_returning_func('ST_Force3DZ')


def test_ST_Force4D():
    _test_geometry_returning_func('ST_Force4D')


def test_ST_ForceCollection():
    _test_geometry_returning_func('ST_ForceCollection')


def test_ST_ForceCurve():
    _test_geometry_returning_func('ST_ForceCurve')


def test_ST_ForcePolygonCCW():
    _test_geometry_returning_func('ST_ForcePolygonCCW')


def test_ST_ForcePolygonCW():
    _test_geometry_returning_func('ST_ForcePolygonCW')


def test_ST_ForceRHR():
    _test_geometry_returning_func('ST_ForceRHR')


def test_ST_ForceSFS():
    _test_geometry_returning_func('ST_ForceSFS')


def test_ST_M():
    _test_simple_func('ST_M')


def test_ST_Multi():
    _test_geometry_returning_func('ST_Multi')


def test_ST_Normalize():
    _test_geometry_returning_func('ST_Normalize')


def test_ST_QuantizeCoordinates():
    _test_geometry_returning_func('ST_QuantizeCoordinates')


def test_ST_RemovePoint():
    _test_geometry_returning_func('ST_RemovePoint')


def test_ST_Reverse():
    _test_geometry_returning_func('ST_Reverse')


def test_ST_Rotate():
    _test_geometry_returning_func('ST_Rotate')


def test_ST_RotateX():
    _test_geometry_returning_func('ST_RotateX')


def test_ST_RotateY():
    _test_geometry_returning_func('ST_RotateY')


def test_ST_RotateZ():
    _test_geometry_returning_func('ST_RotateZ')


def test_ST_Scale():
    _test_geometry_returning_func('ST_Scale')


def test_ST_Segmentize():
    _test_geometry_returning_func('ST_Segmentize')


def test_ST_SetPoint():
    _test_geometry_returning_func('ST_SetPoint')


def test_ST_SetSRID():
    _test_geometry_returning_func('ST_SetSRID')


def test_ST_Snap():
    _test_geometry_returning_func('ST_Snap')


def test_ST_SnapToGrid():
    _test_geometry_returning_func('ST_SnapToGrid')


def test_ST_SwapOrdinates():
    _test_geometry_returning_func('ST_SwapOrdinates')


def test_ST_Transform():
    _test_geometry_returning_func('ST_Transform')


def test_ST_Translate():
    _test_geometry_returning_func('ST_Translate')


def test_ST_TransScale():
    _test_geometry_returning_func('ST_TransScale')


#
# Geometry Outputs
#
def test_ST_AsBinary():
    _test_simple_func('ST_AsBinary')


def test_ST_AsEWKB():
    _test_simple_func('ST_AsEWKB')


def test_ST_AsTWKB():
    _test_simple_func('ST_AsTWKB')


def test_ST_AsGeoJSON():
    _test_simple_func('ST_AsGeoJSON')


def test_ST_AsGML():
    _test_simple_func('ST_AsGML')


def test_ST_AsKML():
    _test_simple_func('ST_AsKML')


def test_ST_AsSVG():
    _test_simple_func('ST_AsSVG')


def test_ST_AsText():
    _test_simple_func('ST_AsText')


def test_ST_AsEWKT():
    _test_simple_func('ST_AsEWKT')


def test_ST_AsMVTGeom():
    _test_geometry_returning_func('ST_AsMVTGeom')


#
# Spatial Relationships and Measurements
#
def test_ST_Area():
    _test_simple_func('ST_Area')


def test_ST_Azimuth():
    _test_simple_func('ST_Azimuth')


def test_ST_Centroid():
    _test_geometry_returning_func('ST_Centroid')


def test_ST_ClosestPoint():
    _test_geometry_returning_func('ST_ClosestPoint')


def test_ST_3DClosestPoint():
    _test_geometry_returning_func('ST_3DClosestPoint')


def test_ST_Contains():
    _test_simple_func('ST_Contains')


def test_ST_ContainsProperly():
    _test_simple_func('ST_ContainsProperly')


def test_ST_Covers():
    _test_simple_func('ST_Covers')


def test_ST_CoveredBy():
    _test_simple_func('ST_CoveredBy')


def test_ST_Crosses():
    _test_simple_func('ST_Crosses')


def test_ST_Disjoint():
    _test_simple_func('ST_Disjoint')


def test_ST_Distance():
    _test_simple_func('ST_Distance')


def test_ST_Distance_Sphere():
    _test_simple_func('ST_Distance_Sphere')


def test_ST_DistanceSphere():
    _test_simple_func('ST_DistanceSphere')


def test_ST_DFullyWithin():
    _test_simple_func('ST_DFullyWithin')


def test_ST_DWithin():
    _test_simple_func('ST_DWithin')


def test_ST_Equals():
    _test_simple_func('ST_Equals')


def test_ST_Intersects():
    _test_simple_func('ST_Intersects')


def test_ST_Length():
    _test_simple_func('ST_Length')


def test_ST_LineLocatePoint():
    _test_simple_func('ST_LineLocatePoint')


def test_ST_LongestLine():
    _test_geometry_returning_func('ST_LongestLine')


def test_ST_3DLongestLine():
    _test_geometry_returning_func('ST_3DLongestLine')


def test_ST_MinimumClearanceLine():
    _test_geometry_returning_func('ST_MinimumClearanceLine')


def test_ST_OrderingEquals():
    _test_simple_func('ST_OrderingEquals')


def test_ST_Overlaps():
    _test_simple_func('ST_Overlaps')


def test_ST_Perimeter():
    _test_simple_func('ST_Perimeter')


def test_ST_Project():
    _test_geography_returning_func('ST_Project')


def test_ST_Relate():
    _test_simple_func('ST_Relate')


def test_ST_ShortestLine():
    _test_geometry_returning_func('ST_ShortestLine')


def test_ST_3DShortestLine():
    _test_geometry_returning_func('ST_3DShortestLine')


def test_ST_Touches():
    _test_simple_func('ST_Touches')


def test_ST_Within():
    _test_simple_func('ST_Within')


#
# Geometry Processing
#
def test_ST_Buffer():
    _test_geometry_returning_func('ST_Buffer')


def test_ST_BuildArea():
    _test_geometry_returning_func('ST_BuildArea')


def test_ST_ClipByBox2D():
    _test_geometry_returning_func('ST_ClipByBox2D')


def test_ST_ChaikinSmoothing():
    _test_geometry_returning_func('ST_ChaikinSmoothing')


def test_ST_ConcaveHull():
    _test_geometry_returning_func('ST_ConcaveHull')


def test_ST_ConvexHull():
    _test_geometry_returning_func('ST_ConvexHull')


def test_ST_CurveToLine():
    _test_geometry_returning_func('ST_CurveToLine')


def test_ST_DelaunayTriangles():
    _test_geometry_returning_func('ST_DelaunayTriangles')


def test_ST_Difference():
    _test_geometry_returning_func('ST_Difference')


def test_ST_Dump():
    _test_simple_func('ST_Dump')


def test_ST_DumpPoints():
    _test_simple_func('ST_DumpPoints')


def test_ST_FilterByM():
    _test_geometry_returning_func('ST_FilterByM')


def test_ST_FlipCoordinates():
    _test_geometry_returning_func('ST_FlipCoordinates')


def test_ST_GeneratePoints():
    _test_geometry_returning_func('ST_GeneratePoints')


def test_ST_GeometricMedian():
    _test_geometry_returning_func('ST_GeometricMedian')


def test_ST_Intersection():
    _test_geometry_returning_func('ST_Intersection')


def test_ST_LineToCurve():
    _test_geometry_returning_func('ST_LineToCurve')


def test_ST_LineMerge():
    _test_geometry_returning_func('ST_LineMerge')


def test_ST_LineSubstring():
    _test_geometry_returning_func('ST_LineSubstring')


def test_ST_MakeValid():
    _test_geometry_returning_func('ST_MakeValid')


def test_ST_MemUnion():
    _test_geometry_returning_func('ST_MemUnion')


def test_ST_MinimumBoundingCircle():
    _test_geometry_returning_func('ST_MinimumBoundingCircle')


def test_ST_Node():
    _test_geometry_returning_func('ST_Node')


def test_ST_OffsetCurve():
    _test_geometry_returning_func('ST_OffsetCurve')


def test_ST_OrientedEnvelope():
    _test_geometry_returning_func('ST_OrientedEnvelope')


def test_ST_PointOnSurface():
    _test_geometry_returning_func('ST_PointOnSurface')


def test_ST_Polygonize():
    _test_geometry_returning_func('ST_Polygonize')


def test_ST_RemoveRepeatedPoints():
    _test_geometry_returning_func('ST_RemoveRepeatedPoints')


def test_ST_SetEffectiveArea():
    _test_geometry_returning_func('ST_SetEffectiveArea')


def test_ST_SharedPaths():
    _test_geometry_returning_func('ST_SharedPaths')


def test_ST_ShiftLongitude():
    _test_geometry_returning_func('ST_ShiftLongitude')


def test_ST_Simplify():
    _test_geometry_returning_func('ST_Simplify')


def test_ST_SimplifyPreserveTopology():
    _test_geometry_returning_func('ST_SimplifyPreserveTopology')


def test_ST_SimplifyVW():
    _test_geometry_returning_func('ST_SimplifyVW')


def test_ST_Split():
    _test_geometry_returning_func('ST_Split')


def test_ST_Subdivide():
    _test_geometry_returning_func('ST_Subdivide')


def test_ST_SymDifference():
    _test_geometry_returning_func('ST_SymDifference')


def test_ST_Union():
    _test_geometry_returning_func('ST_Union')


def test_ST_UnaryUnion():
    _test_geometry_returning_func('ST_UnaryUnion')


def test_ST_VoronoiLines():
    _test_geometry_returning_func('ST_VoronoiLines')


def test_ST_VoronoiPolygons():
    _test_geometry_returning_func('ST_VoronoiPolygons')


def test_ST_WrapX():
    _test_geometry_returning_func('ST_WrapX')


#
# Bounding Box Functions
#
def test_ST_Expand():
    _test_geometry_returning_func('ST_Expand')


#
# Linear Referencing
#
def test_ST_AddMeasure():
    _test_geometry_returning_func('ST_AddMeasure')


def test_ST_LineInterpolatePoint():
    _test_geometry_returning_func('ST_LineInterpolatePoint')


def test_ST_LineInterpolatePoints():
    _test_geometry_returning_func('ST_LineInterpolatePoints')


def test_ST_LocateAlong():
    _test_geometry_returning_func('ST_LocateAlong')


def test_ST_LocateBetween():
    _test_geometry_returning_func('ST_LocateBetween')


def test_ST_LocateBetweenElevations():
    _test_geometry_returning_func('ST_LocateBetweenElevations')


def test_ST_3DLineInterpolatePoint():
    _test_geometry_returning_func('ST_3DLineInterpolatePoint')


#
# Raster Constructors
#
def test_ST_AddBand():
    _test_raster_returning_func('ST_AddBand')


def test_ST_AsRaster():
    _test_raster_returning_func('ST_AsRaster')


#
# Raster Editors
#
def test_ST_Resample():
    _test_raster_returning_func('ST_Resample')


def test_ST_Rescale():
    _test_raster_returning_func('ST_Rescale')


def test_ST_Reskew():
    _test_raster_returning_func('ST_Reskew')


# ST_SnapToGrid already exists for Geometry type so it can not be duplicated
def test_ST_SnapToGrid_raster():
    _test_raster_returning_func('ST_SnapToGrid', type_=Raster)


def test_ST_Resize():
    _test_raster_returning_func('ST_Resize')


#
# Raster Accessors
#
def test_ST_Height():
    _test_simple_func('ST_Height')


def test_ST_Width():
    _test_simple_func('ST_Width')


#
# Raster Pixel Accessors and Setters
#
def test_ST_Value():
    _test_simple_func('ST_Value')


#
# Raster Band Statistics and Analytics
#
def test_ST_ValueCount():
    _test_simple_func('ST_ValueCount')


#
# DEM (Elevation)
#
def test_ST_HillShade():
    _test_raster_returning_func('ST_HillShade')