Add more provenance information to PackageLocation for better error m…

…essages

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

@@ -221,7 +221,7 @@ packageToSdist :: Verbosity -> FilePath -> OutputFormat -> FilePath -> Unresolve
 packageToSdist verbosity projectRootDir format outputFile pkg = do
     let death = die' verbosity ("The impossible happened: a local package isn't local" <> (show pkg))
     dir0 <- case srcpkgSource pkg of
-             LocalUnpackedPackage path             -> pure (Right path)
+             LocalUnpackedPackage path _           -> pure (Right path)
              RemoteSourceRepoPackage _ (Just tgz)  -> pure (Left tgz)
              RemoteSourceRepoPackage {}            -> death
              LocalTarballPackage tgz               -> pure (Left tgz)

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

@@ -140,7 +140,7 @@ configure verbosity packageDBs repoCtxt comp platform progdb
      let installPlan = InstallPlan.configureInstallPlan configFlags installPlan0
      in case fst (InstallPlan.ready installPlan) of
       [pkg@(ReadyPackage
-              (ConfiguredPackage _ (SourcePackage _ _ (LocalUnpackedPackage _) _)
+              (ConfiguredPackage _ (SourcePackage _ _ (LocalUnpackedPackage _ _) _)
                                  _ _ _))] -> do
         configurePackage verbosity
           platform (compilerInfo comp)
@@ -307,7 +307,7 @@ planLocalPackage verbosity comp platform configFlags configExFlags
       localPkg = SourcePackage {
         srcpkgPackageId          = packageId pkg,
         srcpkgDescription        = pkg,
-        srcpkgSource             = LocalUnpackedPackage ".",
+        srcpkgSource             = LocalUnpackedPackage "." Nothing,
         srcpkgDescrOverride      = Nothing
       }
 

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

@@ -216,7 +216,7 @@ checkTarget verbosity target = case target of
 
 fetchPackage :: Verbosity -> RepoContext -> PackageLocation a -> IO ()
 fetchPackage verbosity repoCtxt pkgsrc = case pkgsrc of
-    LocalUnpackedPackage _dir  -> return ()
+    LocalUnpackedPackage _dir _cabalFile -> return ()
     LocalTarballPackage  _file -> return ()
 
     RemoteTarballPackage _uri _ ->

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

@@ -77,7 +77,7 @@ import qualified Hackage.Security.Client as Sec
 --
 isFetched :: UnresolvedPkgLoc -> IO Bool
 isFetched loc = case loc of
-    LocalUnpackedPackage _dir       -> return True
+    LocalUnpackedPackage _dir _     -> return True
     LocalTarballPackage  _file      -> return True
     RemoteTarballPackage _uri local -> return (isJust local)
     RepoTarballPackage repo pkgid _ -> doesFileExist (packageFile repo pkgid)
@@ -91,8 +91,8 @@ isFetched loc = case loc of
 checkFetched :: UnresolvedPkgLoc
              -> IO (Maybe ResolvedPkgLoc)
 checkFetched loc = case loc of
-    LocalUnpackedPackage dir  ->
-      return (Just $ LocalUnpackedPackage dir)
+    LocalUnpackedPackage dir cabalFile ->
+      return (Just $ LocalUnpackedPackage dir cabalFile)
     LocalTarballPackage  file ->
       return (Just $ LocalTarballPackage  file)
     RemoteTarballPackage uri (Just file) ->
@@ -126,8 +126,8 @@ fetchPackage :: Verbosity
              -> UnresolvedPkgLoc
              -> IO ResolvedPkgLoc
 fetchPackage verbosity repoCtxt loc = case loc of
-    LocalUnpackedPackage dir  ->
-      return (LocalUnpackedPackage dir)
+    LocalUnpackedPackage dir cabalFile ->
+      return (LocalUnpackedPackage dir cabalFile)
     LocalTarballPackage  file ->
       return (LocalTarballPackage  file)
     RemoteTarballPackage uri (Just file) ->

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

@@ -139,7 +139,7 @@ get verbosity repoCtxt _ getFlags userTargets = do
             die' verbosity $ "The 'get' command does no yet support targets "
                           ++ "that are remote source repositories."
 
-          LocalUnpackedPackage _ ->
+          LocalUnpackedPackage _ _ ->
             error "Distribution.Client.Get.unpack: the impossible happened."
       where
         usePristine :: Bool

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

@@ -376,7 +376,7 @@ readRepoIndex verbosity repoCtxt repo idxState =
       , srcpkgDescription = pkgdesc
       , srcpkgSource      = case pkgEntry of
           NormalPackage _ _ _ _       -> RepoTarballPackage repo pkgid Nothing
-          BuildTreeRef  _  _ _ path _ -> LocalUnpackedPackage path
+          BuildTreeRef  _  _ _ path _ -> LocalUnpackedPackage path Nothing
       , srcpkgDescrOverride = case pkgEntry of
           NormalPackage _ _ pkgtxt _ -> Just pkgtxt
           _                          -> Nothing

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

@@ -1229,7 +1229,7 @@ installLocalPackage verbosity pkgid location distPref installPkg =
 
   case location of
 
-    LocalUnpackedPackage dir ->
+    LocalUnpackedPackage dir _cabalFile ->
       installPkg (Just dir)
 
     RemoteSourceRepoPackage _repo dir ->

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

@@ -195,7 +195,7 @@ rebuildTargetsDryRun distDirLayout@DistDirLayout{..} shared =
       case mloc of
         Nothing -> return BuildStatusDownload
 
-        Just (LocalUnpackedPackage srcdir) ->
+        Just (LocalUnpackedPackage srcdir _) ->
           -- For the case of a user-managed local dir, irrespective of the
           -- build style, we build from that directory and put build
           -- artifacts under the shared dist directory.

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

@@ -1057,7 +1057,7 @@ readSourcePackageLocalDirectory
 readSourcePackageLocalDirectory verbosity dir cabalFile = do
     monitorFiles [monitorFileHashed cabalFile]
     root <- askRoot
-    let location = LocalUnpackedPackage (root </> dir)
+    let location = LocalUnpackedPackage (root </> dir) (Just cabalFile)
     liftIO $ fmap (mkSpecificSourcePackage location)
            . readSourcePackageCabalFile verbosity cabalFile
          =<< BS.readFile (root </> cabalFile)

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

@@ -577,10 +577,6 @@ resolveTargets selectPackageTargets selectComponentTarget
 
     checkTarget (TargetPackage _ pkgids _)
       = Left (TargetProblemNotSinglePackage pkgids)
-      -- For the moment this error cannot happen here, because it gets
-      -- detected when the package config is being constructed. This case
-      -- will need handling properly when we do add support.
-      --
       -- TODO: how should this use case play together with the
       -- '--cabal-file' option of 'configure' which allows using multiple
       -- .cabal files for a single package?

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

@@ -195,7 +195,7 @@ encodePlanAsJson distDirLayout elaboratedInstallPlan elaboratedSharedConfig =
       packageLocationToJ :: PackageLocation (Maybe FilePath) -> J.Value
       packageLocationToJ pkgloc =
         case pkgloc of
-          LocalUnpackedPackage local ->
+          LocalUnpackedPackage local _cabalFile ->
             J.object [ "type" J..= J.String "local"
                      , "path" J..= J.String local
                      ]

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

@@ -2075,8 +2075,8 @@ elaborateInstallPlan verbosity platform compiler compilerprogdb pkgConfigDB
 shouldBeLocal :: PackageSpecifier (SourcePackage (PackageLocation loc)) -> Maybe PackageId
 shouldBeLocal NamedPackage{}              = Nothing
 shouldBeLocal (SpecificSourcePackage pkg) = case srcpkgSource pkg of
-    LocalUnpackedPackage _ -> Just (packageId pkg)
-    _                      -> Nothing
+    LocalUnpackedPackage _ _ -> Just (packageId pkg)
+    _                        -> Nothing
 
 -- | Given a 'ElaboratedPlanPackage', report if it matches a 'ComponentName'.
 matchPlanPkg :: (ComponentName -> Bool) -> ElaboratedPlanPackage -> Bool

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

@@ -443,7 +443,7 @@ dataDirEnvVarForPackage distDirLayout pkg =
        , Just $ srcPath (elabPkgSourceLocation pkg)
             </> dataDir (elabPkgDescription pkg))
   where
-    srcPath (LocalUnpackedPackage path) = path
+    srcPath (LocalUnpackedPackage path _cabalFile) = path
     srcPath (LocalTarballPackage _path) = unpackedPath
     srcPath (RemoteTarballPackage _uri _localTar) = unpackedPath
     srcPath (RepoTarballPackage _repo _packageId _localTar) = unpackedPath

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

@@ -341,7 +341,7 @@ fakeProjectSourcePackage projectRoot = sourcePackage
     sourcePackage = SourcePackage
       { srcpkgPackageId     = fakePackageId
       , srcpkgDescription   = genericPackageDescription
-      , srcpkgSource        = LocalUnpackedPackage projectRoot
+      , srcpkgSource        = LocalUnpackedPackage projectRoot Nothing
       , srcpkgDescrOverride = Nothing
       }
     genericPackageDescription = emptyGenericPackageDescription

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

@@ -830,6 +830,14 @@ reportTargetSelectorProblems verbosity problems = do
         where
 
 
+    case [ t | TargetSelectorNoScript t <- problems ] of
+      []  -> return ()
+      target:_ ->
+        die' verbosity $
+            "The script '" ++ showTargetString target ++ "' does not exist, "
+         ++ "and only script targets may contain whitespace characters or end "
+         ++ "with ':'"
+
     fail "reportTargetSelectorProblems: internal error"
   where
     noPackageErrorMessage =
@@ -842,14 +850,6 @@ reportTargetSelectorProblems verbosity problems = do
          ++ "packages in your project and all other build configuration. "
          ++ "See the Cabal user guide for full details."
 
-    case [ t | TargetSelectorNoScript t <- problems ] of
-      []  -> return ()
-      target:_ ->
-        die' verbosity $
-            "The script '" ++ showTargetString target ++ "' does not exist, "
-         ++ "and only script targets may contain whitespace characters or end "
-         ++ "with ':'"
-
 
 ----------------------------------
 -- Syntax type
@@ -1828,7 +1828,7 @@ collectKnownPackageInfo dirActions@DirActions{..}
     (pkgdir, pkgfile) <-
       case loc of
         --TODO: local tarballs, remote tarballs etc
-        LocalUnpackedPackage dir -> do
+        LocalUnpackedPackage dir _cabalFile -> do
           dirabs <- canonicalizePath dir
           dirrel <- makeRelativeToCwd dirActions dirabs
           --TODO: ought to get this earlier in project reading

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

@@ -93,7 +93,7 @@ import qualified Data.ByteString.Lazy as BS
 import qualified Distribution.Client.GZipUtils as GZipUtils
 import qualified Distribution.Compat.CharParsing as P
 import System.FilePath
-         ( takeExtension, dropExtension, takeDirectory, splitPath )
+         ( takeExtension, dropExtension, takeDirectory, splitPath, takeFileName )
 import System.Directory
          ( doesFileExist, doesDirectoryExist )
 import Network.URI
@@ -348,12 +348,12 @@ expandUserTarget verbosity userTarget = case userTarget of
       in  return [PackageTargetNamedFuzzy name props userTarget]
 
     UserTargetLocalDir dir ->
-      return [ PackageTargetLocation (LocalUnpackedPackage dir) ]
+      return [ PackageTargetLocation (LocalUnpackedPackage dir Nothing) ]
 
     UserTargetLocalCabalFile file -> do
       let dir = takeDirectory file
       _   <- tryFindPackageDesc verbosity dir (localPackageError dir) -- just as a check
-      return [ PackageTargetLocation (LocalUnpackedPackage dir) ]
+      return [ PackageTargetLocation (LocalUnpackedPackage dir (Just $ takeFileName file)) ]
 
     UserTargetLocalTarball tarballFile ->
       return [ PackageTargetLocation (LocalTarballPackage tarballFile) ]
@@ -392,7 +392,7 @@ readPackageTarget verbosity = traverse modifyLocation
     modifyLocation :: ResolvedPkgLoc -> IO UnresolvedSourcePackage
     modifyLocation location = case location of
 
-      LocalUnpackedPackage dir -> do
+      LocalUnpackedPackage dir _cabalFile -> do
         pkg <- tryFindPackageDesc verbosity dir (localPackageError dir) >>=
                  readGenericPackageDescription verbosity
         return SourcePackage

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

@@ -24,8 +24,10 @@ type ResolvedPkgLoc = PackageLocation FilePath
 
 data PackageLocation local =
 
-    -- | An unpacked package in the given dir, or current dir
-    LocalUnpackedPackage FilePath
+    -- | An unpacked package in the given dir, or current dir,
+    -- with the given .cabal file name within the given dir.
+    -- If Nothing, this will default to @'PackageId' <.> "cabal"@.
+    LocalUnpackedPackage FilePath (Maybe FilePath)
 
     -- | A package as a tarball that's available as a local tarball
   | LocalTarballPackage FilePath

cabal-install/tests/IntegrationTests2.hs

@@ -454,7 +454,7 @@ testTargetSelectorAmbiguous reportSubCase = do
     mkpkgAt pkgidstr exes loc =
       SourcePackage {
         srcpkgPackageId = pkgid,
-        srcpkgSource = LocalUnpackedPackage loc,
+        srcpkgSource = LocalUnpackedPackage loc Nothing,
         srcpkgDescrOverride  = Nothing,
         srcpkgDescription = GenericPackageDescription {
           packageDescription = emptyPackageDescription { package = pkgid },