mirror of
https://github.com/agessaman/meshcore-bot.git
synced 2026-08-02 16:59:25 +00:00
agessaman
3a896ec1ea
- Added asynchronous support for location resolution, improving performance and responsiveness. - Introduced detailed error handling for invalid latitude and longitude inputs, providing specific feedback to users. - Implemented a caching mechanism for geocoding results to optimize repeated lookups. - Refactored the AQI command to streamline location handling and improve clarity in error messages. - Expanded unit tests to cover new geocoding features and error scenarios, ensuring robust functionality.
318 lines
11 KiB
Python
318 lines
11 KiB
Python
"""Unit tests for modules.location (shared location service)."""
|
|
|
|
from __future__ import annotations
|
|
|
|
import asyncio
|
|
import configparser
|
|
from unittest.mock import MagicMock, Mock, patch
|
|
|
|
import pytest
|
|
|
|
from modules.location import (
|
|
GEOCODE_CACHE_CAP,
|
|
INTERNATIONAL_CITIES,
|
|
OPTIONS_AQI,
|
|
OPTIONS_PREFIX,
|
|
OPTIONS_RAIN,
|
|
ResolveOptions,
|
|
cache_put,
|
|
classify_location,
|
|
geocode_city_best_effort,
|
|
get_neighborhood_queries,
|
|
parse_coordinates,
|
|
parse_coordinates_detailed,
|
|
resolve_location,
|
|
resolve_location_async,
|
|
zip_to_city_string,
|
|
)
|
|
|
|
|
|
@pytest.fixture
|
|
def bot():
|
|
b = MagicMock()
|
|
cfg = configparser.ConfigParser()
|
|
cfg.add_section("Weather")
|
|
cfg.set("Weather", "default_state", "WA")
|
|
cfg.set("Weather", "default_country", "US")
|
|
cfg.add_section("Bot")
|
|
b.config = cfg
|
|
b.db_manager = Mock()
|
|
b.db_manager.get_cached_geocoding = Mock(return_value=(None, None))
|
|
b.db_manager.cache_geocoding = Mock()
|
|
b.db_manager.get_cached_json = Mock(return_value=None)
|
|
b.db_manager.cache_json = Mock()
|
|
b.db_manager.execute_query = Mock(return_value=[])
|
|
b.logger = Mock()
|
|
rl = Mock()
|
|
rl.wait_for_request_sync = Mock()
|
|
rl.record_request = Mock()
|
|
b.nominatim_rate_limiter = rl
|
|
return b
|
|
|
|
|
|
def _loc(lat=47.6, lon=-122.3, address="Seattle, WA, USA", info=None):
|
|
loc = Mock()
|
|
loc.latitude = lat
|
|
loc.longitude = lon
|
|
loc.address = address
|
|
loc.raw = {"address": info or {"city": "Seattle", "state": "Washington", "country": "United States", "country_code": "us"}}
|
|
return loc
|
|
|
|
|
|
@pytest.mark.unit
|
|
class TestClassifyLocation:
|
|
def test_coordinates(self):
|
|
q, t = classify_location("47.6,-122.3")
|
|
assert t == "coordinates"
|
|
|
|
def test_zip_with_whitespace(self):
|
|
q, t = classify_location(" 98101 ")
|
|
assert t == "zipcode"
|
|
assert q == "98101"
|
|
|
|
def test_intl_single(self):
|
|
q, t = classify_location("london")
|
|
assert t == "city"
|
|
assert q == "london, uk"
|
|
|
|
def test_intl_multiword(self):
|
|
q, t = classify_location("mexico city")
|
|
assert t == "city"
|
|
assert q == "mexico city, mexico"
|
|
|
|
def test_space_country(self):
|
|
q, t = classify_location("vancouver canada")
|
|
assert t == "city"
|
|
assert q == "vancouver, canada"
|
|
|
|
def test_intl_disabled(self):
|
|
q, t = classify_location("london", use_international_cities=False)
|
|
assert q == "london"
|
|
|
|
|
|
@pytest.mark.unit
|
|
class TestParseCoordinates:
|
|
def test_valid(self):
|
|
assert parse_coordinates("47.6, -122.3") == pytest.approx((47.6, -122.3))
|
|
|
|
def test_invalid_range(self):
|
|
assert parse_coordinates("200,0") is None
|
|
|
|
def test_invalid_format(self):
|
|
assert parse_coordinates("seattle") is None
|
|
|
|
def test_detailed_invalid_latitude(self):
|
|
coords, err, detail = parse_coordinates_detailed("91,0")
|
|
assert coords is None
|
|
assert err == "invalid_latitude"
|
|
assert detail == "91.0"
|
|
|
|
def test_detailed_invalid_longitude(self):
|
|
coords, err, detail = parse_coordinates_detailed("0,200")
|
|
assert coords is None
|
|
assert err == "invalid_longitude"
|
|
assert detail == "200.0"
|
|
|
|
def test_detailed_valid(self):
|
|
coords, err, detail = parse_coordinates_detailed("47.6,-122.3")
|
|
assert coords == pytest.approx((47.6, -122.3))
|
|
assert err is None
|
|
assert detail is None
|
|
|
|
|
|
@pytest.mark.unit
|
|
class TestNeighborhoods:
|
|
def test_greenwood(self):
|
|
qs = get_neighborhood_queries("greenwood")
|
|
assert qs[0] == "greenwood, Seattle, WA, USA"
|
|
|
|
def test_unknown(self):
|
|
assert get_neighborhood_queries("nowhere") == []
|
|
|
|
|
|
@pytest.mark.unit
|
|
class TestKazakhstanDedup:
|
|
def test_single_canonical(self):
|
|
assert INTERNATIONAL_CITIES["kazakhstan"] == "nur-sultan, kazakhstan"
|
|
|
|
|
|
@pytest.mark.unit
|
|
class TestCountryTokenPath:
|
|
def test_france_uses_direct_nominatim(self, bot):
|
|
loc = _loc(48.85, 2.35, "Paris, France", {"city": "Paris", "country": "France"})
|
|
with patch(
|
|
"modules.location.rate_limited_nominatim_geocode_sync", return_value=loc
|
|
) as geo, patch(
|
|
"modules.location.geocode_city_sync",
|
|
) as shared, patch(
|
|
"modules.location.rate_limited_nominatim_reverse_sync", return_value=loc
|
|
):
|
|
lat, lon, _ = geocode_city_best_effort(bot, "paris, france")
|
|
geo.assert_called()
|
|
shared.assert_not_called()
|
|
assert lat == pytest.approx(48.85)
|
|
|
|
def test_texas_uses_shared_geocode(self, bot):
|
|
with patch(
|
|
"modules.location.geocode_city_sync",
|
|
return_value=(33.66, -95.55, {"city": "Paris", "state": "Texas", "country": "United States"}),
|
|
) as shared, patch(
|
|
"modules.location.rate_limited_nominatim_geocode_sync",
|
|
) as geo:
|
|
lat, lon, _ = geocode_city_best_effort(bot, "paris, texas")
|
|
shared.assert_called_once()
|
|
for call in geo.call_args_list:
|
|
assert call[0][1] != "paris, texas"
|
|
assert lat == pytest.approx(33.66)
|
|
|
|
def test_arbitrary_second_token_not_country(self, bot):
|
|
with patch(
|
|
"modules.location.geocode_city_sync",
|
|
return_value=(1.0, 2.0, {"city": "Foo"}),
|
|
) as shared, patch(
|
|
"modules.location.rate_limited_nominatim_geocode_sync",
|
|
) as geo:
|
|
geocode_city_best_effort(bot, "foo, bar")
|
|
geocode_city_best_effort(bot, "springfield, greene")
|
|
assert shared.call_count == 2
|
|
for call in geo.call_args_list:
|
|
q = call[0][1]
|
|
assert q not in ("foo, bar", "springfield, greene")
|
|
|
|
|
|
@pytest.mark.unit
|
|
class TestResolveLocation:
|
|
def test_coords(self, bot):
|
|
r = resolve_location(bot, "47.6,-122.3", options=OPTIONS_AQI)
|
|
assert r.location_type == "coordinates"
|
|
assert r.lat == pytest.approx(47.6)
|
|
assert r.error is None
|
|
|
|
def test_invalid_latitude_error(self, bot):
|
|
r = resolve_location(bot, "91,0", options=OPTIONS_AQI)
|
|
assert r.error == "invalid_latitude"
|
|
assert r.error_detail == "91.0"
|
|
|
|
def test_invalid_longitude_error(self, bot):
|
|
r = resolve_location(bot, "0,200", options=OPTIONS_AQI)
|
|
assert r.error == "invalid_longitude"
|
|
assert r.error_detail == "200.0"
|
|
|
|
def test_empty_no_fallback(self, bot):
|
|
r = resolve_location(bot, None, options=OPTIONS_AQI)
|
|
assert r.error == "no_location"
|
|
|
|
def test_empty_with_fallback(self, bot):
|
|
opts = ResolveOptions(fallback_coords=(48.0, -122.0), label_style="numeric")
|
|
r = resolve_location(bot, "", options=opts)
|
|
assert r.lat == pytest.approx(48.0)
|
|
assert r.location_type == "fallback"
|
|
|
|
def test_city_via_geocode(self, bot):
|
|
with patch(
|
|
"modules.location.geocode_city_sync",
|
|
return_value=(47.6, -122.3, {"city": "Seattle", "state": "Washington", "country": "United States"}),
|
|
):
|
|
r = resolve_location(bot, "seattle", options=OPTIONS_AQI)
|
|
assert r.lat == pytest.approx(47.6)
|
|
assert r.location_type == "city"
|
|
|
|
def test_region_capitals_flag(self, bot):
|
|
loc = _loc(48.85, 2.35, "Paris, France", {"city": "Paris", "country": "France"})
|
|
with patch(
|
|
"modules.location.rate_limited_nominatim_geocode_sync",
|
|
return_value=loc,
|
|
), patch(
|
|
"modules.location.rate_limited_nominatim_reverse_sync",
|
|
return_value=loc,
|
|
):
|
|
r = resolve_location(bot, "france", options=OPTIONS_RAIN)
|
|
assert r.region_note is not None
|
|
assert r.lat == pytest.approx(48.85)
|
|
assert "Paris" in r.query or "paris" in r.query.lower()
|
|
|
|
def test_repeater_lookup(self, bot):
|
|
bot.db_manager.execute_query.return_value = [
|
|
{"latitude": 47.1, "longitude": -122.1, "name": "KR7ABC"}
|
|
]
|
|
r = resolve_location(bot, "KR7ABC", options=OPTIONS_PREFIX)
|
|
assert r.location_type == "repeater"
|
|
assert r.lat == pytest.approx(47.1)
|
|
|
|
def test_zip_override(self, bot):
|
|
loc = _loc(47.45, -122.46, "Vashon, WA, USA")
|
|
with patch("modules.location.rate_limited_nominatim_geocode_sync", return_value=loc), patch(
|
|
"modules.location.rate_limited_nominatim_reverse_sync", return_value=loc
|
|
):
|
|
r = resolve_location(bot, "98013", options=OPTIONS_AQI)
|
|
assert r.lat == pytest.approx(47.45)
|
|
assert r.location_type == "zipcode"
|
|
|
|
|
|
@pytest.mark.unit
|
|
class TestZipCacheCap:
|
|
def test_cache_put_evicts_oldest(self):
|
|
cache: dict[str, str] = {}
|
|
for i in range(GEOCODE_CACHE_CAP + 5):
|
|
cache_put(cache, f"{i:05d}", f"City{i}")
|
|
assert len(cache) == GEOCODE_CACHE_CAP
|
|
assert "00000" not in cache
|
|
assert f"{GEOCODE_CACHE_CAP + 4:05d}" in cache
|
|
|
|
def test_zip_to_city_string_uses_capped_cache(self):
|
|
cache: dict[str, str] = {}
|
|
for i in range(GEOCODE_CACHE_CAP):
|
|
cache[f"{i:05d}"] = f"Old{i}"
|
|
mock_resp = Mock()
|
|
mock_resp.ok = True
|
|
mock_resp.json.return_value = {
|
|
"places": [{"place name": "Seattle", "state abbreviation": "WA"}]
|
|
}
|
|
with patch("modules.location.requests.get", return_value=mock_resp):
|
|
name = zip_to_city_string("99999", cache=cache)
|
|
assert name == "Seattle, WA"
|
|
assert len(cache) == GEOCODE_CACHE_CAP
|
|
assert "99999" in cache
|
|
assert "00000" not in cache
|
|
|
|
|
|
@pytest.mark.unit
|
|
class TestAsyncParity:
|
|
def test_coords_match_sync(self, bot):
|
|
sync = resolve_location(bot, "47.6,-122.3", options=OPTIONS_AQI)
|
|
async_r = asyncio.run(resolve_location_async(bot, "47.6,-122.3", options=OPTIONS_AQI))
|
|
assert async_r.lat == sync.lat
|
|
assert async_r.lon == sync.lon
|
|
assert async_r.error == sync.error
|
|
assert async_r.location_type == sync.location_type
|
|
|
|
def test_empty_match_sync(self, bot):
|
|
sync = resolve_location(bot, None, options=OPTIONS_PREFIX)
|
|
async_r = asyncio.run(resolve_location_async(bot, None, options=OPTIONS_PREFIX))
|
|
assert async_r.error == sync.error
|
|
|
|
def test_city_match_sync(self, bot):
|
|
with patch(
|
|
"modules.location.geocode_city_sync",
|
|
return_value=(47.6, -122.3, {"city": "Seattle", "state": "Washington", "country": "United States"}),
|
|
):
|
|
sync = resolve_location(bot, "seattle", options=OPTIONS_AQI)
|
|
async_r = asyncio.run(resolve_location_async(bot, "seattle", options=OPTIONS_AQI))
|
|
assert async_r.lat == sync.lat
|
|
assert async_r.display_name == sync.display_name
|
|
|
|
|
|
@pytest.mark.unit
|
|
class TestRainReexports:
|
|
def test_helpers_importable_from_rain(self):
|
|
from modules.commands.rain_command import (
|
|
city_display_name,
|
|
join_location,
|
|
reverse_geocode_region,
|
|
titlecase_location,
|
|
)
|
|
assert titlecase_location("memphis") == "Memphis"
|
|
assert join_location("Paris", "France") == "Paris, France"
|
|
assert city_display_name("london ky") == "London"
|
|
assert callable(reverse_geocode_region)
|