Merge pull request #5177

Implement ghc/cabal compatiblity matrix (#415)

(backported #5165)

cabal-install/Distribution/Client/ProjectPlanning.hs

@@ -949,18 +949,7 @@ planPackages verbosity comp platform solver SolverSettings{..}
                                    . PD.packageDescription
                                    . packageDescription)
 
-      . addSetupCabalMinVersionConstraint (mkVersion [1,20])
-          -- While we can talk to older Cabal versions (we need to be able to
-          -- do so for custom Setup scripts that require older Cabal lib
-          -- versions), we have problems talking to some older versions that
-          -- don't support certain features.
-          --
-          -- For example, Cabal-1.16 and older do not know about build targets.
-          -- Even worse, 1.18 and older only supported the --constraint flag
-          -- with source package ids, not --dependency with installed package
-          -- ids. That is bad because we cannot reliably select the right
-          -- dependencies in the presence of multiple instances (i.e. the
-          -- store). See issue #3932. So we require Cabal 1.20 as a minimum.
+      . addSetupCabalMinVersionConstraint setupMinCabalVersionConstraint
 
       . addPreferences
           -- preferences from the config file or command line
@@ -1029,6 +1018,47 @@ planPackages verbosity comp platform solver SolverSettings{..}
         installedPkgIndex sourcePkgDb
         localPackages
 
+    -- While we can talk to older Cabal versions (we need to be able to
+    -- do so for custom Setup scripts that require older Cabal lib
+    -- versions), we have problems talking to some older versions that
+    -- don't support certain features.
+    --
+    -- For example, Cabal-1.16 and older do not know about build targets.
+    -- Even worse, 1.18 and older only supported the --constraint flag
+    -- with source package ids, not --dependency with installed package
+    -- ids. That is bad because we cannot reliably select the right
+    -- dependencies in the presence of multiple instances (i.e. the
+    -- store). See issue #3932. So we require Cabal 1.20 as a minimum.
+    --
+    -- Moreover, lib:Cabal generally only supports the interface of
+    -- current and past compilers; in fact recent lib:Cabal versions
+    -- will warn when they encounter a too new or unknown GHC compiler
+    -- version (c.f. #415). To avoid running into unsupported
+    -- configurations we encode the compatiblity matrix as lower
+    -- bounds on lib:Cabal here (effectively corresponding to the
+    -- respective major Cabal version bundled with the respective GHC
+    -- release).
+    --
+    -- GHC 8.4   needs  Cabal >= 2.1  (GHC 8.4.1-rc1 has Cabal-2.1)
+    -- GHC 8.2   needs  Cabal >= 2.0
+    -- GHC 8.0   needs  Cabal >= 1.24
+    -- GHC 7.10  needs  Cabal >= 1.22
+    --
+    -- (NB: we don't need to consider older GHCs as Cabal >= 1.20 is
+    -- the absolute lower bound)
+    --
+    -- TODO: long-term, this compatibility matrix should be
+    --       stored as a field inside 'Distribution.Compiler.Compiler'
+    setupMinCabalVersionConstraint
+      | isGHC, compVer >= mkVersion [8,4]  = mkVersion [2,1]
+      | isGHC, compVer >= mkVersion [8,2]  = mkVersion [2,0]
+      | isGHC, compVer >= mkVersion [8,0]  = mkVersion [1,24]
+      | isGHC, compVer >= mkVersion [7,10] = mkVersion [1,22]
+      | otherwise                          = mkVersion [1,20]
+      where
+        isGHC    = compFlav `elem` [GHC,GHCJS]
+        compFlav = compilerFlavor comp
+        compVer  = compilerVersion comp
 
 ------------------------------------------------------------------------------
 -- * Install plan post-processing

cabal-install/tests/IntegrationTests2.hs

@@ -1347,14 +1347,16 @@ testSetupScriptStyles config reportSubCase = do
     marker1 @?= "ok"
     removeFile (basedir </> testdir1 </> "marker")
 
-    reportSubCase (show SetupCustomImplicitDeps)
-    (plan2, res2) <- executePlan =<< planProject testdir2 config
-    (pkg2,  _)    <- expectPackageInstalled plan2 res2 pkgidA
-    elabSetupScriptStyle pkg2 @?= SetupCustomImplicitDeps
-    hasDefaultSetupDeps pkg2 @?= Just True
-    marker2 <- readFile (basedir </> testdir2 </> "marker")
-    marker2 @?= "ok"
-    removeFile (basedir </> testdir2 </> "marker")
+    -- implicit deps implies 'Cabal < 2' which conflicts w/ GHC 8.2 or later
+    when (compilerVersion (pkgConfigCompiler sharedConfig) < mkVersion [8,2]) $ do
+      reportSubCase (show SetupCustomImplicitDeps)
+      (plan2, res2) <- executePlan =<< planProject testdir2 config
+      (pkg2,  _)    <- expectPackageInstalled plan2 res2 pkgidA
+      elabSetupScriptStyle pkg2 @?= SetupCustomImplicitDeps
+      hasDefaultSetupDeps pkg2 @?= Just True
+      marker2 <- readFile (basedir </> testdir2 </> "marker")
+      marker2 @?= "ok"
+      removeFile (basedir </> testdir2 </> "marker")
 
     reportSubCase (show SetupNonCustomInternalLib)
     (plan3, res3) <- executePlan =<< planProject testdir3 config

cabal-testsuite/PackageTests/CustomDep/cabal.test.hs

@@ -2,6 +2,8 @@ import Test.Cabal.Prelude
 main = cabalTest $ do
     -- NB: This variant seems to use the bootstrapped Cabal?
     skipUnless =<< hasCabalForGhc
+    -- implicit setup-depends conflict with GHC >= 8.2; c.f. #415
+    skipIf =<< (ghcVersionIs (>= mkVersion [8,2]))
     -- This test depends heavily on what packages are in the global
     -- database, don't record the output
     recordMode DoNotRecord $ do

cabal-testsuite/PackageTests/CustomPlain/cabal.test.hs

 import Test.Cabal.Prelude
 main = cabalTest $ do
+    -- implicit setup-depends conflict with GHC >= 8.2; c.f. #415
+    skipIf =<< (ghcVersionIs (>= mkVersion [8,2]))
     -- Regression test for #4393
     recordMode DoNotRecord $ do
         -- TODO: Hack; see also CustomDep/cabal.test.hs

cabal-testsuite/PackageTests/Regression/T3932/cabal.test.hs

@@ -5,8 +5,11 @@ main = cabalTest $
     -- extra constraint that setup Cabal must be 1.20.  If we don't
     -- have a choice like this available, the unsatisfied constraint
     -- won't be reported.
+    --
+    -- Due to #415, the lower bound may be even higher based on GHC
+    -- version
     withRepo "repo" $ do
         -- Don't record because output wobbles based on installed database.
         recordMode DoNotRecord $ do
             fails (cabal' "new-build" []) >>=
-                assertOutputContains "Setup.hs requires >=1.20"
+                assertOutputContains "Setup.hs requires >="