Rewrite to fully async architecture

.github/workflows/ci.yml

@@ -6,89 +6,125 @@ on:
       - master
   pull_request:
 
+concurrency:
+  group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
+  cancel-in-progress: true
+
 env:
   ALL_FEATURES: "ota_mqtt_data,ota_http_data"
 
 jobs:
-  cancel_previous_runs:
-    name: Cancel previous runs
+  build:
+    name: Build
     runs-on: ubuntu-latest
     steps:
-      - uses: styfle/cancel-workflow-action@0.4.1
-        with:
-          access_token: ${{ secrets.GITHUB_TOKEN }}
-
+      - name: Checkout source code
+        uses: actions/checkout@v4
+
+      - uses: dsherret/rust-toolchain-file@v1
+
+      - name: Build (library)
+        run: cargo build --all --target thumbv7em-none-eabihf
+
   test:
-    name: Build & Test
+    name: Test
     runs-on: ubuntu-latest
     steps:
       - name: Checkout source code
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
+
       - uses: dsherret/rust-toolchain-file@v1
-      - name: Build
+
+      - name: Doc Tests
         uses: actions-rs/cargo@v1
         with:
-          command: build
-          args: --all --target thumbv7em-none-eabihf --features ${{ env.ALL_FEATURES }}
+          command: test
+          args: --doc --features "std,log"
+
+      - name: Macro Tests
+        uses: actions-rs/cargo@v1
+        with:
+          command: test
+          args: -p rustot-derive
 
-      - name: Test
+      - name: Unit Tests
         uses: actions-rs/cargo@v1
         with:
           command: test
-          args: --lib --features "ota_mqtt_data,log"
-  
+          args: --lib --features "std,log"
+
   rustfmt:
     name: rustfmt
     runs-on: ubuntu-latest
     steps:
       - name: Checkout source code
-        uses: actions/checkout@v3
+
+        uses: actions/checkout@v4
       - uses: dsherret/rust-toolchain-file@v1
-      - name: Rustfmt
-        run: cargo fmt -- --check
+
+      - name: Run rustfmt (library)
+        run: cargo fmt --all -- --check --verbose
+
+      # - name: Run rustfmt (examples)
+      #   run: |
+      #     for EXAMPLE in $(ls examples);
+      #     do
+      #       (cd examples/$EXAMPLE && cargo fmt --all -- --check --verbose)
+      #     done
 
   clippy:
     name: clippy
     runs-on: ubuntu-latest
+    env:
+      CLIPPY_PARAMS: -W clippy::all -W clippy::pedantic -W clippy::nursery -W clippy::cargo
     steps:
       - name: Checkout source code
-        uses: actions/checkout@v3
-      - uses: dsherret/rust-toolchain-file@v1
-      - name: Run clippy
-        uses: actions-rs/clippy-check@v1
-        with:
-          token: ${{ secrets.GITHUB_TOKEN }}
-          args: -- ${{ env.CLIPPY_PARAMS }}
 
-  integration-test:
-    name: Integration Tests
-    runs-on: ubuntu-latest
-    needs: ['test', 'rustfmt', 'clippy']
-    steps:
-      - name: Checkout source code
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
       - uses: dsherret/rust-toolchain-file@v1
-      - name: Create OTA Job
-        run: |
-          ./scripts/create_ota.sh
-        env:
-          AWS_DEFAULT_REGION: ${{ secrets.MGMT_AWS_DEFAULT_REGION }}
-          AWS_ACCESS_KEY_ID: ${{ secrets.MGMT_AWS_ACCESS_KEY_ID }}
-          AWS_SECRET_ACCESS_KEY: ${{ secrets.MGMT_AWS_SECRET_ACCESS_KEY }}
-      - name: Integration Tests
-        uses: actions-rs/cargo@v1
-        with:
-          command: test
-          args: --test '*' --features "ota_mqtt_data,log" --target x86_64-unknown-linux-gnu
-        env:
-          IDENTITY_PASSWORD: ${{ secrets.DEVICE_ADVISOR_PASSWORD }}
-          AWS_HOSTNAME: a1vq3mi5y3c6j5-ats.iot.eu-west-1.amazonaws.com
-
-      - name: Cleanup OTA Jobs
-        if: ${{ always() }}
-        run: |
-          ./scripts/cleanup_ota.sh
-        env:
-          AWS_DEFAULT_REGION: ${{ secrets.MGMT_AWS_DEFAULT_REGION }}
-          AWS_ACCESS_KEY_ID: ${{ secrets.MGMT_AWS_ACCESS_KEY_ID }}
-          AWS_SECRET_ACCESS_KEY: ${{ secrets.MGMT_AWS_SECRET_ACCESS_KEY }}
+
+      - name: Run clippy (library)
+        run: cargo clippy --features "log" -- ${{ env.CLIPPY_PARAMS }}
+
+      # - name: Run clippy (examples)
+      #   run: |
+      #     for EXAMPLE in $(ls examples);
+      #     do
+      #       (cd examples/$EXAMPLE && cargo clippy -- ${{ env.CLIPPY_PARAMS }})
+      #     done
+
+  # integration-test:
+  #   name: Integration Tests
+  #   runs-on: ubuntu-latest
+  #   needs: ["build", "test", "rustfmt", "clippy"]
+  #   steps:
+  #     - name: Checkout source code
+  #       uses: actions/checkout@v4
+
+  #     - uses: dsherret/rust-toolchain-file@v1
+
+  #     - name: Create OTA Job
+  #       run: |
+  #         ./scripts/create_ota.sh
+  #       env:
+  #         AWS_DEFAULT_REGION: ${{ secrets.MGMT_AWS_DEFAULT_REGION }}
+  #         AWS_ACCESS_KEY_ID: ${{ secrets.MGMT_AWS_ACCESS_KEY_ID }}
+  #         AWS_SECRET_ACCESS_KEY: ${{ secrets.MGMT_AWS_SECRET_ACCESS_KEY }}
+
+  #     - name: Integration Tests
+  #       uses: actions-rs/cargo@v1
+  #       with:
+  #         command: test
+  #         args: --test '*' --features "ota_mqtt_data,log" --target x86_64-unknown-linux-gnu
+  #       env:
+  #         IDENTITY_PASSWORD: ${{ secrets.IDENTITY_PASSWORD }}
+  #         AWS_HOSTNAME: a1vq3mi5y3c6j5-ats.iot.eu-west-1.amazonaws.com
+
+  #     - name: Cleanup OTA Jobs
+  #       if: ${{ always() }}
+  #       run: |
+  #         ./scripts/cleanup_ota.sh
+  #       env:
+  #         AWS_DEFAULT_REGION: ${{ secrets.MGMT_AWS_DEFAULT_REGION }}
+  #         AWS_ACCESS_KEY_ID: ${{ secrets.MGMT_AWS_ACCESS_KEY_ID }}
+  #         AWS_SECRET_ACCESS_KEY: ${{ secrets.MGMT_AWS_SECRET_ACCESS_KEY }}

.vscode/settings.json

@@ -1,5 +1,7 @@
 {
-    "rust-analyzer.checkOnSave.allTargets": false,
-    "rust-analyzer.cargo.features": ["log"],
-    "rust-analyzer.cargo.target": "x86_64-unknown-linux-gnu"
+    "rust-analyzer.cargo.features": [
+        "log",
+        "ota_mqtt_data"
+    ],
+    "rust-analyzer.cargo.target": "x86_64-unknown-linux-gnu",
 }

Cargo.toml

@@ -1,16 +1,16 @@
 [workspace]
-members = ["shadow_derive"]
+members = ["rustot_derive"]
 
 [package]
 name = "rustot"
-version = "0.4.1"
-authors = ["Mathias Koch <mk@blackbird.online>"]
+version = "0.5.0"
+authors = ["Factbird team <support@factbird.com>"]
 description = "AWS IoT"
 readme = "README.md"
 keywords = ["iot", "no-std"]
 categories = ["embedded", "no-std"]
 license = "MIT OR Apache-2.0"
-repository = "https://github.com/BlackbirdHQ/rustot"
+repository = "https://github.com/FactbirdHQ/rustot"
 edition = "2021"
 documentation = "https://docs.rs/rustot"
 exclude = ["/documentation"]
@@ -22,48 +22,77 @@ name = "rustot"
 maintenance = { status = "actively-developed" }
 
 [dependencies]
-bitmaps = { version = "^3.1", default-features = false }
-heapless = { version = "0.7.0", features = ["serde"] }
-mqttrust = { version = "0.6" }
-nb = "1"
-serde = { version = "1.0.126", default-features = false, features = ["derive"] }
-serde-json-core = { version = "0.4.0" }
+bitmaps = { version = "3.1", default-features = false }
+heapless = { version = "0.9", features = ["serde"] }
+serde = { version = "1.0", default-features = false, features = ["derive"] }
 
 minicbor = { version = "0.25", optional = true }
 minicbor-serde = { version = "0.3.2", optional = true }
 
-smlang = "0.5.0"
-fugit-timer = "0.1.2"
-shadow-derive = { path = "shadow_derive", version = "0.2.1" }
-embedded-storage = "0.3.0"
 
-log = { version = "^0.4", default-features = false, optional = true }
-defmt = { version = "^0.3", optional = true }
+serde-json-core = { version = "0.6" }
+rustot-derive = { path = "rustot_derive", version = "0.2.1" }
+embedded-storage-async = "0.4"
+mqttrust = { git = "https://github.com/FactbirdHQ/mqttrust", rev = "6c33c59" }
+
+futures = { version = "0.3.28", default-features = false }
+
+embassy-time = { version = "0.5.0" }
+embassy-sync = "0.7.2"
+embassy-futures = "0.1.2"
+
+log = { version = "0.4", default-features = false, optional = true }
+defmt = { version = "0.3", optional = true }
+bon = { version = "3.3.2", default-features = false }
 
 [dev-dependencies]
-native-tls = { version = "^0.2" }
-embedded-nal = "0.6.0"
-no-std-net = { version = "^0.5", features = ["serde"] }
-dns-lookup = "1.0.3"
-mqttrust_core = { version = "0.6", features = ["log"] }
-env_logger = "0.9.0"
+native-tls = { version = "0.2" }
+embedded-nal-async = "0.9"
+env_logger = "0.11"
 sha2 = "0.10.1"
-ecdsa = { version = "0.13.4", features = ["pkcs8"] }
-p256 = "0.10.1"
-pkcs8 = { version = "0.8", features = ["encryption", "pem"] }
-timebomb = "0.1.2"
-hex = "0.4.3"
+static_cell = { version = "2", features = ["nightly"] }
+log = { version = "0.4" }
+serde_json = "1"
+
+tokio = { version = "1.33", default-features = false, features = [
+    "macros",
+    "rt",
+    "net",
+    "time",
+    "io-std",
+] }
+tokio-native-tls = { version = "0.3.1" }
+embassy-futures = { version = "0.1.2" }
+embassy-time = { version = "0.5", features = ["log", "std", "generic-queue-8"] }
+embedded-io-adapters = { version = "0.7.0", features = ["tokio-1"] }
+
+ecdsa = { version = "0.16", features = ["pkcs8", "pem"] }
+p256 = "0.13"
+pkcs8 = { version = "0.10", features = ["encryption", "pem"] }
+hex = { version = "0.4.3", features = ["alloc"] }
+
 
 [features]
-default = ["ota_mqtt_data", "provision_cbor"]
+default = ["ota_mqtt_data", "metric_cbor", "provision_cbor"]
+
+metric_cbor = ["dep:minicbor", "dep:minicbor-serde"]
 
 provision_cbor = ["dep:minicbor", "dep:minicbor-serde"]
 
 ota_mqtt_data = ["dep:minicbor", "dep:minicbor-serde"]
+
 ota_http_data = []
 
 std = ["serde/std", "minicbor-serde?/std"]
 
-defmt = ["dep:defmt", "mqttrust/defmt-impl", "heapless/defmt-impl"]
+defmt = [
+    "dep:defmt",
+    "heapless/defmt",
+    "mqttrust/defmt",
+    "embassy-time/defmt",
+]
+log = ["dep:log", "mqttrust/log"]
+
 
-graphviz = ["smlang/graphviz"]
+# [patch."ssh://git@github.com/FactbirdHQ/mqttrust"]
+# mqttrust = { path = "../mqttrust" }

README.md

@@ -1,41 +1,36 @@
-# Rust of things (rustot)
+# Rust of Things (rustot)
 
+> A `no_std`, `no_alloc` crate for interacting with AWS IoT services on embedded devices.
 
-**Work in progress**
+This crate aims to provide a pure-Rust implementation of essential AWS IoT features for embedded systems, inspired by the Amazon FreeRTOS AWS IoT Device SDK.
 
-> no_std, no_alloc crate for AWS IoT Devices, implementing Jobs, OTA, Device Defender and IoT Shadows
+## Features
 
-This crates strives to implement the sum of:
-- [AWS OTA](https://github.com/aws/ota-for-aws-iot-embedded-sdk)
-- [AWS Device Defender](https://github.com/aws/Device-Defender-for-AWS-IoT-embedded-sdk)
-- [AWS Jobs](https://github.com/aws/Jobs-for-AWS-IoT-embedded-sdk)
-- [AWS Device Shadow](https://github.com/aws/Device-Shadow-for-AWS-IoT-embedded-sdk)
-- [AWS IoT Fleet Provisioning](https://github.com/aws/Fleet-Provisioning-for-AWS-IoT-embedded-sdk)
+- **OTA Updates:** ([`ota`] module)
+  - Download and apply firmware updates securely over MQTT or HTTP.
+  - Supports both CBOR and raw binary firmware formats.
+- **Device Shadow:** ([`shadows`] module)
+  - Synchronize device state with the cloud using AWS IoT Device Shadow service.
+  - Get, update, and delete device shadows.
+- **Jobs:** ([`jobs`] module)
+  - Receive and execute jobs remotely on your devices.
+  - Track job status and report progress to AWS IoT.
+- **Device Defender:** ([`defender_metrics`] module)
+  - Implement security best practices and detect anomalies on your devices.
+- **Fleet Provisioning:** ([`provisioning`] module)
+  - Securely provision and connect devices to AWS IoT at scale.
+- **Lightweight and `no_std`:** Designed specifically for resource-constrained embedded devices.
 
+## Contributing
 
-![Test][test]
-[![Code coverage][codecov-badge]][codecov]
-![No Std][no-std-badge]
-[![Crates.io Version][crates-io-badge]][crates-io]
-[![Crates.io Downloads][crates-io-download-badge]][crates-io-download]
-
-Any contributions will be welcomed! Even if they are just suggestions, bugs or reviews!
-
-This is a port of the Amazon-FreeRTOS AWS IoT Device SDK (https://github.com/nguyenvuhung/amazon-freertos/tree/master/libraries/freertos_plus/aws/ota), written in pure Rust.
-
-It is written to work with [mqttrust](https://github.com/BlackbirdHQ/mqttrust), but should work with any other mqtt client, that implements the [Mqtt trait](https://github.com/BlackbirdHQ/mqttrust/blob/master/mqttrust/src/lib.rs) from mqttrust.
-
-
-## Tests
-
-> The crate is covered by tests. These tests can be run by `cargo test --tests --all-features`, and are run by the CI on every push to master.
+Contributions, suggestions, bug reports, and reviews are highly appreciated!
 
 ## License
 
 Licensed under either of
 
 - Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or
- http://www.apache.org/licenses/LICENSE-2.0)
+  http://www.apache.org/licenses/LICENSE-2.0)
 - MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)
 
 at your option.
@@ -45,13 +40,3 @@ at your option.
 Unless you explicitly state otherwise, any contribution intentionally submitted
 for inclusion in the work by you, as defined in the Apache-2.0 license, shall be
 dual licensed as above, without any additional terms or conditions.
-
-<!-- Badges -->
-[test]: https://github.com/BlackbirdHQ/rustot/workflows/Test/badge.svg
-[no-std-badge]: https://img.shields.io/badge/no__std-yes-blue
-[codecov-badge]: https://codecov.io/gh/BlackbirdHQ/rustot/branch/master/graph/badge.svg
-[codecov]: https://codecov.io/gh/BlackbirdHQ/rustot
-[crates-io]: https://crates.io/crates/rustot
-[crates-io-badge]: https://img.shields.io/crates/v/rustot.svg?maxAge=3600
-[crates-io-download]: https://crates.io/crates/rustot
-[crates-io-download-badge]: https://img.shields.io/crates/d/rustot.svg?maxAge=3600