Merge pull request 'Bump MSRV' (#97) from bump-msrv into main

Reviewed-on: #97

.github/workflows/ci.yml

@@ -1,42 +1,39 @@
-on: [push]
-
 name: ci
+on: [push, pull_request]
 
 jobs:
   check:
-    name: Check
+    name: Check build
     strategy:
       matrix:
         os: [ubuntu-latest, macos-latest, windows-latest]
     runs-on: ${{ matrix.os }}
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
-      - uses: actions-rs/toolchain@v1
+      - uses: dtolnay/rust-toolchain@stable
-        with:
+      - run: cargo check --release
-          profile: minimal
-          toolchain: stable
-      - uses: actions-rs/cargo@v1
-        with:
-          command: check
-          args: --release
 
-  msrv:
+  test:
-    name: Check with MSRV
+    name: Run Tests
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
-      - uses: actions-rs/toolchain@v1
+      - uses: dtolnay/rust-toolchain@stable
-        with:
+      - name: Install nextest
-          toolchain: 1.65.0
+        uses: taiki-e/install-action@nextest
-          override: true
+      - run: cargo nextest run --all-features
-          profile: minimal
+      - run: cargo test --doc
-      - uses: actions-rs/cargo@v1
+
-        with:
+  msrv:
-          command: check
+    name: Check MSRV
-          args: --release
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: dtolnay/rust-toolchain@1.68.2
+      - run: cargo check --release
 
   cross-check:
-    name: Check Cross
+    name: Check Cross-Compilation
     runs-on: ubuntu-latest
     strategy:
       matrix:
@@ -44,70 +41,32 @@ jobs:
           - armv7-unknown-linux-gnueabihf
           - thumbv7em-none-eabihf
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
-      - uses: actions-rs/toolchain@v1
+      - uses: dtolnay/rust-toolchain@stable
         with:
-          profile: minimal
+          targets: "armv7-unknown-linux-gnueabihf, thumbv7em-none-eabihf"
-          toolchain: stable
+      - run: cargo check --release --target=${{matrix.target}} --no-default-features
-          target: ${{ matrix.target }}
-          override: true
-      - uses: actions-rs/cargo@v1
-        with:
-          use-cross: true
-          command: check
-          args: --release --target=${{ matrix.target }} --no-default-features
 
   fmt:
-    name: Rustfmt
+    name: Check formatting
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
-      - uses: actions-rs/toolchain@v1
+      - uses: dtolnay/rust-toolchain@stable
-        with:
+      - run: cargo fmt --all -- --check
-          profile: minimal
-          toolchain: stable
-          override: true
-      - run: rustup component add rustfmt
-      - uses: actions-rs/cargo@v1
-        with:
-          command: fmt
-          args: --all -- --check
 
-  check-doc:
+  docs:
     name: Check Documentation Build
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
-      - uses: actions-rs/toolchain@v1
+      - uses: dtolnay/rust-toolchain@nightly
-        with:
+      - run: cargo +nightly doc --all-features --config 'build.rustdocflags=["--cfg", "docs_rs"]'
-          toolchain: nightly
-          override: true
-          profile: minimal
-      - uses: actions-rs/cargo@v1
-        with:
-          command: doc
-          args: --all-features
 
   clippy:
     name: Clippy
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
-      - uses: actions-rs/toolchain@v1
+      - uses: dtolnay/rust-toolchain@stable
-        with:
+      - run: cargo clippy -- -D warnings
-          profile: minimal
-          toolchain: stable
-      - run: rustup component add clippy
-      - uses: actions-rs/cargo@v1
-        with:
-          command: clippy
-          args: -- -D warnings
-
-  ci:
-      if: ${{ success() }}
-      # all new jobs must be added to this list
-      needs: [check, fmt, clippy]
-      runs-on: ubuntu-latest
-      steps:
-        - name: CI succeeded
-          run: exit 0

CHANGELOG.md

@@ -8,6 +8,26 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 
 # [unreleased]
 
+# [v0.11.2] 2024-05-19
+
+- Bumped MSRV to 1.68.2
+
+## Fixed
+
+- Removed `defmt::Format` impl for `MetadataPduCreator` which seems to be problematic.
+
+# [v0.11.1] 2024-04-22
+
+## Fixed
+
+- The default data length for for `SpHeader` constructors where the data field length is not
+  specified is now 0.
+- The `SpHeader::new_from_fields` is public now.
+
+## Added
+
+- `SpHeader::to_vec` method.
+
 # [v0.11.0] 2024-04-16
 
 ## Changed

Cargo.toml

@@ -1,8 +1,8 @@
 [package]
 name = "spacepackets"
-version = "0.11.0"
+version = "0.11.2"
 edition = "2021"
-rust-version = "1.65"
+rust-version = "1.68.2"
 authors = ["Robin Mueller <muellerr@irs.uni-stuttgart.de>"]
 description = "Generic implementations for various CCSDS and ECSS packet standards"
 homepage = "https://egit.irs.uni-stuttgart.de/rust/spacepackets"

README.md

@@ -61,3 +61,13 @@ cargo install grcov --locked
 
 After that, you can simply run `coverage.py` to test the project with coverage. You can optionally
 supply the `--open` flag to open the coverage report in your webbrowser.
+
+# Miri
+
+You can run the [`miri`](https://github.com/rust-lang/miri) tool on this library to check for
+undefined behaviour (UB). This library does not use use any `unsafe` code blocks, but `miri` could
+still catch UB from used libraries.
+
+```sh
+cargo +nightly miri nextest run --all-features
+```

src/cfdp/pdu/metadata.rs

@@ -56,7 +56,6 @@ pub fn build_metadata_opts_from_vec(
 /// This abstraction exposes a specialized API for creating metadata PDUs as specified in
 /// CFDP chapter 5.2.5.
 #[derive(Debug, Copy, Clone, PartialEq, Eq)]
-#[cfg_attr(feature = "defmt", derive(defmt::Format))]
 pub struct MetadataPduCreator<'src_name, 'dest_name, 'opts> {
     pdu_header: PduHeader,
     metadata_params: MetadataGenericParams,

src/lib.rs

@@ -505,8 +505,8 @@ pub struct SpHeader {
 pub type SpacePacketHeader = SpHeader;
 
 impl Default for SpHeader {
-    /// The default function sets the sequence flag field to [SequenceFlags::Unsegmented]. The data
+    /// The default function sets the sequence flag field to [SequenceFlags::Unsegmented] and the
-    /// length field is set to 1, which denotes an empty space packets.
+    /// data length to 0.
     #[inline]
     fn default() -> Self {
         SpHeader {
@@ -516,7 +516,7 @@ impl Default for SpHeader {
                 seq_flags: SequenceFlags::Unsegmented,
                 seq_count: 0,
             },
-            data_len: 1,
+            data_len: 0,
         }
     }
 }
@@ -532,8 +532,8 @@ impl SpHeader {
         }
     }
 
-    /// This constructor sets the sequence flag field to [SequenceFlags::Unsegmented]. The data
+    /// This constructor sets the sequence flag field to [SequenceFlags::Unsegmented] and the data
-    /// length field is set to 1, which denotes an empty space packets.
+    /// length to 0.
     ///
     /// This constructor will panic if the APID exceeds [MAX_APID].
     #[inline]
@@ -545,7 +545,7 @@ impl SpHeader {
                 seq_flags: SequenceFlags::Unsegmented,
                 seq_count: 0,
             },
-            data_len: 1,
+            data_len: 0,
         }
     }
 
@@ -559,7 +559,7 @@ impl SpHeader {
                 seq_flags: SequenceFlags::Unsegmented,
                 seq_count: 0,
             },
-            data_len: 1,
+            data_len: 0,
         })
     }
 
@@ -568,7 +568,7 @@ impl SpHeader {
     ///
     /// The checked constructor variants can be used to avoid panics.
     #[inline]
-    const fn new_from_fields(
+    pub const fn new_from_fields(
         ptype: PacketType,
         sec_header: bool,
         apid: u16,
@@ -755,6 +755,15 @@ impl SpHeader {
             .ok_or(ByteConversionError::ZeroCopyToError)?;
         Ok(&mut buf[CCSDS_HEADER_LEN..])
     }
+
+    /// Create a vector containing the CCSDS header.
+    #[cfg(feature = "alloc")]
+    pub fn to_vec(&self) -> alloc::vec::Vec<u8> {
+        let mut vec = alloc::vec![0; CCSDS_HEADER_LEN];
+        // This can not fail.
+        self.write_to_be_bytes(&mut vec[..]).unwrap();
+        vec
+    }
 }
 
 impl CcsdsPacket for SpHeader {
@@ -1260,12 +1269,14 @@ pub(crate) mod tests {
     fn sp_header_from_apid() {
         let sp_header = SpHeader::new_from_apid(0x03);
         assert_eq!(sp_header.apid(), 0x03);
+        assert_eq!(sp_header.data_len(), 0);
     }
 
     #[test]
     fn sp_header_from_apid_checked() {
         let sp_header = SpHeader::new_from_apid_checked(0x03).unwrap();
         assert_eq!(sp_header.apid(), 0x03);
+        assert_eq!(sp_header.data_len(), 0);
     }
 
     #[cfg(feature = "defmt")]
@@ -1279,4 +1290,14 @@ pub(crate) mod tests {
             expected: 2,
         });
     }
+
+    #[test]
+    fn test_sp_header_as_vec() {
+        let sp_header = SpHeader::new_for_unseg_tc(0x42, 25, 1);
+        let sp_header_as_vec = sp_header.to_vec();
+        let sp_header_read_back = SpHeader::from_be_bytes(&sp_header_as_vec)
+            .expect("Error reading back SP header")
+            .0;
+        assert_eq!(sp_header, sp_header_read_back);
+    }
 }

src/time/ascii.rs

@@ -71,7 +71,19 @@ mod tests {
     use std::format;
 
     #[test]
-    fn test_ascii_timestamp_a_unterminated() {
+    fn test_ascii_timestamp_a_unterminated_epoch() {
+        let date = chrono::DateTime::UNIX_EPOCH;
+        let stamp_formatter = generate_time_code_a(&date);
+        let stamp = format!("{}", stamp_formatter);
+        let t_sep = stamp.find('T');
+        assert!(t_sep.is_some());
+        assert_eq!(t_sep.unwrap(), 10);
+        assert_eq!(stamp.len(), FMT_STR_CODE_A_WITH_SIZE.1);
+    }
+
+    #[test]
+    #[cfg_attr(miri, ignore)]
+    fn test_ascii_timestamp_a_unterminated_now() {
         let date = Utc::now();
         let stamp_formatter = generate_time_code_a(&date);
         let stamp = format!("{}", stamp_formatter);
@@ -82,7 +94,24 @@ mod tests {
     }
 
     #[test]
-    fn test_ascii_timestamp_a_terminated() {
+    fn test_ascii_timestamp_a_terminated_epoch() {
+        let date = chrono::DateTime::UNIX_EPOCH;
+        let stamp_formatter = generate_time_code_a_terminated(&date);
+        let stamp = format!("{}", stamp_formatter);
+        let t_sep = stamp.find('T');
+        assert!(t_sep.is_some());
+        assert_eq!(t_sep.unwrap(), 10);
+        let z_terminator = stamp.find('Z');
+        assert!(z_terminator.is_some());
+        assert_eq!(
+            z_terminator.unwrap(),
+            FMT_STR_CODE_A_TERMINATED_WITH_SIZE.1 - 1
+        );
+        assert_eq!(stamp.len(), FMT_STR_CODE_A_TERMINATED_WITH_SIZE.1);
+    }
+    #[test]
+    #[cfg_attr(miri, ignore)]
+    fn test_ascii_timestamp_a_terminated_now() {
         let date = Utc::now();
         let stamp_formatter = generate_time_code_a_terminated(&date);
         let stamp = format!("{}", stamp_formatter);
@@ -99,7 +128,19 @@ mod tests {
     }
 
     #[test]
-    fn test_ascii_timestamp_b_unterminated() {
+    fn test_ascii_timestamp_b_unterminated_epoch() {
+        let date = chrono::DateTime::UNIX_EPOCH;
+        let stamp_formatter = generate_time_code_b(&date);
+        let stamp = format!("{}", stamp_formatter);
+        let t_sep = stamp.find('T');
+        assert!(t_sep.is_some());
+        assert_eq!(t_sep.unwrap(), 8);
+        assert_eq!(stamp.len(), FMT_STR_CODE_B_WITH_SIZE.1);
+    }
+
+    #[test]
+    #[cfg_attr(miri, ignore)]
+    fn test_ascii_timestamp_b_unterminated_now() {
         let date = Utc::now();
         let stamp_formatter = generate_time_code_b(&date);
         let stamp = format!("{}", stamp_formatter);
@@ -110,7 +151,25 @@ mod tests {
     }
 
     #[test]
-    fn test_ascii_timestamp_b_terminated() {
+    fn test_ascii_timestamp_b_terminated_epoch() {
+        let date = chrono::DateTime::UNIX_EPOCH;
+        let stamp_formatter = generate_time_code_b_terminated(&date);
+        let stamp = format!("{}", stamp_formatter);
+        let t_sep = stamp.find('T');
+        assert!(t_sep.is_some());
+        assert_eq!(t_sep.unwrap(), 8);
+        let z_terminator = stamp.find('Z');
+        assert!(z_terminator.is_some());
+        assert_eq!(
+            z_terminator.unwrap(),
+            FMT_STR_CODE_B_TERMINATED_WITH_SIZE.1 - 1
+        );
+        assert_eq!(stamp.len(), FMT_STR_CODE_B_TERMINATED_WITH_SIZE.1);
+    }
+
+    #[test]
+    #[cfg_attr(miri, ignore)]
+    fn test_ascii_timestamp_b_terminated_now() {
         let date = Utc::now();
         let stamp_formatter = generate_time_code_b_terminated(&date);
         let stamp = format!("{}", stamp_formatter);

src/time/cds.rs

@@ -1622,6 +1622,7 @@ mod tests {
     }
 
     #[test]
+    #[cfg_attr(miri, ignore)]
     fn test_time_now() {
         let timestamp_now = CdsTime::now_with_u16_days().unwrap();
         let compare_stamp = chrono::Utc::now();
@@ -1629,6 +1630,7 @@ mod tests {
     }
 
     #[test]
+    #[cfg_attr(miri, ignore)]
     fn test_time_now_us_prec() {
         let timestamp_now = CdsTime::now_with_u16_days_us_precision().unwrap();
         let compare_stamp = chrono::Utc::now();
@@ -1636,6 +1638,7 @@ mod tests {
     }
 
     #[test]
+    #[cfg_attr(miri, ignore)]
     fn test_time_now_ps_prec() {
         let timestamp_now = CdsTime::from_now_with_u16_days_ps_precision().unwrap();
         let compare_stamp = chrono::Utc::now();
@@ -1643,6 +1646,7 @@ mod tests {
     }
 
     #[test]
+    #[cfg_attr(miri, ignore)]
     fn test_time_now_ps_prec_u16_days() {
         let timestamp_now = CdsTime::from_now_with_u16_days_ps_precision().unwrap();
         let compare_stamp = chrono::Utc::now();
@@ -1650,6 +1654,7 @@ mod tests {
     }
 
     #[test]
+    #[cfg_attr(miri, ignore)]
     fn test_time_now_ps_prec_u24_days() {
         let timestamp_now = CdsTime::now_with_u24_days_ps_precision().unwrap();
         let compare_stamp = chrono::Utc::now();
@@ -2306,6 +2311,7 @@ mod tests {
     }
 
     #[test]
+    #[cfg_attr(miri, ignore)]
     fn test_update_from_now() {
         let mut stamp = CdsTime::new_with_u16_days(0, 0);
         let _ = stamp.update_from_now();
@@ -2321,6 +2327,7 @@ mod tests {
 
     #[test]
     #[cfg(feature = "serde")]
+    #[cfg_attr(miri, ignore)]
     fn test_serialization() {
         let stamp_now = CdsTime::now_with_u16_days().expect("Error retrieving time");
         let val = to_allocvec(&stamp_now).expect("Serializing timestamp failed");

src/time/cuc.rs

@@ -947,6 +947,7 @@ mod tests {
     }
 
     #[test]
+    #[cfg_attr(miri, ignore)]
     fn test_datetime_now() {
         let now = chrono::Utc::now();
         let cuc_now = CucTime::now(FractionalResolution::SixtyNs, LEAP_SECONDS);
@@ -1278,6 +1279,7 @@ mod tests {
     }
 
     #[test]
+    #[cfg_attr(miri, ignore)]
     fn set_fract_resolution() {
         let mut stamp = CucTime::new(2000);
         stamp.set_fractional_resolution(FractionalResolution::SixtyNs);

src/time/mod.rs

@@ -551,6 +551,7 @@ mod tests {
     }
 
     #[test]
+    #[cfg_attr(miri, ignore)]
     fn test_get_current_time() {
         let sec_floats = seconds_since_epoch();
         assert!(sec_floats > 0.0);
@@ -565,6 +566,7 @@ mod tests {
     }
 
     #[test]
+    #[cfg_attr(miri, ignore)]
     fn test_ccsds_epoch() {
         let now = SystemTime::now()
             .duration_since(SystemTime::UNIX_EPOCH)
@@ -685,6 +687,7 @@ mod tests {
     }
 
     #[test]
+    #[cfg_attr(miri, ignore)]
     fn test_from_now() {
         let stamp_now = UnixTime::now().unwrap();
         let dt_now = stamp_now.chrono_date_time().unwrap();