Properly link filename compatibility checks into cabal check (#7479)

* Properly link filename compatibility checks into `cabal check` * Improve consistency and clarity of Check error messages
haskell · Aug 15, 2021 · 0b06a13 · 0b06a13
1 parent aff39d0
commit 0b06a13
Show file tree

Hide file tree

Showing 9 changed files with 93 additions and 100 deletions.
diff --git a/Cabal-tests/tests/ParserTests/regressions/assoc-cpp-options.check b/Cabal-tests/tests/ParserTests/regressions/assoc-cpp-options.check
@@ -1 +1 @@
-'cpp-options': -traditional is not portable C-preprocessor flag
+'cpp-options: -traditional' is not a portable C-preprocessor flag.
diff --git a/Cabal-tests/tests/ParserTests/regressions/denormalised-paths.cabal b/Cabal-tests/tests/ParserTests/regressions/denormalised-paths.cabal
@@ -29,8 +29,12 @@ tested-with:
    || ==8.8.1
 
 extra-source-files:
+  -- this is fine
+  files/**/*.md
+  -- collection of invalid paths
   files/**/*.txt/
   files/../foo.txt
+  files/<>/*.txt
 
 source-repository head
   type:     git
@@ -69,3 +73,6 @@ library
 
   -- this is the only case catched by Cabal-3.0.2.0
   hs-source-dirs:   ../../assoc/src
+
+  -- globs not allowed in field
+  c-sources: c/**/*.c
diff --git a/Cabal-tests/tests/ParserTests/regressions/denormalised-paths.check b/Cabal-tests/tests/ParserTests/regressions/denormalised-paths.check
@@ -1,12 +1,11 @@
 The 'subdir' field of a source-repository is not a good relative path: "trailing same directory segment: ."
+The paths 'files/<>/*.txt', 'c/**/*.c', 'C:foo/bar', '||s' are invalid on Windows, which would cause portability problems for this package. Windows file names cannot contain any of the characters ":*?<>|" and there a few reserved names including "aux", "nul", "con", "prn", "com1-9", "lpt1-9" and "clock$".
 'hs-source-dirs: ../../assoc/src' is a relative path outside of the source tree. This will not work when generating a tarball with 'sdist'.
-'extra-source-files: files/**/*.txt/' is not good relative path: trailing slash
-'extra-source-files: files/../foo.txt' is not good relative path: parent directory segment: ..
-'license-file: LICENSE2/' is not good relative path: trailing slash
-'license-file: .' is not good relative path: trailing dot segment
-'hs-source-dirs: src/.' is not good relative path: trailing same directory segment: .
-'hs-source-dirs: src/../src' is not good relative path: parent directory segment: ..
-'hs-source-dirs: src/../../assoc/src' is not good relative path: parent directory segment: ..
-'hs-source-dirs: C:foo/bar' is not good relative path: reserved character ':'
-'hs-source-dirs: ||s' is not good relative path: reserved character '|'
-'hs-source-dirs: ../../assoc/src' is not good relative path: parent directory segment: ..
+'extra-source-files: files/**/*.txt/' is not a good relative path: "trailing slash"
+'extra-source-files: files/../foo.txt' is not a good relative path: "parent directory segment: .."
+'license-file: LICENSE2/' is not a good relative path: "trailing slash"
+'license-file: .' is not a good relative path: "trailing dot segment"
+'hs-source-dirs: src/.' is not a good relative path: "trailing same directory segment: ."
+'hs-source-dirs: src/../src' is not a good relative path: "parent directory segment: .."
+'hs-source-dirs: src/../../assoc/src' is not a good relative path: "parent directory segment: .."
+'hs-source-dirs: ../../assoc/src' is not a good relative path: "parent directory segment: .."
diff --git a/Cabal-tests/tests/ParserTests/regressions/extensions-paths-5054.check b/Cabal-tests/tests/ParserTests/regressions/extensions-paths-5054.check
@@ -1 +1 @@
-The package uses RebindableSyntax with OverloadedStrings or OverloadedLists in default-extensions, and also Paths_ autogen module. That configuration is known to cause compile failures with Cabal < 2.2. To use these default-extensions with Paths_ autogen module specify at least 'cabal-version: 2.2'.
+Packages using RebindableSyntax with OverloadedStrings or OverloadedLists in default-extensions, in conjunction with the autogenerated module Paths_*, are known to cause compile failures with Cabal < 2.2. To use these default-extensions with a Paths_* autogen module, specify at least 'cabal-version: 2.2'.
diff --git a/Cabal/src/Distribution/PackageDescription/Check.hs b/Cabal/src/Distribution/PackageDescription/Check.hs
diff --git a/cabal-testsuite/PackageTests/AutogenModules/Package/setup.cabal.out b/cabal-testsuite/PackageTests/AutogenModules/Package/setup.cabal.out
@@ -14,7 +14,7 @@ On executable 'Exe' an 'autogen-module' is not on 'other-modules'
 On test suite 'Test' an 'autogen-module' is not on 'other-modules'
 On benchmark 'Bench' an 'autogen-module' is not on 'other-modules'
 Packages using 'cabal-version: 2.0' and the autogenerated module Paths_* must include it also on the 'autogen-modules' field besides 'exposed-modules' and 'other-modules'. This specifies that the module does not come with the package and is generated on setup. Modules built with a custom Setup.hs script also go here to ensure that commands like sdist don't fail.
-The filename ./my.cabal does not match package name (expected: AutogenModules.cabal)
+The filename './my.cabal' does not match package name (expected: 'AutogenModules.cabal')
 Note: the public hackage server would reject this package.
 Building source dist for AutogenModules-0.1...
 cabal: Error: Could not find module: MyLibHelperModule with any suffix: ["gc","chs","hsc","x","y","ly","cpphs","hs","lhs","hsig","lhsig"]. If the module is autogenerated it should be added to 'autogen-modules'.
diff --git a/cabal-testsuite/PackageTests/AutogenModules/Package/setup.out b/cabal-testsuite/PackageTests/AutogenModules/Package/setup.out
@@ -14,7 +14,7 @@ On executable 'Exe' an 'autogen-module' is not on 'other-modules'
 On test suite 'Test' an 'autogen-module' is not on 'other-modules'
 On benchmark 'Bench' an 'autogen-module' is not on 'other-modules'
 Packages using 'cabal-version: 2.0' and the autogenerated module Paths_* must include it also on the 'autogen-modules' field besides 'exposed-modules' and 'other-modules'. This specifies that the module does not come with the package and is generated on setup. Modules built with a custom Setup.hs script also go here to ensure that commands like sdist don't fail.
-The filename ./my.cabal does not match package name (expected: AutogenModules.cabal)
+The filename './my.cabal' does not match package name (expected: 'AutogenModules.cabal')
 Note: the public hackage server would reject this package.
 Building source dist for AutogenModules-0.1...
 setup: Error: Could not find module: MyLibHelperModule with any suffix: ["gc","chs","hsc","x","y","ly","cpphs","hs","lhs","hsig","lhsig"]. If the module is autogenerated it should be added to 'autogen-modules'.
diff --git a/changelog.d/path-validation b/changelog.d/path-validation
@@ -0,0 +1,11 @@
+synopsis: Fix bugs in filename validation
+packages: Cabal
+prs: #7429 #7479
+issues: #7426
+
+description: {
+
+- Relative paths starting with single-character directories are now properly allowed
+- `cabal check` rejects paths which are invalid on Windows or in tarballs
+
+}
diff --git a/changelog.d/rel-path-check b/changelog.d/rel-path-check
Original file line number	Diff line number	Diff line change
		@@ -1 +1 @@
		'cpp-options': -traditional is not portable C-preprocessor flag
		'cpp-options: -traditional' is not a portable C-preprocessor flag.
Original file line number	Diff line number	Diff line change
		@@ -1 +1 @@
		The package uses RebindableSyntax with OverloadedStrings or OverloadedLists in default-extensions, and also Paths_ autogen module. That configuration is known to cause compile failures with Cabal < 2.2. To use these default-extensions with Paths_ autogen module specify at least 'cabal-version: 2.2'.
		Packages using RebindableSyntax with OverloadedStrings or OverloadedLists in default-extensions, in conjunction with the autogenerated module Paths_, are known to cause compile failures with Cabal < 2.2. To use these default-extensions with a Paths_ autogen module, specify at least 'cabal-version: 2.2'.