Merge pull request #5 from cpu/cpu-rust-review

Small tweaks to Rust code after a review pass

Author: aochagavia

.github/dependabot.yml

@@ -0,0 +1,14 @@
+version: 2
+updates:
+  - package-ecosystem: cargo
+    directory: "/"
+    schedule:
+      interval: daily
+      time: "07:00"
+    open-pull-requests-limit: 10
+  - package-ecosystem: "github-actions"
+    directory: ".github/workflows"
+    schedule:
+      interval: "daily"
+      time: "07:00"
+    open-pull-requests-limit: 10

.github/workflows/rust.yml

@@ -0,0 +1,69 @@
+name: Rust
+
+on:
+  push:
+  pull_request:
+
+jobs:
+  format:
+    name: Format
+    runs-on: ubuntu-latest
+    defaults:
+      run:
+        working-directory: ci-bench-runner
+    steps:
+      - uses: actions/checkout@v4
+      - name: Install rust toolchain
+        uses: dtolnay/rust-toolchain@stable
+        with:
+          components: rustfmt
+      - name: Check formatting
+        run: cargo fmt --all -- --check
+
+  clippy:
+    name: Clippy
+    runs-on: ubuntu-latest
+    defaults:
+      run:
+        working-directory: ci-bench-runner
+    steps:
+      - name: Checkout sources
+        uses: actions/checkout@v4
+      - name: Install rust toolchain
+        uses: dtolnay/rust-toolchain@stable
+        with:
+          components: clippy
+      - run: cargo clippy --locked -- --deny warnings
+
+  docs:
+    name: Check for documentation errors
+    runs-on: ubuntu-latest
+    defaults:
+      run:
+        working-directory: ci-bench-runner
+    steps:
+      - name: Checkout sources
+        uses: actions/checkout@v4
+      - name: Install rust toolchain
+        uses: dtolnay/rust-toolchain@stable
+      - name: cargo doc
+        run: cargo doc --locked --no-deps --document-private-items
+        env:
+          RUSTDOCFLAGS: -Dwarnings
+
+  stable:
+    name: Stable Rust
+    runs-on: ubuntu-latest
+    defaults:
+      run:
+        working-directory: ci-bench-runner
+    steps:
+    - uses: actions/checkout@v4
+    - name: Install stable rust toolchain
+      uses: dtolnay/rust-toolchain@stable
+    - name: Install valgrind
+      run: sudo apt-get install -y valgrind
+    - name: Build
+      run: cargo build --locked --verbose
+    - name: Run tests
+      run: cargo test --locked --verbose

ci-bench-runner/Cargo.lock

@@ -27,5 +27,5 @@ uuid = { version = "1.4.1", features = ["v4", "serde"] }
 
 [dev-dependencies]
 ctor = "0.2.5"
-reqwest = "0.11.22"
+reqwest = { version = "0.11.22", default-features = false, features = ["rustls-tls-webpki-roots"] }
 wiremock = "0.5.19"

ci-bench-runner/Cargo.toml

@@ -0,0 +1,7 @@
+fn main() {
+    // In some cases if new migrations are added without accompanying Rust src changes
+    // `cargo build` isn't smart enough to detect the need for recompilation to pick up
+    // the new embedded migrations. This build script is the recommended workaround.
+    // See <https://docs.rs/sqlx/latest/sqlx/macro.migrate.html#triggering-recompilation-on-migration-changes>
+    println!("cargo:rerun-if-changed=migrations");
+}

ci-bench-runner/build.rs

@@ -12,6 +12,7 @@ use tokio::sync::Mutex;
 use uuid::Uuid;
 
 /// An enqueued GitHub event
+#[derive(Debug)]
 pub struct QueuedEvent {
     /// An internal id for this event (i.e. not GitHub's)
     pub id: Uuid,
@@ -63,7 +64,7 @@ pub struct BenchJob {
 }
 
 /// A result for a specific benchmark scenario
-#[derive(sqlx::FromRow)]
+#[derive(Debug, sqlx::FromRow)]
 pub struct BenchResult {
     /// The scenario's name
     pub scenario_name: String,
@@ -75,6 +76,7 @@ pub struct BenchResult {
 }
 
 /// The results of a comparison between two branches of rustls
+#[derive(Debug)]
 pub struct ComparisonResult {
     /// The diffs, per scenario
     pub diffs: Vec<ScenarioDiff>,
@@ -123,7 +125,7 @@ impl TryFrom<i64> for ScenarioKind {
 
     fn try_from(value: i64) -> Result<Self, Self::Error> {
         match value {
-            0 => Ok(ScenarioKind::Icount),
+            0 => Ok(Self::Icount),
             kind => bail!("invalid scenario kind: {kind}"),
         }
     }