Use normalized filepaths in dhall testsuite (#2593)

* Updated hnix dependencies in all Stack configurations

Also added `mkParsec` method to MonadParsec instance for megaparsec>=9.4

* Require turtle >=1.6

* Removed depecated functions

* Use normalized filepaths in tests

* Made normalization tests a bit more chatty

* Fix: Exclude unit test from beta-normalization in Dhall.Test.Normalization

* Improved usage of guards for path selection in test suite

* Normalize filepath in guards for path selection

* Added turtle-1.6.2 to Nix setup

* Unconditionally import Data.List in Dhall.Test.Util

* Added small comment on the use of toDhallPath in Dhall.Test.Tags

* Ran stylish-haskell

* Log pkg-config path of libsodium in the CI

* Log the libsodium version in the CI

* Do not install a GHC with ghcup in the CI

* Fixed pkg-config output in the CI

* Bump cache_generation

* Bumped version of some GH actions

* Changed cache key

* Small comment on pkg-config output

* Added .envrc to .gitignore

* Fixed deprecation warnings in dhall-nixpkgs package

Author: mmhat

.github/workflows/main.yml

@@ -1,5 +1,5 @@
 env:
-  cache_generation: 2021-06-22
+  cache_generation: 2024-06-13
 
 # NOTE: Please keep .mergify.yml in sync when adding or removing any jobs.
 name: main
@@ -45,20 +45,23 @@ jobs:
         with:
           enable-stack: true
           stack-version: "latest"
+          stack-no-global: true
       - name: "Cache"
-        uses: actions/cache@v3
+        uses: actions/cache@v4
         with:
-          key: ${{ matrix.os.runner }}-${{ runner.arch }}-${{ hashFiles(matrix.stack-yaml) }}-${{ env.cache_generation }}
+          key: ${{ matrix.os.runner }}-${{ runner.arch }}-${{ env.cache_generation }}-${{ hashFiles(matrix.stack-yaml) }}
           restore-keys: |
-            ${{ matrix.os.runner }}-${{ runner.arch }}-
+            ${{ matrix.os.runner }}-${{ runner.arch }}-${{ env.cache_generation }}-
           path: |
             ${{ steps.setup-haskell-cabal.outputs.stack-root }}
-      - name: Install libsodium
+      - name: "Install libsodium"
         shell: bash
         run: |
           if [ '${{matrix.os.runner}}' == 'ubuntu-latest' ]; then
             sudo apt-get install -y libsodium-dev
           fi
+          echo "::debug::'pkg-config libsodium' output:"
+          pkg-config --print-errors --libs libsodium || true
       - name: "Build"
         shell: bash
         run: |
@@ -155,7 +158,7 @@ jobs:
           package 'dhall-yaml' "bin/dhall-to-yaml-ng${exe}" "bin/yaml-to-dhall${exe}"
       - name: "Upload package"
         if: ${{ matrix.stack-yaml == 'stack.yaml' }}
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         with:
           name: 'dhall-${{ runner.os }}-${{ runner.arch }}.${{ matrix.os.file-extension }}'
           path: 'dhall-*${{ runner.os }}-${{ runner.arch }}.${{ matrix.os.file-extension }}'

.gitignore

@@ -19,6 +19,7 @@ cabal.sandbox.config
 cabal.project.local
 cabal.project.local~
 .HTF/
+.envrc
 .ghc.environment.*
 .cache
 .history

dhall-docs/dhall-docs.cabal

@@ -152,7 +152,7 @@ Test-Suite tasty
         tasty        < 1.5                ,
         tasty-silver < 3.4                ,
         tasty-hunit  >= 0.10     && < 0.11,
-        turtle       < 1.7                ,
+        turtle       >= 1.6      && < 1.7 ,
         text
     GHC-Options: -Wall
     Default-Language: Haskell2010

dhall-nixpkgs/Main.hs

@@ -681,7 +681,7 @@ githubToNixpkgs GitHub{ name, uri, rev = maybeRev, hash, fetchSubmodules, direct
                 ExitFailure _ -> die (FailedToFetchGitHubArchive args)
 
             case Text.lines text of
-                [ sha256, path ] -> return (r, sha256, Turtle.fromText path)
+                [ sha256, path ] -> return (r, sha256, Text.unpack path)
                 _                -> die (FailedToParseNixPrefetchURL args)
 
         _ -> do
@@ -706,7 +706,7 @@ githubToNixpkgs GitHub{ name, uri, rev = maybeRev, hash, fetchSubmodules, direct
                 Right n -> do
                     return n
 
-            return (rev, sha256, Turtle.fromText path)
+            return (rev, sha256, Text.unpack path)
 
     let finalName =
             case name of
@@ -723,15 +723,11 @@ githubToNixpkgs GitHub{ name, uri, rev = maybeRev, hash, fetchSubmodules, direct
         then return ()
         else die (MissingFile expressionFile)
 
-    expressionText <- Turtle.readTextFile expressionFile
+    expressionText <- Text.IO.readFile expressionFile
 
-    let expressionFileString = Turtle.encodeString expressionFile
+    expression <- Dhall.Core.throws (Dhall.Parser.exprFromText expressionFile expressionText)
 
-    expression <- Dhall.Core.throws (Dhall.Parser.exprFromText expressionFileString expressionText)
-
-    let status = Dhall.Import.emptyStatus baseDirectoryString
-          where
-            baseDirectoryString = Turtle.encodeString baseDirectory
+    let status = Dhall.Import.emptyStatus baseDirectory
 
     dependencies <- Turtle.reduce Foldl.nub (State.evalStateT (findExternalDependencies expression) status)
 
@@ -781,16 +777,11 @@ directoryToNixpkgs Directory{ name, directory, file, source, document, fixedOutp
         else do
             die (MissingFile expressionFile)
 
-    expressionText <- Turtle.readTextFile expressionFile
-
-    let expressionFileString = Turtle.encodeString expressionFile
+    expressionText <- Text.IO.readFile expressionFile
 
-    expression <- Dhall.Core.throws (Dhall.Parser.exprFromText expressionFileString expressionText)
+    expression <- Dhall.Core.throws (Dhall.Parser.exprFromText expressionFile expressionText)
 
-    let status = Dhall.Import.emptyStatus directoryString
-          where
-            directoryString =
-                Turtle.encodeString (Turtle.directory expressionFile)
+    let status = Dhall.Import.emptyStatus (Turtle.directory expressionFile)
 
     dependencies <- Turtle.reduce Foldl.nub (State.evalStateT (findExternalDependencies expression) status)
 
@@ -804,11 +795,9 @@ directoryToNixpkgs Directory{ name, directory, file, source, document, fixedOutp
 
     let buildDhallDirectoryPackage = "buildDhallDirectoryPackage"
 
-    let src | null directoryString        = directoryString
-            | last directoryString == '/' = init directoryString
-            | otherwise                   = directoryString
-          where
-            directoryString = Turtle.encodeString directory
+    let src | null directory        = directory
+            | last directory == '/' = init directory
+            | otherwise             = directory
 
     let functionParams =
             makeNixFunctionParams buildDhallDirectoryPackage nixDependencies
@@ -852,7 +841,7 @@ data Error
     | FailedToCloneRepository [Text]
     | FailedToParseNixPrefetchGit [Text] String
     | MissingFile FilePath
-    
+
 renderError :: Error -> Text
 renderError e = case e of
     MissingSemanticIntegrityCheck url ->

dhall-nixpkgs/dhall-nixpkgs.cabal

@@ -34,7 +34,7 @@ Executable dhall-to-nixpkgs
                      , prettyprinter        >= 1.7.0    && < 1.8
                      , text                 >= 0.11.1.0 && < 2.1
                      , transformers         >= 0.2.0.0  && < 0.6
-                     , turtle                              < 1.6
+                     , turtle               >= 1.6      && < 1.7
                      , network-uri                         < 2.8
   Default-Language:    Haskell2010
   GHC-Options:         -Wall -threaded

dhall/dhall.cabal

@@ -452,7 +452,7 @@ Test-Suite tasty
         tasty-quickcheck          >= 0.9.2    && < 0.11,
         tasty-silver                             < 3.4 ,
         temporary                 >= 1.2.1    && < 1.4 ,
-        turtle                                   < 1.7 ,
+        turtle                    >= 1.6      && < 1.7 ,
     Default-Language: Haskell2010
 
 Test-Suite doctest

dhall/src/Dhall/Diff.hs

@@ -41,16 +41,16 @@ import Dhall.Syntax
 import Numeric.Natural       (Natural)
 import Prettyprinter         (Doc, Pretty)
 
-import qualified Data.Algorithm.Diff    as Algo.Diff
+import qualified Data.Algorithm.Diff   as Algo.Diff
 import qualified Data.List.NonEmpty
 import qualified Data.Set
 import qualified Data.Text
-import qualified Data.Time              as Time
+import qualified Data.Time             as Time
 import qualified Dhall.Map
-import qualified Dhall.Normalize        as Normalize
-import qualified Dhall.Pretty.Internal  as Internal
-import qualified Dhall.Syntax           as Syntax
-import qualified Prettyprinter          as Pretty
+import qualified Dhall.Normalize       as Normalize
+import qualified Dhall.Pretty.Internal as Internal
+import qualified Dhall.Syntax          as Syntax
+import qualified Prettyprinter         as Pretty
 
 {-| This type is a `Doc` enriched with a `same` flag to efficiently track if
     any difference was detected

dhall/src/Dhall/Parser/Combinators.hs

@@ -169,6 +169,10 @@ instance Text.Megaparsec.MonadParsec Void Text Parser where
 
     updateParserState f = Parser (Text.Megaparsec.updateParserState f)
 
+#if MIN_VERSION_megaparsec(9,4,0)
+    mkParsec f = Parser (Text.Megaparsec.mkParsec f)
+#endif
+
 instance Semigroup a => Semigroup (Parser a) where
     (<>) = liftA2 (<>)
 

dhall/tests/Dhall/Test/Diff.hs

@@ -3,9 +3,7 @@
 module Dhall.Test.Diff where
 
 import Data.Text  (Text)
-import Prelude    hiding (FilePath)
 import Test.Tasty (TestTree)
-import Turtle     (FilePath)
 
 import qualified Data.Text                 as Text
 import qualified Data.Text.IO              as Text.IO

dhall/tests/Dhall/Test/Format.hs

@@ -7,7 +7,6 @@ import Dhall.Parser (Header (..))
 import Dhall.Pretty (CharacterSet (..))
 import Test.Tasty   (TestTree)
 
-import qualified Control.Monad             as Monad
 import qualified Data.Text                 as Text
 import qualified Data.Text.IO              as Text.IO
 import qualified Dhall.Core                as Core
@@ -27,7 +26,7 @@ getTests = do
 
             let skip = [ "./tests/format/asciiA.dhall" ]
 
-            Monad.guard (path `notElem` skip)
+            path `Test.Util.pathNotIn` skip
 
             return path