WIP

IntersectMBO · Aug 16, 2024 · fbbe064 · fbbe064
1 parent 1b9c383
commit fbbe064
Show file tree

Hide file tree

Showing 4 changed files with 45 additions and 142 deletions.
diff --git a/.github/workflows/cabal.project.local.ci.Darwin b/.github/workflows/cabal.project.local.ci.Darwin
diff --git a/.github/workflows/cabal.project.local.ci.Linux b/.github/workflows/cabal.project.local.ci.Linux
diff --git a/.github/workflows/cabal.project.local.ci.MINGW64_NT-10.0-20348 b/.github/workflows/cabal.project.local.ci.MINGW64_NT-10.0-20348
diff --git a/.github/workflows/haskell.yml b/.github/workflows/haskell.yml
@@ -7,75 +7,31 @@ on:
 
 jobs:
   build:
-    runs-on: ${{ matrix.os }}
+    runs-on: ${{ matrix.sys.os }}
 
     strategy:
       fail-fast: false
       matrix:
         ghc: ["8.10.7", "9.6", "9.8"]
+        cabal: ["3.12"]
         # os: [ubuntu-latest, macos-latest, windows-latest]
-        os: [ubuntu-latest, windows-latest]
-
-    env:
-      # we need the LD_LIBRARY_PATH env var here because we ended up installing libsecp256k1 into /usr/local,
-      # pkg-config, *does* return the proper location, but the library does not appear to be properly referenced.
-      # FIXME: this is arguably a bug, and pkg-config should return the right values!
-      LD_LIBRARY_PATH: ${{ (matrix.os != 'windows-latest' && '/usr/local/lib') || '' }}
+        sys:
+          - { os: windows-latest, shell: 'C:/msys64/usr/bin/bash.exe -e {0}' }
+          - { os: ubuntu-latest, shell: bash }
 
     steps:
 
+    - name: Install system dependencies
+      uses: input-output-hk/actions/base@latest
+      with:
+        use-sodium-vrf: true
+
     - name: Install Haskell
       uses: input-output-hk/actions/haskell@latest
       id: setup-haskell
       with:
         ghc-version: ${{ matrix.ghc }}
-        cabal-version: "3.10.1.0"
-        pacman-packages: >
-          mingw-w64-x86_64-pkg-config
-          mingw-w64-x86_64-openssl
-          mingw-w64-x86_64-pcre
-          mingw-w64-x86_64-libsodium
-          mingw-w64-x86_64-sed
-          base-devel
-          autoconf-wrapper
-          autoconf
-          automake
-          libtool
-          make
-
-     # this seems to break something. It _must_ come after the pacman setup
-     # above. It appears as if PATHEXT is set _after_ ghcup install ghc/cabal, and
-     # as such we'd need pacman.exe instead.
-    - name: Setup Haskell
-      run: |
-        # Use GHCUP to manage ghc/cabal
-        ghcup install ghc --set ${{ matrix.ghc }}
-        ghcup install cabal --set 3.10.1.0
-
-        ghc --version
-        cabal --version
-
-    - name: "WIN: fixup cabal config"
-      if: runner.os == 'Windows'
-      run: |
-        # make sure cabal knows about msys64, and mingw64 tools. Not clear why C:/cabal/config is empty
-        # and C:/cabal doesn't even exist.  The ghcup bootstrap file should have create it in the image:
-        # See https://github.com/haskell/ghcup-hs/blob/787edc17af4907dbc51c85e25c490edd8d68b80b/scripts/bootstrap/bootstrap-haskell#L591
-        # So we'll do it by hand here for now.
-        #
-        # We'll _not_ add extra-include-dirs, or extra-lib-dirs, and rely on what's shipped with GHC.
-        # https://github.com/msys2/MINGW-packages/issues/10837#issuecomment-1047105402
-        # https://gitlab.haskell.org/ghc/ghc/-/issues/21111
-        # if we _do_ want them, this would be the lines to add below
-
-        $ghcMingwDir = Join-Path -Path $(ghc --print-libdir) `
-                                 -ChildPath ../mingw/x86_64-*-mingw32/lib/ `
-                                 -Resolve
-
-        cabal user-config -a "extra-prog-path: C:/msys64/mingw64/bin, C:/msys64/usr/bin" `
-                          -a "extra-include-dirs: C:/msys64/mingw64/include" `
-                          -a ("extra-lib-dirs: {0}, C:/msys64/mingw64/lib" -f $ghcMingwDir) `
-                          -f init
+        cabal-version: ${{ matrix.cabal }}
 
     - name: Set cache version
       run: echo "CACHE_VERSION=grFfw7r" >> $GITHUB_ENV
@@ -85,54 +41,23 @@ jobs:
     - name: "[PowerShell] Add build script path"
       if: runner.os == 'Windows'
       shell: pwsh
-      run: Add-Content $env:GITHUB_PATH "$(pwd)/.github/bin"
+      run: "PATH=$(pwd)\.github\bin;$env:PATH" >> $env:GITHUB_ENV
 
     - name: "[Bash] Add build script path"
       if: runner.os != 'Windows'
       run: echo "$(pwd)/.github/bin" >> $GITHUB_PATH
 
-    - name: "LINUX: Install build environment (apt-get)"
-      if: runner.os == 'Linux'
-      run: |
-        sudo apt-get update
-        sudo apt-get -y install libsodium23 libsodium-dev
-        sudo apt-get -y remove --purge software-properties-common
-        sudo apt-get -y autoremove
-
-    - name: "MAC: Install build environment (brew)"
-      if: runner.os == 'macOS'
-      run: |
-        brew install libsodium
-        brew install pcre
-
     - name: Cabal update
       run: cabal update
 
-    - name: "Setup cabal-store"
-      id: cabal-store
-      shell: bash
-      run: |
-        cabal_config_file="$(cabal help user-config | tail -n 1 | xargs)"
-
-        if [[ '${{ runner.os }}' != 'Windows' ]]; then
-          echo "cabal-store=$(dirname "$cabal_config_file")/store" | tee -a "$GITHUB_OUTPUT"
-        else
-          echo "cabal-store=C:\\cabal\\store" | tee -a "$GITHUB_OUTPUT"
-        fi
-
-    - name: "Check cabal-store"
-      shell: bash
-      run: echo '${{ steps.cabal-store.outputs.cabal-store }}'
-
     - name: Configure build
-      shell: bash
       run: |
         if [ "${{github.event.inputs.tests}}" == "all" ]; then
           echo "Reconfigure cabal projects to run tests for all dependencies"
           sed -i 's|tests: False|tests: True|g' cabal.project
         fi
 
-        cp ".github/workflows/cabal.project.local.ci.$(uname -s)" cabal.project.local
+        cp ".github/workflows/cabal.project.local.ci" cabal.project.local
 
         echo "# cabal.project.local"
         cat cabal.project.local
@@ -141,51 +66,53 @@ jobs:
       id: record-deps
       run: |
         cabal build all --dry-run
-        cat dist-newstyle/cache/plan.json | jq -r '."install-plan"[].id' | sort | uniq > dependencies.txt
+        cat dist-newstyle/cache/plan.json | jq -r '."install-plan"[] | select(.style != "local") | .id' | sort | uniq > dependencies.txt
 
     - name: "OUTPUT Record weeknum"
-      shell: bash
-      run: echo "weeknum=$(/usr/bin/date -u "+%W")" >> $GITHUB_OUTPUT
-
-    - name: Cache Cabal store
-      uses: actions/cache@v2
-      with:
-        path: ${{ steps.cabal-store.outputs.cabal-store }}
-        key: cache-${{ env.CACHE_VERSION }}-${{ runner.os }}-${{ matrix.ghc }}-${{ hashFiles('dependencies.txt') }}
-        restore-keys: |
-          cache-${{ env.CACHE_VERSION }}-${{ runner.os }}-${{ matrix.ghc }}-${{ hashFiles('dependencies.txt') }}
-          cache-${{ env.CACHE_VERSION }}-${{ runner.os }}-${{ matrix.ghc }}
-
-    - uses: actions/cache@v2
-      name: "Cache `dist-newstyle`"
+      run: echo "weeknum=$(/usr/bin/date -u +%W)" >> $GITHUB_OUTPUT
+
+    # Use a fresh cache each month
+    - name: Store month number as environment variable used in cache version
+      run:  echo "MONTHNUM=$(date -u '+%m')" >> $GITHUB_ENV
+
+    # From the dependency list we restore the cached dependencies.
+    # We use the hash of `dependencies.txt` as part of the cache key because that will be stable
+    # until the `index-state` values in the `cabal.project` file changes.
+    - name: Restore cached dependencies
+      uses: actions/cache/restore@v4
+      id: cache
       with:
         path: |
+          ${{ steps.setup-haskell.outputs.cabal-store }}
           dist-newstyle
-          !dist-newstyle/**/.git
-        key: cache-dist-${{ env.CACHE_VERSION }}-${{ runner.os }}-${{ matrix.ghc }}-${{ steps.record-deps.outputs.weeknum }}
-        restore-keys: cache-dist-${{ env.CACHE_VERSION }}-${{ runner.os }}-${{ matrix.ghc }}
+        key:
+          cache-${{ env.CABAL_CACHE_VERSION }}-${{ runner.os }}-${{ matrix.ghc }}-${{ env.MONTHNUM }}-${{ hashFiles('dependencies.txt') }}
+        # try to restore previous cache from this month if there's no cache for the dependencies set
+        restore-keys: |
+          cache-${{ env.CABAL_CACHE_VERSION }}-${{ runner.os }}-${{ matrix.ghc }}-${{ env.MONTHNUM }}-
 
     - name: Install dependencies
       run: cabal build all --only-dependencies
 
+    # Always store the cabal cache.
+    - name: Cache Cabal store
+      uses: actions/cache/save@v4
+      with:
+        path: |
+          ${{ steps.setup-haskell.outputs.cabal-store }}
+          dist-newstyle
+        key:
+          ${{ steps.cache.outputs.cache-primary-key }}
+
     - name: Build
       run: cabal build all
 
     - name: Run unit tests
-      shell: bash
-      run: |
-        cabal test cardano-addresses
-        if [ "${{ runner.os }}" != "Windows" ] || [ "${{ matrix.ghc }}" !=  "9.6.5" ]; then
-          # This test is currently broken with GHC 9.6 on windows.
-          # This could be related to:
-          # * UTF8 encoding and the use of emoji's in the output.
-          # * unhandled PEi386 relocation type 14 (less likely).
-          cabal test cardano-addresses-cli
-        fi
+      run: cabal test cardano-addresses-cli
 
     - name: Upload Windows Artifact
       uses: actions/upload-artifact@v1
       if: runner.os == 'Windows'
       with:
-        name: ${{ matrix.os }}-exe
-        path: ${{ steps.cabal-store.outputs.cabal-store }}
+        name: ${{ matrix.sys.os }}-exe
+        path: ${{ steps.setup-haskell.outputs.cabal-store }}