/
test_postgresql_provider.py
361 lines (301 loc) · 12.9 KB
/
test_postgresql_provider.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
# =================================================================
#
# Authors: Just van den Broecke <justb4@gmail.com>
# Tom Kralidis <tomkralidis@gmail.com>
# John A Stevenson <jostev@bgs.ac.uk>
# Colin Blackburn <colb@bgs.ac.uk>
#
# Copyright (c) 2019 Just van den Broecke
# Copyright (c) 2022 Tom Kralidis
# Copyright (c) 2022 John A Stevenson and Colin Blackburn
#
# Permission is hereby granted, free of charge, to any person
# obtaining a copy of this software and associated documentation
# files (the "Software"), to deal in the Software without
# restriction, including without limitation the rights to use,
# copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the
# Software is furnished to do so, subject to the following
# conditions:
#
# The above copyright notice and this permission notice shall be
# included in all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
# OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
# HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
# WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
# OTHER DEALINGS IN THE SOFTWARE.
#
# =================================================================
# Needs to be run like: python3 -m pytest
# See pygeoapi/provider/postgresql.py for instructions on setting up
# test database in Docker
import pytest
from pygeofilter.parsers.ecql import parse
from pygeoapi.provider.base import (
ProviderConnectionError,
ProviderItemNotFoundError,
ProviderQueryError
)
from pygeoapi.provider.postgresql import PostgreSQLProvider
import pygeoapi.provider.postgresql as postgresql_provider_module
import os
PASSWORD = os.environ.get('POSTGRESQL_PASSWORD', 'postgres')
@pytest.fixture()
def config():
return {
'name': 'PostgreSQL',
'type': 'feature',
'data': {'host': '127.0.0.1',
'dbname': 'test',
'user': 'postgres',
'password': PASSWORD,
'search_path': ['osm', 'public']
},
'id_field': 'osm_id',
'table': 'hotosm_bdi_waterways',
'geom_field': 'foo_geom'
}
def test_query(config):
"""Testing query for a valid JSON object with geometry"""
p = PostgreSQLProvider(config)
feature_collection = p.query()
assert feature_collection.get('type') == 'FeatureCollection'
features = feature_collection.get('features')
assert features is not None
feature = features[0]
properties = feature.get('properties')
assert properties is not None
geometry = feature.get('geometry')
assert geometry is not None
def test_query_materialised_view(config):
"""Testing query using a materialised view"""
config_materialised_view = config.copy()
config_materialised_view['table'] = 'hotosm_bdi_drains'
provider = PostgreSQLProvider(config_materialised_view)
# Only ID, width and depth properties should be available
assert set(provider.get_fields().keys()) == {"osm_id", "width", "depth"}
def test_query_with_property_filter(config):
"""Test query valid features when filtering by property"""
p = PostgreSQLProvider(config)
feature_collection = p.query(properties=[("waterway", "stream")])
features = feature_collection.get('features')
stream_features = list(
filter(lambda feature: feature['properties']['waterway'] == 'stream',
features))
assert (len(features) == len(stream_features))
feature_collection = p.query(limit=50)
features = feature_collection.get('features')
stream_features = list(
filter(lambda feature: feature['properties']['waterway'] == 'stream',
features))
other_features = list(
filter(lambda feature: feature['properties']['waterway'] != 'stream',
features))
assert (len(features) != len(stream_features))
assert (len(other_features) != 0)
def test_query_with_config_properties(config):
"""
Test that query is restricted by properties in the config.
No properties should be returned that are not requested.
Note that not all requested properties have to exist in the query result.
"""
properties_subset = ['name', 'waterway', 'width', 'does_not_exist']
config.update({'properties': properties_subset})
provider = PostgreSQLProvider(config)
assert provider.properties == properties_subset
result = provider.query()
feature = result.get('features')[0]
properties = feature.get('properties')
for property_name in properties.keys():
assert property_name in config["properties"]
@pytest.mark.parametrize("property_filter, expected", [
([], 14776),
([("waterway", "stream")], 13930),
([("waterway", "this does not exist")], 0),
])
def test_query_hits_with_property_filter(config, property_filter, expected):
"""Test query resulttype=hits"""
provider = PostgreSQLProvider(config)
results = provider.query(properties=property_filter, resulttype="hits")
assert results["numberMatched"] == expected
def test_query_bbox(config):
"""Test query with a specified bounding box"""
psp = PostgreSQLProvider(config)
boxed_feature_collection = psp.query(
bbox=[29.3373, -3.4099, 29.3761, -3.3924]
)
assert len(boxed_feature_collection['features']) == 5
def test_query_sortby(config):
"""Test query with sorting"""
psp = PostgreSQLProvider(config)
up = psp.query(sortby=[{'property': 'osm_id', 'order': '+'}])
assert up['features'][0]['id'] == 13990765
down = psp.query(sortby=[{'property': 'osm_id', 'order': '-'}])
assert down['features'][0]['id'] == 620735702
name = psp.query(sortby=[{'property': 'name', 'order': '+'}])
assert name['features'][0]['properties']['name'] == 'Agasasa'
def test_query_skip_geometry(config):
"""Test query without geometry"""
provider = PostgreSQLProvider(config)
result = provider.query(skip_geometry=True)
feature = result['features'][0]
assert feature['geometry'] is None
@pytest.mark.parametrize('properties', [
['name'],
['name', 'waterway'],
['name', 'waterway', 'this does not exist']
])
def test_query_select_properties(config, properties):
"""Test query with selected properties"""
provider = PostgreSQLProvider(config)
result = provider.query(select_properties=properties)
feature = result['features'][0]
expected = set(provider.get_fields().keys()).intersection(properties)
assert set(feature['properties'].keys()) == expected
@pytest.mark.parametrize('id_, prev, next_', [
(29701937, 29698243, 29704504),
(13990765, 13990765, 25469515), # First item, prev should be id_
(620735702, 620420337, 620735702), # Last item, next should be id_
])
def test_get_simple(config, id_, prev, next_):
"""Testing query for a specific object and identifying prev/next"""
p = PostgreSQLProvider(config)
result = p.get(id_)
assert result['id'] == id_
assert 'geometry' in result
assert 'properties' in result
assert result['type'] == 'Feature'
assert 'foo_geom' not in result['properties'] # geometry is separate
assert result['prev'] == prev
assert result['next'] == next_
def test_get_not_existing_item_raise_exception(config):
"""Testing query for a not existing object"""
p = PostgreSQLProvider(config)
with pytest.raises(ProviderItemNotFoundError):
p.get(-1)
@pytest.mark.parametrize('cql, expected_ids', [
("osm_id BETWEEN 80800000 AND 80900000",
[80827787, 80827793, 80835468, 80835470, 80835472, 80835474,
80835475, 80835478, 80835483, 80835486]),
("osm_id BETWEEN 80800000 AND 80900000 AND waterway = 'stream'",
[80835470]),
("osm_id BETWEEN 80800000 AND 80900000 AND waterway ILIKE 'sTrEam'",
[80835470]),
("osm_id BETWEEN 80800000 AND 80900000 AND waterway LIKE 's%'",
[80835470]),
("osm_id BETWEEN 80800000 AND 80900000 AND name IN ('Muhira', 'Mpanda')",
[80835468, 80835472, 80835475, 80835478]),
("osm_id BETWEEN 80800000 AND 80900000 AND name IS NULL",
[80835474, 80835483]),
("osm_id BETWEEN 80800000 AND 80900000 AND BBOX(foo_geom, 29, -2.8, 29.2, -2.9)", # noqa
[80827793, 80835470, 80835472, 80835483, 80835489]),
("osm_id BETWEEN 80800000 AND 80900000 AND "
"CROSSES(foo_geom, LINESTRING(29.091 -2.731, 29.253 -2.845))",
[80835470, 80835472, 80835489])
])
def test_query_cql(config, cql, expected_ids):
"""Test a variety of CQL queries"""
ast = parse(cql)
provider = PostgreSQLProvider(config)
feature_collection = provider.query(filterq=ast)
assert feature_collection.get('type') == 'FeatureCollection'
features = feature_collection.get('features')
ids = [feature["id"] for feature in features]
assert ids == expected_ids
def test_query_cql_properties_bbox_filters(config):
"""Test query with CQL, properties and bbox filters"""
# Arrange
properties = [('waterway', 'stream')]
bbox = [29, -2.8, 29.2, -2.9]
filterq = parse("osm_id BETWEEN 80800000 AND 80900000")
expected_ids = [80835470]
# Act
provider = PostgreSQLProvider(config)
feature_collection = provider.query(filterq=filterq,
properties=properties,
bbox=bbox)
# Assert
ids = [feature["id"] for feature in feature_collection.get('features')]
assert ids == expected_ids
def test_get_fields(config):
# Arrange
expected_fields = {
'blockage': {'type': 'VARCHAR(80)'},
'covered': {'type': 'VARCHAR(80)'},
'depth': {'type': 'VARCHAR(80)'},
'layer': {'type': 'VARCHAR(80)'},
'name': {'type': 'VARCHAR(80)'},
'natural': {'type': 'VARCHAR(80)'},
'osm_id': {'type': 'INTEGER'},
'tunnel': {'type': 'VARCHAR(80)'},
'water': {'type': 'VARCHAR(80)'},
'waterway': {'type': 'VARCHAR(80)'},
'width': {'type': 'VARCHAR(80)'},
'z_index': {'type': 'VARCHAR(80)'}
}
# Act
provider = PostgreSQLProvider(config)
# Assert
assert provider.get_fields() == expected_fields
assert provider.fields == expected_fields # API uses .fields attribute
def test_instantiation(config):
"""Test attributes are correctly set during instantiation."""
# Act
provider = PostgreSQLProvider(config)
# Assert
assert provider.name == "PostgreSQL"
assert provider.table == "hotosm_bdi_waterways"
assert provider.id_field == "osm_id"
@pytest.mark.parametrize('bad_data, exception, match', [
({'table': 'bad_table'}, ProviderQueryError,
'Table.*not found in schema.*'),
({'data': {'bad': 'data'}}, ProviderConnectionError,
r'Could not connect to .*None:\*\*\*@'),
({'id_field': 'bad_id'}, ProviderQueryError,
r'No such id_field column \(bad_id\) on osm.hotosm_bdi_waterways.'),
])
def test_instantiation_with_bad_config(config, bad_data, exception, match):
# Arrange
config.update(bad_data)
# Make sure we don't use a cached connection or model in the tests
postgresql_provider_module._ENGINE_STORE = {}
postgresql_provider_module._TABLE_MODEL_STORE = {}
# Act and assert
with pytest.raises(exception, match=match):
PostgreSQLProvider(config)
def test_instantiation_with_bad_credentials(config):
# Arrange
config['data'].update({'user': 'bad_user'})
match = r'Could not connect to .*bad_user:\*\*\*@'
# Make sure we don't use a cached connection in the tests
postgresql_provider_module._ENGINE_STORE = {}
# Act and assert
with pytest.raises(ProviderConnectionError, match=match):
PostgreSQLProvider(config)
def test_engine_and_table_model_stores(config):
provider0 = PostgreSQLProvider(config)
# Same config should return same engine and table_model
provider1 = PostgreSQLProvider(config)
assert repr(provider1._engine) == repr(provider0._engine)
assert provider1._engine is provider0._engine
assert provider1.table_model is provider0.table_model
# Same database connection details, but different table
different_table = config.copy()
different_table.update(table="hotosm_bdi_drains")
provider2 = PostgreSQLProvider(different_table)
assert repr(provider2._engine) == repr(provider0._engine)
assert provider2._engine is provider0._engine
assert provider2.table_model is not provider0.table_model
# Although localhost is 127.0.0.1, this should get different engine
# and also a different table_model, as two databases may have different
# tables with the same name
different_host = config.copy()
different_host["data"]["host"] = "localhost"
provider3 = PostgreSQLProvider(different_host)
assert provider3._engine is not provider0._engine
assert provider3.table_model is not provider0.table_model