Pass some haddock flags to dependencies (#8414)

* pass some haddock flags to dependencies * add tests * add changelog * fix whitespace * fix test on MacOS

Pass some haddock flags to dependencies (#8414)
* pass some haddock flags to dependencies * add tests * add changelog * fix whitespace * fix test on MacOS
55b4ed9f · Kobayashi · GitHub · d45f3d8b · 55b4ed9f · 55b4ed9f
Unverified Commit 55b4ed9f authored 2 years ago by Kobayashi Committed by GitHub 2 years ago
--- a/cabal-install/src/Distribution/Client/ProjectConfig/Legacy.hs
+++ b/cabal-install/src/Distribution/Client/ProjectConfig/Legacy.hs
@@ -346,7 +346,15 @@ commandLineFlagsToProjectConfig globalFlags NixStyleFlags {..} clientInstallFlag
        splitConfig pc = (pc
                         , mempty { packageConfigProgramPaths = packageConfigProgramPaths pc
                                  , packageConfigProgramPathExtra = packageConfigProgramPathExtra pc
-                                  , packageConfigDocumentation = packageConfigDocumentation pc })
+
+                                  -- Some flags to haddock should be passed to dependencies
+                                  , packageConfigDocumentation = packageConfigDocumentation pc
+                                  , packageConfigHaddockHoogle = packageConfigHaddockHoogle pc
+                                  , packageConfigHaddockHtml = packageConfigHaddockHtml pc
+                                  , packageConfigHaddockInternal = packageConfigHaddockInternal pc
+                                  , packageConfigHaddockQuickJump = packageConfigHaddockQuickJump pc
+                                  , packageConfigHaddockLinkedSource = packageConfigHaddockLinkedSource pc
+                                  })

 -- | Convert from the types currently used for the user-wide @~/.cabal/config@
 -- file into the 'ProjectConfig' type.

--- a/cabal-testsuite/PackageTests/HaddockArgs/cabal.project
+++ b/cabal-testsuite/PackageTests/HaddockArgs/cabal.project
+packages: .
\ No newline at end of file
--- a/cabal-testsuite/PackageTests/HaddockArgs/example.cabal
+++ b/cabal-testsuite/PackageTests/HaddockArgs/example.cabal
+name:               example
+version:            1.0
+build-type:         Simple
+cabal-version:      >= 1.10
+
+
+library
+    hs-source-dirs:   src
+    exposed-modules:  Lib
+    build-depends:    base, indef
+    default-language: Haskell2010
+
--- a/cabal-testsuite/PackageTests/HaddockArgs/hoogle.out
+++ b/cabal-testsuite/PackageTests/HaddockArgs/hoogle.out
+# cabal v2-update
+Downloading the latest package list from test-local-repo
+# cabal v2-build
+Resolving dependencies...
+Build profile: -w ghc-<GHCVER> -O1
+In order, the following will be built:
+ - sigs-0.1.0.0 (lib) (requires build)
+ - indef-0.1.0.0 (lib) (requires build)
+ - example-1.0 (lib) (first run)
+Configuring library for sigs-0.1.0.0..
+Preprocessing library for sigs-0.1.0.0..
+Building library instantiated with Data.Map = <Data.Map>
+for sigs-0.1.0.0..
+Preprocessing library for sigs-0.1.0.0..
+Running Haddock on library instantiated with Data.Map = <Data.Map>
+for sigs-0.1.0.0..
+Documentation created: dist/doc/html/sigs/sigs.txt
+Installing library in <PATH>
+Configuring library for indef-0.1.0.0..
+Preprocessing library for indef-0.1.0.0..
+Building library instantiated with Data.Map = <Data.Map>
+for indef-0.1.0.0..
+Preprocessing library for indef-0.1.0.0..
+Running Haddock on library instantiated with Data.Map = <Data.Map>
+for indef-0.1.0.0..
+Documentation created: dist/doc/html/indef/indef.txt
+Installing library in <PATH>
+Configuring library for example-1.0..
+Preprocessing library for example-1.0..
+Building library instantiated with Data.Map = <Data.Map>
+for example-1.0..
+Preprocessing library for example-1.0..
+Running Haddock on library instantiated with Data.Map = <Data.Map>
+for example-1.0..
+Documentation created: <ROOT>/hoogle.dist/work/dist/build/<ARCH>/ghc-<GHCVER>/example-1.0/doc/html/example/example.txt
--- a/cabal-testsuite/PackageTests/HaddockArgs/hoogle.test.hs
+++ b/cabal-testsuite/PackageTests/HaddockArgs/hoogle.test.hs
+import Test.Cabal.Prelude
+
+main = withShorterPathForNewBuildStore $ \storeDir -> cabalTest $ withRepo "repo" $ do
+  -- Checks if hoogle txt files are generated.
+  -- Logs contain something like "Documentation created: dist/doc/html/indef/indef.txt", so we don't need
+  -- to do extra check
+  cabalG ["--store-dir=" ++ storeDir] "v2-build"
+    [ "example"
+    , "--enable-documentation"
+    , "--haddock-hoogle"
+    ]
--- a/cabal-testsuite/PackageTests/HaddockArgs/quickjump.out
+++ b/cabal-testsuite/PackageTests/HaddockArgs/quickjump.out
+# cabal v2-update
+Downloading the latest package list from test-local-repo
+# cabal v2-build
+Resolving dependencies...
+Build profile: -w ghc-<GHCVER> -O1
+In order, the following will be built:
+ - sigs-0.1.0.0 (lib) (requires build)
+ - indef-0.1.0.0 (lib) (requires build)
+ - example-1.0 (lib) (first run)
+Configuring library for sigs-0.1.0.0..
+Preprocessing library for sigs-0.1.0.0..
+Building library instantiated with Data.Map = <Data.Map>
+for sigs-0.1.0.0..
+Preprocessing library for sigs-0.1.0.0..
+Running Haddock on library instantiated with Data.Map = <Data.Map>
+for sigs-0.1.0.0..
+Documentation created: dist/doc/html/sigs/index.html
+Installing library in <PATH>
+Configuring library for indef-0.1.0.0..
+Preprocessing library for indef-0.1.0.0..
+Building library instantiated with Data.Map = <Data.Map>
+for indef-0.1.0.0..
+Preprocessing library for indef-0.1.0.0..
+Running Haddock on library instantiated with Data.Map = <Data.Map>
+for indef-0.1.0.0..
+Documentation created: dist/doc/html/indef/index.html
+Installing library in <PATH>
+Configuring library for example-1.0..
+Preprocessing library for example-1.0..
+Building library instantiated with Data.Map = <Data.Map>
+for example-1.0..
+Preprocessing library for example-1.0..
+Running Haddock on library instantiated with Data.Map = <Data.Map>
+for example-1.0..
+Documentation created: <ROOT>/quickjump.dist/work/dist/build/<ARCH>/ghc-<GHCVER>/example-1.0/doc/html/example/index.html
\ No newline at end of file
--- a/cabal-testsuite/PackageTests/HaddockArgs/quickjump.test.hs
+++ b/cabal-testsuite/PackageTests/HaddockArgs/quickjump.test.hs
+import Test.Cabal.Prelude
+
+import System.Directory
+import System.FilePath
+
+main = withShorterPathForNewBuildStore $ \storeDir -> cabalTest $ withRepo "repo" $ do
+  cabalG ["--store-dir=" ++ storeDir] "v2-build"
+    [ "example"
+    , "--enable-documentation"
+    , "--haddock-quickjump"
+    ]
+  liftIO $ do
+    libDir <- findDependencyInStore storeDir "indef"
+    assertFileDoesContain (libDir </> "cabal-hash.txt") "haddock-quickjump: True"
+    docIndexJsonExists <- doesFileExist (libDir </> "share" </> "doc" </> "html" </> "doc-index.json")
+    assertBool "doc-index.json doesn't exist, --quickjump is probably not passed to haddock" docIndexJsonExists
--- a/cabal-testsuite/PackageTests/HaddockArgs/repo/exe-0.1.0.0/Main.hs
+++ b/cabal-testsuite/PackageTests/HaddockArgs/repo/exe-0.1.0.0/Main.hs
+import qualified Data.Map as Map
+import Data.Map (Map)
+import Foo
+main = print $ f (+1) (Map.fromList [(0,1),(2,3)] :: Map Int Int)
--- a/cabal-testsuite/PackageTests/HaddockArgs/repo/exe-0.1.0.0/exe.cabal
+++ b/cabal-testsuite/PackageTests/HaddockArgs/repo/exe-0.1.0.0/exe.cabal
+name:                exe
+version:             0.1.0.0
+license:             BSD3
+author:              Edward Z. Yang
+maintainer:          ezyang@cs.stanford.edu
+build-type:          Simple
+cabal-version:       2.0
+
+executable exe
+  build-depends:       base, containers, indef
+  main-is:             Main.hs
+  default-language:    Haskell2010
--- a/cabal-testsuite/PackageTests/HaddockArgs/repo/indef-0.1.0.0/Foo.hs
+++ b/cabal-testsuite/PackageTests/HaddockArgs/repo/indef-0.1.0.0/Foo.hs
+module Foo where
+
+import Data.Map
+
+-- | A dummy function using 'Map'
+f :: (a -> b) -> Map k a -> Map k b
+f = fmap
--- a/cabal-testsuite/PackageTests/HaddockArgs/repo/indef-0.1.0.0/indef.cabal
+++ b/cabal-testsuite/PackageTests/HaddockArgs/repo/indef-0.1.0.0/indef.cabal
+name:                indef
+version:             0.1.0.0
+license:             BSD3
+author:              Edward Z. Yang
+maintainer:          ezyang@cs.stanford.edu
+build-type:          Simple
+cabal-version:       2.0
+
+library
+  build-depends:       base, sigs
+  exposed-modules:     Foo
+  default-language:    Haskell2010
--- a/cabal-testsuite/PackageTests/HaddockArgs/repo/sigs-0.1.0.0/Data/Map.hsig
+++ b/cabal-testsuite/PackageTests/HaddockArgs/repo/sigs-0.1.0.0/Data/Map.hsig
+{-# LANGUAGE RoleAnnotations #-}
+signature Data.Map where
+type role Map nominal representational
+data Map k a
+instance Functor (Map k)
--- a/cabal-testsuite/PackageTests/HaddockArgs/repo/sigs-0.1.0.0/sigs.cabal
+++ b/cabal-testsuite/PackageTests/HaddockArgs/repo/sigs-0.1.0.0/sigs.cabal
+name:                sigs
+version:             0.1.0.0
+license:             BSD3
+author:              Edward Z. Yang
+maintainer:          ezyang@cs.stanford.edu
+build-type:          Simple
+cabal-version:       2.0
+
+library
+  build-depends:       base
+  signatures: Data.Map
+  default-language:    Haskell2010
--- a/cabal-testsuite/PackageTests/HaddockArgs/src/Lib.hs
+++ b/cabal-testsuite/PackageTests/HaddockArgs/src/Lib.hs
+module Lib where
+
+import Foo
+
+-- | See 'f'
+main :: IO ()
+main = putStrLn "Hello, Haskell!"
--- a/cabal-testsuite/src/Test/Cabal/Prelude.hs
+++ b/cabal-testsuite/src/Test/Cabal/Prelude.hs
@@ -62,7 +62,7 @@ import System.Exit (ExitCode (..))
 import System.FilePath ((</>), takeExtensions, takeDrive, takeDirectory, normalise, splitPath, joinPath, splitFileName, (<.>), dropTrailingPathSeparator)
 import Control.Concurrent (threadDelay)
 import qualified Data.Char as Char
-import System.Directory (getTemporaryDirectory, getCurrentDirectory, canonicalizePath, copyFile, copyFile, doesDirectoryExist, doesFileExist, createDirectoryIfMissing, getDirectoryContents)
+import System.Directory (getTemporaryDirectory, getCurrentDirectory, canonicalizePath, copyFile, copyFile, doesDirectoryExist, doesFileExist, createDirectoryIfMissing, getDirectoryContents, listDirectory)
 import Control.Retry (exponentialBackoff, limitRetriesByCumulativeDelay)
 import Network.Wait (waitTcpVerbose)

@@ -1131,3 +1131,21 @@ withShorterPathForNewBuildStore test = do
             then takeDrive `fmap` getCurrentDirectory
             else getTemporaryDirectory
  withTempDirectory normal tempDir "cabal-test-store" test
+
+-- | Find where a package locates in the store dir. This works only if there is exactly one 1 ghc version
+-- and exactly 1 directory for the given package in the store dir.
+findDependencyInStore :: FilePath -- ^store dir
+                      -> String -- ^package name prefix
+                      -> IO FilePath -- ^package dir
+findDependencyInStore storeDir pkgName = do
+    storeDirForGhcVersion <- head <$> listDirectory storeDir
+    packageDirs <- listDirectory (storeDir </> storeDirForGhcVersion)
+    -- Ideally, we should call 'hashedInstalledPackageId' from 'Distribution.Client.PackageHash'.
+    -- But 'PackageHashInputs', especially 'PackageHashConfigInputs', is too hard to construct.
+    let pkgName' =
+            if buildOS == OSX
+            then filter (not . flip elem "aeiou") pkgName
+                -- simulates the way 'hashedInstalledPackageId' uses to compress package name
+            else pkgName
+    let libDir = head $ filter (pkgName' `isPrefixOf`) packageDirs
+    pure (storeDir </> storeDirForGhcVersion </> libDir)
--- a/changelog.d/pr-8414
+++ b/changelog.d/pr-8414
+synopsis: Pass some haddock flags to dependencies
+packages: cabal-install
+prs: #8414
+issues: #8104 #395
+
+description: {
+
+- Pass "--haddock-hoogle", "--haddock-html", "--haddock-internal", "--haddock-quickjump", "--haddock-hyperlinked-source"
+  to all the dependencies if they are specified as command line args
+
+}