test: avoid use of tempfile module

Use the tmp_path fixture instead which provides automatic
cleanup.
This commit is contained in:
Sarah Hoffmann
2021-05-19 16:42:35 +02:00
parent f93d0fa957
commit af52eed0dd
3 changed files with 67 additions and 82 deletions

View File

@@ -3,97 +3,90 @@ Tests for tools.exec_utils module.
"""
from pathlib import Path
import subprocess
import tempfile
import pytest
import nominatim.tools.exec_utils as exec_utils
@pytest.fixture
def nominatim_env(tmp_phplib_dir, def_config):
class _NominatimEnv:
config = def_config
phplib_dir = tmp_phplib_dir
data_dir = Path('data')
project_dir = Path('.')
sqllib_dir = Path('lib-sql')
config_dir = Path('settings')
module_dir = 'module'
osm2pgsql_path = 'osm2pgsql'
class TestRunLegacyScript:
return _NominatimEnv
@pytest.fixture(autouse=True)
def setup_nominatim_env(self, tmp_path, def_config):
tmp_phplib_dir = tmp_path / 'phplib'
tmp_phplib_dir.mkdir()
(tmp_phplib_dir / 'admin').mkdir()
@pytest.fixture
def test_script(nominatim_env):
def _create_file(code):
with (nominatim_env.phplib_dir / 'admin' / 't.php').open(mode='w') as fd:
fd.write('<?php\n')
fd.write(code + '\n')
class _NominatimEnv:
config = def_config
phplib_dir = tmp_phplib_dir
data_dir = Path('data')
project_dir = Path('.')
sqllib_dir = Path('lib-sql')
config_dir = Path('settings')
module_dir = 'module'
osm2pgsql_path = 'osm2pgsql'
self.testenv = _NominatimEnv
def mk_script(self, code):
codefile = self.testenv.phplib_dir / 'admin' / 't.php'
codefile.write_text('<?php\n' + code + '\n')
return 't.php'
return _create_file
@pytest.fixture(params=[0, 1, 15, 255])
def return_code(request):
return request.param
### run_legacy_script
def test_run_legacy_return_exit_code(nominatim_env, test_script, return_code):
fname = test_script('exit({});'.format(return_code))
assert return_code == exec_utils.run_legacy_script(fname,
nominatim_env=nominatim_env)
@pytest.mark.parametrize("return_code", (0, 1, 15, 255))
def test_run_legacy_return_exit_code(self, return_code):
fname = self.mk_script('exit({});'.format(return_code))
assert return_code == \
exec_utils.run_legacy_script(fname, nominatim_env=self.testenv)
def test_run_legacy_return_throw_on_fail(nominatim_env, test_script):
fname = test_script('exit(11);')
with pytest.raises(subprocess.CalledProcessError):
exec_utils.run_legacy_script(fname, nominatim_env=nominatim_env,
throw_on_fail=True)
def test_run_legacy_return_throw_on_fail(self):
fname = self.mk_script('exit(11);')
with pytest.raises(subprocess.CalledProcessError):
exec_utils.run_legacy_script(fname, nominatim_env=self.testenv,
throw_on_fail=True)
def test_run_legacy_return_dont_throw_on_success(nominatim_env, test_script):
fname = test_script('exit(0);')
assert 0 == exec_utils.run_legacy_script(fname, nominatim_env=nominatim_env,
throw_on_fail=True)
def test_run_legacy_return_dont_throw_on_success(self):
fname = self.mk_script('exit(0);')
assert 0 == exec_utils.run_legacy_script(fname, nominatim_env=self.testenv,
throw_on_fail=True)
def test_run_legacy_use_given_module_path(nominatim_env, test_script):
fname = test_script("exit($_SERVER['NOMINATIM_DATABASE_MODULE_PATH'] == '' ? 0 : 23);")
def test_run_legacy_use_given_module_path(self):
fname = self.mk_script("exit($_SERVER['NOMINATIM_DATABASE_MODULE_PATH'] == '' ? 0 : 23);")
assert 0 == exec_utils.run_legacy_script(fname, nominatim_env=nominatim_env)
assert 0 == exec_utils.run_legacy_script(fname, nominatim_env=self.testenv)
def test_run_legacy_do_not_overwrite_module_path(nominatim_env, test_script, monkeypatch):
monkeypatch.setenv('NOMINATIM_DATABASE_MODULE_PATH', 'other')
fname = test_script("exit($_SERVER['NOMINATIM_DATABASE_MODULE_PATH'] == 'other' ? 0 : 1);")
def test_run_legacy_do_not_overwrite_module_path(self, monkeypatch):
monkeypatch.setenv('NOMINATIM_DATABASE_MODULE_PATH', 'other')
fname = self.mk_script("exit($_SERVER['NOMINATIM_DATABASE_MODULE_PATH'] == 'other' ? 0 : 1);")
assert 0 == exec_utils.run_legacy_script(fname, nominatim_env=nominatim_env)
assert 0 == exec_utils.run_legacy_script(fname, nominatim_env=self.testenv)
### run_api_script
@pytest.fixture
def tmp_project_dir():
with tempfile.TemporaryDirectory() as tempd:
project_dir = Path(tempd)
webdir = project_dir / 'website'
class TestRunApiScript:
@pytest.fixture(autouse=True)
def setup_project_dir(self, tmp_path):
webdir = tmp_path / 'website'
webdir.mkdir()
(webdir / 'test.php').write_text("<?php\necho 'OK\n';")
with (webdir / 'test.php').open(mode='w') as fd:
fd.write("<?php\necho 'OK\n';")
yield project_dir
def test_run_api(self, tmp_path):
assert 0 == exec_utils.run_api_script('test', tmp_path)
def test_run_api(tmp_project_dir):
assert 0 == exec_utils.run_api_script('test', tmp_project_dir)
def test_run_api_execution_error(self, tmp_path):
assert 0 != exec_utils.run_api_script('badname', tmp_path)
def test_run_api_execution_error(tmp_project_dir):
assert 0 != exec_utils.run_api_script('badname', tmp_project_dir)
def test_run_api_with_extra_env(tmp_project_dir):
extra_env = dict(SCRIPT_FILENAME=str(tmp_project_dir / 'website' / 'test.php'))
assert 0 == exec_utils.run_api_script('badname', tmp_project_dir,
extra_env=extra_env)
def test_run_api_with_extra_env(self, tmp_path):
extra_env = dict(SCRIPT_FILENAME=str(tmp_path / 'website' / 'test.php'))
assert 0 == exec_utils.run_api_script('badname', tmp_path,
extra_env=extra_env)
### run_osm2pgsql