workflow: Introduce CI workflow for pre-commit checks

Introduce a GitHub Actions workflow that performs pre-commit checks,
including build and test steps to ensure code quality before merging.

Signed-off-by: Steven Lee <steven_lee@aspeedtech.com>

Author: stevenlee7189

.github/rust-toolchain.toml

@@ -0,0 +1,6 @@
+# Licensed under the Apache-2.0 license
+
+[toolchain]
+channel = "1.85.1"
+components = ["rustfmt", "clippy"]  # Add any additional components you need
+profile = "minimal"  # Optional: You can set this to "minimal", "default", or "complete"

.github/workflows/build-test.yml

@@ -0,0 +1,61 @@
+# Licensed under the Apache-2.0 license
+
+name: Build and Test
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  precommit:
+    runs-on: ubuntu-22.04
+
+    env:
+      CARGO_INCREMENTAL: 0
+      SCCACHE_VERSION: 0.8.2
+      SCCACHE_GHA_CACHE_TO: sccache-aspeed-ddk
+      SCCACHE_GHA_CACHE_FROM: sccache-aspeed-ddk
+      SCCACHE_C_CUSTOM_CACHE_BUSTER: a1b2c3d4e5
+      EXTRA_CARGO_CONFIG: "target.'cfg(all())'.rustflags = [\"-Dwarnings\"]"
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          submodules: recursive
+
+      - name: Install packages
+        run: |
+          sudo apt-get update -qq
+          sudo apt-get install -y build-essential curl gcc-arm-none-eabi llvm clang pkg-config libudev-dev
+          rustup component add clippy rustfmt llvm-tools-preview
+
+      - name: Install sccache
+        uses: mozilla-actions/sccache-action@v0.0.1
+        with:
+          version: ${{ env.SCCACHE_VERSION }}
+
+      - name: Configure sccache
+        run: |
+          echo "RUSTC_WRAPPER=$(which sccache)" >> $GITHUB_ENV
+
+      - name: Verify Cargo.lock is up to date
+        run: |
+          cargo tree --locked > /dev/null || (
+            echo "Please update Cargo.lock"
+            cargo tree
+            git diff Cargo.lock
+            exit 1
+          )
+
+      - name: Run precommit checks (build/format/lint)
+        run: |
+          cargo --config "$EXTRA_CARGO_CONFIG" xtask precommit
+
+      - name: Show sccache stats
+        run: sccache --show-stats
+

Cargo.toml

@@ -15,7 +15,12 @@ version = "0.1.0"
 edition = "2021"
 
 [features]
+default = []
 std = []
+test-rsa = []
+test-ecdsa = []
+test-hmac = []
+test-hash = []
 
 [dependencies]
 ast1060-pac = { git = "https://github.com/rusty1968/ast1060-pac.git", features = ["rt"] }
@@ -30,5 +35,3 @@ cortex-m = { version = "0.7.5" }
 cortex-m-rt = { version = "0.6.5", features = ["device"] }
 panic-halt = "1.0.0"
 
-
-

src/main.rs

@@ -143,7 +143,9 @@ fn main() -> ! {
     syscon.enable_hace();
 
     let mut hace_controller = HaceController::new(&hace);
+
     run_hash_tests(&mut uart_controller, &mut hace_controller);
+
     run_hmac_tests(&mut uart_controller, &mut hace_controller);
 
     // Enable RSA and ECC

xtask/src/test.rs

@@ -36,7 +36,17 @@ fn run_unit_tests() -> Result<()> {
 
     let status = Command::new("cargo")
         .current_dir(&*PROJECT_ROOT)
-        .args(["test", "--lib", "--bins"])
+        // FIXME: Temporarily exclude `aspeed-ddk` since it's a no_std bare-metal crate.
+        // Once an emulator is available or host-side unit tests are added for aspeed-ddk,
+        // this exclusion should be removed.
+        .args([
+            "test",
+            "--workspace",
+            "--exclude",
+            "aspeed-ddk",
+            "--target",
+            "x86_64-unknown-linux-gnu",
+        ])
         .status()?;
 
     if !status.success() {
@@ -52,7 +62,17 @@ fn run_integration_tests() -> Result<()> {
 
     let status = Command::new("cargo")
         .current_dir(&*PROJECT_ROOT)
-        .args(["test", "--test", "*"])
+        // FIXME: Temporarily exclude `aspeed-ddk` since it's a no_std bare-metal crate.
+        // Once an emulator is available or host-side unit tests are added for aspeed-ddk,
+        // this exclusion should be removed.
+        .args([
+            "test",
+            "--workspace",
+            "--exclude",
+            "aspeed-ddk",
+            "--target",
+            "x86_64-unknown-linux-gnu",
+        ])
         .status()?;
 
     if !status.success() {
@@ -146,10 +166,28 @@ fn run_hardware_test_suite(uart: &str, suite: &str) -> Result<()> {
     }
 
     // Generate UART boot image
-    let binary_path = PROJECT_ROOT.join("target/thumbv7em-none-eabihf/release/aspeed-ddk");
-    let boot_image_path = PROJECT_ROOT.join(format!("target/{}-test-boot.img", suite));
+    // let binary_path = PROJECT_ROOT.join("target/thumbv7em-none-eabihf/release/aspeed-ddk");
+    let elf_path = PROJECT_ROOT.join("target/thumbv7em-none-eabihf/release/aspeed-ddk");
+    assert!(elf_path.exists(), "ELF file not found: {:?}", elf_path);
+    println!("ELF binary path: {:?}", elf_path);
+    let bin_path = PROJECT_ROOT.join(format!("target/{}-test-{}.bin", suite, "release"));
+    println!("Binary path: {:?}", bin_path);
+
+    let _status = Command::new("cargo")
+        .args([
+            "objcopy",
+            "--target",
+            "thumbv7em-none-eabihf",
+            "--release",
+            "--",
+            "-O",
+            "binary",
+            bin_path.to_str().unwrap(),
+        ])
+        .status()?;
 
-    crate::build::gen_boot_image(&binary_path, &boot_image_path)?;
+    let boot_image_path = PROJECT_ROOT.join(format!("target/{}-test-boot.img", suite));
+    crate::build::gen_boot_image(&bin_path, &boot_image_path)?;
 
     // TODO: Add actual hardware test execution here
     // This would involve sending the boot image to the hardware via UART