X-Git-Url: https://git.openstreetmap.org./nominatim.git/blobdiff_plain/eb3b78985596a351ad98d09afeee960055bb53eb..0fb8eade136ea03e7853aca0795ca69833c33661:/test/python/test_config.py diff --git a/test/python/test_config.py b/test/python/test_config.py index 03e4a800..6729f954 100644 --- a/test/python/test_config.py +++ b/test/python/test_config.py @@ -1,56 +1,160 @@ """ Test for loading dotenv configuration. """ -from pathlib import Path -import tempfile -import os - import pytest from nominatim.config import Configuration +from nominatim.errors import UsageError + +@pytest.fixture +def make_config(src_dir): + """ Create a configuration object from the given project directory. + """ + def _mk_config(project_dir=None): + return Configuration(project_dir, src_dir / 'settings') + + return _mk_config -DEFCFG_DIR = Path(__file__) / '..' / '..' / '..' / 'settings' -def test_no_project_dir(): - config = Configuration(None, DEFCFG_DIR) +def test_no_project_dir(make_config): + config = make_config() assert config.DATABASE_WEBUSER == 'www-data' -def test_prefer_project_setting_over_default(): - with tempfile.TemporaryDirectory() as project_dir: - with open(project_dir + '/.env', 'w') as envfile: - envfile.write('NOMINATIM_DATABASE_WEBUSER=apache\n') - config = Configuration(Path(project_dir), DEFCFG_DIR) +@pytest.mark.parametrize("val", ('apache', '"apache"')) +def test_prefer_project_setting_over_default(make_config, val, tmp_path): + envfile = tmp_path / '.env' + envfile.write_text('NOMINATIM_DATABASE_WEBUSER={}\n'.format(val)) - assert config.DATABASE_WEBUSER == 'apache' + config = make_config(tmp_path) -def test_prefer_os_environ_over_project_setting(): - with tempfile.TemporaryDirectory() as project_dir: - with open(project_dir + '/.env', 'w') as envfile: - envfile.write('NOMINATIM_DATABASE_WEBUSER=apache\n') + assert config.DATABASE_WEBUSER == 'apache' - os.environ['NOMINATIM_DATABASE_WEBUSER'] = 'nobody' - config = Configuration(Path(project_dir), DEFCFG_DIR) +def test_prefer_os_environ_over_project_setting(make_config, monkeypatch, tmp_path): + envfile = tmp_path / '.env' + envfile.write_text('NOMINATIM_DATABASE_WEBUSER=apache\n') - assert config.DATABASE_WEBUSER == 'nobody' + monkeypatch.setenv('NOMINATIM_DATABASE_WEBUSER', 'nobody') - del os.environ['NOMINATIM_DATABASE_WEBUSER'] + config = make_config(tmp_path) -def test_get_os_env_add_defaults(): - config = Configuration(None, DEFCFG_DIR) + assert config.DATABASE_WEBUSER == 'nobody' - if 'NOMINATIM_DATABASE_WEBUSER' in os.environ: - del os.environ['NOMINATIM_DATABASE_WEBUSER'] + +def test_get_os_env_add_defaults(make_config, monkeypatch): + config = make_config() + + monkeypatch.delenv('NOMINATIM_DATABASE_WEBUSER', raising=False) assert config.get_os_env()['NOMINATIM_DATABASE_WEBUSER'] == 'www-data' -def test_get_os_env_prefer_os_environ(): - config = Configuration(None, DEFCFG_DIR) - os.environ['NOMINATIM_DATABASE_WEBUSER'] = 'nobody' +def test_get_os_env_prefer_os_environ(make_config, monkeypatch): + config = make_config() + + monkeypatch.setenv('NOMINATIM_DATABASE_WEBUSER', 'nobody') assert config.get_os_env()['NOMINATIM_DATABASE_WEBUSER'] == 'nobody' - del os.environ['NOMINATIM_DATABASE_WEBUSER'] + +def test_get_libpq_dsn_convert_default(make_config): + config = make_config() + + assert config.get_libpq_dsn() == 'dbname=nominatim' + + +def test_get_libpq_dsn_convert_php(make_config, monkeypatch): + config = make_config() + + monkeypatch.setenv('NOMINATIM_DATABASE_DSN', + 'pgsql:dbname=gis;password=foo;host=localhost') + + assert config.get_libpq_dsn() == 'dbname=gis password=foo host=localhost' + + +@pytest.mark.parametrize("val,expect", [('foo bar', "'foo bar'"), + ("xy'z", "xy\\'z"), + ]) +def test_get_libpq_dsn_convert_php_special_chars(make_config, monkeypatch, val, expect): + config = make_config() + + monkeypatch.setenv('NOMINATIM_DATABASE_DSN', + 'pgsql:dbname=gis;password={}'.format(val)) + + assert config.get_libpq_dsn() == "dbname=gis password={}".format(expect) + + +def test_get_libpq_dsn_convert_libpq(make_config, monkeypatch): + config = make_config() + + monkeypatch.setenv('NOMINATIM_DATABASE_DSN', + 'host=localhost dbname=gis password=foo') + + assert config.get_libpq_dsn() == 'host=localhost dbname=gis password=foo' + + +@pytest.mark.parametrize("value,result", + [(x, True) for x in ('1', 'true', 'True', 'yes', 'YES')] + + [(x, False) for x in ('0', 'false', 'no', 'NO', 'x')]) +def test_get_bool(make_config, monkeypatch, value, result): + config = make_config() + + monkeypatch.setenv('NOMINATIM_FOOBAR', value) + + assert config.get_bool('FOOBAR') == result + +def test_get_bool_empty(make_config): + config = make_config() + + assert config.DATABASE_MODULE_PATH == '' + assert not config.get_bool('DATABASE_MODULE_PATH') + + +@pytest.mark.parametrize("value,result", [('0', 0), ('1', 1), + ('85762513444', 85762513444)]) +def test_get_int_success(make_config, monkeypatch, value, result): + config = make_config() + + monkeypatch.setenv('NOMINATIM_FOOBAR', value) + + assert config.get_int('FOOBAR') == result + + +@pytest.mark.parametrize("value", ['1b', 'fg', '0x23']) +def test_get_int_bad_values(make_config, monkeypatch, value): + config = make_config() + + monkeypatch.setenv('NOMINATIM_FOOBAR', value) + + with pytest.raises(UsageError): + config.get_int('FOOBAR') + + +def test_get_int_empty(make_config): + config = make_config() + + assert config.DATABASE_MODULE_PATH == '' + + with pytest.raises(UsageError): + config.get_int('DATABASE_MODULE_PATH') + + +def test_get_import_style_intern(make_config, src_dir, monkeypatch): + config = make_config() + + monkeypatch.setenv('NOMINATIM_IMPORT_STYLE', 'street') + + expected = src_dir / 'settings' / 'import-street.style' + + assert config.get_import_style_file() == expected + + +@pytest.mark.parametrize("value", ['custom', '/foo/bar.stye']) +def test_get_import_style_extern(make_config, monkeypatch, value): + config = make_config() + + monkeypatch.setenv('NOMINATIM_IMPORT_STYLE', value) + + assert str(config.get_import_style_file()) == value