pleiades-backend 0.2.0

Backend traits, request/result contracts, capability metadata, policy summaries, and routing helpers for pleiades ephemeris backends.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270

use crate::*;

#[test]
fn backend_metadata_has_a_compact_display() {
    let metadata = BackendMetadata {
        id: BackendId::new("toy"),
        version: "0.1.0".to_string(),
        family: BackendFamily::Algorithmic,
        provenance: BackendProvenance::new("example backend"),
        nominal_range: TimeRange::new(None, None),
        supported_time_scales: vec![TimeScale::Tt, TimeScale::Tdb],
        body_coverage: vec![CelestialBody::Sun, CelestialBody::Moon],
        supported_frames: vec![CoordinateFrame::Ecliptic, CoordinateFrame::Equatorial],
        capabilities: BackendCapabilities::default(),
        accuracy: AccuracyClass::Approximate,
        deterministic: true,
        offline: true,
    };

    assert_eq!(metadata.to_string(), metadata.summary_line());
    assert_eq!(
        metadata.validated_summary_line(),
        Ok(metadata.summary_line())
    );
    assert!(metadata.summary_line().contains("id=toy"));
    assert!(metadata.summary_line().contains("version=0.1.0"));
    assert!(metadata.summary_line().contains("family=Algorithmic"));
    assert!(metadata
        .summary_line()
        .contains("family posture=algorithmic"));
    assert!(metadata.summary_line().contains("accuracy=Approximate"));
    assert!(metadata.summary_line().contains("deterministic=true"));
    assert!(metadata.summary_line().contains("offline=true"));
    assert!(metadata.summary_line().contains("time scales=[TT, TDB]"));
    assert!(metadata.summary_line().contains("bodies=[Sun, Moon]"));
    assert!(metadata
        .summary_line()
        .contains("frames=[Ecliptic, Equatorial]"));
    assert!(metadata.summary_line().contains("capabilities=["));
    assert!(metadata
        .summary_line()
        .contains("provenance=example backend"));
    assert!(metadata.validate().is_ok());
}

#[test]
fn backend_metadata_validation_rejects_blank_and_duplicate_fields() {
    let mut metadata = BackendMetadata {
        id: BackendId::new(" "),
        version: "0.1.0".to_string(),
        family: BackendFamily::Algorithmic,
        provenance: BackendProvenance::new("example backend"),
        nominal_range: TimeRange::new(None, None),
        supported_time_scales: vec![TimeScale::Tt, TimeScale::Tt],
        body_coverage: vec![CelestialBody::Sun, CelestialBody::Sun],
        supported_frames: vec![CoordinateFrame::Ecliptic],
        capabilities: BackendCapabilities::default(),
        accuracy: AccuracyClass::Approximate,
        deterministic: true,
        offline: true,
    };

    let error = metadata
        .validate()
        .expect_err("blank backend ids should fail validation");
    assert_eq!(
        error.summary_line(),
        "backend metadata field `id` is blank or whitespace-padded"
    );
    assert_eq!(error.to_string(), error.summary_line());
    assert!(metadata.validated_summary_line().is_err());

    metadata.id = BackendId::new("toy");
    metadata.provenance.summary = " ".to_string();

    let error = metadata
        .validate()
        .expect_err("blank provenance summaries should fail validation");
    assert_eq!(
        error.summary_line(),
        "backend metadata field `provenance summary` is blank or whitespace-padded"
    );
    assert_eq!(error.to_string(), error.summary_line());

    metadata.provenance.summary = "example backend".to_string();
    metadata.provenance.data_sources = vec![" source A".to_string()];

    let error = metadata
        .validate()
        .expect_err("whitespace-padded provenance sources should fail validation");
    assert_eq!(
        error.summary_line(),
        "backend metadata field `provenance data sources` is blank or whitespace-padded"
    );
    assert_eq!(error.to_string(), error.summary_line());

    metadata.provenance.data_sources = vec!["source A".to_string()];
    metadata.supported_time_scales = vec![TimeScale::Tt];
    metadata.body_coverage = vec![CelestialBody::Sun];
    metadata.supported_frames = vec![CoordinateFrame::Ecliptic, CoordinateFrame::Ecliptic];

    let error = metadata
        .validate()
        .expect_err("duplicate supported frames should fail validation");
    assert_eq!(
        error.summary_line(),
        "backend metadata field `supported frames` contains duplicate entry `Ecliptic`"
    );
    assert_eq!(error.to_string(), error.summary_line());

    metadata.supported_frames = vec![CoordinateFrame::Ecliptic];
    metadata.provenance.data_sources = vec!["source A".to_string(), "source A".to_string()];

    let error = metadata
        .validate()
        .expect_err("duplicate provenance sources should fail validation");
    assert_eq!(
        error.summary_line(),
        "backend metadata field `provenance data sources` contains duplicate entry `source A`"
    );
    assert_eq!(error.to_string(), error.summary_line());

    metadata.provenance.data_sources = vec!["source A".to_string()];
    metadata.nominal_range = TimeRange::new(
        Some(Instant::new(
            JulianDay::from_days(2_451_546.0),
            TimeScale::Tt,
        )),
        Some(Instant::new(
            JulianDay::from_days(2_451_545.0),
            TimeScale::Tt,
        )),
    );

    let error = metadata
        .validate()
        .expect_err("out-of-order nominal ranges should fail validation");
    assert_eq!(
        error.summary_line(),
        "backend metadata nominal range end must not precede the start"
    );
    assert_eq!(error.to_string(), error.summary_line());

    metadata.nominal_range = TimeRange::new(
        Some(Instant::new(
            JulianDay::from_days(2_451_545.0),
            TimeScale::Tt,
        )),
        Some(Instant::new(
            JulianDay::from_days(2_451_546.0),
            TimeScale::Tdb,
        )),
    );

    let error = metadata
        .validate()
        .expect_err("mixed nominal-range scales should fail validation");
    assert_eq!(
        error.summary_line(),
        "backend metadata nominal range bounds must use the same time scale"
    );
    assert_eq!(error.to_string(), error.summary_line());

    metadata.nominal_range = TimeRange::new(
        Some(Instant::new(
            JulianDay::from_days(2_451_545.0),
            TimeScale::Tt,
        )),
        Some(Instant::new(
            JulianDay::from_days(2_451_546.0),
            TimeScale::Tt,
        )),
    );
    metadata.capabilities = BackendCapabilities {
        geocentric: false,
        topocentric: false,
        apparent: false,
        mean: false,
        batch: true,
        native_sidereal: false,
    };

    let error = metadata
        .validate()
        .expect_err("capability flags without a position or value mode should fail validation");
    assert_eq!(
            error.summary_line(),
            "backend metadata field `capabilities` is invalid: backend capabilities must support geocentric or topocentric positions"
        );
    assert_eq!(error.to_string(), error.summary_line());

    metadata.capabilities = BackendCapabilities::default();
    metadata.nominal_range = TimeRange::new(
        Some(Instant::new(
            JulianDay::from_days(f64::INFINITY),
            TimeScale::Tt,
        )),
        Some(Instant::new(
            JulianDay::from_days(2_451_546.0),
            TimeScale::Tt,
        )),
    );

    let error = metadata
        .validate()
        .expect_err("non-finite nominal-range bounds should fail validation");
    assert_eq!(
        error.summary_line(),
        "backend metadata nominal range must use finite Julian-day bounds"
    );
    assert_eq!(error.to_string(), error.summary_line());
}

#[test]
fn backend_provenance_summary_has_a_compact_display() {
    let provenance = BackendProvenance {
        summary: "toy backend for tests".to_string(),
        data_sources: vec!["source A".to_string(), "source B".to_string()],
    };

    assert_eq!(provenance.to_string(), provenance.summary_line());
    assert_eq!(provenance.summary_line(), "toy backend for tests");
    assert!(provenance.summary_line().contains("toy backend for tests"));
    assert_eq!(
        provenance.validated_summary_line(),
        Ok(provenance.summary_line())
    );
    assert!(provenance.validate().is_ok());
}

#[test]
fn backend_provenance_validation_rejects_blank_summary_and_duplicate_sources() {
    let mut provenance = BackendProvenance {
        summary: " ".to_string(),
        data_sources: vec!["source A".to_string(), "source A".to_string()],
    };

    let error = provenance
        .validate()
        .expect_err("blank provenance summaries should fail validation");
    assert_eq!(
        error.summary_line(),
        "backend provenance summary must not be blank or whitespace-padded"
    );
    assert_eq!(error.to_string(), error.summary_line());

    provenance.summary = "toy backend".to_string();
    provenance.data_sources = vec![" source A".to_string()];

    let error = provenance
        .validate()
        .expect_err("whitespace-padded provenance sources should fail validation");
    assert_eq!(
        error.summary_line(),
        "backend provenance data source at index 0 must not be blank or whitespace-padded"
    );
    assert_eq!(error.to_string(), error.summary_line());

    provenance.data_sources = vec!["source A".to_string(), "source A".to_string()];

    let error = provenance
        .validate()
        .expect_err("duplicate provenance sources should fail validation");
    assert_eq!(
        error.summary_line(),
        "backend provenance data sources contain duplicate entry `source A`"
    );
    assert_eq!(error.to_string(), error.summary_line());
    assert!(provenance.validated_summary_line().is_err());
}