Tests for internal libraries (haskell#269) and separate cabal_macros.h (haskell#1893)

Signed-off-by: Edward Z. Yang <[email protected]>

Author: ezyang

Cabal/Cabal.cabal

@@ -95,14 +95,17 @@ extra-source-files:
   tests/PackageTests/HaddockNewline/A.hs
   tests/PackageTests/HaddockNewline/HaddockNewline.cabal
   tests/PackageTests/HaddockNewline/Setup.hs
-  tests/PackageTests/MultipleLibraries/p.cabal
-  tests/PackageTests/MultipleLibraries/p/P.hs
-  tests/PackageTests/MultipleLibraries/p/Foo.hs
-  tests/PackageTests/MultipleLibraries/p/p.cabal
-  tests/PackageTests/MultipleLibraries/p/p/P.hs
-  tests/PackageTests/MultipleLibraries/p/q/Q.hs
-  tests/PackageTests/MultipleLibraries/q/Q.hs
-  tests/PackageTests/MultipleLibraries/q/q.cabal
+  tests/PackageTests/InternalLibraries/Executable/dist-test.Dynamic/test.sh
+  tests/PackageTests/InternalLibraries/Executable/dist-test.Static/test.sh
+  tests/PackageTests/InternalLibraries/Executable/exe/Main.hs
+  tests/PackageTests/InternalLibraries/Executable/foo.cabal
+  tests/PackageTests/InternalLibraries/Executable/src/Foo.hs
+  tests/PackageTests/InternalLibraries/p/Foo.hs
+  tests/PackageTests/InternalLibraries/p/p.cabal
+  tests/PackageTests/InternalLibraries/p/p/P.hs
+  tests/PackageTests/InternalLibraries/p/q/Q.hs
+  tests/PackageTests/InternalLibraries/q/Q.hs
+  tests/PackageTests/InternalLibraries/q/q.cabal
   tests/PackageTests/OrderFlags/Foo.hs
   tests/PackageTests/OrderFlags/my.cabal
   tests/PackageTests/PathsModule/Executable/Main.hs

Cabal/tests/PackageTests/InternalLibraries/Executable/exe/Main.hs

@@ -0,0 +1,2 @@
+import Foo
+main = print (foo 23)

Cabal/tests/PackageTests/InternalLibraries/Executable/foo.cabal

@@ -0,0 +1,18 @@
+name:                foo
+version:             0.1.0.0
+license:             BSD3
+author:              Edward Z. Yang
+maintainer:          [email protected]
+build-type:          Simple
+cabal-version:       >=1.23
+
+library foo-internal
+  exposed-modules:     Foo
+  build-depends:       base
+  hs-source-dirs:      src
+  default-language:    Haskell2010
+
+executable foo
+  main-is: Main.hs
+  build-depends:       base, foo-internal
+  hs-source-dirs: exe

Cabal/tests/PackageTests/InternalLibraries/Executable/src/Foo.hs

@@ -0,0 +1,4 @@
+module Foo where
+{-# NOINLINE foo #-}
+foo :: Int -> Int
+foo x = x + 23

Cabal/tests/PackageTests/InternalLibraries/Library/fooexe/Main.hs

@@ -0,0 +1,6 @@
+module Main where
+
+import Foo
+
+main :: IO ()
+main = print foo

Cabal/tests/PackageTests/InternalLibraries/Library/fooexe/fooexe.cabal

@@ -0,0 +1,12 @@
+name:                fooexe
+version:             0.1.0.0
+license:             BSD3
+author:              Edward Z. Yang
+maintainer:          [email protected]
+build-type:          Simple
+cabal-version:       >=1.10
+
+executable fooexe
+  main-is:             Main.hs
+  build-depends:       base, foolib
+  default-language:    Haskell2010

Cabal/tests/PackageTests/InternalLibraries/Library/foolib/Foo.hs

@@ -0,0 +1,3 @@
+module Foo where
+import Internal
+foo = internal + 2

Cabal/tests/PackageTests/InternalLibraries/Library/foolib/foolib.cabal

@@ -0,0 +1,17 @@
+name:                foolib
+version:             0.1.0.0
+license:             BSD3
+author:              Edward Z. Yang
+maintainer:          [email protected]
+build-type:          Simple
+cabal-version:       >=1.23
+
+library foolib-internal
+  exposed-modules:     Internal
+  hs-source-dirs:      private
+  build-depends:       base
+
+library
+  exposed-modules:     Foo
+  build-depends:       base, foolib-internal
+  default-language:    Haskell2010

Cabal/tests/PackageTests/InternalLibraries/Library/foolib/private/Internal.hs

@@ -0,0 +1,4 @@
+module Internal where
+{-# NOINLINE internal #-}
+internal :: Int
+internal = 23

Cabal/tests/PackageTests/MultipleLibraries/p/Foo.hs renamed to Cabal/tests/PackageTests/InternalLibraries/p/Foo.hs

@@ -0,0 +1,10 @@
+{-# LANGUAGE CPP #-}
+import C
+#ifdef VERSION_filepath
+#error "Should not see macro from library"
+#endif
+#ifdef VERSION_containers
+#error "Should not see macro from executable macros-b"
+#endif
+main = do
+    putStrLn CURRENT_COMPONENT_ID

Cabal/tests/PackageTests/MultipleLibraries/p/p.cabal renamed to Cabal/tests/PackageTests/InternalLibraries/p/p.cabal

@@ -0,0 +1,10 @@
+{-# LANGUAGE CPP #-}
+import C
+#ifdef VERSION_filepath
+#error "Should not see macro from library"
+#endif
+#ifdef VERSION_deepseq
+#error "Should not see macro from executable macros-a"
+#endif
+main = do
+    putStrLn CURRENT_COMPONENT_ID

Cabal/tests/PackageTests/MultipleLibraries/p/p/P.hs renamed to Cabal/tests/PackageTests/InternalLibraries/p/p/P.hs

@@ -0,0 +1,4 @@
+module Main where
+
+main :: IO ()
+main = putStrLn "Hello, Haskell!"

Cabal/tests/PackageTests/MultipleLibraries/p/q/Q.hs renamed to Cabal/tests/PackageTests/InternalLibraries/p/q/Q.hs

@@ -0,0 +1,23 @@
+name:                macros
+version:             0.1.0.0
+license:             BSD3
+license-file:        LICENSE
+author:              Edward Z. Yang
+maintainer:          [email protected]
+build-type:          Simple
+cabal-version:       >=1.10
+
+library macros
+  exposed-modules:     C
+  hs-source-dirs:      src
+  build-depends:       base, filepath
+
+executable macros-a
+  main-is:             A.hs
+  build-depends:       base, deepseq, macros
+  default-language:    Haskell2010
+
+executable macros-b
+  main-is:             B.hs
+  build-depends:       base, containers, macros
+  default-language:    Haskell2010

Cabal/tests/PackageTests/MultipleLibraries/q/Q.hs renamed to Cabal/tests/PackageTests/InternalLibraries/q/Q.hs

@@ -0,0 +1,10 @@
+{-# LANGUAGE CPP #-}
+module C where
+#ifdef VERSION_deepseq
+#error "Should not see macro from executable macros-a"
+#endif
+#ifdef VERSION_containers
+#error "Should not see macro from executable macros-b"
+#endif
+c :: String
+c = CURRENT_COMPONENT_ID

Cabal/tests/PackageTests/MultipleLibraries/q/q.cabal renamed to Cabal/tests/PackageTests/InternalLibraries/q/q.cabal

@@ -27,6 +27,8 @@ module PackageTests.PackageTester
     , run
     , runExe
     , runExe'
+    , runInstalledExe
+    , runInstalledExe'
     , rawRun
     , rawCompileSetup
     , withPackage
@@ -66,7 +68,7 @@ import Distribution.Simple.Configure
 import Distribution.Verbosity (Verbosity)
 import Distribution.Simple.BuildPaths (exeExtension)
 
-#ifndef CURRENT_PACKAGE_KEY
+#ifndef LOCAL_COMPONENT_ID
 import Distribution.Simple.Utils (cabalVersion)
 import Distribution.Text (display)
 #endif
@@ -267,7 +269,7 @@ cabal' cmd extraArgs0 = do
                 -- Would really like to do this, but we're not always
                 -- going to be building against sufficiently recent
                 -- Cabal which provides this macro.
-                -- , "--dependency=Cabal=" ++ THIS_PACKAGE_KEY
+                -- , "--dependency=Cabal=" ++ LOCAL_COMPONENT_ID
                 -- These flags make the test suite run faster
                 -- Can't do this unless we LD_LIBRARY_PATH correctly
                 -- , "--enable-executable-dynamic"
@@ -340,10 +342,10 @@ rawCompileSetup verbosity suite e path = do
         ghcPackageDBParams (ghcVersion suite) (packageDBStack suite) ++
         [ "-hide-all-packages"
         , "-package base"
-#ifdef CURRENT_PACKAGE_KEY
+#ifdef LOCAL_COMPONENT_ID
         -- This is best, but we don't necessarily have it
         -- if we're bootstrapping with old Cabal.
-        , "-package-id " ++ CURRENT_PACKAGE_KEY
+        , "-package-id " ++ LOCAL_COMPONENT_ID
 #else
         -- This mostly works, UNLESS you've installed a
         -- version of Cabal with the SAME version number.
@@ -421,6 +423,17 @@ runExe' exe_name args = do
     let exe = dist_dir </> "build" </> exe_name </> exe_name
     run Nothing exe args
 
+-- | Run an executable that was installed by cabal.  The @exe_name@
+-- is precisely the name of the executable.
+runInstalledExe :: String -> [String] -> TestM ()
+runInstalledExe exe_name args = void (runInstalledExe' exe_name args)
+
+runInstalledExe' :: String -> [String] -> TestM Result
+runInstalledExe' exe_name args = do
+    usr <- prefixDir
+    let exe = usr </> "bin" </> exe_name
+    run Nothing exe args
+
 run :: Maybe FilePath -> String -> [String] -> TestM Result
 run mb_cwd path args = do
     verbosity <- getVerbosity
@@ -480,13 +493,13 @@ requireSuccess r@Result { resultCommand = cmd
 
 record :: Result -> TestM ()
 record res = do
-    build_dir <- distDir
+    log_dir <- topDir
     (suite, _) <- ask
-    liftIO $ createDirectoryIfMissing True build_dir
-    liftIO $ C.appendFile (build_dir </> "test.log")
+    liftIO $ createDirectoryIfMissing True log_dir
+    liftIO $ C.appendFile (log_dir </> "test.log")
                          (C.pack $ "+ " ++ resultCommand res ++ "\n"
                             ++ resultOutput res ++ "\n\n")
-    let test_sh = build_dir </> "test.sh"
+    let test_sh = log_dir </> "test.sh"
     b <- liftIO $ doesFileExist test_sh
     when (not b) . liftIO $ do
         -- This is hella racey but this is not that security important

Cabal/tests/PackageTests/Macros/A.hs

@@ -7,8 +7,14 @@ import qualified PackageTests.TestStanza.Check
 import qualified PackageTests.DeterministicAr.Check
 import qualified PackageTests.TestSuiteTests.ExeV10.Check
 
+import Distribution.Simple.LocalBuildInfo (LocalBuildInfo(localPkgDescr, compiler), absoluteInstallDirs, InstallDirs(libdir), maybeGetComponentLocalBuildInfo, ComponentLocalBuildInfo(componentId), ComponentName(CLibName))
+import Distribution.Simple.InstallDirs (CopyDest(NoCopyDest))
+import Distribution.Simple.BuildPaths (mkLibName, mkSharedLibName)
+import Distribution.Simple.Compiler (compilerId)
+
 import Control.Monad
 
+import System.Directory
 import Data.Version
 import Test.Tasty (TestTree, testGroup, mkTimeout, localOption)
 import Test.Tasty.HUnit (testCase)
@@ -42,17 +48,12 @@ tests config =
 
     -- Test detailed-0.9 test suites
     , testGroup "LibV09" $
-      let
-        tcs :: FilePath -> TestM a -> TestTree
-        tcs name m
-            = testCase name (runTestM config ("TestSuiteTests/LibV09")
-                                             (Just name) m)
-      in -- Test if detailed-0.9 builds correctly
-         [ tcs "Build" $ cabal_build ["--enable-tests"]
+         -- Test if detailed-0.9 builds correctly
+         [ tcs "" "Build" $ cabal_build ["--enable-tests"]
 
          -- Tests for #2489, stdio deadlock
          , localOption (mkTimeout $ 10 ^ (8 :: Int))
-         . tcs "Deadlock" $ do
+         . tcs "" "Deadlock" $ do
             cabal_build ["--enable-tests"]
             shouldFail $ cabal "test" []
          ]
@@ -207,6 +208,8 @@ tests config =
         assertFailure $ "cabal has not calculated different Installed " ++
           "package ID when source is changed."
 
+  -- Test that if two components have the same module name, they do not
+  -- clobber each other.
   , tc "DuplicateModuleName" $ do
       cabal_build ["--enable-tests"]
       r1 <- shouldFail $ cabal' "test" ["foo"]
@@ -216,21 +219,54 @@ tests config =
       assertOutputContains "test C" r2
       assertOutputContains "test A" r2
 
+  -- Test that if test suite has a name which conflicts with a package
+  -- which is in the database, we can still use the test case (they
+  -- should NOT shadow).
   , tc "TestNameCollision" $ do
         withPackageDb $ do
           withPackage "parent" $ cabal_install []
           withPackage "child" $ do
             cabal_build ["--enable-tests"]
             cabal "test" []
 
-  , tc "MultipleLibraries" $ do
+  -- Basic test for internal libraries (in p); package q is to make
+  -- sure that the internal library correctly is used, not the
+  -- external library.
+  , tc "InternalLibraries" $ do
         withPackageDb $ do
             withPackage "q" $ cabal_install []
             withPackage "p" $ do
                 cabal_install []
-                r <- runExe' "foo" []
+                cabal "clean" []
+                r <- runInstalledExe' "foo" []
                 assertOutputContains "I AM THE ONE" r
 
+  -- Internal libraries used by a statically linked executable:
+  -- no libraries should get installed or registered.
+  , tcs "InternalLibraries/Executable" "Static" $ multiple_libraries_executable False
+
+  -- Internal libraries used by a dynamically linked executable:
+  -- ONLY the dynamic library should be installed, no registration
+  , tcs "InternalLibraries/Executable" "Dynamic" $ multiple_libraries_executable True
+
+  -- Internal library used by public library; it must be installed and
+  -- registered.
+  , tc "InternalLibraries/Library" $ do
+        withPackageDb $ do
+            withPackage "foolib" $ cabal_install []
+            withPackage "fooexe" $ do
+                cabal_build []
+                runExe' "fooexe" []
+                    >>= assertOutputContains "25"
+
+  -- Test to ensure that cabal_macros.h are computed per-component.
+  , tc "Macros" $ do
+        cabal_build []
+        runExe' "macros-a" []
+            >>= assertOutputContains "macros-a.exe"
+        runExe' "macros-b" []
+            >>= assertOutputContains "macros-b.exe"
+
   ]
   where
     -- Shared test function for BuildDeps/InternalLibrary* tests.
@@ -243,6 +279,40 @@ tests config =
             ("myLibFunc " ++ expect)
             (concat $ lines (resultOutput r))
 
+    multiple_libraries_executable is_dynamic =
+        withPackageDb $ do
+            cabal_install $ [ if is_dynamic then "--enable-executable-dynamic"
+                                            else "--disable-executable-dynamic"
+                            , "--enable-shared"]
+            dist_dir <- distDir
+            lbi <- liftIO $ getPersistBuildConfig dist_dir
+            let pkg_descr = localPkgDescr lbi
+                compiler_id = compilerId (compiler lbi)
+                cname = (CLibName "foo-internal")
+                Just clbi = maybeGetComponentLocalBuildInfo lbi cname
+                cid = componentId clbi
+                dir = libdir (absoluteInstallDirs pkg_descr lbi cid NoCopyDest)
+            assertBool "interface files should NOT be installed" . not
+                =<< liftIO (doesFileExist (dir </> "Foo.hi"))
+            assertBool "static library should NOT be installed" . not
+                =<< liftIO (doesFileExist (dir </> mkLibName cid))
+            if is_dynamic
+              then
+                assertBool "dynamic library MUST be installed"
+                    =<< liftIO (doesFileExist (dir </> mkSharedLibName compiler_id cid))
+              else
+                assertBool "dynamic library should NOT be installed" . not
+                    =<< liftIO (doesFileExist (dir </> mkSharedLibName compiler_id cid))
+            shouldFail $ ghcPkg "describe" ["foo"]
+            -- clean away the dist directory so that we catch accidental
+            -- dependence on the inplace files
+            cabal "clean" []
+            runInstalledExe' "foo" [] >>= assertOutputContains "46"
+
     tc :: FilePath -> TestM a -> TestTree
     tc name m
         = testCase name (runTestM config name Nothing m)
+
+    tcs :: FilePath -> FilePath -> TestM a -> TestTree
+    tcs name sub_name m
+        = testCase (name </> sub_name) (runTestM config name (Just sub_name) m)