chore(ci): WIP setup cmd tests

Author: tonywu6

.github/workflows/ci.yml

@@ -13,7 +13,9 @@ on:
     - cron: "27 0 * * *" # nightly test for RA
 
 env:
-  CARGO_TERM_COLOR: always
+  CARGO_TERM_COLOR: "always"
+  RUST_LOG: "info"
+  RUST_BACKTRACE: "1"
 
 concurrency:
   group: ${{ github.workflow }}-${{ github.ref }}-${{ github.event_name }}
@@ -23,11 +25,16 @@ jobs:
   test:
     name: Test
 
-    runs-on: ubuntu-latest
     strategy:
       matrix:
         toolchain:
           - stable
+        platform:
+          - ubuntu-latest
+          - windows-latest
+      fail-fast: false
+
+    runs-on: ${{ matrix.platform }}
 
     permissions:
       contents: read
@@ -42,6 +49,8 @@ jobs:
         with:
           toolchain: ${{ matrix.toolchain }}
 
+      - uses: cargo-bins/cargo-binstall@b9bf4400702f721d469eec4d280125f650c85638
+
       - name: Get cache key
         run: |
           CARGO_VERSION=$(cargo --version)
@@ -54,6 +63,7 @@ jobs:
             echo "EOF"
           } >> "$GITHUB_OUTPUT"
         id: cache-key
+        shell: bash
 
       - uses: actions/cache/restore@v4
         with:
@@ -64,14 +74,11 @@ jobs:
         id: cache-restore
 
       - name: Prepare binaries
-        run: cargo bin --install
-
-      - name: Prepare rust-analyzer
-        run: cargo run --package util-rust-analyzer -- download
+        run: |
+          cargo bin --install
+          cargo run --package util-rust-analyzer -- download
 
-      - run: cargo test --release --all-features
-        env:
-          RUST_LOG: info
+      - run: cargo test --all-features --no-fail-fast -- --include-ignored
 
       - name: Evict cache
         run: gh cache delete '${{ steps.cache-key.outputs.CACHE_KEY }}'
@@ -92,8 +99,7 @@ jobs:
       CACHE_KEY_RESTORE: ${{ steps.cache-key.outputs.CACHE_KEY_RESTORE }}
 
   build_features:
-    name: Build
-    runs-on: ubuntu-latest
+    name: Build features
 
     needs:
       - test
@@ -109,6 +115,8 @@ jobs:
           - lib-link-forever
       fail-fast: false
 
+    runs-on: ubuntu-latest
+
     steps:
       - uses: actions/checkout@v4
         with:
@@ -125,11 +133,10 @@ jobs:
           key: ${{ needs.test.outputs.CACHE_KEY }}
           restore-keys: ${{ needs.test.outputs.CACHE_KEY_RESTORE }}
 
-      - run: cargo build --release --features ${{ matrix.features }}
+      - run: cargo build --features ${{ matrix.features }}
 
   test_rustdoc_link_ra:
-    name: rustdoc-link RA
-    runs-on: ubuntu-latest
+    name: (rustdoc-link) Test RA
 
     needs:
       - test
@@ -142,6 +149,8 @@ jobs:
           - "nightly"
       fail-fast: false
 
+    runs-on: ubuntu-latest
+
     steps:
       - uses: actions/checkout@v4
         with:
@@ -162,6 +171,4 @@ jobs:
         env:
           RA_VERSION: ${{ matrix.ra-version }}
 
-      - run: cargo test --release --features rustdoc-link
-        env:
-          RUST_LOG: info
+      - run: cargo test --features rustdoc-link

Cargo.lock

@@ -9,7 +9,6 @@ edition = "2021"
 rust-version = "1.81.0"
 
 [profile.dev.package]
-cargo-run-bin.opt-level = 3
 insta.opt-level = 3
 similar.opt-level = 3
 

Cargo.toml

@@ -63,7 +63,6 @@ cargo-run-bin = { workspace = true }
 insta = { workspace = true }
 predicates = { workspace = true }
 similar = { workspace = true }
-util-rust-analyzer = { path = "../../utils/rust-analyzer" }
 util-testing = { workspace = true }
 
 [features]

crates/mdbookkit/Cargo.toml

@@ -25,14 +25,18 @@ impl Environment {
         let vcs_root = repo
             .workdir()
             .unwrap_or_else(|| repo.commondir())
+            .canonicalize()
+            .context("failed to locate repo root")?
             .pipe(Url::from_directory_path)
-            .expect("failed to locate repo root");
+            .map_err(|_| anyhow!("failed to locate repo root"))?;
 
         let book_src = book
             .root
+            .canonicalize()
+            .context("failed to locate book root")?
             .join(&book.config.book.src)
             .pipe(Url::from_directory_path)
-            .expect("book `src` should be a valid absolute path");
+            .map_err(|_| anyhow!("book `src` should be a valid absolute path"))?;
 
         let markdown = mdbook_markdown().tap_mut(|m| {
             if smart_punctuation(&book.config) {

crates/mdbookkit/src/bin/link_forever/git.rs

@@ -70,7 +70,7 @@ fn test_snapshots() -> Result<()> {
 fn test_minimum_env() -> Result<()> {
     util::setup_logging();
 
-    log::debug!("setup: compile self");
+    log::info!("setup: compile self");
     Command::new("cargo")
         .args([
             "build",
@@ -84,17 +84,17 @@ fn test_minimum_env() -> Result<()> {
             "--profile=dev"
         } else {
             "--profile=release"
-        });
+        })
+        .assert()
+        .success();
 
     let path = setup_paths()?;
 
     let root = TempDir::new()?;
 
-    let _dir = root.path().to_string_lossy();
-
     log::debug!("{root:?}");
 
-    log::debug!("given: a book");
+    log::info!("given: a book");
     Command::new("mdbook")
         .args(["init", "--force"])
         .env("PATH", &path)
@@ -103,21 +103,21 @@ fn test_minimum_env() -> Result<()> {
         .assert()
         .success();
 
-    log::debug!("given: preprocessor is enabled");
+    log::info!("given: preprocessor is enabled");
     std::fs::File::options()
         .append(true)
         .open(root.path().join("book.toml"))?
         .pipe(|mut file| file.write_all("[preprocessor.link-forever]\n".as_bytes()))?;
 
-    log::debug!("when: book has path-based links");
+    log::info!("when: book has path-based links");
     std::fs::File::options()
         .append(true)
         .open(root.path().join("src/chapter_1.md"))?
         .pipe(|mut file| file.write_all("\n[book.toml](../book.toml)\n".as_bytes()))?;
 
-    log::debug!("when: book is not in source control");
+    log::info!("when: book is not in source control");
 
-    log::debug!("then: book builds with warnings");
+    log::info!("then: book builds with warnings");
     Command::new("mdbook")
         .arg("build")
         .env("PATH", &path)
@@ -126,15 +126,15 @@ fn test_minimum_env() -> Result<()> {
         .success()
         .stderr(predicate::str::contains("requires a git repository"));
 
-    log::debug!("when: repo has no commit");
+    log::info!("when: repo has no commit");
     Command::new("git")
         .arg("init")
         .env("PATH", &path)
         .current_dir(&root)
         .assert()
         .success();
 
-    log::debug!("then: book builds with warnings");
+    log::info!("then: book builds with warnings");
     Command::new("mdbook")
         .arg("build")
         .env("PATH", &path)
@@ -143,15 +143,20 @@ fn test_minimum_env() -> Result<()> {
         .success()
         .stderr(predicate::str::contains("no commit found"));
 
-    log::debug!("when: repo has no origin");
+    log::info!("when: repo has no origin");
     Command::new("git")
-        .args(["commit", "--allow-empty", "--message", "init"])
+        .args(["commit", "--allow-empty"])
+        .args(["--message", "init"])
         .env("PATH", &path)
+        .env("GIT_AUTHOR_NAME", "me")
+        .env("GIT_AUTHOR_EMAIL", "me@example.org")
+        .env("GIT_COMMITTER_NAME", "me")
+        .env("GIT_COMMITTER_EMAIL", "me@example.org")
         .current_dir(&root)
         .assert()
         .success();
 
-    log::debug!("then: book builds with warnings");
+    log::info!("then: book builds with warnings");
     Command::new("mdbook")
         .arg("build")
         .env("PATH", &path)
@@ -160,7 +165,7 @@ fn test_minimum_env() -> Result<()> {
         .success()
         .stderr(predicate::str::contains("failed to determine GitHub url"));
 
-    log::debug!("when: repo has origin");
+    log::info!("when: repo has origin");
     Command::new("git")
         .args([
             "remote",
@@ -173,7 +178,7 @@ fn test_minimum_env() -> Result<()> {
         .assert()
         .success();
 
-    log::debug!("then: book builds");
+    log::info!("then: book builds");
     Command::new("mdbook")
         .arg("build")
         .env("PATH", &path)