forked from geopython/pycsw
-
Notifications
You must be signed in to change notification settings - Fork 1
/
conftest.py
549 lines (462 loc) · 19.8 KB
/
conftest.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
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
# =================================================================
#
# Authors: Ricardo Garcia Silva <ricardo.garcia.silva@gmail.com>
#
# Copyright (c) 2016 Ricardo Garcia Silva
#
# 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.
#
# =================================================================
"""pytest configuration file for functional tests"""
import codecs
from collections import namedtuple
import logging
import os
import re
from six.moves import configparser
import psycopg2
import pytest
from pycsw.core import admin
from pycsw.core.config import StaticContext
TESTS_ROOT = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
SuiteDirs = namedtuple("SuiteDirs", [
"get_tests_dir",
"post_tests_dir",
"data_tests_dir",
"expected_results_dir",
])
def pytest_generate_tests(metafunc):
"""Parametrize tests programmatically.
This function scans the filesystem directories under
``tests/functionaltests/suites`` and automatically generates pytest tests
based on the available test suites. Each suite directory has the
following structure:
* A mandatory ``default.cfg`` file specifying the configuration for the
pycsw instance to use in the tests of the suite.
* An optional ``get/`` subdirectory containing a ``requests.txt`` file
with any HTTP GET requests for which to generate tests for. Each request
is specified in a new line, with the following pattern:
* <test_name>,<request_query_string>
* An optional ``post/`` subdirectory containing files that are used as the
payload for HTTP POST requests. The name of each file is used as the name
of the test (without the file's extension);
* An optional ``data/`` subdirectory. This directory, if present, indicates
that the suite uses a custom database. The database is populated with any
additional files that are contained inside this directory. If the
``data`` directory does not exist then the suite's tests will use the
CITE database;
* An ``expected/`` subdirectory containing a file for each of the expected
test outcomes.
The tests are autogenerated by parametrizing the
``tests/functionaltests/test_suites_functional::test_suites`` function
Notes
-----
Check pytest's documentation for information on autogenerating
parametrized tests for further details on how the
``pytest_generate_tests`` function can be used:
http://pytest.org/latest/parametrize.html#basic-pytest-generate-tests-example
"""
global TESTS_ROOT
if metafunc.function.__name__ == "test_suites":
suites_root_dir = os.path.join(TESTS_ROOT, "functionaltests", "suites")
suite_names = os.listdir(suites_root_dir)
arg_values = []
test_ids = []
logging.basicConfig(level=getattr(
logging, metafunc.config.getoption("--pycsw-loglevel").upper()))
if metafunc.config.getoption("--database-backend") == "postgresql":
_recreate_postgresql_database(metafunc.config)
for suite in suite_names:
suite_dir = os.path.join(suites_root_dir, suite)
config_path = os.path.join(suite_dir, "default.cfg")
if not os.path.isfile(config_path):
print("Directory {0!r} does not have a suite "
"configuration file".format(suite_dir))
continue
print("Generating tests for suite {0!r}...".format(suite))
normalize_ids = True if suite in ("harvesting",
"manager") else False
suite_dirs = _get_suite_dirs(suite)
if suite_dirs.post_tests_dir is not None:
post_argvalues, post_ids = _get_post_parameters(
post_tests_dir=suite_dirs.post_tests_dir,
expected_tests_dir=suite_dirs.expected_results_dir,
config_path=config_path,
suite_name=suite,
normalize_ids=normalize_ids
)
arg_values.extend(post_argvalues)
test_ids.extend(post_ids)
if suite_dirs.get_tests_dir is not None:
get_argvalues, get_ids = _get_get_parameters(
get_tests_dir=suite_dirs.get_tests_dir,
expected_tests_dir=suite_dirs.expected_results_dir,
config_path=config_path,
suite_name=suite,
normalize_ids=normalize_ids
)
arg_values.extend(get_argvalues)
test_ids.extend(get_ids)
metafunc.parametrize(
argnames=["configuration", "request_method", "request_data",
"expected_result", "normalize_identifier_fields"],
argvalues=arg_values,
indirect=["configuration"],
ids=test_ids,
)
@pytest.fixture()
def configuration(request, tests_directory, log_level):
"""Configure a suite for execution in tests.
This function is executed once for each individual test request, after
tests have been collected.
The configuration file for each test suite is read into memory. Some
configuration parameters, like the repository's url and table name are
adjusted. The suite's repository is also created, if needed.
Parameters
----------
request: pytest.fixtures.FixtureRequest
tests_directory: py.path.local
Directory created by pytest where any test artifacts are to be saved
log_level: str
Log level for the pycsw server instance that will be created during
tests.
"""
config_path = request.param
config = configparser.SafeConfigParser()
with codecs.open(config_path, encoding="utf-8") as fh:
config.readfp(fh)
suite_name = config_path.split(os.path.sep)[-2]
suite_dirs = _get_suite_dirs(suite_name)
data_dir = suite_dirs.data_tests_dir
if data_dir is not None: # suite has its own database
repository_url = _get_repository_url(request.config, suite_name,
tests_directory)
else: # suite uses the CITE database
data_dir = _get_cite_suite_data_dir()
repository_url = _get_repository_url(request.config, "cite",
tests_directory)
table_name = _get_table_name(suite_name, config, repository_url)
if not _repository_exists(repository_url, table_name):
_initialize_database(repository_url=repository_url,
table_name=table_name,
data_dir=data_dir,
test_dir=tests_directory)
config.set("server", "loglevel", log_level)
config.set("server", "logfile", "")
config.set("repository", "database", repository_url)
config.set("repository", "table", table_name)
return config
@pytest.fixture(scope="session", name="tests_directory")
def fixture_tests_directory(tmpdir_factory):
"""Create a temporary directory for each test session.
This directory is typically situated under ``/tmp`` and is used to create
eventual sqlite databases for each suite.
This functionality is mostly provided by pytest's built-in
``tmpdir_factory`` fixture. More information on this is available at:
http://doc.pytest.org/en/2.9.0/tmpdir.html#the-tmpdir-factory-fixture
"""
tests_dir = tmpdir_factory.mktemp("functional_tests")
return tests_dir
def _get_cite_suite_data_dir():
"""Return the path to the data directory of the CITE test suite."""
global TESTS_ROOT
suites_root_dir = os.path.join(TESTS_ROOT, "functionaltests", "suites")
suite_dir = os.path.join(suites_root_dir, "cite")
data_tests_dir = os.path.join(suite_dir, "data")
data_dir = data_tests_dir if os.path.isdir(data_tests_dir) else None
return data_dir
def _get_get_parameters(get_tests_dir, expected_tests_dir, config_path,
suite_name, normalize_ids):
"""Return the parameters suitable for parametrizing HTTP GET tests."""
method = "GET"
test_argvalues = []
test_ids = []
requests_file_path = os.path.join(get_tests_dir, "requests.txt")
with open(requests_file_path) as fh:
for line in fh:
test_name, test_params = [i.strip() for i in
line.partition(",")[::2]]
expected_result_path = os.path.join(
expected_tests_dir,
"{method}_{name}.xml".format(method=method.lower(),
name=test_name)
)
test_argvalues.append(
(config_path, method, test_params, expected_result_path,
normalize_ids)
)
test_ids.append(
"{suite}_{http_method}_{name}".format(
suite=suite_name, http_method=method.lower(),
name=test_name)
)
return test_argvalues, test_ids
def _get_post_parameters(post_tests_dir, expected_tests_dir, config_path,
suite_name, normalize_ids):
"""Return the parameters suitable for parametrizing HTTP POST tests."""
method = "POST"
test_argvalues = []
test_ids = []
# we are sorting the directory contents because the
# `harvesting` suite requires tests to be executed in alphabetical order
directory_contents = sorted(os.listdir(post_tests_dir))
for request_file_name in directory_contents:
request_path = os.path.join(post_tests_dir,
request_file_name)
expected_result_path = os.path.join(
expected_tests_dir,
"{method}_{filename}".format(
method=method.lower(),
filename=request_file_name
)
)
test_argvalues.append(
(config_path, method, request_path,
expected_result_path, normalize_ids)
)
test_ids.append(
"{suite}_{http_method}_{file_name}".format(
suite=suite_name,
http_method=method.lower(),
file_name=os.path.splitext(
request_file_name)[0])
)
return test_argvalues, test_ids
def _get_repository_url(conf, suite_name, test_dir):
"""Return the repository_url for the input parameters.
Returns
-------
repository_url: str
SQLAlchemy URL for the repository in use.
"""
db_type = conf.getoption("--database-backend")
if db_type == "sqlite":
repository_url = "sqlite:///{test_dir}/{suite}.db".format(
test_dir=test_dir, suite=suite_name)
elif db_type == "postgresql":
repository_url = (
"postgresql://{user}:{password}@{host}:{port}/{database}".format(
user=conf.getoption("--database-user-postgresql"),
password=conf.getoption("--database-password-postgresql"),
host=conf.getoption("--database-host-postgresql"),
port=conf.getoption("--database-port-postgresql"),
database=conf.getoption("--database-name-postgresql"))
)
else:
raise NotImplementedError
return repository_url
def _get_suite_dirs(suite_name):
"""Get the paths to relevant suite directories.
Parameters
----------
suite_name: str
Name of the site
Returns
-------
SuiteDirs
A four element named tuple with the input suite's relevant test
directories.
"""
global TESTS_ROOT
suites_root_dir = os.path.join(TESTS_ROOT, "functionaltests", "suites")
suite_dir = os.path.join(suites_root_dir, suite_name)
data_tests_dir = os.path.join(suite_dir, "data")
post_tests_dir = os.path.join(suite_dir, "post")
get_tests_dir = os.path.join(suite_dir, "get")
expected_results_dir = os.path.join(suite_dir, "expected")
data_dir = data_tests_dir if os.path.isdir(data_tests_dir) else None
posts_dir = post_tests_dir if os.path.isdir(post_tests_dir) else None
gets_dir = get_tests_dir if os.path.isdir(get_tests_dir) else None
expected_dir = (expected_results_dir if os.path.isdir(
expected_results_dir) else None)
return SuiteDirs(get_tests_dir=gets_dir,
post_tests_dir=posts_dir,
data_tests_dir=data_dir,
expected_results_dir=expected_dir)
def _get_table_name(suite, config, repository_url):
"""Get the name of the table used to store records in the database.
Parameters
----------
suite: str
Name of the suite.
config: SafeConfigParser
Configuration for the suite.
repository_url: str
SQLAlchemy URL for the repository in use.
Returns
-------
str
Name of the table to use in the database
"""
if repository_url.startswith("sqlite"):
result = config.get("repository", "table")
elif repository_url.startswith("postgresql"):
result = "{suite}_records".format(suite=suite)
else:
raise NotImplementedError
return result
def _initialize_database(repository_url, table_name, data_dir, test_dir):
"""Initialize database for tests.
This function will create the database and load any test data that
the suite may require.
Parameters
----------
repository_url: str
URL for the repository, as used by SQLAlchemy engines
table_name: str
Name of the table that is to be used to store pycsw records
data_dir: str
Path to a directory that contains sample data records to be loaded
into the database
test_dir: str
Directory where the database is to be created, in case of sqlite.
"""
print("Setting up {0!r} repository...".format(repository_url))
if repository_url.startswith("postgresql"):
extra_kwargs = {
"create_sfsql_tables": True,
"create_plpythonu_functions": False
}
else:
extra_kwargs = {}
admin.setup_db(database=repository_url, table=table_name, home=test_dir,
**extra_kwargs)
if len(os.listdir(data_dir)) > 0:
print("Loading database data...")
admin.load_records(context=StaticContext(), database=repository_url,
table=table_name, xml_dirpath=data_dir)
def _parse_postgresql_repository_url(repository_url):
"""Parse a SQLAlchemy engine URL describing a postgresql database.
Parameters
----------
repository_url: str
SQLAlchemy URL for the repository in use.
Returns
-------
dict
A mapping with the database's connection parameters.
"""
info_re = re.search(r"postgresql://(?P<user>[\w_]+):(?P<password>.*?)@"
r"(?P<host>[\w_.]+):(?P<port>\d+)/"
r"(?P<database>[\w_]+)",
repository_url,
flags=re.UNICODE)
try:
db_info = info_re.groupdict()
except AttributeError:
raise RuntimeError("Could not parse repository url {0!r}".format(
repository_url))
else:
return db_info
def _recreate_postgresql_database(configuration):
"""Recreate a postgresql database.
This function will try to create a new postgresql database for testing
purposes. If the database already exists it is deleted and then recreated.
Parameters
----------
configuration: _pytest.config.Config
The configuration object used by pytest
Raises
------
RuntimeError
If a connection to the postgresql server cannot be made
"""
connection = psycopg2.connect(
database="postgres",
user=configuration.getoption("--database-user-postgresql"),
password=configuration.getoption("--database-password-postgresql"),
host=configuration.getoption("--database-host-postgresql"),
port=configuration.getoption("--database-port-postgresql")
)
connection.set_isolation_level(
psycopg2.extensions.ISOLATION_LEVEL_AUTOCOMMIT)
cursor = connection.cursor()
db_name = configuration.getoption("--database-name-postgresql")
cursor.execute("DROP DATABASE IF EXISTS {database}".format(
database=db_name))
cursor.execute("CREATE DATABASE {database}".format(database=db_name))
cursor.execute(
"SELECT COUNT(1) FROM pg_available_extensions WHERE name='postgis'")
postgis_available = bool(cursor.fetchone()[0])
cursor.close()
connection.close()
if postgis_available:
_create_postgresql_extension(configuration, extension="postgis")
else:
_create_postgresql_extension(configuration, extension="plpythonu")
def _create_postgresql_extension(configuration, extension):
"""Create a postgresql extension in a previously created database.
Parameters
----------
configuration: _pytest.config.Config
The configuration object used by pytest
extension: str
Name of the extension to be created
"""
connection = psycopg2.connect(
database=configuration.getoption("--database-name-postgresql"),
user=configuration.getoption("--database-user-postgresql"),
password=configuration.getoption("--database-password-postgresql"),
host=configuration.getoption("--database-host-postgresql"),
port=configuration.getoption("--database-port-postgresql")
)
connection.set_isolation_level(
psycopg2.extensions.ISOLATION_LEVEL_AUTOCOMMIT)
cursor = connection.cursor()
cursor.execute("CREATE EXTENSION {0}".format(extension))
cursor.close()
connection.close()
def _repository_exists(repository_url, table_name):
"""Test if the database already exists.
Parameters
----------
repository_url: str
URL for the repository, as used by SQLAlchemy engines
table_name: str
Name of the table that is to be used to store pycsw records
Returns
-------
bool
Whether the repository exists or not.
"""
if repository_url.startswith("sqlite"):
repository_path = repository_url.replace("sqlite:///", "")
result = os.path.isfile(repository_path)
elif repository_url.startswith("postgresql"):
db_info = _parse_postgresql_repository_url(repository_url)
try:
connection = psycopg2.connect(user=db_info["user"],
password=db_info["password"],
host=db_info["host"],
port=db_info["port"],
database=db_info["database"])
cursor = connection.cursor()
cursor.execute("SELECT COUNT(1) FROM {table_name}".format(
table_name=table_name))
except (psycopg2.OperationalError, psycopg2.ProgrammingError):
# database or table does not exist yet
result = False
else:
result = True
else:
raise NotImplementedError
return result