Use duplicateImportMsg for cycles too

Author: philderbeast

cabal-install-solver/src/Distribution/Solver/Types/ProjectConfigPath.hs

@@ -11,7 +11,6 @@ module Distribution.Solver.Types.ProjectConfigPath
 
     -- * Messages
     , docProjectConfigPath
-    , cyclicalImportMsg
     , duplicateImportMsg
     , docProjectConfigPathFailReason
 
@@ -64,22 +63,12 @@ docProjectConfigPath (ProjectConfigPath (p :| [])) = text p
 docProjectConfigPath (ProjectConfigPath (p :| ps)) = vcat $
     text p : [ text " " <+> text "imported by:" <+> text l | l <- ps ]
 
--- | A message for a cyclical import, assuming the head of the path is the
--- duplicate.
-cyclicalImportMsg :: ProjectConfigPath -> Doc
-cyclicalImportMsg path@(ProjectConfigPath (duplicate :| _)) =
+-- | A message for a duplicate import. Useful for reporting cyclical imports and
+-- duplicate imports by different import paths.
+duplicateImportMsg :: String -> FilePath -> ProjectConfigPath -> [(FilePath, ProjectConfigPath)] -> Doc
+duplicateImportMsg description duplicate path seenImportsBy =
     vcat
-    [ text "cyclical import of" <+> text duplicate <> semi
-    , nest 2 (docProjectConfigPath path)
-    ]
-
--- | A message for a duplicate import. If a check for cyclical imports has
--- already been made then this would report a duplicate import by two different
--- paths.
-duplicateImportMsg :: FilePath -> ProjectConfigPath -> [(FilePath, ProjectConfigPath)] -> Doc
-duplicateImportMsg duplicate path seenImportsBy =
-    vcat
-    [ text "duplicate import of" <+> text duplicate <> semi
+    [ text description <+> text "import of" <+> text duplicate <> semi
     , nest 2 (docProjectConfigPath path)
     , nest 2 $
         vcat

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

@@ -282,9 +282,9 @@ parseProjectSkeleton cacheDir httpTransport verbosity importsBy projectDir sourc
 
         if
             | isCyclicConfigPath normLocPath ->
-                pure . parseFail $ ParseUtils.FromString (render $ cyclicalImportMsg normLocPath) Nothing
+                pure . parseFail $ ParseUtils.FromString (render $ duplicateImportMsg "cyclical (duplicate)" uniqueImport normLocPath seenImportsBy) Nothing
             | uniqueImport `elem` seenImports -> do
-                pure . parseFail $ ParseUtils.FromString (render $ duplicateImportMsg uniqueImport normLocPath seenImportsBy) Nothing
+                pure . parseFail $ ParseUtils.FromString (render $ duplicateImportMsg "duplicate" uniqueImport normLocPath seenImportsBy) Nothing
             | otherwise -> do
                 normSource <- canonicalizeConfigPath projectDir source
                 let fs = (\z -> CondNode z [normLocPath] mempty) <$> fieldsToConfig normSource (reverse acc)

cabal-testsuite/PackageTests/ConditionalAndImport/cabal.out

@@ -14,52 +14,62 @@ Warning: The directory <ROOT>/cabal.dist/home/.cabal/store/ghc-<GHCVER>/incoming
 # cabal v2-build
 Error: [Cabal-7090]
 Error parsing project file <ROOT>/cyclical-0-self.project:
-cyclical import of cyclical-0-self.project;
+cyclical (duplicate) import of cyclical-0-self.project;
   cyclical-0-self.project
     imported by: cyclical-0-self.project
+  cyclical-0-self.project
 # checking cyclical with hops; out and back
 # cabal v2-build
 Error: [Cabal-7090]
 Error parsing project file <ROOT>/cyclical-1-out-back.project:
-cyclical import of cyclical-1-out-back.project;
+cyclical (duplicate) import of cyclical-1-out-back.project;
   cyclical-1-out-back.project
     imported by: cyclical-1-out-back.config
     imported by: cyclical-1-out-back.project
+  cyclical-1-out-back.project
 # checking cyclical with hops; out to a config that imports itself
 # cabal v2-build
 Error: [Cabal-7090]
 Error parsing project file <ROOT>/cyclical-1-out-self.project:
-cyclical import of cyclical-1-out-self.config;
+cyclical (duplicate) import of cyclical-1-out-self.config;
   cyclical-1-out-self.config
     imported by: cyclical-1-out-self.config
     imported by: cyclical-1-out-self.project
+  cyclical-1-out-self.config
+    imported by: cyclical-1-out-self.project
 # checking cyclical with hops; out, out, twice back
 # cabal v2-build
 Error: [Cabal-7090]
 Error parsing project file <ROOT>/cyclical-2-out-out-backback.project:
-cyclical import of cyclical-2-out-out-backback.project;
+cyclical (duplicate) import of cyclical-2-out-out-backback.project;
   cyclical-2-out-out-backback.project
     imported by: cyclical-2-out-out-backback-b.config
     imported by: cyclical-2-out-out-backback-a.config
     imported by: cyclical-2-out-out-backback.project
+  cyclical-2-out-out-backback.project
 # checking cyclical with hops; out, out, once back
 # cabal v2-build
 Error: [Cabal-7090]
 Error parsing project file <ROOT>/cyclical-2-out-out-back.project:
-cyclical import of cyclical-2-out-out-back-a.config;
+cyclical (duplicate) import of cyclical-2-out-out-back-a.config;
   cyclical-2-out-out-back-a.config
     imported by: cyclical-2-out-out-back-b.config
     imported by: cyclical-2-out-out-back-a.config
     imported by: cyclical-2-out-out-back.project
+  cyclical-2-out-out-back-a.config
+    imported by: cyclical-2-out-out-back.project
 # checking cyclical with hops; out, out to a config that imports itself
 # cabal v2-build
 Error: [Cabal-7090]
 Error parsing project file <ROOT>/cyclical-2-out-out-self.project:
-cyclical import of cyclical-2-out-out-self-b.config;
+cyclical (duplicate) import of cyclical-2-out-out-self-b.config;
   cyclical-2-out-out-self-b.config
     imported by: cyclical-2-out-out-self-b.config
     imported by: cyclical-2-out-out-self-a.config
     imported by: cyclical-2-out-out-self.project
+  cyclical-2-out-out-self-b.config
+    imported by: cyclical-2-out-out-self-a.config
+    imported by: cyclical-2-out-out-self.project
 # checking that cyclical check doesn't false-positive on same file names in different folders; hoping within a folder and then into a subfolder
 # cabal v2-build
 Resolving dependencies...
@@ -76,29 +86,35 @@ Up to date
 # cabal v2-build
 Error: [Cabal-7090]
 Error parsing project file <ROOT>/cyclical-same-filename-out-out-self.project:
-cyclical import of same-filename/cyclical-same-filename-out-out-self.config;
+cyclical (duplicate) import of same-filename/cyclical-same-filename-out-out-self.config;
   same-filename/cyclical-same-filename-out-out-self.config
     imported by: same-filename/cyclical-same-filename-out-out-self.config
     imported by: cyclical-same-filename-out-out-self.config
     imported by: cyclical-same-filename-out-out-self.project
+  same-filename/cyclical-same-filename-out-out-self.config
+    imported by: cyclical-same-filename-out-out-self.config
+    imported by: cyclical-same-filename-out-out-self.project
 # checking that cyclical check catches importing its importer (with the same file name)
 # cabal v2-build
 Error: [Cabal-7090]
 Error parsing project file <ROOT>/cyclical-same-filename-out-out-backback.project:
-cyclical import of cyclical-same-filename-out-out-backback.project;
+cyclical (duplicate) import of cyclical-same-filename-out-out-backback.project;
   cyclical-same-filename-out-out-backback.project
     imported by: same-filename/cyclical-same-filename-out-out-backback.config
     imported by: cyclical-same-filename-out-out-backback.config
     imported by: cyclical-same-filename-out-out-backback.project
+  cyclical-same-filename-out-out-backback.project
 # checking that cyclical check catches importing its importer's importer (hopping over same file names)
 # cabal v2-build
 Error: [Cabal-7090]
 Error parsing project file <ROOT>/cyclical-same-filename-out-out-back.project:
-cyclical import of cyclical-same-filename-out-out-back.config;
+cyclical (duplicate) import of cyclical-same-filename-out-out-back.config;
   cyclical-same-filename-out-out-back.config
     imported by: same-filename/cyclical-same-filename-out-out-back.config
     imported by: cyclical-same-filename-out-out-back.config
     imported by: cyclical-same-filename-out-out-back.project
+  cyclical-same-filename-out-out-back.config
+    imported by: cyclical-same-filename-out-out-back.project
 # checking that imports work skipping into a subfolder and then back out again and again
 # cabal v2-build
 Up to date

cabal-testsuite/PackageTests/ConditionalAndImport/cabal.test.hs

@@ -10,23 +10,23 @@ main = cabalTest . withRepo "repo" . recordMode RecordMarked $ do
   -- +-- etc
   log "checking cyclical loopback of a project importing itself"
   cyclical0 <- fails $ cabal' "v2-build" [ "--project-file=cyclical-0-self.project" ]
-  assertOutputContains "cyclical import of cyclical-0-self.project" cyclical0
+  assertOutputContains "cyclical (duplicate) import of cyclical-0-self.project" cyclical0
 
   -- +-- cyclical-1-out-back.project
   --  +-- cyclical-1-out-back.config (imports cyclical-1-out-back.project)
   -- +-- cyclical-1-out-back.project (already processed)
   --  +-- etc
   log "checking cyclical with hops; out and back"
   cyclical1a <- fails $ cabal' "v2-build" [ "--project-file=cyclical-1-out-back.project" ]
-  assertOutputContains "cyclical import of cyclical-1-out-back.project" cyclical1a
+  assertOutputContains "cyclical (duplicate) import of cyclical-1-out-back.project" cyclical1a
 
   -- +-- cyclical-1-out-self.project
   --  +-- cyclical-1-out-self.config (imports cyclical-1-out-self.config)
   --  +-- cyclical-1-out-self.config (already processed)
   --  +-- etc
   log "checking cyclical with hops; out to a config that imports itself"
   cyclical1b <- fails $ cabal' "v2-build" [ "--project-file=cyclical-1-out-self.project" ]
-  assertOutputContains "cyclical import of cyclical-1-out-self.config" cyclical1b
+  assertOutputContains "cyclical (duplicate) import of cyclical-1-out-self.config" cyclical1b
 
   -- +-- cyclical-2-out-out-backback.project
   --  +-- cyclical-2-out-out-backback-a.config
@@ -35,7 +35,7 @@ main = cabalTest . withRepo "repo" . recordMode RecordMarked $ do
   --  +-- etc
   log "checking cyclical with hops; out, out, twice back"
   cyclical2a <- fails $ cabal' "v2-build" [ "--project-file=cyclical-2-out-out-backback.project" ]
-  assertOutputContains "cyclical import of cyclical-2-out-out-backback.project" cyclical2a
+  assertOutputContains "cyclical (duplicate) import of cyclical-2-out-out-backback.project" cyclical2a
 
   -- +-- cyclical-2-out-out-back.project
   --  +-- cyclical-2-out-out-back-a.config
@@ -44,7 +44,7 @@ main = cabalTest . withRepo "repo" . recordMode RecordMarked $ do
   --   +-- etc
   log "checking cyclical with hops; out, out, once back"
   cyclical2b <- fails $ cabal' "v2-build" [ "--project-file=cyclical-2-out-out-back.project" ]
-  assertOutputContains "cyclical import of cyclical-2-out-out-back-a.config" cyclical2b
+  assertOutputContains "cyclical (duplicate) import of cyclical-2-out-out-back-a.config" cyclical2b
 
   -- +-- cyclical-2-out-out-self.project
   --  +-- cyclical-2-out-out-self-a.config
@@ -53,21 +53,21 @@ main = cabalTest . withRepo "repo" . recordMode RecordMarked $ do
   --   +-- etc
   log "checking cyclical with hops; out, out to a config that imports itself"
   cyclical2c <- fails $ cabal' "v2-build" [ "--project-file=cyclical-2-out-out-self.project" ]
-  assertOutputContains "cyclical import of cyclical-2-out-out-self-b.config" cyclical2c
+  assertOutputContains "cyclical (duplicate) import of cyclical-2-out-out-self-b.config" cyclical2c
 
   -- +-- noncyclical-same-filename-a.project
   --  +-- noncyclical-same-filename-a.config
   --    +-- same-filename/noncyclical-same-filename-a.config (no further imports so not cyclical)
   log "checking that cyclical check doesn't false-positive on same file names in different folders; hoping within a folder and then into a subfolder"
   cyclical3b <- cabal' "v2-build" [ "--project-file=noncyclical-same-filename-a.project" ]
-  assertOutputDoesNotContain "cyclical import of" cyclical3b
+  assertOutputDoesNotContain "cyclical (duplicate) import of" cyclical3b
 
   -- +-- noncyclical-same-filename-b.project
   --  +-- same-filename/noncyclical-same-filename-b.config
   --    +-- noncyclical-same-filename-b.config (no further imports so not cyclical)
   log "checking that cyclical check doesn't false-positive on same file names in different folders; hoping into a subfolder and then back out again"
   cyclical3c <- cabal' "v2-build" [ "--project-file=noncyclical-same-filename-b.project" ]
-  assertOutputDoesNotContain "cyclical import of" cyclical3c
+  assertOutputDoesNotContain "cyclical (duplicate) import of" cyclical3c
 
   -- +-- cyclical-same-filename-out-out-self.project
   --  +-- cyclical-same-filename-out-out-self.config
@@ -76,7 +76,7 @@ main = cabalTest . withRepo "repo" . recordMode RecordMarked $ do
   --    +-- etc
   log "checking that cyclical check catches a same file name that imports itself"
   cyclical4a <- fails $ cabal' "v2-build" [ "--project-file=cyclical-same-filename-out-out-self.project" ]
-  assertOutputContains "cyclical import of same-filename/cyclical-same-filename-out-out-self.config" cyclical4a
+  assertOutputContains "cyclical (duplicate) import of same-filename/cyclical-same-filename-out-out-self.config" cyclical4a
 
   -- +-- cyclical-same-filename-out-out-backback.project
   --  +-- cyclical-same-filename-out-out-backback.config
@@ -85,7 +85,7 @@ main = cabalTest . withRepo "repo" . recordMode RecordMarked $ do
   -- +-- etc
   log "checking that cyclical check catches importing its importer (with the same file name)"
   cyclical4b <- fails $ cabal' "v2-build" [ "--project-file=cyclical-same-filename-out-out-backback.project" ]
-  assertOutputContains "cyclical import of cyclical-same-filename-out-out-backback.project" cyclical4b
+  assertOutputContains "cyclical (duplicate) import of cyclical-same-filename-out-out-backback.project" cyclical4b
 
   -- +-- cyclical-same-filename-out-out-back.project
   --  +-- cyclical-same-filename-out-out-back.config
@@ -94,7 +94,7 @@ main = cabalTest . withRepo "repo" . recordMode RecordMarked $ do
   --  +-- etc
   log "checking that cyclical check catches importing its importer's importer (hopping over same file names)"
   cyclical4c <- fails $ cabal' "v2-build" [ "--project-file=cyclical-same-filename-out-out-back.project" ]
-  assertOutputContains "cyclical import of cyclical-same-filename-out-out-back.config" cyclical4c
+  assertOutputContains "cyclical (duplicate) import of cyclical-same-filename-out-out-back.config" cyclical4c
 
   -- +-- hops-0.project
   --  +-- hops/hops-1.config