Add package-db flag for v2 commands

cabal-install/src/Distribution/Client/ProjectConfig/Legacy.hs

@@ -352,11 +352,11 @@ convertLegacyAllPackageFlags globalFlags configFlags configExFlags installFlags
       configDistPref            = projectConfigDistDir,
       configHcFlavor            = projectConfigHcFlavor,
       configHcPath              = projectConfigHcPath,
-      configHcPkg               = projectConfigHcPkg
+      configHcPkg               = projectConfigHcPkg,
     --configProgramPathExtra    = projectConfigProgPathExtra DELETE ME
     --configInstallDirs         = projectConfigInstallDirs,
     --configUserInstall         = projectConfigUserInstall,
-    --configPackageDBs          = projectConfigPackageDBs,
+      configPackageDBs          = projectConfigPackageDBs
     } = configFlags
 
     ConfigExFlags {

cabal-install/src/Distribution/Client/ProjectConfig/Types.hs

@@ -56,7 +56,7 @@ import Distribution.System
 import Distribution.PackageDescription
          ( FlagAssignment )
 import Distribution.Simple.Compiler
-         ( Compiler, CompilerFlavor
+         ( Compiler, CompilerFlavor, PackageDB
          , OptimisationLevel(..), ProfDetailLevel, DebugInfoLevel(..) )
 import Distribution.Simple.Setup
          ( Flag, HaddockTarget(..), TestShowDetails(..), DumpBuildInfo (..) )
@@ -176,7 +176,7 @@ data ProjectConfigShared
      --projectConfigInstallDirs       :: InstallDirs (Flag PathTemplate),
      --TODO: [required eventually] decide what to do with InstallDirs
      -- currently we don't allow it to be specified in the config file
-     --projectConfigPackageDBs        :: [Maybe PackageDB],
+       projectConfigPackageDBs        :: [Maybe PackageDB],
 
        -- configuration used both by the solver and other phases
        projectConfigRemoteRepos       :: NubList RemoteRepo,     -- ^ Available Hackage servers.

cabal-install/src/Distribution/Client/ProjectPlanning.hs

@@ -593,7 +593,9 @@ rebuildInstallPlan verbosity
                              die' verbosity msg
               Right plan -> return (plan, pkgConfigDB, tis, ar)
       where
-        corePackageDbs = [GlobalPackageDB]
+        corePackageDbs = applyPackageDbFlags [GlobalPackageDB]
+                                             (projectConfigPackageDBs projectConfigShared)
+
         withRepoCtx    = projectConfigWithSolverRepoContext verbosity
                            projectConfigShared
                            projectConfigBuildOnly
@@ -983,6 +985,12 @@ getPackageSourceHashes verbosity withRepoCtx solverPlan = do
     return $! hashesFromRepoMetadata
            <> hashesFromTarballFiles
 
+-- | Append the given package databases to an existing PackageDBStack.
+-- A @Nothing@ entry will clear everything before it.
+applyPackageDbFlags :: PackageDBStack -> [Maybe PackageDB] -> PackageDBStack
+applyPackageDbFlags dbs' []            = dbs'
+applyPackageDbFlags _    (Nothing:dbs) = applyPackageDbFlags []             dbs
+applyPackageDbFlags dbs' (Just db:dbs) = applyPackageDbFlags (dbs' ++ [db]) dbs
 
 -- ------------------------------------------------------------
 -- * Installation planning
@@ -1858,7 +1866,7 @@ elaborateInstallPlan verbosity platform compiler compilerprogdb pkgConfigDB
 
         buildAndRegisterDbs
           | shouldBuildInplaceOnly pkg = inplacePackageDbs
-          | otherwise                  = storePackageDbs
+          | otherwise                  = corePackageDbs
 
         elabPkgDescriptionOverride = descOverride
 
@@ -1971,10 +1979,11 @@ elaborateInstallPlan verbosity platform compiler compilerprogdb pkgConfigDB
                = mempty
         perpkg = maybe mempty f (Map.lookup (packageName pkg) perPackageConfig)
 
-    inplacePackageDbs = storePackageDbs
+    inplacePackageDbs = corePackageDbs
                      ++ [ distPackageDB (compilerId compiler) ]
 
-    storePackageDbs   = storePackageDBStack (compilerId compiler)
+    corePackageDbs = applyPackageDbFlags (storePackageDBStack (compilerId compiler))
+                                         (projectConfigPackageDBs sharedPackageConfig)
 
     -- For this local build policy, every package that lives in a local source
     -- dir (as opposed to a tarball), or depends on such a package, will be

cabal-install/tests/UnitTests/Distribution/Client/ProjectConfig.hs

@@ -459,6 +459,7 @@ instance Arbitrary ProjectConfigShared where
         projectConfigHcPath               <- arbitraryFlag arbitraryShortToken
         projectConfigHcPkg                <- arbitraryFlag arbitraryShortToken
         projectConfigHaddockIndex         <- arbitrary
+        projectConfigPackageDBs           <- arbitrary
         projectConfigRemoteRepos          <- arbitrary
         projectConfigLocalNoIndexRepos    <- arbitrary
         projectConfigActiveRepos          <- arbitrary
@@ -497,6 +498,7 @@ instance Arbitrary ProjectConfigShared where
         <*> shrinkerAla (fmap NonEmpty) projectConfigHcPath
         <*> shrinkerAla (fmap NonEmpty) projectConfigHcPkg
         <*> shrinker projectConfigHaddockIndex
+        <*> shrinker projectConfigPackageDBs
         <*> shrinker projectConfigRemoteRepos
         <*> shrinker projectConfigLocalNoIndexRepos
         <*> shrinker projectConfigActiveRepos

cabal-install/tests/UnitTests/Distribution/Client/TreeDiffInstances.hs

@@ -20,6 +20,8 @@ import Distribution.Client.Types
 import Distribution.Client.Types.OverwritePolicy         (OverwritePolicy)
 import Distribution.Client.Types.SourceRepo              (SourceRepositoryPackage)
 
+import Distribution.Simple.Compiler                      (PackageDB)
+
 import Data.TreeDiff.Class
 import Data.TreeDiff.Instances.Cabal ()
 import Network.URI
@@ -50,6 +52,7 @@ instance ToExpr OptionalStanza
 instance ToExpr Outcome
 instance ToExpr OverwritePolicy
 instance ToExpr PackageConfig
+instance ToExpr PackageDB
 instance ToExpr PackageProperty
 instance ToExpr PreSolver
 instance ToExpr ProjectConfig

cabal-testsuite/PackageTests/PackageDB/cabal-fail-no-base.out

@@ -0,0 +1,16 @@
+# Setup configure
+Configuring p-1.0...
+# Setup build
+Preprocessing library for p-1.0..
+Building library for p-1.0..
+# Setup copy
+Installing library in <PATH>
+# Setup register
+Registering library for p-1.0..
+# cabal v2-build
+Resolving dependencies...
+cabal: Could not resolve dependencies:
+[__0] trying: q-1.0 (user goal)
+[__1] unknown package: base (dependency of q)
+[__1] fail (backjumping, conflict set: base, q)
+After searching the rest of the dependency tree exhaustively, these were the goals I've had most trouble fulfilling: q (2), base (1)

cabal-testsuite/PackageTests/PackageDB/cabal-fail-no-base.test.hs

@@ -0,0 +1,12 @@
+import Test.Cabal.Prelude
+main = cabalTest $ do
+    withPackageDb $ do
+        withDirectory "p" $
+            setup_install []
+
+        env <- getTestEnv
+        let pkgDbPath = testPackageDbDir env
+
+        withDirectory "q" $ do
+            res <- fails $ cabal' "v2-build" ["--package-db=clear", "--package-db=" ++ pkgDbPath]
+            assertOutputContains "unknown package: base" res

cabal-testsuite/PackageTests/PackageDB/cabal-fail-no-p.out

@@ -0,0 +1,16 @@
+# Setup configure
+Configuring p-1.0...
+# Setup build
+Preprocessing library for p-1.0..
+Building library for p-1.0..
+# Setup copy
+Installing library in <PATH>
+# Setup register
+Registering library for p-1.0..
+# cabal v2-build
+Resolving dependencies...
+cabal: Could not resolve dependencies:
+[__0] trying: q-1.0 (user goal)
+[__1] unknown package: p (dependency of q)
+[__1] fail (backjumping, conflict set: p, q)
+After searching the rest of the dependency tree exhaustively, these were the goals I've had most trouble fulfilling: q (2), p (1)

cabal-testsuite/PackageTests/PackageDB/cabal-fail-no-p.test.hs

@@ -0,0 +1,9 @@
+import Test.Cabal.Prelude
+main = cabalTest $ do
+    withPackageDb $ do
+        withDirectory "p" $
+            setup_install []
+
+        withDirectory "q" $ do
+            res <- fails $ cabal' "v2-build" []
+            assertOutputContains "unknown package: p" res

cabal-testsuite/PackageTests/PackageDB/cabal-fail-no-packagedbs.out

@@ -0,0 +1,11 @@
+# Setup configure
+Configuring p-1.0...
+# Setup build
+Preprocessing library for p-1.0..
+Building library for p-1.0..
+# Setup copy
+Installing library in <PATH>
+# Setup register
+Registering library for p-1.0..
+# cabal v2-build
+cabal: No package databases have been specified. If you use --package-db=clear, you must follow it with --package-db= with 'global', 'user' or a specific file.

cabal-testsuite/PackageTests/PackageDB/cabal-fail-no-packagedbs.test.hs

@@ -0,0 +1,9 @@
+import Test.Cabal.Prelude
+main = cabalTest $ do
+    withPackageDb $ do
+        withDirectory "p" $
+            setup_install []
+
+        withDirectory "q" $ do
+            res <- fails $ cabal' "v2-build" ["--package-db=clear"]
+            assertOutputContains "No package databases have been specified." res

cabal-testsuite/PackageTests/PackageDB/cabal-manual-packagedb.out

@@ -0,0 +1,17 @@
+# Setup configure
+Configuring p-1.0...
+# Setup build
+Preprocessing library for p-1.0..
+Building library for p-1.0..
+# Setup copy
+Installing library in <PATH>
+# Setup register
+Registering library for p-1.0..
+# cabal v2-build
+Resolving dependencies...
+Build profile: -w ghc-<GHCVER> -O1
+In order, the following will be built:
+ - q-1.0 (exe:q) (first run)
+Configuring executable 'q' for q-1.0..
+Preprocessing executable 'q' for q-1.0..
+Building executable 'q' for q-1.0..

cabal-testsuite/PackageTests/PackageDB/cabal-manual-packagedb.test.hs

@@ -0,0 +1,12 @@
+import Test.Cabal.Prelude
+main = cabalTest $ do
+    withPackageDb $ do
+        withDirectory "p" $
+            setup_install []
+
+        env <- getTestEnv
+        let pkgDbPath = testPackageDbDir env
+        withDirectory "q" $
+            cabal "v2-build" [ "--package-db=clear"
+                             , "--package-db=global"
+                             , "--package-db=" ++ pkgDbPath]

cabal-testsuite/PackageTests/PackageDB/cabal-packagedb.out

@@ -0,0 +1,17 @@
+# Setup configure
+Configuring p-1.0...
+# Setup build
+Preprocessing library for p-1.0..
+Building library for p-1.0..
+# Setup copy
+Installing library in <PATH>
+# Setup register
+Registering library for p-1.0..
+# cabal v2-build
+Resolving dependencies...
+Build profile: -w ghc-<GHCVER> -O1
+In order, the following will be built:
+ - q-1.0 (exe:q) (first run)
+Configuring executable 'q' for q-1.0..
+Preprocessing executable 'q' for q-1.0..
+Building executable 'q' for q-1.0..

cabal-testsuite/PackageTests/PackageDB/cabal-packagedb.test.hs

@@ -0,0 +1,10 @@
+import Test.Cabal.Prelude
+main = cabalTest $ do
+    withPackageDb $ do
+        withDirectory "p" $
+            setup_install []
+
+        env <- getTestEnv
+        let pkgDbPath = testPackageDbDir env
+        withDirectory "q" $
+            cabal "v2-build" ["--package-db=" ++ pkgDbPath]

cabal-testsuite/PackageTests/PackageDB/p/P.hs

@@ -0,0 +1,2 @@
+module P where
+p = True

cabal-testsuite/PackageTests/PackageDB/p/cabal.project

@@ -0,0 +1 @@
+packages: .

cabal-testsuite/PackageTests/PackageDB/p/p.cabal

@@ -0,0 +1,9 @@
+name:           p
+version:        1.0
+build-type:     Simple
+cabal-version:  >= 1.10
+
+library
+    build-depends: base
+    exposed-modules: P
+    default-language: Haskell2010

cabal-testsuite/PackageTests/PackageDB/q/Main.hs

@@ -0,0 +1,3 @@
+module Main where
+import P
+main = print p

cabal-testsuite/PackageTests/PackageDB/q/cabal.project

@@ -0,0 +1 @@
+packages: .

cabal-testsuite/PackageTests/PackageDB/q/q.cabal

@@ -0,0 +1,9 @@
+name:           q
+version:        1.0
+build-type:     Simple
+cabal-version:  >= 1.10
+
+executable q
+    build-depends: base, p
+    main-is: Main.hs
+    default-language: Haskell2010