prop/test/microwaveprop/qrz_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

173 lines
4.8 KiB
Elixir

defmodule Microwaveprop.QrzTest do
use Microwaveprop.DataCase, async: false
alias Microwaveprop.Qrz
alias Microwaveprop.Qrz.Callsign
alias Microwaveprop.Qrz.Client
alias Microwaveprop.Qrz.Record
setup do
Client.reset_session()
:ok
end
defp stub_login_and_lookup(callsign_xml) 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_xml}
<Session><Key>session123</Key></Session>
</QRZDatabase>
""")
end
end)
end
defp w1aw_xml do
"""
<Callsign>
<call>W1AW</call>
<fname>Hiram Percy</fname>
<name>Maxim</name>
<grid>FN31pr</grid>
</Callsign>
"""
end
describe "lookup_callsign/1" do
test "fetches from API when not cached, stores in DB" do
stub_login_and_lookup(w1aw_xml())
assert {:ok, %Record{} = record} = Qrz.lookup_callsign("W1AW")
assert record.call == "W1AW"
assert record.fname == "Hiram Percy"
assert record.grid == "FN31pr"
assert Repo.get_by(Callsign, callsign: "W1AW")
end
test "returns cached data when within TTL" do
{:ok, _} =
%Callsign{}
|> Callsign.changeset(%{callsign: "W1AW", data: %{"call" => "W1AW", "fname" => "Cached"}})
|> Repo.insert()
# Test config forces cache_ttl_hours: 0 so entries are always stale.
# Override for this test to make the cache fresh.
original = Application.get_env(:microwaveprop, Qrz)
Application.put_env(:microwaveprop, Qrz, Keyword.put(original, :cache_ttl_hours, 24))
on_exit(fn -> Application.put_env(:microwaveprop, Qrz, original) end)
assert {:ok, %Record{} = record} = Qrz.lookup_callsign("W1AW")
assert record.fname == "Cached"
end
test "re-fetches when cache entry is stale" do
past =
DateTime.utc_now()
|> DateTime.add(-48, :hour)
|> DateTime.truncate(:second)
Repo.insert!(%Callsign{
callsign: "W1AW",
data: %{"call" => "W1AW", "fname" => "Old"},
inserted_at: past,
updated_at: past
})
stub_login_and_lookup(w1aw_xml())
assert {:ok, %Record{} = record} = Qrz.lookup_callsign("W1AW")
assert record.fname == "Hiram Percy"
end
test "upserts (updates existing record on re-fetch)" do
past =
DateTime.utc_now()
|> DateTime.add(-48, :hour)
|> DateTime.truncate(:second)
original =
Repo.insert!(%Callsign{
callsign: "W1AW",
data: %{"call" => "W1AW", "fname" => "Old"},
inserted_at: past,
updated_at: past
})
stub_login_and_lookup(w1aw_xml())
assert {:ok, %Record{} = record} = Qrz.lookup_callsign("W1AW")
assert record.fname == "Hiram Percy"
assert Repo.get!(Callsign, original.id).data["fname"] == "Hiram Percy"
end
test "returns {:error, message} when API 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: INVALIDCALL</Error>
<Key>session123</Key>
</Session>
</QRZDatabase>
""")
end
end)
assert {:error, "Not found: INVALIDCALL"} = Qrz.lookup_callsign("INVALIDCALL")
end
test "normalizes callsign to uppercase" do
stub_login_and_lookup(w1aw_xml())
assert {:ok, %Record{call: "W1AW"}} = Qrz.lookup_callsign("w1aw")
end
end
describe "get_callsign/1" do
test "returns nil for unknown callsign" do
assert Qrz.get_callsign("NONEXISTENT") == nil
end
test "returns record regardless of TTL" do
past =
DateTime.utc_now()
|> DateTime.add(-999, :hour)
|> DateTime.truncate(:second)
Repo.insert!(%Callsign{
callsign: "W1AW",
data: %{"call" => "W1AW"},
inserted_at: past,
updated_at: past
})
assert %Callsign{callsign: "W1AW"} = Qrz.get_callsign("W1AW")
end
end
end