add a custom clippy lint to enforce that std::sync::Mutex locks are unwrapped directly

Cargo.toml

@@ -60,6 +60,7 @@ members = [
   "fuzz",
   "logger-cli",
 ]
+exclude = ["tools/dylints"]
 resolver = "2"
 
 [workspace.dependencies]

Makefile

@@ -12,6 +12,13 @@ setup:
 clippy: setup
 	ci/check_license.sh
 	SKIP_PROTO_GEN=1 SKIP_FILE_GEN=1 cargo clippy --workspace --bins --examples --tests -- --no-deps
+	$(MAKE) dylint
+
+.PHONY: dylint
+dylint:
+	command -v cargo-dylint >/dev/null || cargo install cargo-dylint --version 6.0.3 --locked
+	command -v dylint-link >/dev/null || cargo install dylint-link --version 6.0.3 --locked
+	cargo dylint --all -- --workspace --all-targets
 
 # Leaving the below loop around to help with debugging flakes if needed.
 .PHONY: test

ci/license_header.py

@@ -21,6 +21,7 @@
     './fuzz/corpus/',
     './proto/',
     './target/',
+    './tools/dylints/target/',
     './thirdparty/',
 )
 
@@ -50,7 +51,10 @@ def check_file(file_path: str):
 
         if (file_path.endswith('Cargo.toml') and
             not file_path == './Cargo.toml' and
-                not 'license-file = "../LICENSE"' in content):
+            '[package]' in content and
+            not ('license-file = "../LICENSE"' in content or
+                 (file_path.startswith('./tools/dylints/') and
+                  'license-file = "../../../LICENSE"' in content))):
             raise Exception(
                 f'license-file = "../LICENSE" not found in {file_path}')
 

dylint.toml

@@ -0,0 +1,2 @@
+[workspace.metadata.dylint]
+libraries = [{ path = "tools/dylints", pattern = "mutex_lock_must_unwrap" }]