test/python/cli/test_cmd_api.py

   1 # SPDX-License-Identifier: GPL-2.0-only
   2 #
   3 # This file is part of Nominatim. (https://nominatim.org)
   4 #
   5 # Copyright (C) 2022 by the Nominatim developer community.
   6 # For a full list of authors see the git log.
   7 """
   8 Tests for API access commands of command-line interface wrapper.
   9 """
  10 import pytest
  11
  12 import nominatim.clicmd.api
  13
  14
  15 @pytest.mark.parametrize("endpoint", (('search', 'reverse', 'lookup', 'details', 'status')))
  16 def test_no_api_without_phpcgi(endpoint):
  17     assert nominatim.cli.nominatim(module_dir='MODULE NOT AVAILABLE',
  18                                    osm2pgsql_path='OSM2PGSQL NOT AVAILABLE',
  19                                    phpcgi_path=None,
  20                                    cli_args=[endpoint]) == 1
  21
  22
  23 @pytest.mark.parametrize("params", [('search', '--query', 'new'),
  24                                     ('search', '--city', 'Berlin'),
  25                                     ('reverse', '--lat', '0', '--lon', '0', '--zoom', '13'),
  26                                     ('lookup', '--id', 'N1'),
  27                                     ('details', '--node', '1'),
  28                                     ('details', '--way', '1'),
  29                                     ('details', '--relation', '1'),
  30                                     ('details', '--place_id', '10001'),
  31                                     ('status',)])
  32 class TestCliApiCall:
  33
  34     @pytest.fixture(autouse=True)
  35     def setup_cli_call(self, params, cli_call, mock_func_factory, tmp_path):
  36         self.mock_run_api = mock_func_factory(nominatim.clicmd.api, 'run_api_script')
  37
  38         def _run():
  39             return cli_call(*params, '--project-dir', str(tmp_path))
  40
  41         self.run_nominatim = _run
  42
  43
  44     def test_api_commands_simple(self, tmp_path, params):
  45         (tmp_path / 'website').mkdir()
  46         (tmp_path / 'website' / (params[0] + '.php')).write_text('')
  47
  48         assert self.run_nominatim() == 0
  49
  50         assert self.mock_run_api.called == 1
  51         assert self.mock_run_api.last_args[0] == params[0]
  52
  53
  54     def test_bad_project_dir(self):
  55         assert self.run_nominatim() == 1
  56
  57
  58 QUERY_PARAMS = {
  59  'search': ('--query', 'somewhere'),
  60  'reverse': ('--lat', '20', '--lon', '30'),
  61  'lookup': ('--id', 'R345345'),
  62  'details': ('--node', '324')
  63 }
  64
  65 @pytest.mark.parametrize("endpoint", (('search', 'reverse', 'lookup')))
  66 class TestCliApiCommonParameters:
  67
  68     @pytest.fixture(autouse=True)
  69     def setup_website_dir(self, cli_call, project_env, endpoint):
  70         self.endpoint = endpoint
  71         self.cli_call = cli_call
  72         self.project_dir = project_env.project_dir
  73         (self.project_dir / 'website').mkdir()
  74
  75
  76     def expect_param(self, param, expected):
  77         (self.project_dir / 'website' / (self.endpoint + '.php')).write_text(f"""<?php
  78         exit($_GET['{param}']  == '{expected}' ? 0 : 10);
  79         """)
  80
  81
  82     def call_nominatim(self, *params):
  83         return self.cli_call(self.endpoint, *QUERY_PARAMS[self.endpoint],
  84                              '--project-dir', str(self.project_dir), *params)
  85
  86
  87     def test_param_output(self):
  88         self.expect_param('format', 'xml')
  89         assert self.call_nominatim('--format', 'xml') == 0
  90
  91
  92     def test_param_lang(self):
  93         self.expect_param('accept-language', 'de')
  94         assert self.call_nominatim('--lang', 'de') == 0
  95         assert self.call_nominatim('--accept-language', 'de') == 0
  96
  97
  98     @pytest.mark.parametrize("param", ('addressdetails', 'extratags', 'namedetails'))
  99     def test_param_extradata(self, param):
 100         self.expect_param(param, '1')
 101
 102         assert self.call_nominatim('--' + param) == 0
 103
 104     def test_param_polygon_output(self):
 105         self.expect_param('polygon_geojson', '1')
 106
 107         assert self.call_nominatim('--polygon-output', 'geojson') == 0
 108
 109
 110     def test_param_polygon_threshold(self):
 111         self.expect_param('polygon_threshold', '0.3452')
 112
 113         assert self.call_nominatim('--polygon-threshold', '0.3452') == 0
 114
 115
 116 def test_cli_search_param_bounded(cli_call, project_env):
 117     webdir = project_env.project_dir / 'website'
 118     webdir.mkdir()
 119     (webdir / 'search.php').write_text(f"""<?php
 120         exit($_GET['bounded']  == '1' ? 0 : 10);
 121         """)
 122
 123     assert cli_call('search', *QUERY_PARAMS['search'], '--project-dir', str(project_env.project_dir),
 124                     '--bounded') == 0
 125
 126
 127 def test_cli_search_param_dedupe(cli_call, project_env):
 128     webdir = project_env.project_dir / 'website'
 129     webdir.mkdir()
 130     (webdir / 'search.php').write_text(f"""<?php
 131         exit($_GET['dedupe']  == '0' ? 0 : 10);
 132         """)
 133
 134     assert cli_call('search', *QUERY_PARAMS['search'], '--project-dir', str(project_env.project_dir),
 135                     '--no-dedupe') == 0
 136
 137
 138 def test_cli_details_param_class(cli_call, project_env):
 139     webdir = project_env.project_dir / 'website'
 140     webdir.mkdir()
 141     (webdir / 'details.php').write_text(f"""<?php
 142         exit($_GET['class']  == 'highway' ? 0 : 10);
 143         """)
 144
 145     assert cli_call('details', *QUERY_PARAMS['details'], '--project-dir', str(project_env.project_dir),
 146                     '--class', 'highway') == 0
 147
 148
 149 @pytest.mark.parametrize('param', ('lang', 'accept-language'))
 150 def test_cli_details_param_lang(cli_call, project_env, param):
 151     webdir = project_env.project_dir / 'website'
 152     webdir.mkdir()
 153     (webdir / 'details.php').write_text(f"""<?php
 154         exit($_GET['accept-language']  == 'es' ? 0 : 10);
 155         """)
 156
 157     assert cli_call('details', *QUERY_PARAMS['details'], '--project-dir', str(project_env.project_dir),
 158                     '--' + param, 'es') == 0
 159