Fix running cargo test in workspace root (#427)

Allow running `cargo test` / `cargo build` in the workspace root by
scoping `embassy-executor` features to builds for `arm` targets.

Move the workflow-specific command line params into the workspace
Cargo.toml (`warnings = "deny"`) so running `cargo clippy` on a
workstation will produce the same results as CI.

Author: dymk

.github/workflows/check.yml

@@ -111,7 +111,7 @@ jobs:
       # intentionally no target specifier; see https://github.com/jonhoo/rust-ci-conf/pull/4
       # --feature-powerset runs for every combination of features
       - name: cargo hack
-        run: cargo hack --feature-powerset --mutually-exclusive-features=log,defmt clippy --locked --target ${{ matrix.target }} -- -Dwarnings
+        run: cargo hack --feature-powerset --mutually-exclusive-features=log,defmt clippy --locked --target ${{ matrix.target }}
 
   deny:
     # cargo-deny checks licenses, advisories, sources, and bans for
@@ -138,21 +138,9 @@ jobs:
 
   test:
     runs-on: ubuntu-latest
-    name: ubuntu / stable / test / ${{ matrix.crate }}
+    name: ubuntu / stable / test
     strategy:
       fail-fast: false
-      matrix:
-        crate:
-          - battery-service
-          - cfu-service
-          - embedded-services
-          - espi-service
-          - hid-service
-          - platform-service
-          - power-button-service
-          - power-policy-service
-          - storage_bus
-          - type-c-service
     steps:
       - uses: actions/checkout@v4
         with:
@@ -165,11 +153,11 @@ jobs:
         with:
           name: updated-lock-files
       - name: cargo test
-        run: cargo test --locked -p ${{ matrix.crate }}
+        run: cargo test --locked
         # After ensuring tests pass, finally ensure the test code itself contains no clippy warnings
       - name: cargo clippy
         run: |
-          cargo clippy --locked --tests -p ${{ matrix.crate }} -- -Dwarnings
+          cargo clippy --locked --tests
 
   msrv:
     # check that we can build using the minimal rust version that is specified by this crate
@@ -223,7 +211,7 @@ jobs:
       - name: cargo clippy
         working-directory: ${{ matrix.example_directory }}
         run: |
-          cargo clippy --target thumbv8m.main-none-eabihf --locked -- -Dwarnings
+          cargo clippy --target thumbv8m.main-none-eabihf --locked
 
   check-std-examples:
     runs-on: ubuntu-latest
@@ -248,4 +236,4 @@ jobs:
       - name: cargo clippy
         working-directory: ${{ matrix.example_directory }}
         run: |
-          cargo clippy --locked -- -Dwarnings
+          cargo clippy --locked

Cargo.lock

@@ -22,6 +22,9 @@ edition = "2024"
 license = "MIT"
 repository = "https://github.com/OpenDevicePartnership/embedded-services"
 
+[workspace.lints.rust]
+warnings = "deny"
+
 [workspace.dependencies]
 aligned = "0.4"
 anyhow = "1.0"

Cargo.toml

@@ -7,6 +7,9 @@ repository = "https://github.com/OpenDevicePartnership/embedded-services"
 rust-version = "1.85"
 license = "MIT"
 
+[lints]
+workspace = true
+
 [dependencies]
 defmt = { workspace = true, optional = true }
 embassy-executor.workspace = true

battery-service/Cargo.toml

@@ -4,6 +4,9 @@ version = "0.1.0"
 edition = "2024"
 license = "MIT"
 
+[lints]
+workspace = true
+
 [dependencies]
 defmt = { workspace = true, optional = true }
 embassy-executor.workspace = true

cfu-service/Cargo.toml

@@ -7,6 +7,9 @@ description = "Embedded Service Layer for IPC, Feature Customization and Extensi
 repository = "https://github.com/OpenDevicePartnership/embedded-services"
 rust-version = "1.85"
 
+[lints]
+workspace = true
+
 [dependencies]
 bitfield.workspace = true
 bitflags.workspace = true
@@ -46,10 +49,6 @@ critical-section = { workspace = true, features = ["std"] }
 tokio = { workspace = true, features = ["rt", "macros", "time"] }
 embassy-time = { workspace = true, features = ["std"] }
 embassy-time-driver = { workspace = true }
-embassy-executor = { workspace = true, features = [
-    "arch-std",
-    "executor-thread",
-] }
 embassy-futures.workspace = true
 static_cell.workspace = true
 

embedded-service/Cargo.toml

@@ -117,17 +117,31 @@ impl<'a> Data<'a> {
 
     /// Fetch type ID for message contents to allow reception of multiple top level elements
     /// Ex:
-    /// match message.data.type_id() {
-    ///     TypeId::of::<MessageClassA>() -> (),
-    ///     TypeId::of::<MessageClassB>() -> (), etc.
+    /// ```
+    /// # use core::any::TypeId;
+    /// # use embedded_services::comms::{Data, Message, EndpointID, Internal};
+    /// struct MessageClassA;
+    /// struct MessageClassB;
+    /// let message = Message {
+    ///     from: EndpointID::from(Internal::PlatformInfo),
+    ///     to: EndpointID::from(Internal::PlatformInfo),
+    ///     data: Data::new(&MessageClassA),
+    /// };
+    /// if message.data.type_id() == TypeId::of::<MessageClassA>() {
+    ///     // do something
+    /// } else if message.data.type_id() == TypeId::of::<MessageClassB>() {
+    ///     // do something else
+    /// } else {
+    ///     // do something else
     /// }
+    /// ```
     pub fn type_id(&self) -> TypeId {
         self.contents.type_id()
     }
 
     /// Shorthand if only a few Message types are supported by an Endpoint:
-    /// if data.is_a::<MessageClassA>() {}
-    /// else if data.is_a::<MessageClassB>() {}
+    /// if `data.is_a::<MessageClassA>() {}`
+    /// else if `data.is_a::<MessageClassB>() {}`
     /// etc.
     pub fn is_a<T: Any>(&self) -> bool {
         self.type_id() == TypeId::of::<T>()

embedded-service/src/comms.rs

@@ -18,12 +18,12 @@ impl<T> CriticalSectionCell<T> {
     /// for read/write conditions but does not automatically handle logical data
     /// race conditions. It is still possible for a user to read a value but have
     /// it change after they've performed the read. This just ensures data integrity:
-    /// CriticalSectionCell<T> will always contain a valid T, even if it's been read "late"
+    /// `CriticalSectionCell<T>` will always contain a valid `T`, even if it's been read "late"
     pub fn set(&self, value: T) {
         critical_section::with(|_cs| self.inner.set(value))
     }
 
-    /// Swap contents between two CriticalSectionCell's    
+    /// Swap contents between two CriticalSectionCell's
     /// # Panics
     ///
     /// This function will panic if `self` and `other` are different `Cell`s that partially overlap.
@@ -33,7 +33,7 @@ impl<T> CriticalSectionCell<T> {
         critical_section::with(|_cs| self.inner.swap(&other.inner));
     }
 
-    /// consume the CriticalSectionCell and return the inner value T
+    /// consume the `CriticalSectionCell` and return the inner value `T`
     pub fn into_inner(self) -> T {
         self.inner.into_inner()
     }
@@ -58,13 +58,13 @@ impl<T: ?Sized> CriticalSectionCell<T> {
 }
 
 impl<T: Default> CriticalSectionCell<T> {
-    /// consume the inner T, returning its value and replacing it with default()
+    /// consume the inner `T`, returning its value and replacing it with `Default::default()`
     pub fn take(&self) -> T {
         critical_section::with(|_cs| self.inner.take())
     }
 }
 
-// SAFETY: Sync is implemented here for CriticalSectionCell as T is only accessed via nestable critical sections
+// SAFETY: Sync is implemented here for `CriticalSectionCell` as `T` is only accessed via nestable critical sections
 unsafe impl<T> Sync for CriticalSectionCell<T> {}
 
 // SAFETY: Can implement send here due to critical section without T being explicitly Send
@@ -78,7 +78,7 @@ impl<T: Copy> Clone for CriticalSectionCell<T> {
 }
 
 impl<T: Default> Default for CriticalSectionCell<T> {
-    /// Creates a `Cell<T>`, with the `Default` value for T.
+    /// Creates a `Cell<T>`, with the `Default` value for `T`.
     #[inline]
     fn default() -> CriticalSectionCell<T> {
         CriticalSectionCell::new(Default::default())

embedded-service/src/critical_section_cell.rs

@@ -1,5 +1,5 @@
 //! HID sevices
-//! See spec at http://msdn.microsoft.com/en-us/library/windows/hardware/hh852380.aspx
+//! See spec at <http://msdn.microsoft.com/en-us/library/windows/hardware/hh852380.aspx>
 use core::convert::Infallible;
 
 use embassy_sync::once_lock::OnceLock;

embedded-service/src/hid/mod.rs

@@ -12,7 +12,7 @@ pub enum Error {
     NodeAlreadyInList,
 }
 
-/// override Result type for shorthand -> Result<T>
+/// override Result type for shorthand `-> Result<T>`
 pub type Result<T> = core::result::Result<T, Error>;
 
 /// Embedded node that "intrudes" on a structure