refactor(firmware): centralize configuration and diagnostics

firmware/libs/kaptan-flight-config/src/cbor.rs

@@ -1,4 +1,4 @@
-//! Bounded CBOR import/export for one explicit current record.
+//! Bounded CBOR persistence codec for one explicit current record.
 
 use kaptan_config::{
     ConfigModel, ConfigValue, ConfigViolation, FieldWriteError, ValidationRule, ValueKind,
@@ -13,7 +13,7 @@ pub const MAXIMUM_CANDIDATE_BYTES: usize = 4096;
 const FORMAT_KEY: u16 = 0;
 const SCHEMA_KEY: u16 = u16::MAX;
 
-/// CBOR import failure.
+/// CBOR snapshot decoding failure.
 #[derive(Clone, Copy, Debug, Eq, PartialEq, KaptanError)]
 pub enum CborError {
     /// The supplied payload exceeded the bounded configuration storage budget.
@@ -126,17 +126,14 @@ fn decode_current(bytes: &[u8]) -> Result<CandidateProfile, CborError> {
                 }
             }
             _ => {
-                let index = CandidateProfile::descriptors()
-                    .iter()
-                    .position(|descriptor| descriptor.id.get() == key)
+                let (index, descriptor) = CandidateProfile::descriptors()
+                    .enumerate()
+                    .find(|(_, descriptor)| descriptor.id.get() == key)
                     .ok_or(CborError::Malformed)?;
                 if values[index].is_some() {
                     return Err(CborError::Malformed);
                 }
-                values[index] = Some(decode_value(
-                    &mut decoder,
-                    CandidateProfile::descriptors()[index].kind,
-                )?);
+                values[index] = Some(decode_value(&mut decoder, descriptor.kind)?);
             }
         }
     }
@@ -151,10 +148,10 @@ fn decode_current(bytes: &[u8]) -> Result<CandidateProfile, CborError> {
     if values.iter().any(Option::is_none) {
         return Err(CborError::Malformed);
     }
-    let mut candidate = CandidateProfile::default();
+    let mut candidate = CandidateProfile::factory();
     for (index, value) in values.into_iter().enumerate() {
         let descriptor = CandidateProfile::descriptors()
-            .get(index)
+            .nth(index)
             .ok_or(CborError::Malformed)?;
         candidate
             .set_field(descriptor.id, value.ok_or(CborError::Malformed)?)
@@ -210,7 +207,7 @@ mod tests {
     fn round_trip_and_trailing_rejection_are_exact() {
         let mut writer = minicbor::encode::write::Cursor::new([0_u8; MAXIMUM_CANDIDATE_BYTES]);
         let capabilities = VehicleCapabilities::quad_x();
-        encode_candidate(CandidateProfile::default(), &capabilities, &mut writer).unwrap();
+        encode_candidate(CandidateProfile::factory(), &capabilities, &mut writer).unwrap();
         let length = writer.position();
         let bytes = writer.into_inner();
         assert!(decode_candidate(&bytes[..length], &capabilities).is_ok());
@@ -225,7 +222,7 @@ mod tests {
     #[test]
     fn encoding_rejects_a_cross_field_invalid_transaction_before_writing() {
         let capabilities = VehicleCapabilities::quad_x();
-        let mut candidate = CandidateProfile::default();
+        let mut candidate = CandidateProfile::factory();
         candidate
             .set_field(kaptan_config::FieldId::new(2), ConfigValue::U64(50_001))
             .expect("the scalar is locally valid");
@@ -295,8 +292,8 @@ mod tests {
             .u16(FORMAT_VERSION)
             .unwrap();
         encoder.u16(SCHEMA_KEY).unwrap().bytes(&SCHEMA_ID).unwrap();
-        let candidate = CandidateProfile::default();
-        for descriptor in CandidateProfile::descriptors().iter().skip(1) {
+        let candidate = CandidateProfile::factory();
+        for descriptor in CandidateProfile::descriptors().skip(1) {
             encoder.u16(descriptor.id.get()).unwrap();
             encode_value(&mut encoder, candidate.field_value(descriptor.id).unwrap()).unwrap();
         }
@@ -312,7 +309,6 @@ mod tests {
     fn cbor_scalar_write_preserves_the_generated_field_and_rule() {
         let capabilities = VehicleCapabilities::quad_x();
         let mass = CandidateProfile::descriptors()
-            .iter()
             .find(|descriptor| descriptor.display_key == "thrust.mass_kg")
             .expect("declared mass descriptor");
         let mut writer = minicbor::encode::write::Cursor::new([0_u8; MAXIMUM_CANDIDATE_BYTES]);
@@ -326,7 +322,7 @@ mod tests {
             .u16(FORMAT_VERSION)
             .unwrap();
         encoder.u16(SCHEMA_KEY).unwrap().bytes(&SCHEMA_ID).unwrap();
-        let candidate = CandidateProfile::default();
+        let candidate = CandidateProfile::factory();
         for descriptor in CandidateProfile::descriptors() {
             encoder.u16(descriptor.id.get()).unwrap();
             let value = if descriptor.id == mass.id {
@@ -367,7 +363,7 @@ mod tests {
             .u16(format_version)
             .unwrap();
         encoder.u16(SCHEMA_KEY).unwrap().bytes(&schema_id).unwrap();
-        let candidate = CandidateProfile::default();
+        let candidate = CandidateProfile::factory();
         for descriptor in CandidateProfile::descriptors() {
             encoder.u16(remap_key(descriptor.id.get())).unwrap();
             encode_value(&mut encoder, candidate.field_value(descriptor.id).unwrap()).unwrap();