GitHub test action (haskell/ghcide#903)

* Add github test action

* Disable unreliable test

Does not work reliably on all platforms.

Reenable when haskell/ghcide#861 lands

* Add hlint and -Werror

* Explicit timeout

6h is the default and also the maximum:

https://docs.github.com/en/free-pro-team@latest/actions/reference/usage-limits-billing-and-administration

* Experiment tests to use Cabal instead of Stack

* Fix an unreliable test

* Trim down matrix

* Add ghc-lib to the test matrix

* Address broken hie-compat ghc-lib build

* Drop stack descriptor family

We keep two stack descriptors:

- One for Nightly
- One for Windows (stuck in GHC 8.10.1)

To ensure that `stack test` doesn't break, we keep running the stack tests in CI

* Update README to point end users to HLS

* Drop support for `stack test`

Author: pepeiborra

.azure/linux-stack.yml

@@ -3,29 +3,19 @@ jobs:
   timeoutInMinutes: 60
   pool:
     vmImage: 'ubuntu-latest'
-  strategy:
-    matrix:
-      stack_810:
-        STACK_YAML: "stack810.yaml"
-      stack_88:
-        STACK_YAML: "stack88.yaml"
-      stack_86:
-        STACK_YAML: "stack.yaml"
-      stack_ghc_lib_88:
-        STACK_YAML: "stack-ghc-lib.yaml"
   variables:
       STACK_ROOT: $(Pipeline.Workspace)/.stack
   steps:
   - checkout: self
   - task: Cache@2
     inputs:
-      key: stack-root-cache | $(Agent.OS) | $(Build.SourcesDirectory)/$(STACK_YAML) | $(Build.SourcesDirectory)/ghcide.cabal
+      key: stack-root-cache | $(Agent.OS) | $(Build.SourcesDirectory)/stack.yaml | $(Build.SourcesDirectory)/ghcide.cabal
       path: $(STACK_ROOT)
       cacheHitVar: STACK_ROOT_CACHE_RESTORED
     displayName: "Cache stack root"
   - task: Cache@2
     inputs:
-      key: stack-work-cache | $(Agent.OS) | $(Build.SourcesDirectory)/$(STACK_YAML) | $(Build.SourcesDirectory)/ghcide.cabal
+      key: stack-work-cache | $(Agent.OS) | $(Build.SourcesDirectory)/stack.yaml | $(Build.SourcesDirectory)/ghcide.cabal
       path: .stack-work
       cacheHitVar: STACK_WORK_CACHE_RESTORED
     displayName: "Cache stack work"
@@ -41,14 +31,9 @@ jobs:
       fi
       mkdir -p $STACK_ROOT
     displayName: 'Install Stack'
-  - bash: stack setup --stack-yaml=$STACK_YAML
+  - bash: stack setup
     displayName: 'stack setup'
   - bash: cabal update # some tests use Cabal cradles
     displayName: 'cabal update'
-  - bash: stack build --test --only-dependencies --stack-yaml=$STACK_YAML
-    displayName: 'stack build --test --only-dependencies'
-  - bash: |
-      export PATH=/opt/cabal/bin:$PATH
-      stack test --ghc-options=-Werror  --stack-yaml=$STACK_YAML --ta "--rerun-update" || stack test --ghc-options=-Werror --stack-yaml=$STACK_YAML --ta "--rerun" || LSP_TEST_LOG_COLOR=0 LSP_TEST_LOG_MESSAGES=true LSP_TEST_LOG_STDERR=true stack test --ghc-options=-Werror --stack-yaml=$STACK_YAML --ta "--rerun"
-    # ghcide stack tests are flaky, see https://github.com/digital-asset/daml/issues/2606.
-    displayName: 'stack test --ghc-options=-Werror'
+  - bash: stack build --test --no-run-tests
+    displayName: 'stack build --test --no-run-tests'

.azure/windows-stack.yml

@@ -3,29 +3,19 @@ jobs:
   timeoutInMinutes: 120
   pool:
     vmImage: 'windows-2019'
-  strategy:
-    matrix:
-      stack_810:
-       STACK_YAML: "stack8101.yaml"
-      stack_88:
-       STACK_YAML: "stack88.yaml"
-      stack_86:
-        STACK_YAML: "stack.yaml"
-      stack_ghc_lib_88:
-        STACK_YAML: "stack-ghc-lib.yaml"
   variables:
       STACK_ROOT: "C:\\sr"
   steps:
   - checkout: self
   - task: Cache@2
     inputs:
-      key: stack-root-cache | $(Agent.OS) | $(Build.SourcesDirectory)/$(STACK_YAML) | $(Build.SourcesDirectory)/ghcide.cabal
+      key: stack-root-cache | $(Agent.OS) | $(Build.SourcesDirectory)/stack-windows.yaml | $(Build.SourcesDirectory)/ghcide.cabal
       path: $(STACK_ROOT)
       cacheHitVar: STACK_ROOT_CACHE_RESTORED
     displayName: "Cache stack root"
   - task: Cache@2
     inputs:
-      key: stack-work-cache | $(Agent.OS) | $(Build.SourcesDirectory)/$(STACK_YAML) | $(Build.SourcesDirectory)/ghcide.cabal
+      key: stack-work-cache | $(Agent.OS) | $(Build.SourcesDirectory)/stack-windows.yaml | $(Build.SourcesDirectory)/ghcide.cabal
       path: .stack-work
       cacheHitVar: STACK_WORK_CACHE_RESTORED
     displayName: "Cache stack work"
@@ -37,22 +27,15 @@ jobs:
       unzip -o /usr/bin/stack.zip -d /usr/bin/
       mkdir -p "$STACK_ROOT"
     displayName: 'Install Stack'
-  - bash: stack setup --stack-yaml $STACK_YAML
+  - bash: stack setup --stack-yaml stack-windows.yaml
     displayName: 'stack setup'
   - bash: |
       # Installing happy and alex standalone to avoid error "strip.exe: unable to rename ../*.exe; reason: File exists"
-      stack install happy --stack-yaml $STACK_YAML
-      stack install alex --stack-yaml $STACK_YAML
+      stack install happy --stack-yaml stack-windows.yaml
+      stack install alex --stack-yaml stack-windows.yaml
       choco install -y cabal --version=$CABAL_VERSION
       $(cygpath $ProgramData)/chocolatey/bin/RefreshEnv.cmd
       # GHC 8.10.1 fails with ghc segfaults, using -fexternal-interpreter seems to make it working
       # There are other transient errors like timeouts downloading from stackage so we retry 3 times
-      if [ "$STACK_YAML" = "stack8101.yaml" ]; then
-        stack build --only-dependencies --stack-yaml $STACK_YAML --ghc-options="-fexternal-interpreter" || stack build --only-dependencies --stack-yaml $STACK_YAML --ghc-options="-fexternal-interpreter" || stack build --only-dependencies --stack-yaml $STACK_YAML  --ghc-options="-fexternal-interpreter"
-      else
-        stack build --only-dependencies --stack-yaml $STACK_YAML || stack build --only-dependencies --stack-yaml $STACK_YAML || stack build --only-dependencies --stack-yaml $STACK_YAML
-      fi
-    displayName: 'stack build --only-dependencies'
-  - bash: |
-      stack test --ghc-options=-Werror --stack-yaml $STACK_YAML --ta "--rerun-update" || stack test --ghc-options=-Werror --stack-yaml=$STACK_YAML --ta "--rerun" || LSP_TEST_LOG_COLOR=0 LSP_TEST_LOG_MESSAGES=true LSP_TEST_LOG_STDERR=true stack test --ghc-options=-Werror --stack-yaml=$STACK_YAML --ta "--rerun"
-    displayName: 'stack test --ghc-options=-Werror'
+        stack build --test --no-run-tests --stack-yaml stack-windows.yaml --ghc-options="-fexternal-interpreter" || stack build --test --no-run-tests --stack-yaml stack-windows.yaml --ghc-options="-fexternal-interpreter" || stack build --test --no-run-tests --stack-yaml stack-windows.yaml  --ghc-options="-fexternal-interpreter"
+    displayName: 'stack build --test'

.github/workflows/bench.yml

@@ -22,15 +22,11 @@ jobs:
 
     - name: Cache Cabal
       uses: actions/cache@v2
-      env:
-        cache-name: cache-cabal
       with:
-        path: ~/.cabal/
-        key: ${{ runner.os }}-${{ matrix.ghc }}-build-${{ env.cache-name }}-${{ hashFiles('ghcide.cabal', 'cabal.project') }}
-        restore-keys: |
-          ${{ runner.os }}-${{ matrix.ghc }}-build-${{ env.cache-name }}-
-          ${{ runner.os }}-${{ matrix.ghc }}-build-
-          ${{ runner.os }}-${{ matrix.ghc }}
+        path: |
+          ~/.cabal/packages
+          ~/.cabal/store
+        key: ${{ runner.os }}-${{ matrix.ghc }}-cabal-bench
 
     - run: cabal update
 

.github/workflows/test.yml

@@ -0,0 +1,69 @@
+name: Testing
+
+on: [push, pull_request]
+jobs:
+  test:
+    timeout-minutes: 360
+    runs-on: ${{ matrix.os }}
+
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [macOS-latest, ubuntu-latest, windows-latest]
+        ghc: ['8.10.2', '8.8.4', '8.6.5']
+        ghc-lib: [false]
+        exclude:
+          - os: windows-latest
+            ghc: '8.10.2' # broken due to https://gitlab.haskell.org/ghc/ghc/-/issues/18550
+          - os: windows-latest
+            ghc: '8.8.4' # also fails due to segfault :(
+        include:
+          - os: windows-latest
+            ghc: '8.10.1'
+          - os: ubuntu-latest
+            ghc: '8.10.1'
+            ghc-lib: true
+
+    steps:
+    - uses: actions/checkout@v2
+    - uses: actions/[email protected]
+      with:
+        ghc-version: ${{ matrix.ghc }}
+        cabal-version: '3.2'
+
+    - run: ./fmt.sh
+      name: "HLint via ./fmt.sh"
+
+    - name: Cache Cabal
+      uses: actions/cache@v2
+      with:
+        path: |
+          ~/.cabal/packages
+          ~/.cabal/store
+        key: ${{ runner.os }}-${{ matrix.ghc }}-{{matrix.ghc-lib}}-cabal-test
+
+    - run: cabal update
+
+    - name: cabal.project.local
+      run: |
+        echo "tests: True" > cabal.project.local
+        echo "package ghcide" >> cabal.project.local
+        echo "  ghc-options: -Werror" >> cabal.project.local
+
+    - name: ghc-lib
+      if: ${{ matrix.ghc-lib }}
+      run: |
+        echo "  flags: ghc-lib" >> cabal.project.local
+        echo "package hie-compat" >> cabal.project.local
+        echo "  flags: ghc-lib" >> cabal.project.local
+
+    - name: Build
+      shell: bash
+      # Retry it three times to workaround compiler segfaults in windows
+      run: cabal build || cabal build || cabal build
+
+    - name: Test
+      shell: bash
+      # run the tests without parallelism to avoid running out of memory
+      run: cabal test --test-options="-j1 --rerun-update" || cabal test --test-options="-j1 --rerun" || LSP_TEST_LOG_COLOR=0 LSP_TEST_LOG_MESSAGES=true LSP_TEST_LOG_STDERR=true cabal test --test-options="-j1 --rerun"
+      if: ${{ !matrix.ghc-lib}}

README.md

@@ -46,6 +46,10 @@ a simple reproduction of the bug.
 
 ### Install `ghcide`
 
+[We recommend](https://neilmitchell.blogspot.com/2020/09/dont-use-ghcide-anymore-directly.html) installing and using the Haskell extension in VS Code, or the prebuilt binaries provided by https://github.com/haskell/haskell-language-server
+
+If you still wish to install `ghcide` direcly, the instructions below might prove useful *but you are on your own*.
+
 #### With Nix
 
 Note that you need to compile `ghcide` with the same `ghc` as the project you are working on.
@@ -317,13 +321,15 @@ args = ["--lsp"]
 
 ## Hacking on ghcide
 
-To build and work on `ghcide` itself, you can use Stack or cabal, e.g.,
-running `stack test` will execute the test suite.
+To build and work on `ghcide` itself, you should use cabal, e.g.,
+running `cabal test` will execute the test suite. You can use `stack test` too, but
+note that some tests will fail, and none of the maintainers are currently using `stack`.
+
 If you are using Windows, you should disable the `auto.crlf` setting and configure your editor to use LF line endings, directly or making it use the existing `.editor-config`.
 
 If you are chasing down test failures, you can use the tasty-rerun feature by running tests as
 
-    stack --stack-yaml=stack84.yaml test --test-arguments "--rerun"
+    cabal test --test-options"--rerun"
 
 This writes a log file called `.tasty-rerun-log` of the failures, and only runs those.
 See the [tasty-rerun](https://hackage.haskell.org/package/tasty-rerun-1.1.17/docs/Test-Tasty-Ingredients-Rerun.html) documentation for other options.
@@ -332,12 +338,9 @@ If you are touching performance sensitive code, take the time to run a different
 benchmark between HEAD and master using the benchHist script. This assumes that
 "master" points to the upstream master.
 
-Run the benchmarks with `stack`:
-
-    export STACK_YAML=...
-    stack bench
+Run the benchmarks with `cabal bench`.
 
-It should take around 15 minutes and the results will be stored in the `bench-hist` folder. To interpret the results, see the comments in the `bench/hist/Main.hs` module.
+It should take around 15 minutes and the results will be stored in the `bench-results` folder. To interpret the results, see the comments in the `bench/hist/Main.hs` module.
 
 More details in [bench/README](bench/README.md)
 

hie-compat/hie-compat.cabal

@@ -38,8 +38,8 @@ library
 
   if (impl(ghc > 8.5) && impl(ghc < 8.7) && !flag(ghc-lib))
     hs-source-dirs: src-ghc86
-  if ((impl(ghc > 8.7) && impl(ghc < 8.10)) || flag(ghc-lib))
+  if (impl(ghc > 8.7) && impl(ghc < 8.10)) 
     hs-source-dirs: src-ghc88 src-reexport
-  if (impl(ghc > 8.9) && impl(ghc < 8.11))
+  if (impl(ghc > 8.9) && impl(ghc < 8.11) || flag(ghc-lib))
     hs-source-dirs: src-ghc810 src-reexport
 

stack-ghc-lib.yaml

@@ -30,6 +30,3 @@ extra-deps:
 
 nix:
   packages: [zlib]
-
-ghc-options:
-  ghcide: -DSTACK

stack8101.yaml renamed to stack-windows.yaml

@@ -1,28 +1,32 @@
-resolver: nightly-2019-09-21
+resolver: nightly-2020-09-02
+allow-newer: true
 packages:
 - .
 - ./hie-compat/
 extra-deps:
-- aeson-1.4.6.0
 - haskell-lsp-0.22.0.0
 - haskell-lsp-types-0.22.0.0
 - lsp-test-0.11.0.6
-- hie-bios-0.7.1@rev:2
+- ghc-check-0.5.0.1
+- hie-bios-0.7.1
+
+# not yet in stackage
+- Chart-diagrams-1.9.3
+- SVGFonts-1.7.0.1
+- diagrams-1.4
+- diagrams-svg-1.4.3
+- diagrams-contrib-1.4.4
+- diagrams-core-1.4.2
+- diagrams-lib-1.4.3
+- diagrams-postscript-1.5
+- monoid-extras-0.5.1
+- svg-builder-0.1.1
+- active-0.2.0.14
+- dual-tree-0.2.2.1
+- force-layout-0.4.0.6
+- statestack-0.3
 - implicit-hie-0.1.2.3
 - implicit-hie-cradle-0.3.0.0
-- fuzzy-0.1.0.0
-- regex-pcre-builtin-0.95.1.1.8.43
-- regex-base-0.94.0.0
-- regex-tdfa-1.3.1.0
-- shake-0.18.5
-- parser-combinators-1.2.1
-- haddock-library-1.8.0
-- tasty-rerun-1.1.17
-- ghc-check-0.5.0.1
-- extra-1.7.2
 
 nix:
   packages: [zlib]
-
-ghc-options:
-  ghcide: -DSTACK