| blob | bf8f082e818437ca51f7b279b1f53464a904d3b9 |
1 {-# LANGUAGE OverloadedStrings #-}
3 -- | This is a set of unit tests for the dependency solver,
4 -- which uses the solver DSL ("UnitTests.Distribution.Solver.Modular.DSL")
5 -- to more conveniently create package databases to run the solver tests on.
7 where
9 -- base
14 -- test-framework
17 -- Cabal
22 )
24 -- cabal-install
33 tests =
34 [ testGroup
35 "Simple dependencies"
39 preferOldest $
44 , runTest $ indep $ mkTest db1 "indepTwoVersions" ["C", "D"] (solverSuccess [("B", 1), ("B", 2), ("C", 1), ("D", 1)])
45 , runTest $ indep $ mkTest db1 "aliasWhenPossible1" ["C", "E"] (solverSuccess [("B", 1), ("C", 1), ("E", 1)])
46 , runTest $ indep $ mkTest db1 "aliasWhenPossible2" ["D", "E"] (solverSuccess [("B", 2), ("D", 1), ("E", 1)])
47 , runTest $ indep $ mkTest db2 "aliasWhenPossible3" ["C", "D"] (solverSuccess [("A", 1), ("A", 2), ("B", 1), ("B", 2), ("C", 1), ("D", 1)])
55 ]
56 , testGroup
57 "Flagged dependencies"
62 , runTest $ indep $ mkTest db18 "linkFlags3" ["A", "B"] (solverSuccess [("A", 1), ("B", 1), ("C", 1), ("D", 1), ("D", 2), ("F", 1)])
63 ]
64 , testGroup
65 "Lifting dependencies out of conditionals"
67 , runTest $ twoLevelDeepCommonDependencyLogMessage "two level deep common dependency log message"
69 ]
70 , testGroup
71 "Manual flags"
78 setVerbose $
81 -- TODO: We should check the summarized log instead of the full log
82 -- for the manual flags error message, but it currently only
83 -- appears in the full log.
87 constraints cs $
90 ]
91 , testGroup
92 "Qualified manual flag constraints"
96 constraints cs $
98 solverSuccess
104 ]
106 cs =
109 ]
111 constraints cs $
113 solverSuccess
119 ]
121 cs =
124 ]
126 constraints cs $
128 solverSuccess
134 ]
139 constraints cs $
143 cs =
146 ]
148 checkFullLog lns =
149 all
153 ]
155 constraints cs $
156 setVerbose $
159 ]
160 , testGroup
161 "Stanzas"
162 [ runTest $ enableAllTests $ mkTest db5 "simpleTest1" ["C"] (solverSuccess [("A", 2), ("C", 1)])
164 , runTest $ enableAllTests $ mkTest db5 "simpleTest3" ["E"] (solverSuccess [("A", 1), ("E", 1)])
166 , runTest $ enableAllTests $ mkTest db5 "simpleTest5" ["G"] (solverSuccess [("A", 2), ("G", 1)])
168 , runTest $ indep $ enableAllTests $ mkTest db5 "simpleTest7" ["E", "G"] (solverSuccess [("A", 1), ("A", 2), ("E", 1), ("G", 1)])
169 , runTest $ enableAllTests $ mkTest db6 "depsWithTests1" ["C"] (solverSuccess [("A", 1), ("B", 1), ("C", 1)])
170 , runTest $ indep $ enableAllTests $ mkTest db6 "depsWithTests2" ["C", "D"] (solverSuccess [("A", 1), ("B", 1), ("C", 1), ("D", 1)])
172 ]
173 , testGroup
174 "Setup dependencies"
180 , runTest $ mkTest db8 "setupDeps6" ["C", "D"] (solverSuccess [("A", 1), ("B", 1), ("B", 2), ("C", 1), ("D", 1)])
181 , runTest $ mkTest db9 "setupDeps7" ["F", "G"] (solverSuccess [("A", 1), ("B", 1), ("B", 2), ("C", 1), ("D", 1), ("E", 1), ("E", 2), ("F", 1), ("G", 1)])
183 , runTest $ indep $ mkTest dbSetupDeps "setupDeps9" ["A", "B"] (solverSuccess [("A", 1), ("B", 1), ("C", 1), ("D", 1), ("D", 2)])
184 ]
185 , testGroup
186 "Base shim"
193 ]
194 , testGroup
195 "Base and non-reinstallable"
198 solverFailure (isInfixOf "rejecting: base-1.0.0 (constraint from non-reinstallable package requires installed instance)")
200 allowBootLibInstalls $
205 solverFailure (isInfixOf "rejecting: ghc-2.0.0 (constraint from non-reinstallable package requires installed instance)")
206 ]
207 , testGroup
208 "reject-unconstrained"
210 onlyConstrained $
214 onlyConstrained $
218 onlyConstrained $
222 onlyConstrained $
224 solverFailure $
225 isInfixOf $
234 ]
235 , testGroup
236 "Cycles"
244 , runTest $ mkTest db15 "cycleThroughSetupDep5" ["E"] (solverSuccess [("C", 2), ("D", 1), ("E", 1)])
247 ]
248 , testGroup
249 "Extensions"
251 , runTest $ mkTestExts [EnableExtension CPP] dbExts1 "unsupportedIndirect" ["B"] anySolverFailure
252 , runTest $ mkTestExts [EnableExtension RankNTypes] dbExts1 "supported" ["A"] (solverSuccess [("A", 1)])
253 , runTest $ mkTestExts (map EnableExtension [CPP, RankNTypes]) dbExts1 "supportedIndirect" ["C"] (solverSuccess [("A", 1), ("B", 1), ("C", 1)])
255 , runTest $ mkTestExts (map EnableExtension [CPP, RankNTypes]) dbExts1 "disabledExtension" ["D"] anySolverFailure
256 , runTest $ mkTestExts (UnknownExtension "custom" : map EnableExtension [CPP, RankNTypes]) dbExts1 "supportedUnknown" ["E"] (solverSuccess [("A", 1), ("B", 1), ("C", 1), ("E", 1)])
257 ]
258 , testGroup
259 "Languages"
261 , runTest $ mkTestLangs [Haskell98, Haskell2010] dbLangs1 "supported" ["A"] (solverSuccess [("A", 1)])
263 , runTest $ mkTestLangs [Haskell98, Haskell2010, UnknownLanguage "Haskell3000"] dbLangs1 "supportedUnknown" ["C"] (solverSuccess [("A", 1), ("B", 1), ("C", 1)])
264 ]
265 , testGroup
266 "Qualified Package Constraints"
272 constraints cs $
278 ]
280 constraints cs $
285 constraints cs $
288 ]
289 , testGroup
290 "Package Preferences"
291 [ runTest $ preferences [ExPkgPref "A" $ mkvrThis 1] $ mkTest db13 "selectPreferredVersionSimple" ["A"] (solverSuccess [("A", 1)])
292 , runTest $ preferences [ExPkgPref "A" $ mkvrOrEarlier 2] $ mkTest db13 "selectPreferredVersionSimple2" ["A"] (solverSuccess [("A", 2)])
293 , runTest
294 $ preferences
297 ]
299 , runTest
300 $ preferences
303 ]
305 , runTest
306 $ preferences
309 ]
311 , runTest
312 $ preferences
315 ]
317 ]
318 , testGroup
319 "Stanza Preferences"
332 ]
333 , testGroup
334 "Buildable Field"
336 , testBuildable "avoid building component with unknown extension" (ExExt (UnknownExtension "unknown"))
337 , testBuildable "avoid building component with unknown language" (ExLang (UnknownLanguage "unknown"))
338 , runTest $ mkTest dbBuildable1 "choose flags that set buildable to false" ["pkg"] (solverSuccess [("flag1-false", 1), ("flag2-true", 1), ("pkg", 1)])
339 , runTest $ mkTest dbBuildable2 "choose version that sets buildable to false" ["A"] (solverSuccess [("A", 1), ("B", 2)])
340 ]
341 , testGroup
342 "Pkg-config dependencies"
345 , runTest $ mkTestPCDepends (Just [("pkgA", "1.0.0"), ("pkgB", "1.0.0")]) dbPC1 "pruneNotFound" ["C"] (solverSuccess [("A", 1), ("B", 1), ("C", 1)])
346 , runTest $ mkTestPCDepends (Just [("pkgA", "1.0.0"), ("pkgB", "2.0.0")]) dbPC1 "chooseNewest" ["C"] (solverSuccess [("A", 1), ("B", 2), ("C", 1)])
349 ]
350 , testGroup
351 "Independent goals"
352 [ runTest $ indep $ mkTest db16 "indepGoals1" ["A", "B"] (solverSuccess [("A", 1), ("B", 1), ("C", 1), ("D", 1), ("D", 2), ("E", 1)])
360 ]
362 testGroup
363 "Backjumping"
373 , runTest $ indep $ mkTest dbBJ8 "bj8" ["A", "B"] (solverSuccess [("A", 1), ("B", 1), ("C", 1)])
374 ]
375 , testGroup
376 "main library dependencies"
384 ]
387 solverFailure (isInfixOf "rejecting: B-1.0.0 (does not contain library, which is required by A)")
389 db =
393 ]
397 ]
398 , testGroup
399 "sub-library dependencies"
403 ]
406 solverFailure $
407 isInfixOf $
408 "rejecting: B-1.0.0 (does not contain library 'sub-lib', which is required by A)"
412 ]
415 solverFailure $
416 isInfixOf $
417 "rejecting: B-1.0.0 (library 'sub-lib' is private, but it is required by A)"
422 `withSubLibrary` exSubLib "sub-lib" [ExFlagged "make-lib-private" (dependencies []) publicDependencies]
423 ]
427 solverFailure $
428 isInfixOf $
429 "rejecting: B-1.0.0 (library 'sub-lib' is private, but it is required by A)"
434 `withSubLibrary` exSubLib "sub-lib" [ExFlagged "make-lib-private" (dependencies []) publicDependencies]
435 ]
443 ]
445 goals =
449 ]
451 goalOrder goals $
453 solverFailure $
454 isInfixOf $
455 "rejecting: C-1.0.0 (requires library 'sub-lib' from B, but the component is private)"
460 ]
468 ]
472 ]
474 testGroup
475 "build-tool-depends"
476 [ runTest $ mkTest dbBuildTools "simple exe dependency" ["A"] (solverSuccess [("A", 1), ("bt-pkg", 2)])
478 disableSolveExecutables $
479 mkTest dbBuildTools "don't install build tool packages in legacy mode" ["A"] (solverSuccess [("A", 1)])
480 , runTest $ mkTest dbBuildTools "flagged exe dependency" ["B"] (solverSuccess [("B", 1), ("bt-pkg", 2)])
482 enableAllTests $
488 disableSolveExecutables $
496 solverFailure (isInfixOf "does not contain executable 'unknown-exe', which is required by F +flagF")
498 enableAllTests $
500 solverFailure (isInfixOf "does not contain executable 'unknown-exe', which is required by G *test")
503 solverFailure $
504 isInfixOf $
505 -- The solver reports the version conflict when a version conflict
506 -- and an executable conflict apply to the same package version.
507 "[__1] rejecting: H:bt-pkg:exe.bt-pkg-4.0.0 (conflict: H => H:bt-pkg:exe.bt-pkg (exe exe1)==3.0.0)\n"
508 ++ "[__1] rejecting: H:bt-pkg:exe.bt-pkg-3.0.0 (does not contain executable 'exe1', which is required by H)\n"
509 ++ "[__1] rejecting: H:bt-pkg:exe.bt-pkg-2.0.0 (conflict: H => H:bt-pkg:exe.bt-pkg (exe exe1)==3.0.0)"
510 , runTest $ chooseExeAfterBuildToolsPackage True "choose exe after choosing its package - success"
511 , runTest $ chooseExeAfterBuildToolsPackage False "choose exe after choosing its package - failure"
512 , runTest $ rejectInstalledBuildToolPackage "reject installed package for build-tool dependency"
513 , runTest $ requireConsistentBuildToolVersions "build tool versions must be consistent within one package"
514 ]
516 testGroup
517 "legacy build-tools"
520 disableSolveExecutables $
521 mkTest dbLegacyBuildTools1 "bt1 - don't install build tool packages in legacy mode" ["A"] (solverSuccess [("A", 1)])
526 disableSolveExecutables $
527 mkTest dbLegacyBuildTools2 "bt2 - don't check for build tool executables in legacy mode" ["A"] (solverSuccess [("A", 1)])
529 , runTest $ mkTest dbLegacyBuildTools4 "bt4" ["C"] (solverSuccess [("A", 1), ("B", 1), ("C", 1), ("alex", 1), ("alex", 2)])
530 , runTest $ mkTest dbLegacyBuildTools5 "bt5" ["B"] (solverSuccess [("A", 1), ("A", 2), ("B", 1), ("alex", 1)])
531 , runTest $ mkTest dbLegacyBuildTools6 "bt6" ["A"] (solverSuccess [("A", 1), ("alex", 1), ("happy", 1)])
532 ]
534 testGroup
535 "internal dependencies"
536 [ runTest $ mkTest dbIssue3775 "issue #3775" ["B"] (solverSuccess [("A", 2), ("B", 2), ("warp", 1)])
537 ]
541 in [ let db = [Right $ exAv "A" 1 [ExFlagged "build-lib" (dependencies []) unbuildableDependencies]]
550 ]
558 ]
562 solverFailure $
563 isInfixOf $
564 "rejecting: B-1.0.0 (library is not buildable in the "
571 ]
581 ]
585 solverFailure $
586 isInfixOf $
587 "rejecting: A:B:exe.B-1.0.0 (executable 'bt' is not "
590 chooseUnbuildableExeAfterBuildToolsPackage
591 "choose unbuildable exe after choosing its package"
592 ]
593 , testGroup
594 "--fine-grained-conflicts"
596 --
597 -- When the solver explores A-4, it finds that it cannot satisfy B's
598 -- dependencies. This allows the solver to skip the subsequent
599 -- versions of A that also depend on B.
600 runTest $
608 ]
609 msg =
622 ]
628 -- dependency:
629 --
630 -- The solver rejects A-4 because its constraint on B excludes B-1.
631 -- Then the solver is able to skip A-3 and A-2 because they also
632 -- exclude B-1, even though they don't have the exact same constraints
633 -- on B.
634 runTest $
641 ]
642 msg =
654 ]
660 -- package, B, before choosing a version for one of its reverse
661 -- dependencies, C. While the solver is exploring the subtree rooted
662 -- at B-3, it finds that C-2's dependency on B conflicts with B-3.
663 -- Then the solver is able to skip C-1, because it also excludes B-3.
664 --
665 -- --fine-grained-conflicts could have a benefit in this case even
666 -- though the solver would have found the conflict between B-3 and C-1
667 -- immediately after trying C-1 anyway. It prevents C-1 from
668 -- introducing any other conflicts which could increase the size of
669 -- the conflict set.
670 runTest $
678 ]
680 expectedMsg =
692 ]
694 goalOrder goals $
699 -- multiple reasons to add a variable to the conflict set. In this
700 -- case, package A conflicts with B and C. The solver should take the
701 -- union of the conflicts and then only skip a version if it does not
702 -- resolve any of the conflicts.
703 --
704 -- The solver rejects A-3 because it can't find consistent versions for
705 -- its two dependencies, B and C. Then it skips A-2 because A-2 also
706 -- depends on B and C. This test ensures that the solver considers
707 -- A-1 even though A-1 only resolves one of the conflicts (A-1 removes
708 -- the dependency on C).
709 runTest $
718 ]
720 msg =
738 ]
740 goalOrder goals $
745 -- that the solver encountered in a subtree. The solver should only
746 -- show the conflicts that are contained in the current conflict set.
747 --
748 -- The goal order forces the solver to try A-4, encounter a conflict
749 -- with B-2, try B-1, and then try C. A-4 conflicts with the only
750 -- version of C, so the solver backjumps with a conflict set of
751 -- {A, C}. When the solver skips the next version of A, the log should
752 -- mention the conflict with C but not B.
753 runTest $
762 ]
764 msg =
778 ]
780 goalOrder goals $
785 -- skipped due to being excluded by one of its reverse dependencies'
786 -- constraints.
787 runTest $
793 ]
794 msg =
798 -- conflict set, with the details of each package's
799 -- conflict:
800 --
801 -- A: A's constraint rejected B-2.
802 -- B: B was rejected by A's B==3 constraint
803 "[__1] rejecting: B-2.0.0 (conflict: A => B==3.0.0)"
805 -- previous conflict set. It also needs to update A's
806 -- entry to say that A also rejected B-1. Otherwise, the
807 -- solver wouldn't know that A-1 could resolve one of
808 -- the conflicts encountered while exploring A-2. The
809 -- solver would skip A-1, even though it leads to the
810 -- solution.
811 "[__1] skipping: B-1.0.0 (has the same characteristics that caused "
819 ]
825 -- skipped due to excluding a version of one of its dependencies.
826 -- This test is similar the previous one, with the goal order reversed.
827 runTest $
833 ]
835 msg =
847 ]
849 goalOrder goals $
853 ]
855 testGroup
856 "Solver log"
858 runTest $
862 p lg =
867 SolverResult p $
871 msg =
872 "After searching the rest of the dependency tree exhaustively, "
892 "Backjump limit reached (currently 1, change with --max-backjumps "
895 , testMinimizeConflictSet
896 "minimize conflict set with --minimize-conflict-set"
897 , testNoMinimizeConflictSet
898 "show original conflict set with --no-minimize-conflict-set"
903 ]
911 ]
915 , testGroup
916 "package versions abbreviation (issue #9559.)"
922 ]
933 ]
938 ]
939 ]
940 ]
941 where
942 indep = independentGoals
949 {-------------------------------------------------------------------------------
950 Specific example database for the tests
951 -------------------------------------------------------------------------------}
953 db1 :: ExampleDb
954 db1 =
965 ]
967 -- In this example, we _can_ install C and D as independent goals, but we have
968 -- to pick two different versions for B (arbitrarily)
969 db2 :: ExampleDb
970 db2 =
977 ]
979 db3 :: ExampleDb
980 db3 =
986 ]
988 -- | Like db3, but the flag picks a different package rather than a
989 -- different package version
990 --
991 -- In db3 we cannot install C and D as independent goals because:
992 --
993 -- * The multiple instance restriction says C and D _must_ share B
994 -- * Since C relies on A-1, C needs B to be compiled with flagB on
995 -- * Since D relies on A-2, D needs B to be compiled with flagB off
996 -- * Hence C and D have incompatible requirements on B's flags.
997 --
998 -- However, _even_ if we don't check explicitly that we pick the same flag
999 -- assignment for 0.B and 1.B, we will still detect the problem because
1000 -- 0.B depends on 0.A-1, 1.B depends on 1.A-2, hence we cannot link 0.A to
1001 -- 1.A and therefore we cannot link 0.B to 1.B.
1002 --
1003 -- In db4 the situation however is trickier. We again cannot install
1004 -- packages C and D as independent goals because:
1005 --
1006 -- * As above, the multiple instance restriction says that C and D _must_ share B
1007 -- * Since C relies on Ax-2, it requires B to be compiled with flagB off
1008 -- * Since D relies on Ay-2, it requires B to be compiled with flagB on
1009 -- * Hence C and D have incompatible requirements on B's flags.
1010 --
1011 -- But now this requirement is more indirect. If we only check dependencies
1012 -- we don't see the problem:
1013 --
1014 -- * We link 0.B to 1.B
1015 -- * 0.B relies on Ay-1
1016 -- * 1.B relies on Ax-1
1017 --
1018 -- We will insist that 0.Ay will be linked to 1.Ay, and 0.Ax to 1.Ax, but since
1019 -- we only ever assign to one of these, these constraints are never broken.
1020 db4 :: ExampleDb
1021 db4 =
1029 ]
1031 -- | Simple database containing one package with a manual flag.
1032 dbManualFlags :: ExampleDb
1033 dbManualFlags =
1039 ]
1041 -- | Database containing a setup dependency with a manual flag. A's library and
1042 -- setup script depend on two different versions of B. B's manual flag can be
1043 -- set to different values in the two places where it is used.
1044 dbSetupDepWithManualFlag :: ExampleDb
1045 dbSetupDepWithManualFlag =
1049 declareFlags bFlags $
1050 exAv
1051 "B"
1052 1
1053 [ exFlagged
1054 "flag"
1057 ]
1059 declareFlags bFlags $
1060 exAv
1061 "B"
1062 2
1063 [ exFlagged
1064 "flag"
1067 ]
1072 ]
1074 -- | A database similar to 'dbSetupDepWithManualFlag', except that the library
1075 -- and setup script both depend on B-1. B must be linked because of the Single
1076 -- Instance Restriction, and its flag can only have one value.
1077 dbLinkedSetupDepWithManualFlag :: ExampleDb
1078 dbLinkedSetupDepWithManualFlag =
1082 exAv
1083 "B"
1084 1
1085 [ exFlagged
1086 "flag"
1089 ]
1092 ]
1094 -- | Some tests involving testsuites
1095 --
1096 -- Note that in this test framework test suites are always enabled; if you
1097 -- want to test without test suites just set up a test database without
1098 -- test suites.
1099 --
1100 -- * C depends on A (through its test suite)
1101 -- * D depends on B-2 (through its test suite), but B-2 is unavailable
1102 -- * E depends on A-1 directly and on A through its test suite. We prefer
1103 -- to use A-1 for the test suite in this case.
1104 -- * F depends on A-1 directly and on A-2 through its test suite. In this
1105 -- case we currently fail to install F, although strictly speaking
1106 -- test suites should be considered independent goals.
1107 -- * G is like E, but for version A-2. This means that if we cannot install
1108 -- E and G together, unless we regard them as independent goals.
1109 db5 :: ExampleDb
1110 db5 =
1119 ]
1121 -- Now the _dependencies_ have test suites
1122 --
1124 -- * Installing C is a simple example. C wants version 1 of A, but depends on
1126 -- B, and B's testsuite depends on an any version of A. In this case we prefer
1127 -- to link (if we don't regard test suites as independent goals then of course
1128 -- linking here doesn't even come into it).
1130 -- * Installing [C, D] means that we prefer to link B -- depending on how we
1132 -- set things up, this means that we should also link their test suites.
1133 db6 :: ExampleDb
1134 db6 =
1140 ]
1142 -- | This test checks that the solver can backjump to disable a flag, even if
1143 -- the problematic dependency is also under a test suite. (issue #4390)
1144 --
1145 -- The goal order forces the solver to choose the flag before enabling testing.
1146 -- Previously, the solver couldn't handle this case, because it only tried to
1147 -- disable testing, and when that failed, it backjumped past the flag choice.
1148 -- The solver should also try to set the flag to false, because that avoids the
1149 -- dependency on B.
1151 testTestSuiteWithFlag name =
1152 goalOrder goals $
1153 enableAllTests $
1156 where
1157 db :: ExampleDb
1158 db =
1163 ]
1166 goals =
1171 ]
1173 -- Packages with setup dependencies
1174 --
1175 -- Install..
1177 -- * B: Simple example, just make sure setup deps are taken into account at all
1179 -- * C: Both the package and the setup script depend on any version of A.
1181 -- In this case we prefer to link
1183 -- * D: Variation on C.1 where the package requires a specific (not latest)
1185 -- version but the setup dependency is not fixed. Again, we prefer to
1186 -- link (picking the older version)
1188 -- * E: Variation on C.2 with the setup dependency the more inflexible.
1190 -- Currently, in this case we do not see the opportunity to link because
1191 -- we consider setup dependencies after normal dependencies; we will
1192 -- pick A.2 for E, then realize we cannot link E.setup.A to A.2, and pick
1193 -- A.1 instead. This isn't so easy to fix (if we want to fix it at all);
1194 -- in particular, considering setup dependencies _before_ other deps is
1195 -- not an improvement, because in general we would prefer to link setup
1196 -- setups to package deps, rather than the other way around. (For example,
1197 -- if we change this ordering then the test for D would start to install
1198 -- two versions of A).
1200 -- * F: The package and the setup script depend on different versions of A.
1202 -- This will only work if setup dependencies are considered independent.
1203 db7 :: ExampleDb
1204 db7 =
1212 ]
1214 -- If we install C and D together (not as independent goals), we need to build
1215 -- both B.1 and B.2, both of which depend on A.
1216 db8 :: ExampleDb
1217 db8 =
1223 ]
1225 -- Extended version of `db8` so that we have nested setup dependencies
1226 db9 :: ExampleDb
1227 db9 =
1228 db8
1233 ]
1235 -- Multiple already-installed packages with inter-dependencies, and one package
1236 -- (C) that depends on package A-1 for its setup script and package A-2 as a
1237 -- library dependency.
1238 db10 :: ExampleDb
1239 db10 =
1246 , Left ghc_prim
1247 , Left base
1248 , Left a1
1249 , Left a2
1251 ]
1253 -- | This database tests that a package's setup dependencies are correctly
1254 -- linked when the package is linked. See pull request #3268.
1255 --
1256 -- When A and B are installed as independent goals, their dependencies on C must
1257 -- be linked, due to the single instance restriction. Since C depends on D, 0.D
1258 -- and 1.D must be linked. C also has a setup dependency on D, so 0.C-setup.D
1259 -- and 1.C-setup.D must be linked. However, D's two link groups must remain
1260 -- independent. The solver should be able to choose D-1 for C's library and D-2
1261 -- for C's setup script.
1262 dbSetupDeps :: ExampleDb
1263 dbSetupDeps =
1269 ]
1271 -- | Tests for dealing with base shims
1272 db11 :: ExampleDb
1273 db11 =
1277 , Left base4
1279 ]
1281 -- | Slightly more realistic version of db11 where base-3 depends on syb
1282 -- This means that if a package depends on base-3 and on syb, then they MUST
1283 -- share the version of syb
1284 --
1285 -- * Package A relies on base-3 (which relies on base-4)
1286 -- * Package B relies on base-4
1287 -- * Package C relies on both A and B
1288 -- * Package D relies on base-3 and on syb-2, which is not possible because
1289 -- base-3 has a dependency on syb-1 (non-inheritance of the Base qualifier)
1290 -- * Package E relies on base-4 and on syb-2, which is fine.
1291 db12 :: ExampleDb
1292 db12 =
1297 , Left base4
1298 , Left syb1
1305 ]
1307 dbBase :: ExampleDb
1308 dbBase =
1310 exAv
1311 "base"
1312 1
1317 ]
1319 dbNonupgrade :: ExampleDb
1320 dbNonupgrade =
1328 ]
1330 db13 :: ExampleDb
1331 db13 =
1335 ]
1337 -- | A, B, and C have three different dependencies on D that can be set to
1338 -- different versions with qualified constraints. Each version of D can only
1339 -- be depended upon by one version of A, B, or C, so that the versions of A, B,
1340 -- and C in the install plan indicate which version of D was chosen for each
1341 -- dependency. The one-to-one correspondence between versions of A, B, and C and
1342 -- versions of D also prevents linking, which would complicate the solver's
1343 -- behavior.
1344 dbConstraints :: ExampleDb
1345 dbConstraints =
1351 dbStanzaPreferences1 :: ExampleDb
1352 dbStanzaPreferences1 =
1355 ]
1357 dbStanzaPreferences2 :: ExampleDb
1358 dbStanzaPreferences2 =
1360 ]
1362 -- | This is a test case for a bug in stanza preferences (#3930). The solver
1363 -- should be able to install 'A' by enabling 'flag' and disabling testing. When
1364 -- it tries goals in the specified order and prefers testing, it encounters
1365 -- 'unknown-pkg2'. 'unknown-pkg2' is only introduced by testing and 'flag', so
1366 -- the conflict set should contain both of those variables. Before the fix, it
1367 -- only contained 'flag'. The solver backjumped past the choice to disable
1368 -- testing and failed to find the solution.
1370 testStanzaPreference name =
1372 exAv
1373 "A"
1374 1
1375 [ exFlagged
1376 "flag"
1377 []
1379 ]
1380 `withTest` exTest
1381 "test"
1382 [ exFlagged
1383 "flag"
1385 []
1386 ]
1387 goals =
1391 ]
1393 goalOrder goals $
1398 -- | Database with some cycles
1399 --
1400 -- * Simplest non-trivial cycle: A -> B and B -> A
1401 -- * There is a cycle C -> D -> C, but it can be broken by picking the
1402 -- right flag assignment.
1403 db14 :: ExampleDb
1404 db14 =
1410 ]
1412 -- | Cycles through setup dependencies
1413 --
1414 -- The first cycle is unsolvable: package A has a setup dependency on B,
1415 -- B has a regular dependency on A, and we only have a single version available
1416 -- for both.
1417 --
1418 -- The second cycle can be broken by picking different versions: package C-2.0
1419 -- has a setup dependency on D, and D has a regular dependency on C-*. However,
1420 -- version C-1.0 is already available (perhaps it didn't have this setup dep).
1421 -- Thus, we should be able to break this cycle even if we are installing package
1422 -- E, which explicitly depends on C-2.0.
1423 db15 :: ExampleDb
1424 db15 =
1433 ]
1435 -- | Detect a cycle between a package and its setup script.
1436 --
1437 -- This type of cycle can easily occur when v2-build adds default setup
1438 -- dependencies to packages without custom-setup stanzas. For example, cabal
1439 -- adds 'time' as a setup dependency for 'time'. The solver should detect the
1440 -- cycle when it attempts to link the setup and non-setup instances of the
1441 -- package and then choose a different version for the setup dependency.
1443 issue4161 name =
1444 setVerbose $
1446 SolverResult checkFullLog $
1448 where
1449 db :: ExampleDb
1450 db =
1454 ]
1457 checkFullLog =
1459 isInfixOf $
1460 "rejecting: time:setup.time~>time-2.0.0 (cyclic dependencies; "
1463 -- | Packages pkg-A, pkg-B, and pkg-C form a cycle. The solver should backtrack
1464 -- as soon as it chooses the last package in the cycle, to avoid searching parts
1465 -- of the tree that have no solution. Since there is no way to break the cycle,
1466 -- it should fail with an error message describing the cycle.
1468 testCyclicDependencyErrorMessages name =
1469 goalOrder goals $
1471 SolverResult checkFullLog $
1472 Left checkSummarizedLog
1473 where
1474 db :: ExampleDb
1475 db =
1481 ]
1483 -- The solver should backtrack as soon as pkg-A, pkg-B, and pkg-C form a
1484 -- cycle. It shouldn't try pkg-D or pkg-E.
1486 checkFullLog =
1490 checkSummarizedLog =
1491 isInfixOf "rejecting: pkg-C-1.0.0 (cyclic dependencies; conflict set: pkg-A, pkg-B, pkg-C)"
1493 -- Solve for pkg-D and pkg-E last.
1497 -- | Check that the solver can backtrack after encountering the SIR (issue #2843)
1498 --
1499 -- When A and B are installed as independent goals, the single instance
1500 -- restriction prevents B from depending on C. This database tests that the
1501 -- solver can backtrack after encountering the single instance restriction and
1502 -- choose the only valid flag assignment (-flagA +flagB):
1503 --
1504 -- > flagA flagB B depends on
1505 -- > On _ C-*
1506 -- > Off On E-* <-- only valid flag assignment
1507 -- > Off Off D-2.0, C-*
1508 --
1509 -- Since A depends on C-* and D-1.0, and C-1.0 depends on any version of D,
1510 -- we must build C-1.0 against D-1.0. Since B depends on D-2.0, we cannot have
1511 -- C in the transitive closure of B's dependencies, because that would mean we
1512 -- would need two instances of C: one built against D-1.0 and one built against
1513 -- D-2.0.
1514 db16 :: ExampleDb
1515 db16 =
1518 exAv
1519 "B"
1520 1
1522 , exFlagged
1523 "flagA"
1525 [ exFlagged
1526 "flagB"
1529 ]
1530 ]
1535 ]
1537 -- Try to get the solver to backtrack while satisfying
1538 -- reject-unconstrained-dependencies: both the first and last versions of A
1539 -- require packages outside the closed set, so it will have to try the
1540 -- middle one.
1541 db17 :: ExampleDb
1542 db17 =
1548 ]
1550 -- | This test checks that when the solver discovers a constraint on a
1551 -- package's version after choosing to link that package, it can backtrack to
1552 -- try alternative versions for the linked-to package. See pull request #3327.
1553 --
1554 -- When A and B are installed as independent goals, their dependencies on C
1555 -- must be linked. Since C depends on D, A and B's dependencies on D must also
1556 -- be linked. This test fixes the goal order so that the solver chooses D-2 for
1557 -- both 0.D and 1.D before it encounters the test suites' constraints. The
1558 -- solver must backtrack to try D-1 for both 0.D and 1.D.
1560 testIndepGoals2 name =
1561 goalOrder goals $
1562 independentGoals $
1563 enableAllTests $
1566 where
1567 db :: ExampleDb
1568 db =
1574 ]
1577 goals =
1586 ]
1588 -- | Issue #2834
1589 -- When both A and B are installed as independent goals, their dependencies on
1590 -- C must be linked. The only combination of C's flags that is consistent with
1591 -- A and B's dependencies on D is -flagA +flagB. This database tests that the
1592 -- solver can backtrack to find the right combination of flags (requiring F, but
1593 -- not E or G) and apply it to both 0.C and 1.C.
1594 --
1595 -- > flagA flagB C depends on
1596 -- > On _ D-1, E-*
1597 -- > Off On F-* <-- Only valid choice
1598 -- > Off Off D-2, G-*
1599 --
1600 -- The single instance restriction means we cannot have one instance of C
1601 -- built against D-1 and one instance built against D-2; since A depends on
1602 -- D-1, and B depends on C-2, it is therefore important that C cannot depend
1603 -- on any version of D.
1604 db18 :: ExampleDb
1605 db18 =
1609 exAv
1610 "C"
1611 1
1612 [ exFlagged
1613 "flagA"
1615 [ exFlagged
1616 "flagB"
1619 ]
1620 ]
1626 ]
1628 -- | When both values for flagA introduce package B, the solver should be able
1629 -- to choose B before choosing a value for flagA. It should try to choose a
1630 -- version for B that is in the union of the version ranges required by +flagA
1631 -- and -flagA.
1633 commonDependencyLogMessage name =
1635 solverFailure $
1636 isInfixOf $
1640 where
1641 db :: ExampleDb
1642 db =
1644 exAv
1645 "A"
1646 1
1647 [ exFlagged
1648 "flagA"
1651 ]
1653 ]
1655 -- | Test lifting dependencies out of multiple levels of conditionals.
1657 twoLevelDeepCommonDependencyLogMessage name =
1659 solverFailure $
1660 isInfixOf $
1661 "unknown package: B (dependency of A +/-flagA +/-flagB)"
1662 where
1663 db :: ExampleDb
1664 db =
1666 exAv
1667 "A"
1668 1
1669 [ exFlagged
1670 "flagA"
1671 [ exFlagged
1672 "flagB"
1675 ]
1676 [ exFlagged
1677 "flagB"
1680 ]
1681 ]
1682 ]
1684 -- | Test handling nested conditionals that are controlled by the same flag.
1685 -- The solver should treat flagA as introducing 'unknown' with value true, not
1686 -- both true and false. That means that when +flagA causes a conflict, the
1687 -- solver should try flipping flagA to false to resolve the conflict, rather
1688 -- than backjumping past flagA.
1690 testBackjumpingWithCommonDependency name =
1692 where
1693 db :: ExampleDb
1694 db =
1696 exAv
1697 "A"
1698 1
1699 [ exFlagged
1700 "flagA"
1701 [ exFlagged
1702 "flagA"
1705 ]
1707 ]
1709 ]
1711 -- | Tricky test case with independent goals (issue #2842)
1712 --
1713 -- Suppose we are installing D, E, and F as independent goals:
1714 --
1715 -- * D depends on A-* and C-1, requiring A-1 to be built against C-1
1716 -- * E depends on B-* and C-2, requiring B-1 to be built against C-2
1717 -- * F depends on A-* and B-*; this means we need A-1 and B-1 both to be built
1718 -- against the same version of C, violating the single instance restriction.
1719 --
1720 -- We can visualize this DB as:
1721 --
1722 -- > C-1 C-2
1723 -- > /|\ /|\
1724 -- > / | \ / | \
1725 -- > / | X | \
1726 -- > | | / \ | |
1727 -- > | |/ \| |
1728 -- > | + + |
1729 -- > | | | |
1730 -- > | A B |
1731 -- > \ |\ /| /
1732 -- > \ | \ / | /
1733 -- > \| V |/
1734 -- > D F E
1736 testIndepGoals3 name =
1737 goalOrder goals $
1738 independentGoals $
1740 where
1741 db :: ExampleDb
1742 db =
1750 ]
1753 goals =
1764 ]
1766 -- | This test checks that the solver correctly backjumps when dependencies
1767 -- of linked packages are not linked. It is an example where the conflict set
1768 -- from enforcing the single instance restriction is not sufficient. See pull
1769 -- request #3327.
1770 --
1771 -- When A, B, and C are installed as independent goals with the specified goal
1772 -- order, the first choice that the solver makes for E is 0.E-2. Then, when it
1773 -- chooses dependencies for B and C, it links both 1.E and 2.E to 0.E. Finally,
1774 -- the solver discovers C's test's constraint on E. It must backtrack to try
1775 -- 1.E-1 and then link 2.E to 1.E. Backjumping all the way to 0.E does not lead
1776 -- to a solution, because 0.E's version is constrained by A and cannot be
1777 -- changed.
1779 testIndepGoals4 name =
1780 goalOrder goals $
1781 independentGoals $
1782 enableAllTests $
1785 where
1786 db :: ExampleDb
1787 db =
1794 ]
1797 goals =
1807 ]
1809 -- | Test the trace messages that we get when a package refers to an unknown pkg
1810 --
1811 -- TODO: Currently we don't actually test the trace messages, and this particular
1812 -- test still succeeds. The trace can only be verified by hand.
1813 db21 :: ExampleDb
1814 db21 =
1818 ]
1820 -- | A variant of 'db21', which actually fails.
1821 db22 :: ExampleDb
1822 db22 =
1825 ]
1827 -- | Another test for the unknown package message. This database tests that
1828 -- filtering out redundant conflict set messages in the solver log doesn't
1829 -- interfere with generating a message about a missing package (part of issue
1830 -- #3617). The conflict set for the missing package is {A, B}. That conflict set
1831 -- is propagated up the tree to the level of A. Since the conflict set is the
1832 -- same at both levels, the solver only keeps one of the backjumping messages.
1833 db23 :: ExampleDb
1834 db23 =
1836 ]
1838 -- | Database for (unsuccessfully) trying to expose a bug in the handling
1839 -- of implied linking constraints. The question is whether an implied linking
1840 -- constraint should only have the introducing package in its conflict set,
1841 -- or also its link target.
1842 --
1843 -- It turns out that as long as the Single Instance Restriction is in place,
1844 -- it does not matter, because there will always be an option that is failing
1845 -- due to the SIR, which contains the link target in its conflict set.
1846 --
1847 -- Even if the SIR is not in place, if there is a solution, one will always
1848 -- be found, because without the SIR, linking is always optional, but never
1849 -- necessary.
1851 testIndepGoals5 name fixGoalOrder =
1853 FixedGoalOrder -> goalOrder goals test
1854 DefaultGoalOrder -> test
1855 where
1856 test :: SolverTest
1857 test =
1858 independentGoals $
1860 solverSuccess
1863 db :: ExampleDb
1864 db =
1872 ]
1875 goals =
1884 ]
1886 -- | A simplified version of 'testIndepGoals5'.
1888 testIndepGoals6 name fixGoalOrder =
1890 FixedGoalOrder -> goalOrder goals test
1891 DefaultGoalOrder -> test
1892 where
1893 test :: SolverTest
1894 test =
1895 independentGoals $
1897 solverSuccess
1900 db :: ExampleDb
1901 db =
1908 ]
1911 goals =
1918 ]
1920 dbExts1 :: ExampleDb
1921 dbExts1 =
1927 ]
1929 dbLangs1 :: ExampleDb
1930 dbLangs1 =
1934 ]
1936 -- | cabal must set enable-exe to false in order to avoid the unavailable
1937 -- dependency. Flags are true by default. The flag choice causes "pkg" to
1938 -- depend on "false-dep".
1940 testBuildable testName unavailableDep =
1941 runTest $
1943 where
1945 db =
1947 exAv
1948 "pkg"
1949 1
1950 [ exFlagged
1951 "enable-exe"
1954 ]
1955 `withExe` exExe
1956 "exe"
1957 [ unavailableDep
1959 ]
1962 ]
1964 -- | cabal must choose -flag1 +flag2 for "pkg", which requires packages
1965 -- "flag1-false" and "flag2-true".
1966 dbBuildable1 :: ExampleDb
1967 dbBuildable1 =
1969 exAv
1970 "pkg"
1971 1
1974 ]
1975 `withExes` [ exExe
1976 "exe1"
1980 ]
1981 , exExe
1982 "exe2"
1984 , ExFlagged
1985 "flag1"
1988 ]
1989 ]
1994 ]
1996 -- | cabal must pick B-2 to avoid the unknown dependency.
1997 dbBuildable2 :: ExampleDb
1998 dbBuildable2 =
2003 `withExe` exExe
2004 "exe"
2007 ]
2009 ]
2011 -- | Package databases for testing @pkg-config@ dependencies.
2012 -- when no pkgconfig db is present, cabal must pick flag1 false and flag2 true to avoid the pkg dependency.
2013 dbPC1 :: ExampleDb
2014 dbPC1 =
2020 ]
2022 -- | Test for the solver's summarized log. The final conflict set is {A, F},
2023 -- though the goal order forces the solver to find the (avoidable) conflict
2024 -- between B and C first. When the solver reaches the backjump limit, it should
2025 -- only show the log to the first conflict. When the backjump limit is high
2026 -- enough to allow an exhaustive search, the solver should make use of the final
2027 -- conflict set to only show the conflict between A and F in the summarized log.
2029 testSummarizedLog testName mbj expectedMsg =
2030 runTest $
2031 maxBackjumps mbj $
2032 goalOrder goals $
2035 where
2036 db =
2042 ]
2047 dbMinimizeConflictSet :: ExampleDb
2048 dbMinimizeConflictSet =
2055 ]
2057 -- | Test that the solver can find a minimal conflict set with
2058 -- --minimize-conflict-set. In the first run, the goal order causes the solver
2059 -- to find that A-3 conflicts with B, A-2 conflicts with C, and A-1 conflicts
2060 -- with D. The full log should show that the original final conflict set is
2061 -- {A, B, C, D}. Then the solver should be able to reduce the conflict set to
2062 -- {A, D}, since all versions of A conflict with D. The summarized log should
2063 -- only mention A and D.
2065 testMinimizeConflictSet testName =
2066 runTest $
2067 minimizeConflictSet $
2068 goalOrder goals $
2069 setVerbose $
2072 where
2074 checkFullLog =
2075 containsInOrder
2085 ]
2087 expectedMsg =
2099 -- | This test uses the same packages and goal order as testMinimizeConflictSet,
2100 -- but it doesn't set --minimize-conflict-set. The solver should print the
2101 -- original final conflict set and the conflict between A and B. It should also
2102 -- suggest rerunning with --minimize-conflict-set.
2104 testNoMinimizeConflictSet testName =
2105 runTest $
2106 goalOrder goals $
2107 setVerbose $
2110 where
2111 expectedMsg =
2125 {-------------------------------------------------------------------------------
2126 Simple databases for the illustrations for the backjumping blog post
2127 -------------------------------------------------------------------------------}
2129 -- | Motivate conflict sets
2130 dbBJ1a :: ExampleDb
2131 dbBJ1a =
2135 ]
2137 -- | Show that we can skip some decisions
2138 dbBJ1b :: ExampleDb
2139 dbBJ1b =
2145 ]
2147 -- | Motivate why both A and B need to be in the conflict set
2148 dbBJ1c :: ExampleDb
2149 dbBJ1c =
2153 ]
2155 -- | Motivate the need for accumulating conflict sets while we walk the tree
2156 dbBJ2 :: ExampleDb
2157 dbBJ2 =
2163 ]
2165 -- | Motivate the need for `QGoalReason`
2166 dbBJ3 :: ExampleDb
2167 dbBJ3 =
2173 ]
2175 -- | `QGOalReason` not unique
2176 dbBJ4 :: ExampleDb
2177 dbBJ4 =
2181 ]
2183 -- | Flags are represented somewhat strangely in the tree
2184 --
2185 -- This example probably won't be in the blog post itself but as a separate
2186 -- bug report (#3409)
2187 dbBJ5 :: ExampleDb
2188 dbBJ5 =
2193 ]
2195 -- | Conflict sets for cycles
2196 dbBJ6 :: ExampleDb
2197 dbBJ6 =
2202 ]
2204 -- | Conflicts not unique
2205 dbBJ7 :: ExampleDb
2206 dbBJ7 =
2211 ]
2213 -- | Conflict sets for SIR (C shared subgoal of independent goals A, B)
2214 dbBJ8 :: ExampleDb
2215 dbBJ8 =
2219 ]
2221 {-------------------------------------------------------------------------------
2222 Databases for build-tool-depends
2223 -------------------------------------------------------------------------------}
2225 -- | Multiple packages depending on exes from 'bt-pkg'.
2226 dbBuildTools :: ExampleDb
2227 dbBuildTools =
2230 exAv
2231 "B"
2232 1
2233 [ exFlagged
2234 "flagB"
2237 ]
2242 exAv
2243 "F"
2244 1
2245 [ exFlagged
2246 "flagF"
2249 ]
2256 ]
2258 -- The solver should never choose an installed package for a build tool
2259 -- dependency.
2261 rejectInstalledBuildToolPackage name =
2263 solverFailure $
2264 isInfixOf $
2265 "rejecting: A:B:exe.B-1.0.0/installed-1 "
2267 where
2268 db :: ExampleDb
2269 db =
2272 ]
2274 -- | This test forces the solver to choose B as a build-tool dependency before
2275 -- it sees the dependency on executable exe2 from B. The solver needs to check
2276 -- that the version that it already chose for B contains the necessary
2277 -- executable. This order causes a different "missing executable" error message
2278 -- than when the solver checks for the executable in the same step that it
2279 -- chooses the build-tool package.
2280 --
2281 -- This case may become impossible if we ever add the executable name to the
2282 -- build-tool goal qualifier. Then this test would involve two qualified goals
2283 -- for B, one for exe1 and another for exe2.
2285 chooseExeAfterBuildToolsPackage shouldSucceed name =
2286 goalOrder goals $
2288 if shouldSucceed
2290 else
2291 solverFailure $
2292 isInfixOf $
2293 "rejecting: A:+flagA (requires executable 'exe2' from A:B:exe.B, "
2295 where
2296 db :: ExampleDb
2297 db =
2299 exAv
2300 "A"
2301 1
2303 , exFlagged
2304 "flagA"
2307 ]
2311 ]
2314 goals =
2318 ]
2320 -- | Test that when one package depends on two executables from another package,
2321 -- both executables must come from the same instance of that package. We could
2322 -- lift this restriction in the future by adding the executable name to the goal
2323 -- qualifier.
2325 requireConsistentBuildToolVersions name =
2327 solverFailure $
2328 isInfixOf $
2331 where
2332 db :: ExampleDb
2333 db =
2335 exAv
2336 "A"
2337 1
2340 ]
2343 ]
2347 -- | This test is similar to the failure case for
2348 -- chooseExeAfterBuildToolsPackage, except that the build tool is unbuildable
2349 -- instead of missing.
2351 chooseUnbuildableExeAfterBuildToolsPackage name =
2353 goalOrder goals $
2355 solverFailure $
2356 isInfixOf $
2357 "rejecting: A:+use-bt2 (requires executable 'bt2' from A:B:exe.B, but "
2359 where
2360 db :: ExampleDb
2361 db =
2363 exAv
2364 "A"
2365 1
2367 , exFlagged
2368 "use-bt2"
2371 ]
2376 ]
2377 ]
2380 goals =
2384 ]
2386 {-------------------------------------------------------------------------------
2387 Databases for legacy build-tools
2388 -------------------------------------------------------------------------------}
2389 dbLegacyBuildTools1 :: ExampleDb
2390 dbLegacyBuildTools1 =
2393 ]
2395 -- Test that a recognized build tool dependency specifies the name of both the
2396 -- package and the executable. This db has no solution.
2397 dbLegacyBuildTools2 :: ExampleDb
2398 dbLegacyBuildTools2 =
2402 ]
2404 -- Test that build-tools on a random thing doesn't matter (only
2405 -- the ones we recognize need to be in db)
2406 dbLegacyBuildTools3 :: ExampleDb
2407 dbLegacyBuildTools3 =
2409 ]
2411 -- Test that we can solve for different versions of executables
2412 dbLegacyBuildTools4 :: ExampleDb
2413 dbLegacyBuildTools4 =
2419 ]
2421 -- Test that exe is not related to library choices
2422 dbLegacyBuildTools5 :: ExampleDb
2423 dbLegacyBuildTools5 =
2428 ]
2430 -- Test that build-tools on build-tools works
2431 dbLegacyBuildTools6 :: ExampleDb
2432 dbLegacyBuildTools6 =
2436 ]
2438 -- Test that build-depends on library/executable package works.
2439 -- Extracted from https://github.com/haskell/cabal/issues/3775
2440 dbIssue3775 :: ExampleDb
2441 dbIssue3775 =
2444 -- executable!
2447 ]
2449 -- | Returns true if the second list contains all elements of the first list, in
2450 -- order.