Merge pull request #2577 from martijnbastiaan/bump-tasty

martijnbastiaan · web-flow · commit 540cf0e6e21e · 2023-09-17T18:49:09.000+02:00
Bump Tasty to released version (1.5)
diff --git a/.ci/build.sh b/.ci/build.sh
@@ -23,11 +23,6 @@ if [[ "$GHC_HEAD" != "yes" ]]; then
 fi
 set -u
 
-cabal v2-build clash-prelude --write-ghc-environment-files=always
-# Undo mmap crash workaround for clash-cosim, see PR #2572.
-# It uses a custom setup, which can't be linked with -rtsopts
-GHCRTS="" cabal v2-build clash-cosim --write-ghc-environment-files=always
-
 # Build with default constraints
 cabal v2-build all --write-ghc-environment-files=always
 
diff --git a/.ci/cabal.project.local b/.ci/cabal.project.local
@@ -10,7 +10,7 @@ package *
 
 package clash-prelude
   ghc-options: -Werror
-  flags: +doctests +multiple-hidden
+  flags: +doctests +multiple-hidden -workaround-ghc-mmap-crash
   tests: True
   benchmarks: True
 
@@ -20,10 +20,11 @@ package clash-prelude
 package clash-lib
   ghc-options: -Werror
   tests: True
-  flags: +debug
+  flags: +debug -workaround-ghc-mmap-crash
 
 package clash-ghc
   ghc-options: -Werror
+  flags: -workaround-ghc-mmap-crash
 
 package clash-cosim
   ghc-options: -Werror
@@ -47,7 +48,7 @@ package clash-lib-hedgehog
 package clash-testsuite
   ghc-options: -Werror
   -- enable cosim
-  flags: +cosim +multiple-hidden
+  flags: +cosim +multiple-hidden -workaround-ghc-mmap-crash
 
 package clash-benchmark
   ghc-options: -Werror
diff --git a/.ci/clash-ffi-example-build.sh b/.ci/clash-ffi-example-build.sh
diff --git a/.ci/gitlab/common.yml b/.ci/gitlab/common.yml
@@ -5,7 +5,7 @@
   variables:
     # Note that we copy+paste the image name into CACHE_FALLBACK_KEY. If we don't,
     # $GHC_VERSION gets inserted at verbatim, instead of resolving to some ghc version.
-    CACHE_FALLBACK_KEY: $CI_JOB_NAME-master-ghcr.io/clash-lang/clash-ci-$GHC_VERSION:2023-08-22-1-3-non_protected
+    CACHE_FALLBACK_KEY: $CI_JOB_NAME-master-ghcr.io/clash-lang/clash-ci-$GHC_VERSION:2023-08-22-2-3-non_protected
     GIT_SUBMODULE_STRATEGY: recursive
     TERM: xterm-color
   retry:
@@ -14,15 +14,14 @@
       - runner_system_failure
       - stuck_or_timeout_failure
   cache:
-    key: $CI_JOB_NAME-$CI_COMMIT_REF_SLUG-$CI_JOB_IMAGE-1
+    key: $CI_JOB_NAME-$CI_COMMIT_REF_SLUG-$CI_JOB_IMAGE-2
     when: always
     paths:
       - cache.tar.zst
   before_script:
     - export THREADS=$(./.ci/effective_cpus.sh)
     - export CABAL_JOBS=$(./.ci/effective_cpus.sh)
     - export CABAL_DIR=$HOME/.cabal
-    - if [[ "$WORKAROUND_GHC_MMAP_CRASH" == "yes" ]]; then export GHCRTS="-xm20000000"; fi
     - export
     - tar -xf cache.tar.zst -C / || true
     - .ci/setup.sh
diff --git a/.ci/gitlab/test.yml b/.ci/gitlab/test.yml
@@ -28,7 +28,6 @@ stages:
     - export CABAL_DIR=$HOME/.cabal
     - export clash_lib_datadir=$(pwd)/clash-lib/
     - export clash_cosim_datadir=$(pwd)/clash-cosim/
-    - if [[ "$WORKAROUND_GHC_MMAP_CRASH" == "yes" ]]; then export GHCRTS="-xm20000000"; fi
     - export
     - tar -xf dist.tar.zst -C /
 
@@ -51,7 +50,6 @@ stages:
     - export CABAL_DIR=$HOME/.cabal
     - export clash_lib_datadir=$(pwd)/clash-lib/
     - export clash_cosim_datadir=$(pwd)/clash-cosim/
-    - if [[ "$WORKAROUND_GHC_MMAP_CRASH" == "yes" ]]; then export GHCRTS="-xm20000000"; fi
     - export
     - tar -xf cache.tar.zst -C / || true
     - tar -xf dist.tar.zst -C /
@@ -169,7 +167,6 @@ ffi:example:
     - export clash_cosim_datadir=$(pwd)/clash-cosim/
     - export MASKBINS="$(mktemp -d)"
     - PATH="$MASKBINS:$PATH"
-    - if [[ "$WORKAROUND_GHC_MMAP_CRASH" == "yes" ]]; then export GHCRTS="-xm20000000"; fi
     - export
     - tar -xf cache.tar.zst -C / || true
       # The iverilog on CI cannot run the example, we only test it builds
@@ -180,7 +177,6 @@ ffi:example:
       # Make sure we get custom cabals setting in the clash-example project too
     - cp cabal.project.local clash-ffi/example
   script:
-     - if [[ "$WORKAROUND_GHC_MMAP_CRASH" == "yes" ]]; then ./.ci/clash-ffi-example-build.sh; fi
      - cd clash-ffi/example && ./run-iverilog.sh
   after_script:
     - tar -cf - /root/.cabal | zstd -T${THREADS} -3 > cache.tar.zst
diff --git a/.ci/setup.sh b/.ci/setup.sh
@@ -78,6 +78,10 @@ if [ ! -f cabal.project.local ]; then
   fi
 
   set +u
+  if [[ "$WORKAROUND_GHC_MMAP_CRASH" == "yes" ]]; then
+    sed -i 's/-workaround-ghc-mmap-crash/+workaround-ghc-mmap-crash/g' cabal.project.local
+  fi
+
   if [[ "$GHC_HEAD" == "yes" ]]; then
     cat .ci/cabal.project.local.append-HEAD >> cabal.project.local
   fi
@@ -92,6 +96,11 @@ cat cabal.project.local
 rm -f ${HOME}/.cabal/config
 cabal user-config init
 sed -i "s/-- ghc-options:/ghc-options: -j$THREADS/g" ${HOME}/.cabal/config
+set +u
+if [[ "$WORKAROUND_GHC_MMAP_CRASH" == "yes" ]]; then
+  sed -i "s/ghc-options:/ghc-options: +RTS -xm20000000 -RTS -with-rtsopts=-xm20000000/g" ${HOME}/.cabal/config
+fi
+set -u
 sed -i "s/^[- ]*jobs:.*/jobs: $CABAL_JOBS/g" ${HOME}/.cabal/config
 sed -i "/remote-repo-cache:.*/d" ${HOME}/.cabal/config
 cat ${HOME}/.cabal/config
diff --git a/.ci/stack-8.10.yaml b/.ci/stack-8.10.yaml
@@ -18,7 +18,4 @@ extra-deps:
 - docopt-0.7.0.7@sha256:a3d2eac54cd77d8c0b306ff96fb57be55542f143d81766aa1ae51458ad790dbe,3655
 - prettyprinter-interp-0.2.0.0@sha256:45299b61bd6c27d594c1a72b5a8dd5734e791a59828725e4f4e420f3cc37232b,2016
 - infinite-list-0.1@sha256:4de250517ce75e128c766fbc1f23b5a778ea964e695e47f8e83e0f3b293091bf,2383
-- git: https://github.com/UnkindPartition/tasty.git
-  commit: e0e71bc40fcc1fa410f98a5963b9ed8eefa1e92d
-  subdirs:
-    - core
+- tasty-1.5@sha256:c62c96da1e9d65bf61ce583e9f7085eed1daeb62a45f3106ca252bf9ef87025b,2763
diff --git a/.ci/stack-8.6.yaml b/.ci/stack-8.6.yaml
@@ -30,7 +30,4 @@ extra-deps:
 - string-interpolate-0.3.1.2@sha256:4d0987f453c66040aa8e482fe28a7d3cdc9d8df01b698bc92f42a592cfb337db,4268
 - prettyprinter-interp-0.2.0.0@sha256:45299b61bd6c27d594c1a72b5a8dd5734e791a59828725e4f4e420f3cc37232b,2016
 - infinite-list-0.1@sha256:4de250517ce75e128c766fbc1f23b5a778ea964e695e47f8e83e0f3b293091bf,2383
-- git: https://github.com/UnkindPartition/tasty.git
-  commit: e0e71bc40fcc1fa410f98a5963b9ed8eefa1e92d
-  subdirs:
-    - core
+- tasty-1.5@sha256:c62c96da1e9d65bf61ce583e9f7085eed1daeb62a45f3106ca252bf9ef87025b,2763
diff --git a/.ci/stack-8.8.yaml b/.ci/stack-8.8.yaml
@@ -25,7 +25,4 @@ extra-deps:
 - string-interpolate-0.3.1.2@sha256:4d0987f453c66040aa8e482fe28a7d3cdc9d8df01b698bc92f42a592cfb337db,4268
 - prettyprinter-interp-0.2.0.0@sha256:45299b61bd6c27d594c1a72b5a8dd5734e791a59828725e4f4e420f3cc37232b,2016
 - infinite-list-0.1@sha256:4de250517ce75e128c766fbc1f23b5a778ea964e695e47f8e83e0f3b293091bf,2383
-- git: https://github.com/UnkindPartition/tasty.git
-  commit: e0e71bc40fcc1fa410f98a5963b9ed8eefa1e92d
-  subdirs:
-    - core
+- tasty-1.5@sha256:c62c96da1e9d65bf61ce583e9f7085eed1daeb62a45f3106ca252bf9ef87025b,2763
diff --git a/.ci/stack-9.0.yaml b/.ci/stack-9.0.yaml
@@ -15,7 +15,4 @@ packages:
 extra-deps:
 - prettyprinter-interp-0.2.0.0@sha256:45299b61bd6c27d594c1a72b5a8dd5734e791a59828725e4f4e420f3cc37232b,2016
 - infinite-list-0.1@sha256:4de250517ce75e128c766fbc1f23b5a778ea964e695e47f8e83e0f3b293091bf,2383
-- git: https://github.com/UnkindPartition/tasty.git
-  commit: e0e71bc40fcc1fa410f98a5963b9ed8eefa1e92d
-  subdirs:
-    - core
+- tasty-1.5@sha256:c62c96da1e9d65bf61ce583e9f7085eed1daeb62a45f3106ca252bf9ef87025b,2763
diff --git a/.ci/stack-9.2.yaml b/.ci/stack-9.2.yaml
@@ -17,7 +17,4 @@ extra-deps:
 - hashable-1.3.5.0@sha256:3a2beeafb220f9de706568a7e4a5b3c762cc4c9f25c94d7ef795b8c2d6a691d7,4240
 - prettyprinter-interp-0.2.0.0@sha256:45299b61bd6c27d594c1a72b5a8dd5734e791a59828725e4f4e420f3cc37232b,2016
 - infinite-list-0.1@sha256:4de250517ce75e128c766fbc1f23b5a778ea964e695e47f8e83e0f3b293091bf,2383
-- git: https://github.com/UnkindPartition/tasty.git
-  commit: e0e71bc40fcc1fa410f98a5963b9ed8eefa1e92d
-  subdirs:
-    - core
+- tasty-1.5@sha256:c62c96da1e9d65bf61ce583e9f7085eed1daeb62a45f3106ca252bf9ef87025b,2763
diff --git a/.ci/stack-9.4.yaml b/.ci/stack-9.4.yaml
@@ -22,7 +22,4 @@ extra-deps:
  - hashable-1.4.1.0
  - git: https://github.com/christiaanb/hint.git
    commit: 7803c34c8ae1d83c0f7c13fe6b30fcb3abd0ac51
- - git: https://github.com/UnkindPartition/tasty.git
-   commit: e0e71bc40fcc1fa410f98a5963b9ed8eefa1e92d
-   subdirs:
-     - core
+ - tasty-1.5@sha256:c62c96da1e9d65bf61ce583e9f7085eed1daeb62a45f3106ca252bf9ef87025b,2763
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -138,7 +138,7 @@ jobs:
         CABAL_JOBS: 2
         MULTIPLE_HIDDEN: ${{ matrix.multiple_hidden }}
         CI_COMMIT_BRANCH: ${{ github.base_ref }}
-        GHCRTS: ${{ fromJSON('["","-xm20000000"]')[matrix.workaround_ghc_mmap_crash == 'yes'] }}
+        WORKAROUND_GHC_MMAP_CRASH: ${{ matrix.workaround_ghc_mmap_crash }}
 
     steps:
       - name: Checkout
@@ -163,10 +163,9 @@ jobs:
         with:
           path: |
             dist-newstyle
-            ~/.cabal/packages
             ~/.cabal/store
 
-          key: ${{ matrix.ghc }}-${{ hashFiles('frozen') }}
+          key: ${{ matrix.ghc }}-${{ hashFiles('frozen', 'cabal.project') }}
           restore-keys: ${{ matrix.ghc }}-
 
       - name: Build Clash
diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml
@@ -67,7 +67,6 @@ nix-build:
   needs: []
   stage: test
   before_script:
-   - if [[ "$WORKAROUND_GHC_MMAP_CRASH" == "yes" ]]; then export GHCRTS="-xm20000000"; fi
    - nix-env -i gawk
   script:
     - nix-build -j$(./.ci/effective_cpus.sh)
diff --git a/benchmark/profiling/prepare/clash-profiling-prepare.cabal b/benchmark/profiling/prepare/clash-profiling-prepare.cabal
@@ -26,7 +26,7 @@ library
 executable clash-profile-normalization-prepare
   main-is:             profile-normalization-prepare.hs
   default-language:    Haskell2010
-  ghc-options:         -Wall -Wcompat -rtsopts
+  ghc-options:         -Wall -Wcompat
   build-depends:       base,
                        binary,
                        bytestring,
@@ -38,7 +38,7 @@ executable clash-profile-normalization-prepare
 executable clash-profile-netlist-prepare
   main-is:             profile-netlist-prepare.hs
   default-language:    Haskell2010
-  ghc-options:         -Wall -Wcompat -rtsopts
+  ghc-options:         -Wall -Wcompat
   build-depends:       base,
                        binary,
                        bytestring,
diff --git a/benchmark/profiling/run/clash-profiling.cabal b/benchmark/profiling/run/clash-profiling.cabal
@@ -12,7 +12,7 @@ cabal-version:       >=1.10
 executable clash-profile-normalization-run
   main-is:             profile-normalization-run.hs
   default-language:    Haskell2010
-  ghc-options:         -O2 -Wall -Wcompat -rtsopts
+  ghc-options:         -O2 -Wall -Wcompat
   build-depends:       base,
                        binary,
                        bytestring,
@@ -30,7 +30,7 @@ executable clash-profile-normalization-run
 executable clash-profile-netlist-run
   main-is:             profile-netlist-run.hs
   default-language:    Haskell2010
-  ghc-options:         -O2 -Wall -Wcompat -rtsopts
+  ghc-options:         -O2 -Wall -Wcompat
   build-depends:       base,
                        binary,
                        bytestring,
diff --git a/cabal.project b/cabal.project
@@ -16,7 +16,7 @@ write-ghc-environment-files: always
 -- index state, to go along with the cabal.project.freeze file. update the index
 -- state by running `cabal update` twice and looking at the index state it
 -- displays to you (as the second update will be a no-op)
-index-state: 2023-08-11T09:59:08Z
+index-state: 2023-09-12T05:36:44Z
 
 -- For some reason the `clash-testsuite` executable fails to run without
 -- this, as it cannot find the related library...
@@ -82,8 +82,3 @@ package recursion-schemes
 package regex-tdfa
     optimization: 2
 
-source-repository-package
-    type: git
-    location: https://github.com/UnkindPartition/tasty.git
-    tag: 249bee98b588ef6936925e268ea7707f5e450c30
-    subdir: core
diff --git a/clash-cores/clash-cores.cabal b/clash-cores/clash-cores.cabal
@@ -166,7 +166,7 @@ test-suite unittests
   hs-source-dirs: test
   type: exitcode-stdio-1.0
   main-is: unittests.hs
-  ghc-options: -rtsopts
+
   if !flag(unittests)
     buildable: False
 
@@ -196,7 +196,7 @@ test-suite doctests
   type:             exitcode-stdio-1.0
   default-language: Haskell2010
   main-is:          doctests.hs
-  ghc-options:      -Wall -Wcompat -threaded -rtsopts
+  ghc-options:      -Wall -Wcompat -threaded
   hs-source-dirs:   test
 
   if !flag(doctests)
diff --git a/clash-cosim/clash-cosim.cabal b/clash-cosim/clash-cosim.cabal
@@ -117,6 +117,6 @@ test-suite test
       tasty-hunit,
       tasty-quickcheck,
       template-haskell
-  ghc-options:   -Wall -Wcompat -rtsopts
+  ghc-options:   -Wall -Wcompat
   if flag(pedantic)
     ghc-options: -Werror
diff --git a/clash-ffi/clash-ffi.cabal b/clash-ffi/clash-ffi.cabal
@@ -91,7 +91,6 @@ executable ffi-interface-tests
     ExistentialQuantification
   hs-source-dirs: tests
   main-is: Main.hs
-  ghc-options: -rtsopts
   other-modules:
     Clash.FFI.Test
     Clash.FFI.Test.Instances
diff --git a/clash-ghc/clash-ghc.cabal b/clash-ghc/clash-ghc.cabal
@@ -65,12 +65,24 @@ flag use-ghc-paths
   default: False
   manual: True
 
+flag workaround-ghc-mmap-crash
+  description:
+    Only use this flag when hit by GHC bug #19421. See clash-compiler PR #2444.
+  default: False
+  manual: True
+
 executable clash
   Main-Is:            src-ghc/Batch.hs
   Build-Depends:      base, clash-ghc
-  GHC-Options:        -Wall -Wcompat -threaded -rtsopts -with-rtsopts=-A128m
+  GHC-Options:        -Wall -Wcompat -threaded -rtsopts
   if flag(dynamic)
     GHC-Options: -dynamic
+  -- Note that multiple -with-rtsopts are not cumulative, so we can't add the
+  -- common RTS options in the unconditional GHC-Options
+  if flag(workaround-ghc-mmap-crash)
+    GHC-Options: "-with-rtsopts=-A128m -xm20000000"
+  else
+    GHC-Options: -with-rtsopts=-A128m
   extra-libraries:    pthread
   default-language:   Haskell2010
 
diff --git a/clash-lib/clash-lib.cabal b/clash-lib/clash-lib.cabal
@@ -91,6 +91,12 @@ flag doctests
   default: True
   manual: True
 
+flag workaround-ghc-mmap-crash
+  description:
+    Only use this flag when hit by GHC bug #19421. See clash-compiler PR #2444.
+  default: False
+  manual: True
+
 common common-options
   default-language:   Haskell2010
   default-extensions: BangPatterns
@@ -339,7 +345,7 @@ executable v16-upgrade-primitives
     directory,
     stringsearch,
     Glob
-  GHC-Options:        -Wall -Wcompat -rtsopts
+  GHC-Options:        -Wall -Wcompat
   default-language:   Haskell2010
 
 executable static-files
@@ -352,7 +358,7 @@ executable static-files
     extra,
     filepath
   Other-Modules:      Paths_clash_lib
-  GHC-Options:        -Wall -Wcompat -rtsopts
+  GHC-Options:        -Wall -Wcompat
   default-language:   Haskell2010
   if impl(ghc >= 9.2.0)
     buildable: False
@@ -362,7 +368,7 @@ test-suite doctests
   type:             exitcode-stdio-1.0
   default-language: Haskell2010
   main-is:          doctests.hs
-  ghc-options:      -Wall -Wcompat -threaded -rtsopts
+  ghc-options:      -Wall -Wcompat -threaded
   hs-source-dirs:   tests
 
   if !flag(doctests)
@@ -379,7 +385,13 @@ test-suite unittests
   type:             exitcode-stdio-1.0
   default-language: Haskell2010
   main-is:          unittests.hs
-  ghc-options:      -Wall -Wcompat -threaded -rtsopts -with-rtsopts=-N
+  ghc-options:      -Wall -Wcompat -threaded
+  -- Note that multiple -with-rtsopts are not cumulative, so we can't add the
+  -- common RTS options in the unconditional GHC-Options
+  if flag(workaround-ghc-mmap-crash)
+    GHC-Options: "-with-rtsopts=-N -xm20000000"
+  else
+    GHC-Options: -with-rtsopts=-N
   hs-source-dirs:   tests
 
   if !flag(unittests)
diff --git a/clash-prelude/clash-prelude.cabal b/clash-prelude/clash-prelude.cabal
diff --git a/clash-term/clash-term.cabal b/clash-term/clash-term.cabal
diff --git a/nix/overlay.nix b/nix/overlay.nix
diff --git a/stack.yaml b/stack.yaml
diff --git a/tests/clash-testsuite.cabal b/tests/clash-testsuite.cabal
diff --git a/tests/src/Test/Tasty/Clash.hs b/tests/src/Test/Tasty/Clash.hs
