You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
7.8 KiB
7.8 KiB
Test Refactoring Optimization Strategy
Refactoring Rules
1. Structure
- One
SCENARIO("description")per logical test group, with[tag1][tag2]annotations - Shared fixture: all constants, structs, and variables declared between
SCENARIOopening and firstSECTION - Precompute expected values analytically at fixture level (use
scripts/*.pyfor complex simulations)
2. Duplication Elimination
- Use lambdas that capture the fixture for repeated setup→call→assert patterns
- Reuse shared structs in-place (mutate fields rather than recreating)
- Single-line
SECTIONs when body is one statement:SECTION("name") { helper(arg); }
3. Assertions
using Catch::Matchers::WithinAbs;after includesREQUIRE_THAT(value, WithinAbs(expected, tolerance))— neverApprox()- Always use named tolerance constants — never hardcode raw numbers for tolerance in
WithinAbs().
Tolerance Reference
| Constant | Value | Use for |
|---|---|---|
A_TOL |
1e-6 |
Semi-major axis (meters), magnitude < 1e10 (use A_TOL_LARGE for larger) |
E_TOL |
1e-12 |
Eccentricity, round-trip conversion |
ANG_TOL |
1e-12 |
Angles in radians (nu, inc, Ω, ω) |
ANG_TOL_COARSE |
1e-4 |
Angles, degenerate cases (polar/retrograde) |
R_TOL |
1e-6 |
Radius / distance magnitudes (meters) |
V_TOL |
1e-6 |
Velocity magnitudes (m/s) |
M_TOL |
1e-6 |
Time / period values (seconds) |
REL_TOL |
1e-8 |
Relative / percentage errors (dimensionless) |
DRIFT_TOL |
1e-12 |
Energy drift percent (parabolic orbit) |
- Declare tolerance constants in the fixture (between
SCENARIOopening and firstSECTION) - Tighten aggressively: if observed error is
1e-8, use1e-6(two orders of margin) - Replace qualitative checks (
a > b) with quantitative (WithinAbs(expected, tol)) INFO("label: " << value)for debugging context
4. Precalc Scripts
- For each test file, create
scripts/precalc_<test_name>.pythat computes expected values. - Check the capability matrix first — only use sim_engine.py for implemented features.
- Always output local-frame values (distances from parent, not global from origin).
- C++ tests typically use local coordinates (e.g.,
vec3_distance(craft->local_position, (Vec3){0,0,0})). - Global distances are dominated by parent body positions (e.g., Earth-Sun distance swamps LEO orbit).
- C++ tests typically use local coordinates (e.g.,
- Always output SI units (meters, m/s, seconds) — C++ tests use SI internally.
- Output C++-style comments with precalculated constants for embedding in the test.
- Run with:
python3 scripts/precalc_<test_name>.py - If sim_engine.py lacks a feature, use analytical formulas instead (but notify the user what feature was missing)
Refactoring Procedure
Step 1: Refactor
- Verify the test file has a TOML config in
old_tests/. If it doesn't, skip — it's likely hardcoded. - Check if the test is already in
tests/(already refactored). Skip if so. - Check the capability matrix in Section 5 — if the test needs SOI, maneuvers, rendezvous, etc., flag this before starting.
- Process one test file at a time.
- Create
scripts/precalc_<test_name>.pyand run it to get expected values. - Copy from
old_tests/totests/, rewrite using the pattern fromtest_true_anomaly_roundtrip.cpp. - Rewrite TOML configs to TOML 1.0 inline table syntax (single-line
{}). - Follow all rules in sections 1-4 above.
Step 2: Tighten Tolerances
- Build and verify:
make test-buildthen./build/orbit_test '[tag]' -s. - Run full suite:
make test. - Review every tolerance against actual observed errors from
-soutput. - If a constant's margin is too loose (e.g.,
1e-6when error is1e-10), tighten to1e-8. - If a test fails due to a tolerance being too tight, report the observed error to the user and ask whether to loosen the constant or investigate the root cause. Never silently widen a tolerance.
- Refer to the tolerance reference table in Section 3 for constant names.
Step 3: Code Review
- Remove unused includes (only include what's actually used).
- Remove unused variables (e.g.,
const double mu = G * M_sun;if never referenced). - Look for repeated initialization patterns — extract into helper lambdas (
make_elements,convert_and_recover). - Use
constfor all fixture data and recovered results. - Replace C-style arrays with
std::arraywhere appropriate. - Ensure consistent tolerance usage (no hardcoded
1e-4whenANG_TOL_COARSEexists). - Check for
compare_vec3availability intest_utilitiesinstead of 6 individualREQUIRE_THATcalls. - Run full suite again:
make test. - Always ask for review before moving to the next file.
- Only commit when asked.
Tooling & Sim Engine Capabilities
Tooling
scripts/sim_engine.py— Generic orbital mechanics simulator (Python, TOML 1.0 configs)- Replicates C++ physics: Kepler propagation, orbital↔Cartesian transforms, drift detection
- Multi-body hierarchical propagation with global/local coordinate tracking
- Use for precalculating expected values (transition times, final states, energy conservation)
- TOML configs in
tests/must use TOML 1.0 inline table syntax (single-line{})- Old configs in
old_tests/use multiline inline tables (toml-c17 style) — keep for reference - Python's
tomllibrequires single-line inline tables
- Old configs in
Sim Engine Capabilities
Implemented
- Body propagation (elliptical + parabolic via Barker's equation)
- Orbital↔Cartesian transforms (full z-x-z Euler rotation)
- Velocity drift detection and element reconstruction
- Global coordinate computation (hierarchical parent→child)
- Spacecraft struct, loading, propagation
- Impulsive burns (prograde, retrograde, normal, antinormal, radial_in, radial_out, custom)
- TOML 1.0 config parsing
NOT Implemented (notify the user before beginning to refactor)
- SOI transitions
- Maneuver trigger system (TRIGGER_TIME, TRIGGER_TRUE_ANOMALY)
- Hohmann transfer calculations
- Rendezvous planning
- OrbitTracker
- Energy functions (KE, PE, total)
- Hyperbolic propagation
Test Refactoring Status
Completed
test_barkers_equation✅ — Barker's equation unit tests + parabolic propagationtest_cartesian_to_elements_advanced✅ — Advanced conversion tests (eccentricity spectrum, inclination, true anomaly, 3D orientation)test_cartesian_to_elements_basic✅ — Element round-trip conversion (semi-major axis, eccentricity, true anomaly, inclination, radius, velocity)test_parabolic_orbit✅ — Parabolic orbit energy conservation + escape trajectory + initial conditionstest_extreme_eccentricity✅ — High-eccentricity orbits (single SCENARIO, precalculated values, REL_TOL)test_extreme_orientation_mixed✅ — Extreme orientation conversions, rotation matrix properties, singularity handlingtest_extreme_timescales✅ — 9 TEST_CASEs → 1 SCENARIO with 11 SECTIONs, all WithinAbs use named constantstest_analytical_propagation✅ — 5 SCENARIOs → 1 SCENARIO with 23 SECTIONs, precalculated values, all WithinAbs use named constants
Can Refactor Now (sim_engine.py supports all features needed)
test_moon_orbits— multi-body propagationtest_periapsis_burn— prograde burnstest_hybrid_burns— impulse burnstest_omega_debug— burn + element reconstruction
Blocked on Missing Features
test_soi_transition— needs SOI transitionstest_root_body_transitions— needs SOI transitionstest_maneuver_planning— needs maneuver trigger systemtest_hybrid_energy_conservation— needs energy functions (KE, PE, total)test_hyperbolic_orbit— needs hyperbolic propagationtest_rendezvous— needs Hohmann transfer calculations
Skip (Hardcoded / No TOML)
test_integration— hardcoded vector tests, no TOML config