filter == version constraints

philderbeast · philderbeast · commit 7c50909f1de8 · 2026-02-01T20:13:30.000-05:00
- Update test for == constraint check
- Add OnlyConstrainedEq
- Test --reject-unconstrained-dependencies=eq
- Add haddocks for eq option
- Remove pkgIsExplicit
- One-line keepNonEmpty
- Use pattern guard
- Top level filterThisVersion
- Name tests
diff --git a/cabal-install-solver/src/Distribution/Solver/Modular/Solver.hs b/cabal-install-solver/src/Distribution/Solver/Modular/Solver.hs
@@ -23,6 +23,8 @@ import Distribution.Solver.Types.PackagePath
 import Distribution.Solver.Types.PackagePreferences
 import Distribution.Solver.Types.PkgConfigDb (PkgConfigDb)
 import Distribution.Solver.Types.LabeledPackageConstraint
+import Distribution.Solver.Types.PackageConstraint (PackageConstraint(..), PackageProperty(..))
+import Distribution.Types.VersionRange (normaliseVersionRange, projectVersionRange, VersionRangeF(ThisVersionF))
 import Distribution.Solver.Types.Settings
 import Distribution.Solver.Types.Variable
 
@@ -140,17 +142,14 @@ solve sc cinfo idx pkgConfigDB userPrefs userConstraints userGoals =
                        validateTree cinfo idx pkgConfigDB
     prunePhase       = (if asBool (avoidReinstalls sc) then P.avoidReinstalls (const True) else id) .
                        (case onlyConstrained sc of
-                          OnlyConstrainedAll ->
-                            P.onlyConstrained pkgIsExplicit
-                          OnlyConstrainedNone ->
-                            id)
+                          OnlyConstrainedEq -> P.onlyConstrained (`S.member` allExplicitEq)
+                          OnlyConstrainedAll -> P.onlyConstrained (`S.member` allExplicit)
+                          OnlyConstrainedNone -> id)
     buildPhase       = buildTree idx (independentGoals sc) (S.toList userGoals)
 
+    allExplicitEq = M.keysSet (filterThisVersion userConstraints) `S.union` userGoals
     allExplicit = M.keysSet userConstraints `S.union` userGoals
 
-    pkgIsExplicit :: PN -> Bool
-    pkgIsExplicit pn = S.member pn allExplicit
-
     -- When --reorder-goals is set, we use preferReallyEasyGoalChoices, which
     -- prefers (keeps) goals only if the have 0 or 1 enabled choice.
     --
@@ -167,6 +166,14 @@ solve sc cinfo idx pkgConfigDB userPrefs userConstraints userGoals =
       | asBool (reorderGoals sc) = P.preferReallyEasyGoalChoices
       | otherwise                = id {- P.firstGoal -}
 
+-- | Keep version ranges that normalise to equality version constraints (== v).
+filterThisVersion :: M.Map PN [LabeledPackageConstraint] -> M.Map PN [LabeledPackageConstraint]
+filterThisVersion = M.filter (not . null) . M.map (filter isThisVersion) where
+  isThisVersion lpc
+    | LabeledPackageConstraint (PackageConstraint _ (PackagePropertyVersion vr)) _ <- lpc
+    , ThisVersionF _ <- projectVersionRange $ normaliseVersionRange vr = True
+    | otherwise = False
+  
 -- | Dump solver tree to a file (in debugging mode)
 --
 -- This only does something if the @debug-tracetree@ configure argument was
diff --git a/cabal-install-solver/src/Distribution/Solver/Types/Settings.hs b/cabal-install-solver/src/Distribution/Solver/Types/Settings.hs
@@ -61,6 +61,7 @@ newtype AllowBootLibInstalls = AllowBootLibInstalls Bool
 data OnlyConstrained
   = OnlyConstrainedNone
   | OnlyConstrainedAll
+  | OnlyConstrainedEq
   deriving (Eq, Generic, Show)
 
 newtype EnableBackjumping = EnableBackjumping Bool
@@ -108,12 +109,14 @@ instance NFData AllowBootLibInstalls
 instance NFData OnlyConstrained
 
 instance Pretty OnlyConstrained where
+  pretty OnlyConstrainedEq  = PP.text "eq"
   pretty OnlyConstrainedAll  = PP.text "all"
   pretty OnlyConstrainedNone = PP.text "none"
 
 instance Parsec OnlyConstrained where
   parsec = P.choice
-    [ P.string "all"  >> return OnlyConstrainedAll
+    [ P.string "eq"  >> return OnlyConstrainedEq
+    , P.string "all"  >> return OnlyConstrainedAll
     , P.string "none" >> return OnlyConstrainedNone
     ]
 
diff --git a/cabal-install/src/Distribution/Client/Setup.hs b/cabal-install/src/Distribution/Client/Setup.hs
@@ -3692,9 +3692,9 @@ optionSolverFlags
         getoc
         setoc
         ( reqArg
-            "none|all"
+            "none|all|eq"
             ( parsecToReadE
-                (const "reject-unconstrained-dependencies must be 'none' or 'all'")
+                (const "reject-unconstrained-dependencies must be 'none', 'all', or 'eq'")
                 (toFlag `fmap` parsec)
             )
             (flagToList . fmap prettyShow)
diff --git a/cabal-testsuite/PackageTests/RequireExplicit/MultiPkg/cabal.multipkg-all.out b/cabal-testsuite/PackageTests/RequireExplicit/MultiPkg/cabal.multipkg-all.out
@@ -0,0 +1,37 @@
+# cabal v2-update
+Downloading the latest package list from test-local-repo
+# cabal build
+Resolving dependencies...
+Error: [Cabal-7107]
+Could not resolve dependencies:
+[__0] trying: b-0 (user goal)
+[__1] next goal: other-lib (dependency of b)
+[__1] fail (not a user-provided goal nor mentioned as a constraint, but reject-unconstrained-dependencies was set)
+[__1] fail (backjumping, conflict set: b, other-lib)
+After searching the rest of the dependency tree exhaustively, these were the goals I've had most trouble fulfilling: b (2), other-lib (1)
+# cabal build
+Resolving dependencies...
+Error: [Cabal-7107]
+Could not resolve dependencies:
+[__0] trying: b-0 (user goal)
+[__1] next goal: b:some-exe:exe.some-exe (dependency of b)
+[__1] fail (not a user-provided goal nor mentioned as a constraint, but reject-unconstrained-dependencies was set)
+[__1] fail (backjumping, conflict set: b, b:some-exe:exe.some-exe)
+After searching the rest of the dependency tree exhaustively, these were the goals I've had most trouble fulfilling: b (2), b:some-exe:exe.some-exe (1)
+# cabal build
+Resolving dependencies...
+Build profile: -w ghc-<GHCVER> -O1
+In order, the following would be built:
+ - other-lib-1.0 (lib) (requires build)
+ - some-exe-1.0 (exe:some-exe) (requires build)
+ - some-lib-1.0 (lib) (requires build)
+ - b-0 (lib) (first run)
+ - a-0 (lib) (first run)
+# cabal build
+Build profile: -w ghc-<GHCVER> -O1
+In order, the following would be built:
+ - other-lib-1.0 (lib) (requires build)
+ - some-exe-1.0 (exe:some-exe) (requires build)
+ - some-lib-1.0 (lib) (requires build)
+ - b-0 (lib) (first run)
+ - a-0 (lib) (first run)
diff --git a/cabal-testsuite/PackageTests/RequireExplicit/MultiPkg/cabal.multipkg-eq.out b/cabal-testsuite/PackageTests/RequireExplicit/MultiPkg/cabal.multipkg-eq.out
@@ -0,0 +1,29 @@
+# cabal v2-update
+Downloading the latest package list from test-local-repo
+# cabal build
+Resolving dependencies...
+Build profile: -w ghc-<GHCVER> -O1
+In order, the following would be built:
+ - other-lib-1.0 (lib) (requires build)
+ - some-exe-1.0 (exe:some-exe) (requires build)
+ - some-lib-1.0 (lib) (requires build)
+ - b-0 (lib) (first run)
+ - a-0 (lib) (first run)
+# cabal build
+Resolving dependencies...
+Build profile: -w ghc-<GHCVER> -O1
+In order, the following would be built:
+ - other-lib-1.0 (lib) (requires build)
+ - some-exe-1.0 (exe:some-exe) (requires build)
+ - some-lib-1.0 (lib) (requires build)
+ - b-0 (lib) (first run)
+ - a-0 (lib) (first run)
+# cabal build
+Resolving dependencies...
+Error: [Cabal-7107]
+Could not resolve dependencies:
+[__0] trying: a-0 (user goal)
+[__1] next goal: some-lib (dependency of a)
+[__1] fail (not a user-provided goal nor mentioned as a constraint, but reject-unconstrained-dependencies was set)
+[__1] fail (backjumping, conflict set: a, some-lib)
+After searching the rest of the dependency tree exhaustively, these were the goals I've had most trouble fulfilling: a (2), some-lib (1)
diff --git a/cabal-testsuite/PackageTests/RequireExplicit/MultiPkg/cabal.test.hs b/cabal-testsuite/PackageTests/RequireExplicit/MultiPkg/cabal.test.hs
@@ -1,16 +1,68 @@
 import Test.Cabal.Prelude
+
 -- See #4332, dep solving output is not deterministic
-main = cabalTest . recordMode DoNotRecord $ withRepo "repo" $ do
-  -- other-lib is a dependency of b, but it's not listed in cabal.project
-  res <- fails $ cabal' "v2-build" ["all", "--dry-run", "--reject-unconstrained-dependencies", "all", "--constraint", "some-exe -any"]
-  assertOutputContains "not a user-provided goal" res
 
-  -- and some-exe is a build-tool dependency of b, again not listed
-  res <- fails $ cabal' "v2-build" ["all", "--dry-run", "--reject-unconstrained-dependencies", "all", "--constraint", "other-lib -any"]
-  assertOutputContains "not a user-provided goal" res
+assertErr = assertOutputContains "not a user-provided goal nor mentioned as a constraint, but reject-unconstrained-dependencies was set"
+
+constraint x = "--constraint=" ++ x
+
+main = do
+  cabalTest' "multipkg-all" . withRepo "repo" $ do
+    let opts =
+          [ "--dry-run"
+          , "--reject-unconstrained-dependencies=all"
+          ]
+
+    -- other-lib is a dependency of b, but it's not listed in cabal.project
+    res <- fails $ cabal' "build" ("all" : opts ++ [constraint "some-exe -any"])
+    assertErr res
+
+    -- and some-exe is a build-tool dependency of b, again not listed
+    res <- fails $ cabal' "build" ("all" : opts ++ [constraint "other-lib -any"])
+    assertErr res
+
+    -- everything's listed, good to go
+    cabal "build" $
+      "all"
+        : opts
+        ++ [ constraint "other-lib -any"
+           , constraint "some-exe -any"
+           ]
+
+    -- a depends on b, but b is a local dependency, so it gets a pass
+    cabal "build" $
+      "a"
+        : opts
+        ++ [ constraint "other-lib -any"
+           , constraint "some-exe -any"
+           ]
+
+  cabalTest' "multipkg-eq" . withRepo "repo" $ do
+    -- all the options except for those about some-lib
+    let opts =
+          [ "all"
+          , "--dry-run"
+          , "--reject-unconstrained-dependencies=eq"
+          , constraint "other-lib ==1.0"
+          , constraint "some-exe ==1.0"
+          ]
+
+    -- everything's listed as == constraint
+    cabal "build" (opts ++ [constraint "some-lib ==1.0"])
 
-  -- everything's listed, good to go
-  cabal "v2-build" ["all", "--dry-run", "--reject-unconstrained-dependencies", "all", "--constraint", "other-lib -any", "--constraint", "some-exe -any"]
+    -- everything's listed as == constraint when normalised
+    cabal "build" $
+      opts
+        ++ [ constraint "some-lib ==1.0"
+           , constraint "some-lib >0"
+           , constraint "some-lib <2"
+           ]
 
-  -- a depends on b, but b is a local dependency, so it gets a pass
-  cabal "v2-build" ["a", "--dry-run", "--reject-unconstrained-dependencies", "all", "--constraint", "other-lib -any", "--constraint", "some-exe -any"]
+    -- not everything's listed as == constraint when normalised
+    res <-
+      fails . cabal' "build" $
+        opts
+          ++ [ constraint "some-lib >0"
+             , constraint "some-lib <2"
+             ]
+    assertErr res
diff --git a/doc/cabal-project-description-file.rst b/doc/cabal-project-description-file.rst
@@ -790,8 +790,8 @@ The following settings control the behavior of the dependency solver:
       active-repositories: :none
 
 
-.. cfg-field:: reject-unconstrained-dependencies: all, none
-               --reject-unconstrained-dependencies=[all|none]
+.. cfg-field:: reject-unconstrained-dependencies: eq, all, none
+               --reject-unconstrained-dependencies=[eq|all|none]
    :synopsis: Restrict the solver to packages that have constraints on them.
 
    :default: none
@@ -801,9 +801,11 @@ The following settings control the behavior of the dependency solver:
    aware of in a build plan. If you wish to restrict the build plan to
    a closed set of packages (e.g., from a freeze file), use this flag.
 
-   When set to `all`, all non-local packages that aren't goals must be
-   explicitly constrained. When set to `none`, the solver will
-   consider all packages.
+   When set to `eq` or `all`, all non-local packages that aren't goals must be
+   explicitly constrained. where `all` accepts any version constraint and `eq`
+   accepts version ranges that normalise to an equality constraint.
+
+   When set to `none`, the solver will consider all packages.
 
 .. _package-configuration-options:
 
