Merge branch 'accessor-tests' into no-flatten-package-description

Author: leana8959

Cabal-tests/tests/ParserTests.hs

@@ -14,8 +14,18 @@ import Control.Monad                               (unless, void)
 import Data.Algorithm.Diff                         (PolyDiff (..), getGroupedDiff)
 import Data.Maybe                                  (isNothing)
 import Distribution.Fields                         (pwarning)
-import Distribution.PackageDescription             (GenericPackageDescription)
-import Distribution.Types.GenericPackageDescription(condLibrary)
+import Distribution.PackageDescription
+  ( GenericPackageDescription
+  , packageDescription
+  , gpdScannedVersion
+  , genPackageFlags
+  , condLibrary
+  , condSubLibraries
+  , condForeignLibs
+  , condExecutables
+  , condTestSuites
+  , condBenchmarks
+  )
 import Distribution.PackageDescription.Parsec      (parseGenericPackageDescription)
 import Distribution.PackageDescription.PrettyPrint (showGenericPackageDescription)
 import Distribution.Parsec                         (PWarnType (..), PWarning (..), showPErrorWithSource, showPWarningWithSource)
@@ -35,15 +45,13 @@ import qualified Distribution.InstalledPackageInfo as IPI
 
 #ifdef MIN_VERSION_tree_diff
 import Data.TreeDiff                 (ansiWlEditExpr, ediff, toExpr)
-import Data.TreeDiff.Class           (ToExpr)
 import Data.TreeDiff.Golden          (ediffGolden)
 import Data.TreeDiff.Instances.Cabal ()
 #endif
 
 tests :: TestTree
 tests = testGroup "parsec tests"
     [ regressionTests
-    , accessorsTests
     , warningTests
     , errorTests
     , ipiTests
@@ -153,40 +161,6 @@ errorTest fp = cabalGoldenTest fp correct $ do
     input = "tests" </> "ParserTests" </> "errors" </> fp
     correct = replaceExtension input "errors"
 
--------------------------------------------------------------------------------
--- Merging accessors tests
--------------------------------------------------------------------------------
-
-accessorsTests :: TestTree
-accessorsTests = testGroup "accessors"
-    [
-#ifdef MIN_VERSION_tree_diff
-      accessorsGoldenTestCondLibrary
-        [ "library-merging.cabal"
-        ]
-#endif
-    ]
-
-#ifdef MIN_VERSION_tree_diff
-accessorsGoldenTestCondLibrary :: [FilePath] -> TestTree
-accessorsGoldenTestCondLibrary = testGroup "condLibrary" . map (accessorsGoldenTest condLibrary)
-
-accessorsGoldenTest
-  :: ToExpr a
-  => (GenericPackageDescription -> a)
-  -> FilePath -> TestTree
-accessorsGoldenTest f fp = ediffGolden goldenTest fp exprFile $ do
-    contents <- BS.readFile input
-    let res = withSource (PCabalFile (fp, contents)) $ parseGenericPackageDescription contents
-    let (_, x) = runParseResult res
-    case x of
-        Right gpd      -> pure . toExpr $ f gpd
-        Left (_, errs) -> fail $ unlines $ "ERROR" : map (showPErrorWithSource . fmap renderCabalFileSource) (NE.toList errs)
-  where
-    input = "tests" </> "ParserTests" </> "accessors" </> fp
-    exprFile = replaceExtension input "expr"
-#endif
-
 -------------------------------------------------------------------------------
 -- Regressions
 -------------------------------------------------------------------------------
@@ -270,16 +244,29 @@ formatGoldenTest fp = cabalGoldenTest "format" correct $ do
 
 #ifdef MIN_VERSION_tree_diff
 treeDiffGoldenTest :: FilePath -> TestTree
-treeDiffGoldenTest fp = ediffGolden goldenTest "expr" exprFile $ do
-    contents <- BS.readFile input
-    let res = withSource (PCabalFile (fp, contents)) $ parseGenericPackageDescription contents
-    let (_, x) = runParseResult res
-    case x of
-        Right gpd      -> pure (toExpr gpd)
-        Left (_, errs) -> fail $ unlines $ "ERROR" : map (showPErrorWithSource . fmap renderCabalFileSource) (NE.toList errs)
-  where
-    input = "tests" </> "ParserTests" </> "regressions" </> fp
-    exprFile = replaceExtension input "expr"
+treeDiffGoldenTest fp =
+  let go label f = ediffGolden goldenTest label exprFile $ do
+        contents <- BS.readFile input
+        let res = withSource (PCabalFile (fp, contents)) $ parseGenericPackageDescription contents
+        let (_, x) = runParseResult res
+        case x of
+            Right gpd      -> pure (toExpr $ f gpd)
+            Left (_, errs) -> fail $ unlines $ "ERROR" : map (showPErrorWithSource . fmap renderCabalFileSource) (NE.toList errs)
+        where
+          input = "tests" </> "ParserTests" </> "regressions" </> fp
+          exprFile = replaceExtension input (label <> ".expr")
+  in testGroup "expr"
+      [ go "packageDescription" packageDescription
+      , go "gpdScannedVersion" gpdScannedVersion
+      , go "genPackageFlags" genPackageFlags
+      -- Test accessors because they encapsulate the merging behaviour
+      , go "condLibrary" condLibrary
+      , go "condSubLibraries" condSubLibraries
+      , go "condForeignLibs" condForeignLibs
+      , go "condExecutables" condExecutables
+      , go "condTestSuites" condTestSuites
+      , go "condBenchmarks" condBenchmarks
+      ]
 #endif
 
 formatRoundTripTest :: FilePath -> TestTree
@@ -288,24 +275,38 @@ formatRoundTripTest fp = testCase "roundtrip" $ do
     x <- parse contents
     let contents' = showGenericPackageDescription x
     y <- parse (toUTF8BS contents')
-    -- previously we mangled licenses a bit
-    let y' = y
+
+    let checkField field =
+          unless (field x == field y) $
 {- FOURMOLU_DISABLE -}
-    unless (x == y') $
 #ifdef MIN_VERSION_tree_diff
-        assertFailure $ unlines
-            [ "re-parsed doesn't match"
-            , show $ ansiWlEditExpr $ ediff x y
-            ]
+            assertFailure $ unlines
+                [ "re-parsed doesn't match"
+                , show $ ansiWlEditExpr $ ediff x y
+                ]
 #else
-        assertFailure $ unlines
-            [ "re-parsed doesn't match"
-            , "expected"
-            , show x
-            , "actual"
-            , show y
-            ]
+            assertFailure $ unlines
+                [ "re-parsed doesn't match"
+                , "expected"
+                , show x
+                , "actual"
+                , show y
+                ]
 #endif
+    -- Due to the imports being merged, the structural comparison will fail
+    -- Instead, we check the equality after merging
+    sequence_
+      [ checkField packageDescription
+      , checkField gpdScannedVersion
+      , checkField genPackageFlags
+      , checkField condLibrary
+      , checkField condSubLibraries
+      , checkField condForeignLibs
+      , checkField condExecutables
+      , checkField condTestSuites
+      , checkField condBenchmarks
+      ]
+
   where
     parse :: BS.ByteString -> IO GenericPackageDescription
     parse c = do

Cabal-tests/tests/ParserTests/regressions/Octree-0.5.condBenchmarks.expr

@@ -0,0 +1 @@
+[]

Cabal-tests/tests/ParserTests/regressions/Octree-0.5.condExecutables.expr

@@ -0,0 +1 @@
+[]

Cabal-tests/tests/ParserTests/regressions/Octree-0.5.condForeignLibs.expr

@@ -0,0 +1 @@
+[]

Cabal-tests/tests/ParserTests/regressions/Octree-0.5.condLibrary.expr

@@ -0,0 +1,109 @@
+Just
+  CondNode {
+    condTreeData = Library {
+      libName = LMainLibName,
+      exposedModules = [
+        ModuleName "Data.Octree"],
+      reexportedModules = [],
+      signatures = [],
+      libExposed = True,
+      libVisibility =
+      LibraryVisibilityPublic,
+      libBuildInfo = BuildInfo {
+        buildable = True,
+        buildTools = [],
+        buildToolDepends = [],
+        cppOptions = [],
+        asmOptions = [],
+        cmmOptions = [],
+        ccOptions = [],
+        cxxOptions = [],
+        jsppOptions = [],
+        ldOptions = [],
+        hsc2hsOptions = [],
+        pkgconfigDepends = [],
+        frameworks = [],
+        extraFrameworkDirs = [],
+        asmSources = [],
+        cmmSources = [],
+        cSources = [],
+        cxxSources = [],
+        jsSources = [],
+        hsSourceDirs = [],
+        otherModules = [
+          ModuleName
+            "Data.Octree.Internal"],
+        virtualModules = [],
+        autogenModules = [],
+        defaultLanguage = Nothing,
+        otherLanguages = [],
+        defaultExtensions = [],
+        otherExtensions = [],
+        oldExtensions = [
+          EnableExtension
+            ScopedTypeVariables],
+        extraLibs = [],
+        extraLibsStatic = [],
+        extraGHCiLibs = [],
+        extraBundledLibs = [],
+        extraLibFlavours = [],
+        extraDynLibFlavours = [],
+        extraLibDirs = [],
+        extraLibDirsStatic = [],
+        includeDirs = [],
+        includes = [],
+        autogenIncludes = [],
+        installIncludes = [],
+        options = PerCompilerFlavor
+          []
+          [],
+        profOptions = PerCompilerFlavor
+          []
+          [],
+        sharedOptions =
+        PerCompilerFlavor [] [],
+        profSharedOptions =
+        PerCompilerFlavor [] [],
+        staticOptions =
+        PerCompilerFlavor [] [],
+        customFieldsBI = [],
+        targetBuildDepends = [
+          Dependency
+            (PackageName "base")
+            (IntersectVersionRanges
+              (OrLaterVersion
+                (mkVersion [4, 0]))
+              (EarlierVersion
+                (mkVersion [4, 7])))
+            mainLibSet,
+          Dependency
+            (PackageName "AC-Vector")
+            (OrLaterVersion
+              (mkVersion [2, 3, 0]))
+            mainLibSet,
+          Dependency
+            (PackageName "QuickCheck")
+            (OrLaterVersion
+              (mkVersion [2, 4, 0]))
+            mainLibSet],
+        mixins = []}},
+    condTreeConstraints = [
+      Dependency
+        (PackageName "base")
+        (IntersectVersionRanges
+          (OrLaterVersion
+            (mkVersion [4, 0]))
+          (EarlierVersion
+            (mkVersion [4, 7])))
+        mainLibSet,
+      Dependency
+        (PackageName "AC-Vector")
+        (OrLaterVersion
+          (mkVersion [2, 3, 0]))
+        mainLibSet,
+      Dependency
+        (PackageName "QuickCheck")
+        (OrLaterVersion
+          (mkVersion [2, 4, 0]))
+        mainLibSet],
+    condTreeComponents = []}

Cabal-tests/tests/ParserTests/regressions/Octree-0.5.condSubLibraries.expr

@@ -0,0 +1 @@
+[]