More fixes for cabal-doctest

Author: hamishmack

builder/comp-builder.nix

@@ -53,7 +53,7 @@ let self =
 , doHoogle ? component.doHoogle # Also build a hoogle index
 , hyperlinkSource ? component.doHyperlinkSource # Link documentation to the source code
 , quickjump ? component.doQuickjump # Generate an index for interactive documentation navigation
-, keepSource ? component.keepSource  # Build from `source` output in the store then delete `dist`
+, keepSource ? component.keepSource || configureAllComponents # Build from `source` output in the store then delete `dist`
 , setupHaddockFlags ? component.setupHaddockFlags
 
 # Profiling
@@ -83,6 +83,11 @@ let self =
 }@drvArgs:
 
 let
+  componentForSetup =
+    if configureAllComponents
+      then allComponent
+      else component;
+
   # TODO fix cabal wildcard support so hpack wildcards can be mapped to cabal wildcards
   canCleanSource = !(cabal-generator == "hpack" && !(package.cleanHpack or false));
   # In order to support relative references to other packages we need to use
@@ -92,7 +97,7 @@ let
   # is the sub directory in that root path that contains the package.
   # `cleanSrc.subDir` is used in `prePatch` and `lib/cover.nix`.
   cleanSrc = haskellLib.rootAndSubDir (if canCleanSource
-    then haskellLib.cleanCabalComponent package component "${componentId.ctype}-${componentId.cname}" src
+    then haskellLib.cleanCabalComponent package componentForSetup "${componentId.ctype}-${componentId.cname}" src
     else
       # We can clean out the siblings though to at least avoid changes to other packages
       # from triggering a rebuild of this one.
@@ -114,10 +119,7 @@ let
   needsProfiling = enableExecutableProfiling || enableLibraryProfiling;
 
   configFiles = makeConfigFiles {
-    component =
-      if configureAllComponents
-        then allComponent
-        else component;
+    component = componentForSetup;
     inherit (package) identifier;
     inherit fullName flags needsProfiling;
   };
@@ -333,15 +335,17 @@ let
       ++ (lib.optional enableSeparateDataOutput "data")
       ++ (lib.optional keepSource "source");
 
-    configurePhase =
+    prePatch =
       (lib.optionalString (!canCleanSource) ''
       echo "Cleaning component source not supported, leaving it un-cleaned"
       '') +
       (lib.optionalString keepSource ''
         cp -r . $source
         cd $source
         chmod -R +w .
-      '') + ''
+      '') + commonAttrs.prePatch;
+
+    configurePhase = ''
       runHook preConfigure
       echo Configure flags:
       printf "%q " ${finalConfigureFlags}
@@ -369,7 +373,11 @@ let
         target-pkg-and-db = "${ghc.targetPrefix}ghc-pkg -v0 --package-db $out/package.conf.d";
       in ''
       runHook preInstall
-      $SETUP_HS copy ${lib.concatStringsSep " " setupInstallFlags}
+      $SETUP_HS copy ${lib.concatStringsSep " " (
+        setupInstallFlags
+        ++ lib.optional configureAllComponents
+              (haskellLib.componentTarget componentId)
+      )}
       ${lib.optionalString (haskellLib.isLibrary componentId) ''
         $SETUP_HS register --gen-pkg-config=${name}.conf
         ${ghc.targetPrefix}ghc-pkg -v0 init $out/package.conf.d
@@ -456,9 +464,24 @@ let
       '')
       }
       runHook postInstall
-    '' + (lib.optionalString keepSource ''
-      rm -rf dist
-    '') + (lib.optionalString (haskellLib.isTest componentId) ''
+    '' + (
+      # Keep just the autogen files and package.conf.inplace package
+      # DB (probably empty unless this is a library component).
+      # We also have to remove any refernces to $out to avoid
+      # circular references.
+      if configureAllComponents
+        then ''
+          mv dist dist-tmp-dir
+          mkdir -p dist/build
+          mv dist-tmp-dir/build/${componentId.cname}/autogen dist/build/
+          mv dist-tmp-dir/package.conf.inplace dist/
+          remove-references-to -t $out dist/build/autogen/*
+          rm -rf dist-tmp-dir
+        ''
+        else lib.optionalString keepSource ''
+          rm -rf dist
+        ''
+    ) + (lib.optionalString (haskellLib.isTest componentId) ''
       echo The test ${package.identifier.name}.components.tests.${componentId.cname} was built.  To run the test build ${package.identifier.name}.checks.${componentId.cname}.
     '');
 

test/cabal-doctests/cabal-doctests-test.cabal

@@ -11,6 +11,7 @@ custom-setup
    cabal-doctest >= 1 && <1.1
 
 library
+  hs-source-dirs: src
   exposed-modules: Lib
   other-modules: Paths_cabal_doctests_test
   build-depends:
@@ -19,12 +20,12 @@ library
   default-language: Haskell2010
 
 test-suite doctests
+  hs-source-dirs: doctests
   x-doctest-options: --no-magic
   type: exitcode-stdio-1.0
   main-is: Doctests.hs
   ghc-options: -threaded -rtsopts -with-rtsopts=-N
   build-depends:
       base >=4.7 && <5
     , doctest
-    , cabal-doctests-test
   default-language: Haskell2010

test/cabal-doctests/default.nix

@@ -28,9 +28,7 @@ in recurseIntoAttrs ({
 
     buildCommand = ''
       printf "Checking that doctest tests have run ... " >& 2
-      doctest_output="${packages.cabal-doctests-test.checks.doctests}"
-      test -f "$doctest_output"
-      cat "$doctest_output" >& 2
+      cat ${packages.cabal-doctests-test.checks.doctests}/test-stdout >& 2
 
       touch $out
     '';