Merge pull request #6723 from m-renaud/m-renaud-init-with-comments-go…

…lden

Add cabal init golden test for cabal file with field comments.

cabal-install/tests/UnitTests/Distribution/Client/Init/FileCreators.hs

@@ -41,6 +41,7 @@ tests = [ testGroup "cabal init goldens"
           [ checkCabalFileGolden exeFlags "exe-only-golden.cabal"
           , checkCabalFileGolden libAndExeFlags "lib-and-exe-golden.cabal"
           , checkCabalFileGolden libExeAndTestFlags "lib-exe-and-test-golden.cabal"
+          , checkCabalFileGolden libExeAndTestWithCommentsFlags "lib-exe-and-test-with-comments-golden.cabal"
           ]
         ]
 
@@ -154,6 +155,17 @@ libExeAndTestFlags = baseFlags {
   , testDirs = Just ["tests"]
   }
 
+-- ==================================================
+-- Lib, exe, and test suite with comments.
+
+libExeAndTestWithCommentsFlags :: InitFlags
+libExeAndTestWithCommentsFlags = libExeAndTestFlags {
+    minimal = Flag False
+  , noComments = Flag False
+  , quiet = Flag False
+  }
+
+
 
 -- ==================================================
 -- Test dependency.

tests/fixtures/init/lib-exe-and-test-with-comments-golden.cabal

@@ -0,0 +1,105 @@
+cabal-version:      2.4
+
+-- Initial package description
+-- 'lib-exe-and-test-with-comments-golden.cabal' generated by 'cabal init'.
+--   For further documentation, see http://haskell.org/cabal/users-guide/
+
+-- The name of the package.
+name:               foo
+
+-- The package version.  See the Haskell package versioning policy (PVP)
+-- for standards guiding when and how versions should be incremented.
+-- https://pvp.haskell.org
+-- PVP summary:      +-+------- breaking API changes
+--                   | | +----- non-breaking API additions
+--                   | | | +--- code changes with no API change
+version:            3.2.1
+
+-- A short (one-line) description of the package.
+synopsis:           The foo package
+
+-- A longer description of the package.
+-- description:
+
+-- URL for the project homepage or repository.
+homepage:           https://github.com/foo/foo
+
+-- A URL where users can report bugs.
+-- bug-reports:
+
+-- The license under which the package is released.
+license:            NONE
+
+-- The package author(s).
+author:             me
+
+-- An email address to which users can send suggestions, bug reports, and
+-- patches.
+maintainer:         [email protected]
+
+-- A copyright notice.
+-- copyright:
+
+category:           SomeCat
+
+-- Extra files to be distributed with the package, such as examples or a
+-- README.
+extra-source-files: CHANGELOG.md
+
+
+library
+  -- Modules exported by the library.
+  exposed-modules:    A, B
+
+  -- Modules included in this library but not exported.
+  -- other-modules:
+
+  -- LANGUAGE extensions used by modules in this package.
+  -- other-extensions:
+
+  -- Other library packages from which modules are imported.
+  build-depends:      base ^>=4.13.0.0, containers ^>=5.7.0.0, unordered-containers ^>=2.7.0.0
+
+  -- Directories containing source files.
+  hs-source-dirs:     src
+
+  -- Base language which the package is written in.
+  default-language:   Haskell2010
+
+
+executable foo
+  -- .hs or .lhs file containing the Main module.
+  main-is:            Main.hs
+
+  -- Modules included in this executable, other than Main.
+  -- other-modules:
+
+  -- LANGUAGE extensions used by modules in this package.
+  -- other-extensions:
+
+  -- Other library packages from which modules are imported.
+  build-depends:      base ^>=4.13.0.0, containers ^>=5.7.0.0, unordered-containers ^>=2.7.0.0
+
+  -- Directories containing source files.
+  hs-source-dirs:     app
+
+  -- Base language which the package is written in.
+  default-language:   Haskell2010
+
+
+test-suite foo-test
+  -- Base language which the package is written in.
+  default-language:   Haskell2010
+
+  -- The interface type and version of the test suite.
+  type:               exitcode-stdio-1.0
+
+  -- The directory where the test specifications are found.
+  hs-source-dirs:     tests
+
+  -- The entrypoint to the test suite.
+  main-is:            MyLibTest.hs
+
+  -- Test dependencies.
+  build-depends:      base ^>=4.13.0.0, containers ^>=5.7.0.0, unordered-containers ^>=2.7.0.0
+