fit-sdk-rust 0.2.1

Pure-Rust implementation of the Garmin FIT (Flexible and Interoperable Data Transfer) protocol.
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
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
//! M8 — Encoder integration tests.
//!
//! 1. Round-trip: decode Activity.fit → encode → re-decode → same message count.
//! 2. Field-level round-trip: specific field values survive encode/decode.
//! 3. Synthetic minimal FIT: encode one message, decode back.
//! 4. Integrity: encoded files pass CRC checks.

use std::path::PathBuf;

use fit::{Decoder, Encoder, Field, FieldKind, Message, Value};

fn fixture(name: &str) -> PathBuf {
    let mut p = PathBuf::from(env!("CARGO_MANIFEST_DIR"));
    p.push("tests/fixtures/test_data");
    p.push(name);
    p
}

fn read_fixture(name: &str) -> Vec<u8> {
    std::fs::read(fixture(name)).expect("fixture must be readable")
}

// ────────────────────────────────────────────────────────────────────
// 1. Round-trip on Activity.fit
// ────────────────────────────────────────────────────────────────────

#[test]
fn roundtrip_activity_message_count() {
    let bytes = read_fixture("Activity.fit");

    // Decode with all transforms enabled (default).
    let (messages, errors) = Decoder::builder(&bytes).build().read_all();
    assert!(errors.is_empty(), "decode errors: {errors:?}");

    // Encode back to FIT binary.
    let enc = Encoder::new();
    let encoded = enc.encode(&messages).expect("encode must succeed");

    // Verify encoded file passes integrity check.
    fit::check_integrity(&encoded).expect("encoded file must pass CRC check");

    // Re-decode and compare message count.
    let (messages2, errors2) = Decoder::builder(&encoded).build().read_all();
    assert!(errors2.is_empty(), "re-decode errors: {errors2:?}");
    assert_eq!(
        messages.len(),
        messages2.len(),
        "message count must survive round-trip"
    );
}

#[test]
fn roundtrip_activity_message_names() {
    let bytes = read_fixture("Activity.fit");
    let (messages, _errors) = Decoder::builder(&bytes).build().read_all();

    let enc = Encoder::new();
    let encoded = enc.encode(&messages).unwrap();
    let (messages2, _errors2) = Decoder::builder(&encoded).build().read_all();

    // Each message's name must survive the round-trip.
    for (a, b) in messages.iter().zip(messages2.iter()) {
        assert_eq!(a.global_mesg_num, b.global_mesg_num, "mesg_num mismatch");
        assert_eq!(
            a.name, b.name,
            "name mismatch for mesg_num {}",
            a.global_mesg_num
        );
    }
}

#[test]
fn roundtrip_activity_timestamps() {
    let bytes = read_fixture("Activity.fit");
    let (messages, _errors) = Decoder::builder(&bytes).build().read_all();

    let enc = Encoder::new();
    let encoded = enc.encode(&messages).unwrap();
    let (messages2, _errors2) = Decoder::builder(&encoded).build().read_all();

    // Check that all DateTime fields survive.
    for (a, b) in messages.iter().zip(messages2.iter()) {
        for (fa, fb) in a.fields.iter().zip(b.fields.iter()) {
            if let (Value::DateTime(da), Value::DateTime(db)) = (&fa.value, &fb.value) {
                assert_eq!(da, db, "DateTime mismatch in {}", a.name);
            }
        }
    }
}

#[test]
fn roundtrip_activity_is_valid_fit() {
    let bytes = read_fixture("Activity.fit");
    let (messages, _errors) = Decoder::builder(&bytes).build().read_all();

    let enc = Encoder::new();
    let encoded = enc.encode(&messages).unwrap();

    // Basic FIT validation.
    assert!(
        fit::is_fit(&encoded),
        "encoded bytes must be a valid FIT file"
    );
    fit::check_integrity(&encoded).expect("CRC must be valid");
}

// ────────────────────────────────────────────────────────────────────
// 2. Field-level round-trip
// ────────────────────────────────────────────────────────────────────

#[test]
fn roundtrip_specific_field_values() {
    let bytes = read_fixture("Activity.fit");
    let (messages, _errors) = Decoder::builder(&bytes).build().read_all();

    let enc = Encoder::new();
    let encoded = enc.encode(&messages).unwrap();
    let (messages2, _errors2) = Decoder::builder(&encoded).build().read_all();

    // Check first file_id message's type field.
    let file_id_1 = messages.iter().find(|m| m.global_mesg_num == 0);
    let file_id_2 = messages2.iter().find(|m| m.global_mesg_num == 0);
    if let (Some(a), Some(b)) = (file_id_1, file_id_2) {
        assert_eq!(
            a.field("type").map(|f| &f.value),
            b.field("type").map(|f| &f.value),
            "file_id.type must survive round-trip"
        );
    }

    // Check first session's sport.
    let session_1 = messages.iter().find(|m| m.name == "session");
    let session_2 = messages2.iter().find(|m| m.name == "session");
    if let (Some(a), Some(b)) = (session_1, session_2) {
        assert_eq!(
            a.field("sport").map(|f| &f.value),
            b.field("sport").map(|f| &f.value),
            "session.sport must survive round-trip"
        );
    }
}

// ────────────────────────────────────────────────────────────────────
// 3. Synthetic minimal FIT
// ────────────────────────────────────────────────────────────────────

#[cfg(feature = "chrono")]
#[test]
fn encode_single_record_message() {
    use chrono::{TimeZone, Utc};

    let messages = vec![Message {
        global_mesg_num: 0, // file_id
        name: "file_id",
        fields: vec![
            Field {
                name: "type".to_string(),
                kind: FieldKind::Standard { field_def_num: 0 },
                value: Value::Enum("activity".into()),
                units: None,
            },
            Field {
                name: "time_created".to_string(),
                kind: FieldKind::Standard { field_def_num: 3 },
                value: Value::DateTime(Utc.with_ymd_and_hms(2021, 7, 19, 21, 11, 20).unwrap()),
                units: None,
            },
        ],
    }];

    let enc = Encoder::new();
    let encoded = enc.encode(&messages).unwrap();

    assert!(fit::is_fit(&encoded));
    fit::check_integrity(&encoded).expect("CRC must be valid");

    // Re-decode and verify.
    let (decoded, errors) = Decoder::builder(&encoded).build().read_all();
    assert!(errors.is_empty(), "errors: {errors:?}");
    assert_eq!(decoded.len(), 1);
    assert_eq!(decoded[0].name, "file_id");

    let type_field = decoded[0].field("type").unwrap();
    assert_eq!(type_field.value, Value::Enum("activity".into()));
}

#[test]
fn encode_with_uint_fields() {
    let messages = vec![Message {
        global_mesg_num: 0, // file_id
        name: "file_id",
        fields: vec![
            Field {
                name: "type".to_string(),
                kind: FieldKind::Standard { field_def_num: 0 },
                value: Value::Enum("activity".into()),
                units: None,
            },
            Field {
                name: "manufacturer".to_string(),
                kind: FieldKind::Standard { field_def_num: 1 },
                value: Value::UInt(1), // garmin
                units: None,
            },
            Field {
                name: "product".to_string(),
                kind: FieldKind::Standard { field_def_num: 2 },
                value: Value::UInt(3415),
                units: None,
            },
        ],
    }];

    let enc = Encoder::new();
    let encoded = enc.encode(&messages).unwrap();

    fit::check_integrity(&encoded).expect("CRC must be valid");

    let (decoded, errors) = Decoder::builder(&encoded).build().read_all();
    assert!(errors.is_empty(), "errors: {errors:?}");
    assert_eq!(decoded.len(), 1);

    let msg = &decoded[0];
    // manufacturer is an enum-typed field (uint16); the default typed-decoder
    // converts UInt(1) → Enum("garmin"). The encoder's job is to preserve
    // the wire bytes — which it does, as evidenced by the round-trip naming.
    assert_eq!(
        msg.field("manufacturer").unwrap().value,
        Value::Enum("garmin".into())
    );
    // product activates the `garmin_product` SubField (because manufacturer ==
    // garmin); 3415 is not a named garmin_product value, so it stays a UInt.
    assert_eq!(
        msg.field("garmin_product").unwrap().value,
        Value::UInt(3415)
    );
}

#[test]
fn encode_multiple_messages() {
    let messages = vec![
        Message {
            global_mesg_num: 0, // file_id
            name: "file_id",
            fields: vec![Field {
                name: "type".to_string(),
                kind: FieldKind::Standard { field_def_num: 0 },
                value: Value::Enum("activity".into()),
                units: None,
            }],
        },
        Message {
            global_mesg_num: 49, // file_creator
            name: "file_creator",
            fields: vec![Field {
                name: "software_version".to_string(),
                kind: FieldKind::Standard { field_def_num: 0 },
                value: Value::UInt(1),
                units: None,
            }],
        },
    ];

    let enc = Encoder::new();
    let encoded = enc.encode(&messages).unwrap();

    fit::check_integrity(&encoded).expect("CRC must be valid");

    let (decoded, errors) = Decoder::builder(&encoded).build().read_all();
    assert!(errors.is_empty(), "errors: {errors:?}");
    assert_eq!(decoded.len(), 2);
    assert_eq!(decoded[0].name, "file_id");
    assert_eq!(decoded[1].name, "file_creator");
}

// ────────────────────────────────────────────────────────────────────
// 4. Raw decode round-trip (using raw Decoder, not TypedDecoder)
// ────────────────────────────────────────────────────────────────────

#[test]
fn raw_roundtrip_activity() {
    let bytes = read_fixture("Activity.fit");
    let (raw_msgs, errors) = Decoder::new(&bytes).read_all();
    assert!(errors.is_empty(), "raw decode errors: {errors:?}");

    // Encode via typed pipeline (need Messages).
    let (typed_msgs, t_errors) = Decoder::builder(&bytes).build().read_all();
    assert!(t_errors.is_empty());

    let enc = Encoder::new();
    let encoded = enc.encode(&typed_msgs).unwrap();

    // Re-decode raw and compare count.
    let (raw_msgs2, errors2) = Decoder::new(&encoded).read_all();
    assert!(errors2.is_empty(), "raw re-decode errors: {errors2:?}");
    assert_eq!(
        raw_msgs.len(),
        raw_msgs2.len(),
        "raw message count must survive round-trip"
    );
}

// ────────────────────────────────────────────────────────────────────
// 5. Field-level round-trip on Activity.fit
// ────────────────────────────────────────────────────────────────────

/// Compare two Values, allowing a small absolute tolerance for `Float`
/// (which round-trips through scale/offset and integer truncation).
fn values_roughly_equal(a: &Value, b: &Value) -> bool {
    match (a, b) {
        (Value::Float(x), Value::Float(y)) => (x - y).abs() < 1e-6,
        (Value::Array(xs), Value::Array(ys)) if xs.len() == ys.len() => xs
            .iter()
            .zip(ys.iter())
            .all(|(x, y)| values_roughly_equal(x, y)),
        _ => a == b,
    }
}

#[test]
fn roundtrip_activity_field_values_full() {
    let bytes = read_fixture("Activity.fit");
    let (messages, _) = Decoder::builder(&bytes).build().read_all();

    let enc = Encoder::new();
    let encoded = enc.encode(&messages).unwrap();
    let (messages2, errors2) = Decoder::builder(&encoded).build().read_all();
    assert!(errors2.is_empty(), "re-decode errors: {errors2:?}");

    assert_eq!(messages.len(), messages2.len(), "msg count");

    // For every (message, field) pair on the original side, the same field
    // (looked up by name) must decode to a roughly-equal Value after the
    // round-trip. We tolerate fields the encoder cannot represent yet (dev
    // fields, components synthesised at decode time) by skipping them on the
    // original side when they are absent from the round-trip.
    let mut compared = 0usize;
    for (a, b) in messages.iter().zip(messages2.iter()) {
        assert_eq!(a.global_mesg_num, b.global_mesg_num);
        for fa in &a.fields {
            // Skip developer fields (encoder M8 doesn't emit them yet).
            if !matches!(fa.kind, FieldKind::Standard { .. }) {
                continue;
            }
            let Some(fb) = b.field(&fa.name) else {
                continue;
            };
            assert!(
                values_roughly_equal(&fa.value, &fb.value),
                "{}.{}: {:?} vs {:?}",
                a.name,
                fa.name,
                fa.value,
                fb.value,
            );
            compared += 1;
        }
    }
    // Sanity: we must have actually compared a lot of fields.
    assert!(compared > 1000, "only compared {compared} fields");
}

#[test]
fn roundtrip_preserves_record_speed_with_scale() {
    // record.speed has scale=1000 (raw u16 → m/s f64). Verify that a Float
    // value survives encode → decode through the reverse-scale path.
    let bytes = read_fixture("Activity.fit");
    let (messages, _) = Decoder::builder(&bytes).build().read_all();

    let speed_before: Vec<f64> = messages
        .iter()
        .filter(|m| m.name == "record")
        .filter_map(|m| m.field("speed"))
        .filter_map(|f| match &f.value {
            Value::Float(v) => Some(*v),
            _ => None,
        })
        .collect();
    assert!(
        !speed_before.is_empty(),
        "fixture must have at least one record.speed Float"
    );

    let enc = Encoder::new();
    let encoded = enc.encode(&messages).unwrap();
    let (messages2, _) = Decoder::builder(&encoded).build().read_all();

    let speed_after: Vec<f64> = messages2
        .iter()
        .filter(|m| m.name == "record")
        .filter_map(|m| m.field("speed"))
        .filter_map(|f| match &f.value {
            Value::Float(v) => Some(*v),
            _ => None,
        })
        .collect();

    assert_eq!(speed_before.len(), speed_after.len(), "speed count");
    for (a, b) in speed_before.iter().zip(speed_after.iter()) {
        // 1/scale = 1e-3 m/s — round-trip should keep us well within that.
        assert!((a - b).abs() < 1e-3, "speed drift: {a} vs {b}");
    }
}