feat(rust): make doctest opt-in

Doctest is only supported for library crates - make it opt-in for now to avoid the guesswork Signed-off-by: Roman Volosatovs <rvolosatovs@riseup.net>
rvolosatovs · Oct 21, 2024 · 2483173 · 2483173
1 parent 8c0d0a8
commit 2483173
Show file tree

Hide file tree

Showing 4 changed files with 16 additions and 12 deletions.
diff --git a/checks/default.nix b/checks/default.nix
@@ -74,15 +74,14 @@ in
       assert attrs.${system} ? "${name}-x86_64-unknown-linux-musl-oci";
       assert attrs.${system} ? ${name}; x;
   in
+    assert flakes.rust.complex.checks.${system} ? doctest;
     assert flakes.rust.complex.packages.${system} ? default;
     assert flakes.rust.hello-multibin.packages.${system} ? default;
     assert flakes.rust.hello-multibin.packages.${system} ? rust-hello-multibin-wasm32-wasip2;
     assert flakes.rust.hello.packages.${system} ? default;
     assert flakes.rust.hello.packages.${system} ? rust-hello-wasm32-wasip2-oci;
     assert flakes.rust.hello.packages.${system} ? rust-hello-wasm32-wasip2;
-    assert flakes.rust.lib.checks.${system} ? doctest;
     assert flakes.rust.lib.packages.${system} ? rust-lib-wasm32-wasip2;
-    assert flakes.rust.workspace.checks.${system} ? doctest;
     assert flakes.rust.workspace.packages.${system} ? default;
     assert flakes.rust.workspace.packages.${system} ? rust-workspace-wasm32-wasip2;
       (assertRustPackages flakes.rust.complex.packages "rust-complex")

diff --git a/examples/rust-complex/flake.nix b/examples/rust-complex/flake.nix
@@ -14,6 +14,7 @@
 
       build.workspace = true;
       clippy.workspace = true;
+      test.doc = true;
       test.workspace = true;
 
       buildOverrides = {

diff --git a/lib/rust/default.nix b/lib/rust/default.nix
@@ -128,6 +128,7 @@ in {
 
   defaultTestConfig.allFeatures = false;
   defaultTestConfig.allTargets = false;
+  defaultTestConfig.doc = false;
   defaultTestConfig.excludes = [];
   defaultTestConfig.features = [];
   defaultTestConfig.noDefaultFeatures = false;

diff --git a/lib/rust/mkAttrs.nix b/lib/rust/mkAttrs.nix
@@ -210,21 +210,24 @@ with self.lib.rust.targets;
         }
         callCraneWithDeps (mkHostArgs craneArgs);
 
+      callHostCraneCheckWithDeps = craneArgs:
+        trace' "callHostCraneCheckWithDeps" {
+          inherit craneArgs;
+        }
+        callHostCraneWithDeps (craneArgs
+          // {
+            doCheck = true; # without performing the actual testing, this check is useless
+          });
+
       checks =
         {
           clippy = callHostCraneWithDeps {} hostCraneLib.cargoClippy;
           doc = callHostCraneWithDeps {} hostCraneLib.cargoDoc;
-          doctest =
-            callHostCraneWithDeps {
-              doCheck = true; # without performing the actual testing, this check is useless
-            }
-            hostCraneLib.cargoDocTest;
           fmt = callHostCrane {} hostCraneLib.cargoFmt;
-          nextest =
-            callHostCraneWithDeps {
-              doCheck = true; # without performing the actual testing, this check is useless
-            }
-            hostCraneLib.cargoNextest;
+          nextest = callHostCraneCheckWithDeps {} hostCraneLib.cargoNextest;
+        }
+        // (optionalAttrs (test ? doc && test.doc)) {
+          doctest = callHostCraneCheckWithDeps {} hostCraneLib.cargoDocTest;
         }
         // (optionalAttrs (pathExists "${src}/Cargo.lock") {
           # TODO: Use `cargoLock` if `Cargo.lock` missing