Rerun test suite to avoid flaky tests

Author: jneira

.github/workflows/test.yml

@@ -64,5 +64,5 @@ jobs:
       # run the tests without parallelism, otherwise tasty will attempt to run
       # all functional test cases simultaneously which causes way too many hls
       # instances to be spun up for the poor github actions runner to handle
-      run: cabal test --test-options=-j1
+      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"
 

.gitignore

@@ -6,6 +6,8 @@ cabal.project.local
 *~
 *.lock
 
+.tasty-rerun-log
+
 # shake build information
 _build/
 

haskell-language-server.cabal

@@ -276,6 +276,7 @@ test-suite wrapper-test
     , process
     , tasty
     , tasty-ant-xml  >=1.1.6
+    , tasty-rerun
 
   hs-source-dirs:     test/wrapper
   main-is:            Main.hs

test/wrapper/Main.hs

@@ -4,14 +4,17 @@ import Data.Maybe
 import Test.Hls.Util
 import Test.Tasty
 import Test.Tasty.HUnit
+import Test.Tasty.Ingredients.Rerun
+import Test.Tasty.Runners ( listingTests, consoleTestReporter)
 import System.Process
 import System.Environment
 
 main :: IO ()
 main = do
   flushStackEnvironment
-  defaultMain $
-    testGroup "haskell-language-server-wrapper" [projectGhcVersionTests]
+  defaultMainWithIngredients
+      [rerunningTests [listingTests, consoleTestReporter]] $
+        testGroup "haskell-language-server-wrapper" [projectGhcVersionTests]
 
 projectGhcVersionTests :: TestTree
 projectGhcVersionTests = testGroup "--project-ghc-version"