test/bdd/environment.py

   1 # SPDX-License-Identifier: GPL-3.0-or-later
   2 #
   3 # This file is part of Nominatim. (https://nominatim.org)
   4 #
   5 # Copyright (C) 2024 by the Nominatim developer community.
   6 # For a full list of authors see the git log.
   7 from pathlib import Path
   8 import sys
   9
  10 from behave import *
  11
  12 sys.path.insert(1, str(Path(__file__, '..', '..', '..', 'src').resolve()))
  13
  14 from steps.geometry_factory import GeometryFactory
  15 from steps.nominatim_environment import NominatimEnvironment
  16
  17 TEST_BASE_DIR = Path(__file__, '..', '..').resolve()
  18
  19 userconfig = {
  20     'REMOVE_TEMPLATE' : False,
  21     'KEEP_TEST_DB' : False,
  22     'DB_HOST' : None,
  23     'DB_PORT' : None,
  24     'DB_USER' : None,
  25     'DB_PASS' : None,
  26     'TEMPLATE_DB' : 'test_template_nominatim',
  27     'TEST_DB' : 'test_nominatim',
  28     'API_TEST_DB' : 'test_api_nominatim',
  29     'API_TEST_FILE'  : TEST_BASE_DIR / 'testdb' / 'apidb-test-data.pbf',
  30     'SERVER_MODULE_PATH' : None,
  31     'TOKENIZER' : None, # Test with a custom tokenizer
  32     'STYLE' : 'extratags',
  33     'API_ENGINE': 'falcon',
  34     'PHPCOV' : False, # set to output directory to enable code coverage
  35 }
  36
  37 use_step_matcher("re")
  38
  39 def before_all(context):
  40     # logging setup
  41     context.config.setup_logging()
  42     # set up -D options
  43     for k,v in userconfig.items():
  44         context.config.userdata.setdefault(k, v)
  45     # Nominatim test setup
  46     context.nominatim = NominatimEnvironment(context.config.userdata)
  47     context.osm = GeometryFactory()
  48
  49
  50 def before_scenario(context, scenario):
  51     if not 'SQLITE' in context.tags \
  52        and context.config.userdata['API_TEST_DB'].startswith('sqlite:'):
  53         context.scenario.skip("Not usable with Sqlite database.")
  54     elif 'DB' in context.tags:
  55         context.nominatim.setup_db(context)
  56     elif 'APIDB' in context.tags:
  57         context.nominatim.setup_api_db()
  58     elif 'UNKNOWNDB' in context.tags:
  59         context.nominatim.setup_unknown_db()
  60
  61 def after_scenario(context, scenario):
  62     if 'DB' in context.tags:
  63         context.nominatim.teardown_db(context)
  64
  65
  66 def before_tag(context, tag):
  67     if tag == 'fail-legacy':
  68         if context.config.userdata['TOKENIZER'] == 'legacy':
  69             context.scenario.skip("Not implemented in legacy tokenizer")
  70     if tag == 'v1-api-php-only':
  71         if context.config.userdata['API_ENGINE'] != 'php':
  72             context.scenario.skip("Only valid with PHP version of v1 API.")
  73     if tag == 'v1-api-python-only':
  74         if context.config.userdata['API_ENGINE'] == 'php':
  75             context.scenario.skip("Only valid with Python version of v1 API.")