Expand CI checks

Cargo.toml

@@ -19,6 +19,7 @@ toml = "0.8"
 assert_cmd = "2.0"
 cargo_metadata = "0.18"
 ctor = "0.2"
+regex = "1.10"
 
 [lints.clippy]
 pedantic = { level = "warn", priority = -1 }

README.md

@@ -2,7 +2,7 @@
 
 A linker replacement to help protect against malicious build scripts
 
-`build-wrap` "re-links" a build script so that it is executed under another command. By default, the command is [Bubblewrap] (Linux) or [`sandbox-exec`] (macOS), though this is configurable. See [Environment variables] and [How it works] for more information.
+`build-wrap` "re-links" a build script so that it is executed under another command. By default, the command is [Bubblewrap] (Linux) or [`sandbox-exec`] (macOS), though this is configurable. See [Environment variables that `build-wrap` reads] and [How `build-wrap` works] for more information.
 
 ## Installation
 
@@ -95,9 +95,9 @@ Given a build script `B`, its "wrapped" version `B'` contains a copy of `B` and
 - Aside from configuration and dealing with an occasional warning, `build-wrap` should not require a user to adjust their normal workflow.
 
 [Bubblewrap]: https://github.com/containers/bubblewrap
-[Environment variables]: #environment-variables
-[How it works]: #how-it-works
+[Environment variables that `build-wrap` reads]: #environment-variables-that-build-wrap-reads
 [How `BUILD_WRAP_CMD` is expanded]: #how-build_wrap_cmd-is-expanded
+[How `build-wrap` works]: #how-build-wrap-works
 [`BUILD_WRAP_CMD` is expanded]: #how-build_wrap_cmd-is-expanded
 [`cc-rs`]: https://github.com/rust-lang/cc-rs
 [`sandbox-exec`]: https://keith.github.io/xcode-man-pages/sandbox-exec.1.html

tests/ci.rs

@@ -1,4 +1,6 @@
 use assert_cmd::Command;
+use regex::Regex;
+use std::{fs::read_to_string, path::Path};
 
 pub mod util;
 
@@ -25,3 +27,52 @@ fn dylint() {
         .assert()
         .success();
 }
+
+#[test]
+fn markdown_link_check() {
+    let tempdir = util::tempdir().unwrap();
+
+    // smoelius: Pin `markdown-link-check` to version 3.11 until the following issue is resolved:
+    // https://github.com/tcort/markdown-link-check/issues/304
+    Command::new("npm")
+        .args(["install", "[email protected]"])
+        .current_dir(&tempdir)
+        .assert()
+        .success();
+
+    let readme_md = Path::new(env!("CARGO_MANIFEST_DIR")).join("README.md");
+
+    Command::new("npx")
+        .args(["markdown-link-check", &readme_md.to_string_lossy()])
+        .current_dir(&tempdir)
+        .assert()
+        .success();
+}
+
+#[test]
+fn readme_reference_links_are_sorted() {
+    let re = Regex::new(r"^\[[^\]]*\]:").unwrap();
+    let readme = read_to_string("README.md").unwrap();
+    let links = readme
+        .lines()
+        .filter(|line| re.is_match(line))
+        .collect::<Vec<_>>();
+    let mut links_sorted = links.clone();
+    links_sorted.sort_unstable();
+    assert_eq!(links_sorted, links);
+}
+
+#[test]
+fn readme_reference_links_are_used() {
+    let re = Regex::new(r"(?m)^(\[[^\]]*\]):").unwrap();
+    let readme = read_to_string("README.md").unwrap();
+    for captures in re.captures_iter(&readme) {
+        assert_eq!(2, captures.len());
+        let m = captures.get(1).unwrap();
+        assert!(
+            readme[..m.start()].contains(m.as_str()),
+            "{} is unused",
+            m.as_str()
+        );
+    }
+}