Merge pull request #9690 from fendor/fix/dont-drop-subcomponent-fp-targets

Revert "Drop sub-component targets (#8966)"

Author: mergify[bot]

Cabal/src/Distribution/Simple/BuildTarget.hs

@@ -310,6 +310,7 @@ test-suite unit-tests
       UnitTests.Distribution.Client.InstallPlan
       UnitTests.Distribution.Client.JobControl
       UnitTests.Distribution.Client.ProjectConfig
+      UnitTests.Distribution.Client.ProjectPlanning
       UnitTests.Distribution.Client.Store
       UnitTests.Distribution.Client.Tar
       UnitTests.Distribution.Client.Targets

cabal-install/cabal-install.cabal

@@ -8,6 +8,7 @@ module Distribution.Client.CmdBench
 
     -- * Internals exposed for testing
   , componentNotBenchmarkProblem
+  , isSubComponentProblem
   , noBenchmarksProblem
   , selectPackageTargets
   , selectComponentTarget
@@ -196,17 +197,25 @@ selectPackageTargets targetSelector targets
 -- For the @bench@ command we just need to check it is a benchmark, in addition
 -- to the basic checks on being buildable etc.
 selectComponentTarget
-  :: AvailableTarget k
+  :: SubComponentTarget
+  -> AvailableTarget k
   -> Either BenchTargetProblem k
-selectComponentTarget t
+selectComponentTarget subtarget@WholeComponent t
   | CBenchName _ <- availableTargetComponentName t =
-      selectComponentTargetBasic t
+      selectComponentTargetBasic subtarget t
   | otherwise =
       Left
         ( componentNotBenchmarkProblem
             (availableTargetPackageId t)
             (availableTargetComponentName t)
         )
+selectComponentTarget subtarget t =
+  Left
+    ( isSubComponentProblem
+        (availableTargetPackageId t)
+        (availableTargetComponentName t)
+        subtarget
+    )
 
 -- | The various error conditions that can occur when matching a
 -- 'TargetSelector' against 'AvailableTarget's for the @bench@ command.
@@ -215,6 +224,8 @@ data BenchProblem
     TargetProblemNoBenchmarks TargetSelector
   | -- | The 'TargetSelector' refers to a component that is not a benchmark
     TargetProblemComponentNotBenchmark PackageId ComponentName
+  | -- | Asking to benchmark an individual file or module is not supported
+    TargetProblemIsSubComponent PackageId ComponentName SubComponentTarget
   deriving (Eq, Show)
 
 type BenchTargetProblem = TargetProblem BenchProblem
@@ -227,6 +238,15 @@ componentNotBenchmarkProblem pkgid name =
   CustomTargetProblem $
     TargetProblemComponentNotBenchmark pkgid name
 
+isSubComponentProblem
+  :: PackageId
+  -> ComponentName
+  -> SubComponentTarget
+  -> TargetProblem BenchProblem
+isSubComponentProblem pkgid name subcomponent =
+  CustomTargetProblem $
+    TargetProblemIsSubComponent pkgid name subcomponent
+
 reportTargetProblems :: Verbosity -> [BenchTargetProblem] -> IO a
 reportTargetProblems verbosity =
   dieWithException verbosity . RenderBenchTargetProblem . map renderBenchTargetProblem
@@ -263,4 +283,13 @@ renderBenchProblem (TargetProblemComponentNotBenchmark pkgid cname) =
     ++ prettyShow pkgid
     ++ "."
   where
-    targetSelector = TargetComponent pkgid cname
+    targetSelector = TargetComponent pkgid cname WholeComponent
+renderBenchProblem (TargetProblemIsSubComponent pkgid cname subtarget) =
+  "The bench command can only run benchmarks as a whole, "
+    ++ "not files or modules within them, but the target '"
+    ++ showTargetSelector targetSelector
+    ++ "' refers to "
+    ++ renderTargetSelector targetSelector
+    ++ "."
+  where
+    targetSelector = TargetComponent pkgid cname subtarget

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

@@ -226,7 +226,8 @@ selectPackageTargets targetSelector targets
 --
 -- For the @build@ command we just need the basic checks on being buildable etc.
 selectComponentTarget
-  :: AvailableTarget k
+  :: SubComponentTarget
+  -> AvailableTarget k
   -> Either TargetProblem' k
 selectComponentTarget = selectComponentTargetBasic
 

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

@@ -24,6 +24,7 @@ import Distribution.Client.TargetProblem
 import Distribution.Client.TargetSelector
   ( ComponentKind (..)
   , ComponentKindFilter
+  , SubComponentTarget (..)
   , TargetSelector (..)
   , componentKind
   , showTargetSelector
@@ -141,18 +142,28 @@ renderTargetSelector (TargetAllPackages (Just kfilter)) =
   "all the "
     ++ renderComponentKind Plural kfilter
     ++ " in the project"
-renderTargetSelector (TargetComponent pkgid cname) =
-  "the "
+renderTargetSelector (TargetComponent pkgid cname subtarget) =
+  renderSubComponentTarget subtarget
+    ++ "the "
     ++ renderComponentName (packageName pkgid) cname
-renderTargetSelector (TargetComponentUnknown pkgname (Left ucname)) =
-  "the component "
+renderTargetSelector (TargetComponentUnknown pkgname (Left ucname) subtarget) =
+  renderSubComponentTarget subtarget
+    ++ "the component "
     ++ prettyShow ucname
     ++ " in the package "
     ++ prettyShow pkgname
-renderTargetSelector (TargetComponentUnknown pkgname (Right cname)) =
-  "the "
+renderTargetSelector (TargetComponentUnknown pkgname (Right cname) subtarget) =
+  renderSubComponentTarget subtarget
+    ++ "the "
     ++ renderComponentName pkgname cname
 
+renderSubComponentTarget :: SubComponentTarget -> String
+renderSubComponentTarget WholeComponent = ""
+renderSubComponentTarget (FileTarget filename) =
+  "the file " ++ filename ++ " in "
+renderSubComponentTarget (ModuleTarget modname) =
+  "the module " ++ prettyShow modname ++ " in "
+
 renderOptionalStanza :: Plural -> OptionalStanza -> String
 renderOptionalStanza Singular TestStanzas = "test suite"
 renderOptionalStanza Plural TestStanzas = "test suites"
@@ -249,7 +260,7 @@ renderTargetProblem verb _ (TargetAvailableInIndex pkgname) =
     ++ "in this project (either directly or indirectly), but it is in the current "
     ++ "package index. If you want to add it to the project then edit the "
     ++ "cabal.project file."
-renderTargetProblem verb _ (TargetComponentNotProjectLocal pkgid cname) =
+renderTargetProblem verb _ (TargetComponentNotProjectLocal pkgid cname _) =
   "Cannot "
     ++ verb
     ++ " the "
@@ -262,7 +273,7 @@ renderTargetProblem verb _ (TargetComponentNotProjectLocal pkgid cname) =
     ++ "non-local dependencies. To run test suites or benchmarks from "
     ++ "dependencies you can unpack the package locally and adjust the "
     ++ "cabal.project file to include that package directory."
-renderTargetProblem verb _ (TargetComponentNotBuildable pkgid cname) =
+renderTargetProblem verb _ (TargetComponentNotBuildable pkgid cname _) =
   "Cannot "
     ++ verb
     ++ " the "
@@ -275,7 +286,7 @@ renderTargetProblem verb _ (TargetComponentNotBuildable pkgid cname) =
     ++ "property is conditional on flags. Alternatively you may simply have to "
     ++ "edit the .cabal file to declare it as buildable and fix any resulting "
     ++ "build problems."
-renderTargetProblem verb _ (TargetOptionalStanzaDisabledByUser _ cname) =
+renderTargetProblem verb _ (TargetOptionalStanzaDisabledByUser _ cname _) =
   "Cannot "
     ++ verb
     ++ " the "
@@ -294,7 +305,7 @@ renderTargetProblem verb _ (TargetOptionalStanzaDisabledByUser _ cname) =
     ++ "explanation."
   where
     compkinds = renderComponentKind Plural (componentKind cname)
-renderTargetProblem verb _ (TargetOptionalStanzaDisabledBySolver pkgid cname) =
+renderTargetProblem verb _ (TargetOptionalStanzaDisabledBySolver pkgid cname _) =
   "Cannot "
     ++ verb
     ++ " the "

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

@@ -268,7 +268,8 @@ selectPackageTargets haddockFlags targetSelector targets
 -- For the @haddock@ command we just need the basic checks on being buildable
 -- etc.
 selectComponentTarget
-  :: AvailableTarget k
+  :: SubComponentTarget
+  -> AvailableTarget k
   -> Either TargetProblem' k
 selectComponentTarget = selectComponentTargetBasic
 

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

@@ -774,7 +774,7 @@ partitionToKnownTargetsAndHackagePackages verbosity pkgDb elaboratedPlan targetS
 
       let
         targetSelectors' = flip filter targetSelectors $ \case
-          TargetComponentUnknown name _
+          TargetComponentUnknown name _ _
             | name `elem` hackageNames -> False
           TargetPackageNamed name _
             | name `elem` hackageNames -> False
@@ -954,7 +954,7 @@ warnIfNoExes verbosity buildCtx =
     selectors = concatMap (NE.toList . snd) targets
     noExes = null $ catMaybes $ exeMaybe <$> components
 
-    exeMaybe (ComponentTarget (CExeName exe)) = Just exe
+    exeMaybe (ComponentTarget (CExeName exe) _) = Just exe
     exeMaybe _ = Nothing
 
 -- | Return the package specifiers and non-global environment file entries.
@@ -1034,7 +1034,7 @@ installCheckUnitExes
           else traverse_ warnAbout (zip symlinkables exes)
     where
       exes = catMaybes $ (exeMaybe . fst) <$> components
-      exeMaybe (ComponentTarget (CExeName exe)) = Just exe
+      exeMaybe (ComponentTarget (CExeName exe) _) = Just exe
       exeMaybe _ = Nothing
 
       warnAbout (True, _) = return ()
@@ -1136,7 +1136,7 @@ entriesForLibraryComponents :: TargetsMap -> [GhcEnvironmentFileEntry]
 entriesForLibraryComponents = Map.foldrWithKey' (\k v -> mappend (go k v)) []
   where
     hasLib :: (ComponentTarget, NonEmpty TargetSelector) -> Bool
-    hasLib (ComponentTarget (CLibName _), _) = True
+    hasLib (ComponentTarget (CLibName _) _, _) = True
     hasLib _ = False
 
     go
@@ -1262,7 +1262,8 @@ selectPackageTargets targetSelector targets
 --
 -- For the @build@ command we just need the basic checks on being buildable etc.
 selectComponentTarget
-  :: AvailableTarget k
+  :: SubComponentTarget
+  -> AvailableTarget k
   -> Either TargetProblem' k
 selectComponentTarget = selectComponentTargetBasic
 

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

@@ -52,7 +52,7 @@ woPackageTargets :: WithoutProjectTargetSelector -> TargetSelector
 woPackageTargets (WoPackageId pid) =
   TargetPackageNamed (pkgName pid) Nothing
 woPackageTargets (WoPackageComponent pid cn) =
-  TargetComponentUnknown (pkgName pid) (Right cn)
+  TargetComponentUnknown (pkgName pid) (Right cn) WholeComponent
 woPackageTargets (WoURI _) =
   TargetAllPackages (Just ExeKind)
 

cabal-install/src/Distribution/Client/CmdInstall/ClientInstallTargetSelector.hs

@@ -290,9 +290,10 @@ selectPackageTargets targetSelector targets
 -- (an executable, a test, or a benchmark), in addition
 -- to the basic checks on being buildable etc.
 selectComponentTarget
-  :: AvailableTarget k
+  :: SubComponentTarget
+  -> AvailableTarget k
   -> Either ListBinTargetProblem k
-selectComponentTarget t =
+selectComponentTarget subtarget@WholeComponent t =
   case availableTargetComponentName t of
     CExeName _ -> component
     CTestName _ -> component
@@ -302,7 +303,14 @@ selectComponentTarget t =
   where
     pkgid = availableTargetPackageId t
     cname = availableTargetComponentName t
-    component = selectComponentTargetBasic t
+    component = selectComponentTargetBasic subtarget t
+selectComponentTarget subtarget t =
+  Left
+    ( isSubComponentProblem
+        (availableTargetPackageId t)
+        (availableTargetComponentName t)
+        subtarget
+    )
 
 -- | The various error conditions that can occur when matching a
 -- 'TargetSelector' against 'AvailableTarget's for the @run@ command.
@@ -315,6 +323,8 @@ data ListBinProblem
     TargetProblemMultipleTargets TargetsMap
   | -- | The 'TargetSelector' refers to a component that is not an executable
     TargetProblemComponentNotRightKind PackageId ComponentName
+  | -- | Asking to run an individual file or module is not supported
+    TargetProblemIsSubComponent PackageId ComponentName SubComponentTarget
   deriving (Eq, Show)
 
 type ListBinTargetProblem = TargetProblem ListBinProblem
@@ -335,6 +345,15 @@ componentNotRightKindProblem pkgid name =
   CustomTargetProblem $
     TargetProblemComponentNotRightKind pkgid name
 
+isSubComponentProblem
+  :: PackageId
+  -> ComponentName
+  -> SubComponentTarget
+  -> TargetProblem ListBinProblem
+isSubComponentProblem pkgid name subcomponent =
+  CustomTargetProblem $
+    TargetProblemIsSubComponent pkgid name subcomponent
+
 reportTargetProblems :: Verbosity -> [ListBinTargetProblem] -> IO a
 reportTargetProblems verbosity =
   dieWithException verbosity . ListBinTargetException . unlines . map renderListBinTargetProblem
@@ -385,7 +404,16 @@ renderListBinProblem (TargetProblemComponentNotRightKind pkgid cname) =
     ++ prettyShow pkgid
     ++ "."
   where
-    targetSelector = TargetComponent pkgid cname
+    targetSelector = TargetComponent pkgid cname WholeComponent
+renderListBinProblem (TargetProblemIsSubComponent pkgid cname subtarget) =
+  "The list-bin command can only find a binary as a whole, "
+    ++ "not files or modules within them, but the target '"
+    ++ showTargetSelector targetSelector
+    ++ "' refers to "
+    ++ renderTargetSelector targetSelector
+    ++ "."
+  where
+    targetSelector = TargetComponent pkgid cname subtarget
 renderListBinProblem (TargetProblemNoRightComps targetSelector) =
   "Cannot list-bin the target '"
     ++ showTargetSelector targetSelector

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

@@ -734,7 +734,8 @@ selectPackageTargetsSingle decision targetSelector targets
 --
 -- For the @repl@ command we just need the basic checks on being buildable etc.
 selectComponentTarget
-  :: AvailableTarget k
+  :: SubComponentTarget
+  -> AvailableTarget k
   -> Either ReplTargetProblem k
 selectComponentTarget = selectComponentTargetBasic