Add .doc derivation to test components (#1982)

* Add a .haddock/.doc derivation to test components

Haddocks are built with --tests if we are in a test component.

* Write haddocks of tests into package prefix dir

Haddock will generate a <componentName>/ directory within this path
automatically. So a package with name "foo" and test suite "bar" will
have docdir paths:

$doc/share/doc/foo/html/index.html # library haddocks
$doc/share/doc/foo/html/bar/index.html # bar test suite haddocks

* Remove references to component derivation

Makes the cleanup step search more liberally for .html files to remove
references from. This is needed because test suite haddocks are placed
in a <package-name>/html/<test suite name>/ subdirectory.

* Fix test

---------

Co-authored-by: Hamish Mackenzie <[email protected]>

Author: ch1bo

builder/comp-builder.nix

@@ -361,7 +361,7 @@ let
       });
       profiled = self (drvArgs // { enableLibraryProfiling = true; });
       dwarf = self (drvArgs // { enableDWARF = true; });
-    } // lib.optionalAttrs (haskellLib.isLibrary componentId) ({
+    } // lib.optionalAttrs (haskellLib.isLibrary componentId || haskellLib.isTest componentId) ({
         inherit haddock;
         inherit (haddock) haddockDir; # This is null if `doHaddock = false`
       } // lib.optionalAttrs (haddock ? doc) {

builder/haddock-builder.nix

@@ -23,11 +23,11 @@
 
 let
   doHaddock' = doHaddock
-    && (haskellLib.isLibrary componentId)
+    && (haskellLib.isLibrary componentId || haskellLib.isTest componentId)
     && !haskellLib.isCrossHost;
 
-  # the target dir for haddock documentation
-  docdir = docoutput: docoutput + "/share/doc/" + componentId.cname;
+  # The target dir for haddock documentation
+  docdir = docoutput: docoutput + "/share/doc/" + package.identifier.name;
 
   packageCfgDir = configFiles.packageCfgDir;
 
@@ -111,6 +111,7 @@ let
       [[ -n $(find . -name "*.hs" -o -name "*.lhs") ]] && {
       $SETUP_HS haddock \
         "--html" \
+        ${lib.optionalString (haskellLib.isTest componentId) "--tests"} \
         ${lib.optionalString doHoogle "--hoogle"} \
         ${lib.optionalString hyperlinkSource "--hyperlink-source"} \
         ${lib.optionalString quickjump "--quickjump"} \
@@ -129,7 +130,7 @@ let
            # Ensure that libraries are not pulled into the docs closure.
            # As an example, the prettified source code of a
            # Paths_package module will contain store paths of the library package.
-           for x in "$html/src/"*.html; do
+           for x in $(find "$html" -name "*.html"); do
              remove-references-to -t $out $x
              remove-references-to -t ${componentDrv} $x
            done

test/sublib-docs/default.nix

@@ -46,9 +46,9 @@ in recurseIntoAttrs {
       otool -L $exe |grep .dylib
     '') + ''
 
-      # Check that it looks like we have docs
+      printf "check that it looks like we have docs..." >& 2
       test -f "${packages.sublib-docs.components.library.doc}/share/doc/sublib-docs/html/Lib.html"
-      test -f "${packages.sublib-docs.components.sublibs.slib.doc}/share/doc/slib/html/Slib.html"
+      test -f "${packages.sublib-docs.components.sublibs.slib.doc}/share/doc/sublib-docs/html/Slib.html"
 
       touch $out
     '';