prop/test/microwaveprop/callsign_location_test.exs
Graham McIntire 99e7560601
Drop gridmap.org dependency, resolve callsigns locally
Instead of shelling out to https://gridmap.org/locate/:callsign for
callsign → lat/lon lookups, ports the resolver pipeline from gridmap-web
into this project so the whole flow runs in-process.

New modules:

- Microwaveprop.Qrz — cache facade over the QRZ.com XML callsign API.
  Looks up from qrz_callsigns first, falls back to a live fetch, and
  upserts the result with a configurable cache_ttl_hours (default
  168h / 7 days).
- Microwaveprop.Qrz.Client — HTTP/XML client against
  https://xmldata.qrz.com/xml/current/. Holds the session key in an
  Agent, transparently re-logs-in on :session_expired, and parses
  responses via xmerl.
- Microwaveprop.Qrz.Callsign — Ecto schema for the qrz_callsigns
  cache table, binary_id primary key per project convention.
- Microwaveprop.Qrz.Record — slim struct with only the 11 fields
  we actually consume (identity, name, grid, address, lat/lon).
  The full XML payload stays in the raw :data jsonb column for
  anyone who wants the other ~40 QRZ fields.
- Microwaveprop.Geocoder — Req-based client against the Google Maps
  Geocoding API. Only called as a fallback when QRZ has no explicit
  <lat>/<lon> for the callsign.
- Microwaveprop.CallsignLocation — orchestrator. Reads the
  callsign_locations cache, on miss calls Qrz then either uses QRZ's
  coords directly or geocodes the formatted address, snaps to an
  8-char Maidenhead grid via Microwaveprop.Radio.Maidenhead, and
  upserts the result.

Microwaveprop.Radio.CallsignClient.locate/1 is rewritten to delegate
to CallsignLocation.lookup/1 and shape the response back to the
existing {:ok, %{callsign, gridsquare, lat, lon}} contract so the
callers in PathLive and RoverLive don't change.

Wiring:

- priv/repo/migrations/20260413000000_create_qrz_callsigns_and_callsign_locations.exs
  creates qrz_callsigns and callsign_locations with unique indexes
  on :callsign.
- Microwaveprop.Qrz.Client added to the application supervision tree
  so the session Agent is started.
- :xmerl added to extra_applications so the release bundles it.
- config/test.exs wires Req.Test plugs for Microwaveprop.Qrz.Client
  and Microwaveprop.Geocoder, forces cache_ttl_hours: 0 so the cache
  never short-circuits test-level stubs, and supplies dummy QRZ
  credentials.
- config/runtime.exs pulls QRZ_USERNAME / QRZ_PASSWORD / QRZ_AGENT
  and GOOGLE_API_KEY from the environment so prod and dev can
  configure both upstream keys out of band.

Tests (ported verbatim from gridmap-web):

- test/microwaveprop/qrz/callsign_test.exs — schema/changeset
- test/microwaveprop/qrz_test.exs — cache hit, cache miss, TTL
  behavior, upsert on stale, error passthrough, case-insensitive
  input
- test/microwaveprop/geocoder_test.exs — success, zero results,
  request denied, transport error
- test/microwaveprop/callsign_location_test.exs — end-to-end flow
  including the QRZ-lat/lon shortcut and the missing-address error
  path

All 1294 tests still pass. Credo strict clean.
2026-04-12 17:43:29 -05:00

184 lines
5.5 KiB
Elixir

defmodule Microwaveprop.CallsignLocationTest do
use Microwaveprop.DataCase, async: false
alias Microwaveprop.CallsignLocation
alias Microwaveprop.CallsignLocation.Location
alias Microwaveprop.Geocoder
alias Microwaveprop.Qrz.Client
setup do
Client.reset_session()
:ok
end
defp stub_qrz_lookup(opts \\ []) do
lat = Keyword.get(opts, :lat)
lon = Keyword.get(opts, :lon)
lat_xml = if lat, do: "<lat>#{lat}</lat>", else: ""
lon_xml = if lon, do: "<lon>#{lon}</lon>", else: ""
Req.Test.expect(Client, 2, fn conn ->
params = Plug.Conn.fetch_query_params(conn).query_params
if Map.has_key?(params, "username") do
Plug.Conn.send_resp(conn, 200, """
<?xml version="1.0" encoding="utf-8"?>
<QRZDatabase version="1.34">
<Session><Key>session123</Key></Session>
</QRZDatabase>
""")
else
Plug.Conn.send_resp(conn, 200, """
<?xml version="1.0" encoding="utf-8"?>
<QRZDatabase version="1.34">
<Callsign>
<call>W1AW</call>
<fname>Hiram Percy</fname>
<name>Maxim</name>
<addr1>225 Main St</addr1>
<addr2>Newington</addr2>
<state>CT</state>
<zip>06111</zip>
<country>United States</country>
#{lat_xml}
#{lon_xml}
</Callsign>
<Session><Key>session123</Key></Session>
</QRZDatabase>
""")
end
end)
end
defp stub_geocoder do
Req.Test.expect(Geocoder, fn conn ->
conn
|> Plug.Conn.put_resp_content_type("application/json")
|> Plug.Conn.send_resp(
200,
Jason.encode!(%{
"status" => "OK",
"results" => [
%{
"geometry" => %{
"location" => %{"lat" => 41.714775, "lng" => -72.727260}
}
}
]
})
)
end)
end
describe "lookup/1" do
test "fetches from QRZ, geocodes, caches, and returns result" do
stub_qrz_lookup()
stub_geocoder()
assert {:ok, result} = CallsignLocation.lookup("W1AW")
assert result.callsign == "W1AW"
assert_in_delta result.latitude, 41.714775, 0.001
assert_in_delta result.longitude, -72.727260, 0.001
assert is_binary(result.gridsquare)
assert String.length(result.gridsquare) == 8
assert result.name == "Hiram Percy Maxim"
assert result.address == "225 Main St, Newington, CT, 06111, United States"
assert Repo.get_by(Location, callsign: "W1AW")
end
test "returns cached data without calling geocoder" do
{:ok, _} =
%Location{}
|> Location.changeset(%{
callsign: "W1AW",
latitude: 41.714,
longitude: -72.727,
gridsquare: "FN31pr58"
})
|> Repo.insert()
assert {:ok, result} = CallsignLocation.lookup("W1AW")
assert result.callsign == "W1AW"
assert_in_delta result.latitude, 41.714, 0.001
assert result.gridsquare == "FN31pr58"
end
test "returns error when QRZ lookup fails" do
Req.Test.expect(Client, 2, fn conn ->
params = Plug.Conn.fetch_query_params(conn).query_params
if Map.has_key?(params, "username") do
Plug.Conn.send_resp(conn, 200, """
<?xml version="1.0" encoding="utf-8"?>
<QRZDatabase version="1.34">
<Session><Key>session123</Key></Session>
</QRZDatabase>
""")
else
Plug.Conn.send_resp(conn, 200, """
<?xml version="1.0" encoding="utf-8"?>
<QRZDatabase version="1.34">
<Session>
<Error>Not found: INVALID</Error>
<Key>session123</Key>
</Session>
</QRZDatabase>
""")
end
end)
assert {:error, _} = CallsignLocation.lookup("INVALID")
end
test "uses QRZ lat/lon when available instead of geocoding" do
stub_qrz_lookup(lat: 33.229, lon: -96.458)
assert {:ok, result} = CallsignLocation.lookup("W1AW")
assert result.callsign == "W1AW"
assert_in_delta result.latitude, 33.229, 0.001
assert_in_delta result.longitude, -96.458, 0.001
assert is_binary(result.gridsquare)
assert String.length(result.gridsquare) == 8
assert result.name == "Hiram Percy Maxim"
assert result.address == "225 Main St, Newington, CT, 06111, United States"
end
test "falls back to geocoding when QRZ has no lat/lon" do
stub_qrz_lookup()
stub_geocoder()
assert {:ok, result} = CallsignLocation.lookup("W1AW")
assert_in_delta result.latitude, 41.714775, 0.001
assert_in_delta result.longitude, -72.727260, 0.001
end
test "returns error when no address available" do
Req.Test.expect(Client, 2, fn conn ->
params = Plug.Conn.fetch_query_params(conn).query_params
if Map.has_key?(params, "username") do
Plug.Conn.send_resp(conn, 200, """
<?xml version="1.0" encoding="utf-8"?>
<QRZDatabase version="1.34">
<Session><Key>session123</Key></Session>
</QRZDatabase>
""")
else
Plug.Conn.send_resp(conn, 200, """
<?xml version="1.0" encoding="utf-8"?>
<QRZDatabase version="1.34">
<Callsign>
<call>W1AW</call>
</Callsign>
<Session><Key>session123</Key></Session>
</QRZDatabase>
""")
end
end)
assert {:error, "No address available for callsign"} = CallsignLocation.lookup("W1AW")
end
end
end