Merge rust-bitcoin#40: Introduce CI to rbmt

64a68b0 cargo-rbmt: add dogfood ci workflow (Nick Johnson)
df2e43c cargo-rbmt: walk back cargo method (Nick Johnson)
39ddd4d cargo-rbmt: add "existing" variant for simple setups (Nick Johnson)

Pull request description:

  Slinging things too fast broke so introducing a dogfood CI task to try and raise the bar.

  Adds an `existing` variant to the lock file management for simpler workspaces like this which don't use a minimal and recent, instead shipping a Cargo.lock. I would like to iron out the dependency requirements here to test the min/recent, but saving that for later since its non-trivial.

ACKs for top commit:
  tcharding:
    ACK 64a68b0

Tree-SHA512: ec838f83ab23159591380e1daa28dddd0a56ca82be432fb04658b1011da386602352811cee0404b492a92e8cb5e248ea9e2e6c89d314ec5b9f251f102e038da6

Author: tcharding

.github/workflows/ci.yml

@@ -0,0 +1,39 @@
+name: CI
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+
+jobs:
+  dogfood:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v6
+
+      - name: Install Rust toolchains
+        uses: actions-rust-lang/setup-rust-toolchain@v1
+        with:
+          toolchain: nightly,1.74.0,stable
+          components: clippy,rustfmt
+
+      - name: Install cargo-rbmt from current commit
+        run: cargo install --locked --path cargo-rbmt
+
+      - name: Run lint on workspace
+        run: cargo +nightly rbmt --lock-file existing lint
+
+      - name: Build documentation (stable)
+        run: cargo rbmt --lock-file existing docs
+
+      - name: Build documentation (docs.rs / nightly)
+        run: cargo +nightly rbmt --lock-file existing docsrs
+
+      - name: Run tests with stable
+        run: cargo rbmt --lock-file existing test stable
+
+      - name: Run tests with nightly
+        run: cargo +nightly rbmt --lock-file existing test nightly
+
+      - name: Run tests with MSRV
+        run: cargo +1.74.0 rbmt --lock-file existing test msrv

cargo-rbmt/src/bench.rs

@@ -1,6 +1,7 @@
 //! Benchmark testing tasks.
 
-use crate::environment::{cargo, get_crate_dirs, quiet_println};
+use crate::environment::{get_crate_dirs, quiet_println};
+use crate::quiet_cmd;
 use crate::toolchain::{check_toolchain, Toolchain};
 use xshell::Shell;
 
@@ -21,7 +22,7 @@ pub fn run(sh: &Shell, packages: &[String]) -> Result<(), Box<dyn std::error::Er
         // Use pushd pattern to change and restore directory.
         let _dir = sh.push_dir(crate_dir);
 
-        cargo(sh, "bench")
+        quiet_cmd!(sh, "cargo --locked bench")
             .env("RUSTFLAGS", "--cfg=bench")
             .run()?;
     }

cargo-rbmt/src/docs.rs

@@ -1,6 +1,6 @@
 //! Documentation building tasks.
 
-use crate::environment::cargo;
+use crate::quiet_cmd;
 use crate::toolchain::{check_toolchain, Toolchain};
 use xshell::Shell;
 
@@ -11,7 +11,7 @@ use xshell::Shell;
 pub fn run(sh: &Shell, packages: &[String]) -> Result<(), Box<dyn std::error::Error>> {
     check_toolchain(sh, Toolchain::Stable)?;
 
-    let mut cmd = cargo(sh, "doc --all-features --no-deps");
+    let mut cmd = quiet_cmd!(sh, "cargo --locked doc --all-features --no-deps");
 
     // Add package filters if specified.
     for package in packages {
@@ -30,7 +30,7 @@ pub fn run(sh: &Shell, packages: &[String]) -> Result<(), Box<dyn std::error::Er
 pub fn run_docsrs(sh: &Shell, packages: &[String]) -> Result<(), Box<dyn std::error::Error>> {
     check_toolchain(sh, Toolchain::Nightly)?;
 
-    let mut cmd = cargo(sh, "doc --all-features --no-deps");
+    let mut cmd = quiet_cmd!(sh, "cargo --locked doc --all-features --no-deps");
 
     // Add package filters if specified.
     for package in packages {

cargo-rbmt/src/environment.rs

@@ -109,11 +109,3 @@ pub fn get_target_directory(sh: &Shell) -> Result<String, Box<dyn std::error::Er
 
     Ok(target_dir.to_string())
 }
-
-/// Helper function to run cargo commands with CI flags.
-///
-/// The locked flag ensures using existing Cargo.lock file without
-/// updating dependencies.
-pub fn cargo<'a>(sh: &'a Shell, args: &str) -> xshell::Cmd<'a> {
-    quiet_cmd!(sh, "cargo --locked {args}")
-}

cargo-rbmt/src/integration.rs

@@ -1,6 +1,7 @@
 //! Integration test tasks for packages with bitcoind-tests or similar test packages.
 
-use crate::environment::{cargo, get_crate_dirs, quiet_println, CONFIG_FILE_PATH};
+use crate::environment::{get_crate_dirs, quiet_println, CONFIG_FILE_PATH};
+use crate::quiet_cmd;
 use serde::Deserialize;
 use std::path::{Path, PathBuf};
 use xshell::{cmd, Shell};
@@ -109,7 +110,7 @@ pub fn run(sh: &Shell, packages: &[String]) -> Result<(), Box<dyn std::error::Er
         // Run tests for each version.
         for version in &versions_to_test {
             quiet_println(&format!("  Testing with version: {}", version));
-            cargo(sh, "test --features={version}").run()?;
+            quiet_cmd!(sh, "cargo --locked test --features={version}").run()?;
         }
     }
 

cargo-rbmt/src/lint.rs

@@ -2,7 +2,8 @@ use std::fs;
 use std::path::Path;
 use xshell::Shell;
 
-use crate::environment::{cargo, get_crate_dirs, quiet_println, CONFIG_FILE_PATH};
+use crate::environment::{get_crate_dirs, quiet_println, CONFIG_FILE_PATH};
+use crate::quiet_cmd;
 use crate::toolchain::{check_toolchain, Toolchain};
 
 /// Lint configuration loaded from rbmt.toml.
@@ -57,12 +58,12 @@ fn lint_workspace(sh: &Shell) -> Result<(), Box<dyn std::error::Error>> {
     quiet_println("Linting workspace...");
 
     // Run clippy on workspace with all features.
-    cargo(sh, "clippy --workspace --all-targets --all-features --keep-going")
+    quiet_cmd!(sh, "cargo --locked clippy --workspace --all-targets --all-features --keep-going")
         .args(&["--", "-D", "warnings"])
         .run()?;
 
     // Run clippy on workspace without features.
-    cargo(sh, "clippy --workspace --all-targets --keep-going")
+    quiet_cmd!(sh, "cargo --locked clippy --workspace --all-targets --keep-going")
         .args(&["--", "-D", "warnings"])
         .run()?;
 
@@ -89,7 +90,7 @@ fn lint_crates(sh: &Shell, packages: &[String]) -> Result<(), Box<dyn std::error
         let _old_dir = sh.push_dir(&crate_dir);
 
         // Run clippy without default features.
-        cargo(sh, "clippy --all-targets --no-default-features --keep-going")
+        quiet_cmd!(sh, "cargo --locked clippy --all-targets --no-default-features --keep-going")
             .args(&["--", "-D", "warnings"])
             .run()?;
     }
@@ -105,7 +106,7 @@ fn check_duplicate_deps(sh: &Shell) -> Result<(), Box<dyn std::error::Error>> {
     let allowed_duplicates = &config.allowed_duplicates;
 
     // Run cargo tree to find duplicates.
-    let output = cargo(sh, "tree --target=all --all-features --duplicates")
+    let output = quiet_cmd!(sh, "cargo --locked tree --target=all --all-features --duplicates")
         .ignore_status()
         .read()?;
 
@@ -123,7 +124,7 @@ fn check_duplicate_deps(sh: &Shell) -> Result<(), Box<dyn std::error::Error>> {
 
     if !duplicates.is_empty() {
         // Show full tree for context.
-        cargo(sh, "tree --target=all --all-features --duplicates").run()?;
+        quiet_cmd!(sh, "cargo --locked tree --target=all --all-features --duplicates").run()?;
         eprintln!("Error: Found duplicate dependencies in workspace!");
         for dup in &duplicates {
             eprintln!("  {}", dup);

cargo-rbmt/src/lock.rs

@@ -1,8 +1,8 @@
 //! Manage cargo lock files for minimal and recent dependency versions.
 //!
-//! Note: This module uses `quiet_cmd!` directly instead of the `cargo()` helper
-//! because these commands intentionally generate and modify lockfiles. Using
-//! `--locked` would prevent the dependency resolution we need here.
+//! Note: These commands intentionally omit `--locked` because they need to
+//! generate and modify lockfiles. Using `--locked` would prevent the dependency
+//! resolution we need here.
 
 use crate::environment::quiet_println;
 use crate::quiet_cmd;
@@ -22,6 +22,8 @@ pub enum LockFile {
     /// Uses recent/updated versions of dependencies.
     #[default]
     Recent,
+    /// Uses the existing Cargo.lock as-is (for binary crates).
+    Existing,
 }
 
 impl LockFile {
@@ -30,6 +32,7 @@ impl LockFile {
         match self {
             LockFile::Minimal => "Cargo-minimal.lock",
             LockFile::Recent => "Cargo-recent.lock",
+            LockFile::Existing => CARGO_LOCK,
         }
     }
 }
@@ -105,6 +108,11 @@ fn copy_lock_file(sh: &Shell, target: LockFile) -> Result<(), Box<dyn std::error
 
 /// Restore a specific lock file to Cargo.lock.
 pub fn restore_lock_file(sh: &Shell, source: LockFile) -> Result<(), Box<dyn std::error::Error>> {
+    // Existing uses Cargo.lock as-is, no need to restore.
+    if matches!(source, LockFile::Existing) {
+        return Ok(());
+    }
+
     let src_path = sh.current_dir().join(source.filename());
     let dest_path = sh.current_dir().join(CARGO_LOCK);
     fs::copy(&src_path, &dest_path)?;

cargo-rbmt/src/test.rs

@@ -1,6 +1,7 @@
 //! Test tasks with feature matrix testing.
 
-use crate::environment::{cargo, get_crate_dirs, quiet_println, CONFIG_FILE_PATH};
+use crate::environment::{get_crate_dirs, quiet_println, CONFIG_FILE_PATH};
+use crate::quiet_cmd;
 use crate::toolchain::{check_toolchain, Toolchain};
 use serde::Deserialize;
 use std::ffi::OsStr;
@@ -173,7 +174,7 @@ fn do_test(sh: &Shell, config: &TestConfig) -> Result<(), Box<dyn std::error::Er
     quiet_println("Running basic tests");
 
     // Basic test (includes build).
-    cargo(sh, "test").run()?;
+    quiet_cmd!(sh, "cargo --locked test").run()?;
 
     // Run examples.
     for example in &config.examples {
@@ -183,18 +184,18 @@ fn do_test(sh: &Shell, config: &TestConfig) -> Result<(), Box<dyn std::error::Er
             1 => {
                 // Format: "name" - run with default features.
                 let name = parts[0];
-                cargo(sh, "run --example {name}").run()?;
+                quiet_cmd!(sh, "cargo --locked run --example {name}").run()?;
             }
             2 => {
                 let name = parts[0];
                 let features = parts[1];
 
                 if features == "-" {
                     // Format: "name:-" - run with no-default-features.
-                    cargo(sh, "run --no-default-features --example {name}").run()?;
+                    quiet_cmd!(sh, "cargo --locked run --no-default-features --example {name}").run()?;
                 } else {
                     // Format: "name:features" - run with specific features.
-                    cargo(sh, "run --example {name} --features={features}").run()?;
+                    quiet_cmd!(sh, "cargo --locked run --example {name} --features={features}").run()?;
                 }
             }
             _ => {
@@ -219,7 +220,7 @@ fn do_feature_matrix(sh: &Shell, config: &TestConfig) -> Result<(), Box<dyn std:
         for features in &config.exact_features {
             let features_str = features.join(" ");
             quiet_println(&format!("Testing exact features: {}", features_str));
-            cargo(sh, "test --no-default-features --features={features_str}").run()?;
+            quiet_cmd!(sh, "cargo --locked test --no-default-features --features={features_str}").run()?;
         }
         return Ok(());
     }
@@ -228,17 +229,17 @@ fn do_feature_matrix(sh: &Shell, config: &TestConfig) -> Result<(), Box<dyn std:
     if !config.features_with_no_std.is_empty() {
         let no_std = FeatureFlag::NoStd;
         quiet_println("Testing no-std");
-        cargo(sh, "test --no-default-features --features={no_std}").run()?;
+        quiet_cmd!(sh, "cargo --locked test --no-default-features --features={no_std}").run()?;
 
         loop_features(sh, Some(FeatureFlag::NoStd), &config.features_with_no_std)?;
     } else {
         quiet_println("Testing no-default-features");
-        cargo(sh, "test --no-default-features").run()?;
+        quiet_cmd!(sh, "cargo --locked test --no-default-features").run()?;
     }
 
     // Test all features.
     quiet_println("Testing all-features");
-    cargo(sh, "test --all-features").run()?;
+    quiet_cmd!(sh, "cargo --locked test --all-features").run()?;
 
     // Test features with std.
     if !config.features_with_std.is_empty() {
@@ -290,21 +291,21 @@ fn loop_features<S: AsRef<str>>(
     // Test all features together.
     let all_features = combine_features(base, features);
     quiet_println(&format!("Testing features: {}", all_features));
-    cargo(sh, "test --no-default-features --features={all_features}").run()?;
+    quiet_cmd!(sh, "cargo --locked test --no-default-features --features={all_features}").run()?;
 
     // Test each feature individually and all pairs (only if more than one feature).
     if features.len() > 1 {
         for i in 0..features.len() {
             let feature_combo = combine_features(base, &features[i..=i]);
             quiet_println(&format!("Testing features: {}", feature_combo));
-            cargo(sh, "test --no-default-features --features={feature_combo}").run()?;
+            quiet_cmd!(sh, "cargo --locked test --no-default-features --features={feature_combo}").run()?;
 
             // Test all pairs with features[i].
             for j in (i + 1)..features.len() {
                 let pair = [&features[i], &features[j]];
                 let feature_combo = combine_features(base, &pair);
                 quiet_println(&format!("Testing features: {}", feature_combo));
-                cargo(sh, "test --no-default-features --features={feature_combo}").run()?;
+                quiet_cmd!(sh, "cargo --locked test --no-default-features --features={feature_combo}").run()?;
             }
         }
     }

rbmt.toml

@@ -0,0 +1,13 @@
+[lint]
+allowed_duplicates = [
+    "windows-sys",
+    "windows-targets",
+    "windows_aarch64_gnullvm",
+    "windows_aarch64_msvc",
+    "windows_i686_gnu",
+    "windows_i686_gnullvm",
+    "windows_i686_msvc",
+    "windows_x86_64_gnu",
+    "windows_x86_64_gnullvm",
+    "windows_x86_64_msvc",
+]