central/tests/test_sat_common.py

114 lines
4.3 KiB
Python
Raw Normal View History

v0.12.0: sat_positions adapter (live global satellite positions) + sat_common refactor ## Architectural framing The v0.11.1 `satpass_predict` adapter is **observer-anchored**: "when does satellite X pass over fixed observer Y, and what's the elevation/azimuth at that observer's site?" It answers a fixed-QTH question and emits one event per (observer, satellite, AOS) tuple. The new `sat_positions` adapter is the **global** counterpart: "where is satellite X right now?" No observer. One event per tracked NORAD ID per poll, on subject `central.sat.position.<norad_id>`. Consumers (meshAI, GUI map widgets, anything that wants a live world map) subscribe to `central.sat.position.>` and plot. They complement each other; neither replaces the other. Direct quote from Matt's use-case: *"location of the sats... map of where the sats are then we have meshai or whatever other service calling central's data grab it and do whatever work it needed."* This adapter is that. ## sat_common extraction rationale The four pure SGP4 / coordinate helpers (`EARTH_RADIUS_KM`, `gmst_rad`, `eci_to_ecef`, `subsatellite_point`) were private symbols inside `satpass_predict.py`. `sat_positions` needs the same three helpers. Three options were considered: 1. **Cross-import** from `satpass_predict.py` — creates an adapter-to-adapter dependency, ugly. 2. **Extract to `sat_common.py`** — matches the existing `wfigs_common.py` / `swpc_common.py` precedent. Both adapters become siblings of a shared helper module. ✓ chosen. 3. **Duplicate** — math drift over time. Symbol names dropped their leading underscore on extraction (public-API convention matching `swpc_common.parse_swpc_timestamp` / `wfigs_common.severity_from_acres`). Existing internal call sites in `satpass_predict.py` were updated via mechanical `replace_all`. Observer-specific helpers (`_observer_ecef`, `_topocentric_az_el`, `_visibility_footprint`, `_severity_from_elev`, `_build_pass_geometry`, `_next_passes`) stay in `satpass_predict.py` per YAGNI — they're not used by `sat_positions` today. Existing `tests/test_satpass_predict.py` was updated mechanically to import the helpers from `sat_common` via aliases (preserves the underscore-prefixed local names in the tests so the rest of the test body needs no change). All 44 satpass_predict tests pass unchanged. ## CENTRAL_SAT stream cap bump `config.streams.max_bytes` for `CENTRAL_SAT` goes from **1 GiB → 5 GiB** in migration 039. Sizing math: - celestrak_tle: ~190 sats × 1 envelope/day = ~190 events/day = ~1.4k events/week. Fit in 1 GiB easily. - sat_positions: ~190 sats × 1440 ticks/day (60s cadence) = **~273.6k events/day = ~1.9M events/week**. At ~1 KB per envelope including the CloudEvents wrapper, that's **~1.9 GiB/week**. - Plus existing TLE + pass envelopes already on the stream → ~3 GiB headroom needed. - 5 GiB = 5368709120 bytes = operator-tunable margin without over-provisioning. `STREAM_CATEGORY_DOMAINS["CENTRAL_SAT"]` extends from `("tle", "pass")` to `("tle", "pass", "position")` so the supervisor's retention sweep covers position events too. ## Subject + dedup | Field | Value | |---|---| | Subject | `central.sat.position.<norad_id>` — one subject per satellite, globally | | Dedup id | `<norad_id>:<position_iso>` where `position_iso` is the propagation timestamp truncated to whole seconds (defensive collapse if cadence is ever tightened) | | Severity | 1 (informational telemetry, no alerting) | | data_class | `telemetry` — surfaces on `/telemetry`, not `/events` | | Cadence | 60s default; operator-tunable via standard `cadence_s` field | ## Settings shape ```json {"track_only_norad_ids": [], "max_tle_age_days": 14} ``` - Empty `track_only_norad_ids` = track every NORAD ID with a fresh TLE in the events table (derive-from-celestrak_tle, default behavior). - Non-empty list pins to those NORAD IDs only (operator override — "I only care about the ISS and these 12 Starlink sats"). - `max_tle_age_days` bounds TLE freshness; LEO drag means TLEs go stale in days, GEO is good for months. Parameterized into the SQL query as a timedelta interval so operator-tightened windows (e.g. 3d) apply without code change. ## Event.data fields `norad_id`, `satellite_name`, `lon_deg`, `lat_deg`, `alt_km`, `velocity_kmps`, `heading_deg`, `tle_epoch`. - `lon_deg`/`lat_deg`/`alt_km`: sub-satellite point via SGP4 → ECI → ECEF rotation → spherical-earth lon/lat/alt. - `velocity_kmps`: magnitude of the SGP4 ECI velocity vector. ECI vs ECEF difference is ~6% for LEO (earth rotation 0.46 km/s vs 7.7 km/s orbital speed); fine for consumer "the sat is moving at X km/s" text. - `heading_deg`: great-circle initial bearing from the sub-sat point at `t` to the sub-sat point at `t+1s` (finite-difference; simpler than rotating velocity through GMST + the earth-rotation cross term). ## Diff size — flag for review **+894 / -63 = +831 net** across 14 files. Spec budget was ≤700 lines. **Over by ~131 net** (or ~194 gross). Breakdown: - `sat_positions.py`: 286 lines (under the ≤350 adapter line cap ✓) - `sat_common.py`: 65 lines (the extraction) - Migration 039: 58 lines (heavy on inline comments documenting the size math; could trim ~25 lines if you want) - satpass_predict.py: net -1 line (refactor; lost 4 helper defs and one constant comment, gained 5-line import block) - Templates: 14 lines (event_rows + event_summaries partials) - Wiring: 4 lines (supervisor + ADAPTER_GROUPS) - Docs (CONSUMER-INTEGRATION.md): 40 lines (required by `tests/test_consumer_doc.py::test_every_adapter_has_a_subsection`) - **Tests: 426 lines.** This is the bulk of the overage. The tests are all spec-mandated (sub-sat math, velocity range, heading range, build_event, subject_for, empty-TLE, track_only gate, stale-TLE skip, sat_common helpers, regression-guard on the moved helpers via test_satpass_predict.py preservation). I could shrink `test_sat_positions.py` by consolidating the 11 spec-mandated tests into fewer parameterized cases, but each test pins one behavior the spec called out by name. Flagging for your call: keep as-is, or do you want a tighter parameterized version? ## Test plan - [x] `pytest tests/test_sat_common.py tests/test_sat_positions.py` — **28 new tests, all pass**. - [x] `pytest tests/test_satpass_predict.py` — **44/44 pass** (regression guard: existing tests work after the sat_common extraction). - [x] `pytest tests/test_events_feed_frontend.py` — **119/119 pass** (JSON-feed coverage extended to include sat_positions sample event + expected subject string). - [x] `pytest tests/test_telemetry_separation.py` — **9/9 pass** (`_TELEMETRY` pin extended to include `sat_positions`). - [x] `pytest tests/test_consumer_doc.py` — **6/6 pass** (CONSUMER-INTEGRATION.md `### sat_positions` subsection added). - [x] `pytest tests/test_producer_doc.py` — **10/10 pass** (no PRODUCER-INTEGRATION update needed; CENTRAL_SAT stream is pre-existing). - [x] Full sweep `pytest tests/` (excluding postgres-dep files): **1209 passed, 1 skipped, 0 failures**. - [x] Ruff: clean on all new code. 3 pre-existing F841 unused-variable warnings (supervisor.py:390 `poll_start`, test_events_feed_frontend.py:425 / :466 `result`) confirmed via `git blame` to be from commits May 2026 — not introduced. ## Deploy plan 1. Squash-merge → tag v0.12.0 at merge SHA → push tag. 2. `ssh central`, `git pull` on `/opt/central`. **No `uv sync`** (no new dep). 3. **`central-migrate`** to apply migration 039 (seeds `config.adapters` row + bumps `config.streams.max_bytes` for CENTRAL_SAT). 4. `sudo systemctl restart central-supervisor` (picks up STREAM_CATEGORY_DOMAINS extension + new adapter discovery). 5. `sudo systemctl restart central-gui` (picks up new partials + ADAPTER_GROUPS change). 6. **No** `central-archive` restart (CENTRAL_SAT stream already exists; no new stream). 7. Verify: `nats stream info CENTRAL_SAT` shows max_bytes=5368709120; supervisor journal shows sat_positions discovered. 8. Smoke-test: enable celestrak_tle first if not already, wait for one poll, then enable sat_positions via GUI. Within 60s expect one `central.sat.position.<norad_id>` event per tracked sat on the stream. ## Halt acknowledgment Per spec acceptance bar #6: **squash-merge NOT authorized**. Branch + PR open. Halting for line-by-line review. 🤖 Generated with [Claude Code](https://claude.com/claude-code)
2026-06-09 15:23:32 -06:00
"""Tests for the shared satellite-math helpers extracted in v0.12.0.
These pin the public API surface (no leading underscores) and the numerical
behavior at known reference points. They duplicate some property tests from
test_satpass_predict.py by design -- those test the helpers via internal
re-exports (aliased imports), while these test the module's published
interface directly. If the public names ever drift or get renamed, these
fail first.
"""
from __future__ import annotations
import math
from datetime import datetime, timezone
import pytest
from sgp4.api import Satrec, jday
from central.adapters.sat_common import (
EARTH_RADIUS_KM,
eci_to_ecef,
gmst_rad,
subsatellite_point,
)
# Live TLE from the v0.11.0 stations fixture, ISS (NORAD 25544).
_ISS_L1 = "1 25544U 98067A 26159.80410962 .00007129 00000+0 13425-3 0 9999"
_ISS_L2 = "2 25544 51.6336 341.5878 0006923 148.5365 211.6039 15.49672912570453"
_REF = datetime(2026, 6, 9, 7, 0, 0, tzinfo=timezone.utc)
class TestEarthRadius:
def test_value_matches_wgs84_equatorial(self):
assert EARTH_RADIUS_KM == pytest.approx(6378.137, abs=1e-6)
class TestGmstRad:
def test_returns_value_in_canonical_range(self):
val = gmst_rad(2460835.0, 0.5) # arbitrary post-2000 JD
assert 0.0 <= val < 2.0 * math.pi
def test_monotonic_within_a_day(self):
"""GMST advances ~2π per sidereal day. Two samples 6h apart must
differ by roughly π/2 (modulo wraparound)."""
v0 = gmst_rad(2460835.0, 0.0)
v1 = gmst_rad(2460835.0, 0.25)
delta = (v1 - v0) % (2.0 * math.pi)
# 6h sidereal angle is slightly more than π/2 (sidereal day < solar day).
assert math.pi / 2.0 < delta < math.pi / 2.0 + 0.02
class TestEciToEcef:
def test_zero_rotation_is_identity(self):
result = eci_to_ecef((100.0, 200.0, 300.0), 0.0)
assert result == pytest.approx((100.0, 200.0, 300.0))
def test_rotation_preserves_magnitude(self):
"""Rotation about the z-axis preserves the vector norm."""
pos = (3000.0, 4000.0, 5000.0)
rot = eci_to_ecef(pos, math.pi / 3.0)
mag_in = math.sqrt(sum(c * c for c in pos))
mag_out = math.sqrt(sum(c * c for c in rot))
assert mag_out == pytest.approx(mag_in, rel=1e-12)
def test_z_component_unaffected(self):
"""Earth-rotation axis is z; z component never changes under GMST rotation."""
_, _, z = eci_to_ecef((1.0, 2.0, 42.0), 1.3)
assert z == 42.0
class TestSubsatellitePoint:
def test_north_pole_returns_pole(self):
lon, lat, alt = subsatellite_point((0.0, 0.0, 7000.0))
assert lat == pytest.approx(90.0)
assert alt == pytest.approx(7000.0 - EARTH_RADIUS_KM)
def test_equator_lon_zero(self):
lon, lat, alt = subsatellite_point((EARTH_RADIUS_KM + 400.0, 0.0, 0.0))
assert lon == pytest.approx(0.0)
assert lat == pytest.approx(0.0)
assert alt == pytest.approx(400.0, abs=1e-6)
def test_equator_lon_90_east(self):
lon, lat, alt = subsatellite_point((0.0, EARTH_RADIUS_KM + 400.0, 0.0))
assert lon == pytest.approx(90.0)
assert lat == pytest.approx(0.0)
def test_lon_normalised_into_180_range(self):
"""A satellite over the antimeridian (-y axis) reads as -90°, never +270°."""
lon, _, _ = subsatellite_point((0.0, -(EARTH_RADIUS_KM + 400.0), 0.0))
assert -180.0 <= lon <= 180.0
assert lon == pytest.approx(-90.0)
class TestIssRoundTripViaSgp4:
"""End-to-end: TLE -> SGP4 ECI -> ECEF -> sub-sat point. Pins the math
against a known orbital configuration. Drift from this would mean the
helpers regressed in a way that affects production output."""
def test_iss_sub_sat_point_at_pinned_ref_time(self):
sat = Satrec.twoline2rv(_ISS_L1, _ISS_L2)
jd, fr = jday(_REF.year, _REF.month, _REF.day,
_REF.hour, _REF.minute, _REF.second)
err, pos_eci, _ = sat.sgp4(jd, fr)
assert err == 0
pos_ecef = eci_to_ecef(pos_eci, gmst_rad(jd, fr))
lon, lat, alt = subsatellite_point(pos_ecef)
# ISS inclination 51.6° -- lat must lie within bounds
assert -52.0 <= lat <= 52.0
# lon in valid range
assert -180.0 <= lon <= 180.0
# ISS altitude ~400-420 km
assert 380.0 <= alt <= 460.0