Migrate tests of plugins (#1612)

* Class plugin

* Splice plugin, extract hlsCommand from hls-test-utils

* Haddock comments plugin

* Update github actions

* Remove invalid import

* Bump up specification version of package description to 2.4

* Fix hls.cabal

* Remove the build of eval plugin's testdata from circle ci

* Limit the parallelism of building test suites in circle ci

Co-authored-by: Pepe Iborra <[email protected]>

Author: berberman

.circleci/config.yml

@@ -38,7 +38,7 @@ defaults: &defaults
 
     - run:
         name: Build Testsuite without running it
-        command: stack --stack-yaml=${STACK_FILE}  build --test --no-run-tests
+        command: stack -j 1 --stack-yaml=${STACK_FILE} build --test --no-run-tests
         no_output_timeout: 30m
 
     - store_artifacts:
@@ -52,14 +52,6 @@ defaults: &defaults
           - ~/build/.stack-work
           - ~/build/ghcide/.stack-work
 
-    - run:
-        name: Setup stack eval hie.html
-        command: cp plugins/hls-eval-plugin/test/testdata/hie-stack.yaml plugins/hls-eval-plugin/test/testdata/hie.yaml
-
-    - run:
-        name: Setup stack eval stack.html
-        command: grep '^resolver:\|^compiler:' stack-build.txt > plugins/hls-eval-plugin/test/testdata/stack.yaml
-
     - run:
         name: Build including tests
         command: stack --stack-yaml=${STACK_FILE} test --no-run-tests

.github/workflows/test.yml

@@ -131,27 +131,30 @@ jobs:
         # instances to be spun up for the poor github actions runner to handle
         run: cabal test wrapper-test --test-options="-j1" || cabal test wrapper-test --test-options="-j1" || cabal test wrapper-test --test-options="-j1"
 
-      - name: Test hls-tactics-plugin test suite
+      - name: Test hls-brittany-plugin
         if: ${{ matrix.test }}
-        run: LSP_TEST_LOG_COLOR=0 LSP_TEST_LOG_MESSAGES=true LSP_TEST_LOG_STDERR=true cabal test hls-tactics-plugin --test-options="-j1"
+        run: cabal test hls-brittany-plugin || cabal test hls-brittany-plugin --test-options="-j1"
 
-      - name: Test brittany plugin
+      - name: Test hls-class-plugin
         if: ${{ matrix.test }}
-        env:
-          HLS_TEST_EXE: hls
-          HLS_WRAPPER_TEST_EXE: hls-wrapper
-        run: cabal test hls-brittany-plugin || cabal test hls-brittany-plugin --test-options="-j1"
+        run: cabal test hls-class-plugin || cabal test hls-class-plugin --test-options="-j1"
 
-      - name: Test stylish-haskell plugin
+      - name: Test hls-eval-plugin
+        if: ${{ matrix.test }}
+        run: cabal test hls-eval-plugin --test-options="-j1 --rerun" || cabal test hls-eval-plugin --test-options="-j1 --rerun"
+
+      - name: Test hls-haddock-comments-plugin
+        if: ${{ matrix.test }}
+        run: cabal test hls-haddock-comments-plugin || cabal test hls-haddock-comments-plugin --test-options="-j1"
+
+      - name: Test hls-splice-plugin
+        if: ${{ matrix.test }}
+        run: cabal test hls-splice-plugin || cabal test hls-splice-plugin --test-options="-j1"
+
+      - name: Test hls-stylish-haskell-plugin
         if: ${{ matrix.test }}
-        env:
-          HLS_TEST_EXE: hls
-          HLS_WRAPPER_TEST_EXE: hls-wrapper
         run: cabal test hls-stylish-haskell-plugin || cabal test hls-stylish-haskell-plugin --test-options="-j1"
 
-      - name: Test eval plugin
+      - name: Test hls-tactics-plugin test suite
         if: ${{ matrix.test }}
-        env:
-          HLS_TEST_EXE: hls
-          HLS_WRAPPER_TEST_EXE: hls-wrapper
-        run: cabal test hls-eval-plugin || cabal test hls-eval-plugin --test-options="-j1"
+        run: LSP_TEST_LOG_COLOR=0 LSP_TEST_LOG_MESSAGES=true LSP_TEST_LOG_STDERR=true cabal test hls-tactics-plugin --test-options="-j1"

haskell-language-server.cabal

@@ -27,7 +27,6 @@ extra-source-files:
   test/testdata/**/*.h
   test/testdata/**/*.hs
   test/testdata/**/*.expected
-  test/testdata/**/*.error
 
 flag pedantic
   description: Enable -Werror
@@ -394,11 +393,10 @@ test-suite func-test
     , containers
     , unordered-containers
 
-  hs-source-dirs:     test/functional plugins/hls-splice-plugin/src
+  hs-source-dirs:     test/functional test/utils
 
   main-is:            Main.hs
   other-modules:
-    Class
     Command
     Completion
     Config
@@ -417,9 +415,7 @@ test-suite func-test
     Rename
     Symbol
     TypeDefinition
-    Splice
-    HaddockComments
-    Ide.Plugin.Splice.Types
+    Test.Hls.Command
 
   default-extensions: OverloadedStrings
   ghc-options:

hls-plugin-api/hls-plugin-api.cabal

@@ -1,4 +1,4 @@
-cabal-version: 2.2
+cabal-version: 2.4
 name:          hls-plugin-api
 version:       1.1.0.0
 synopsis:      Haskell Language Server API for plugin communication

hls-test-utils/hls-test-utils.cabal

@@ -1,4 +1,4 @@
-cabal-version: 2.2
+cabal-version: 2.4
 name:          hls-test-utils
 version:       1.0.0.0
 synopsis:      Utilities used in the tests of Haskell Language Server

hls-test-utils/src/Test/Hls/Util.hs

@@ -15,9 +15,6 @@ module Test.Hls.Util
     , ghcVersion, GhcVersion(..)
     , hostOS, OS(..)
     , matchesCurrentEnv, EnvSpec(..)
-    , hlsCommand
-    , hlsCommandExamplePlugin
-    , hlsCommandVomit
     , ignoreForGhcVersions
     , ignoreInEnv
     , inspectCodeAction
@@ -26,7 +23,6 @@ module Test.Hls.Util
     , knownBrokenOnWindows
     , knownBrokenForGhcVersions
     , knownBrokenInEnv
-    , logFilePath
     , setupBuildToolFiles
     , SymbolLocation
     , waitForDiagnosticsFrom
@@ -57,7 +53,6 @@ import           System.Environment
 import           System.Time.Extra (Seconds, sleep)
 import           System.FilePath
 import           System.IO.Temp
-import           System.IO.Unsafe
 import           Test.Hspec.Runner
 import           Test.Hspec.Core.Formatters hiding (Seconds)
 import           Test.Tasty (TestTree)
@@ -164,26 +159,6 @@ ignoreForGhcVersions vers reason
     | ghcVersion `elem` vers =  ignoreTestBecause reason
     | otherwise = id
 
-logFilePath :: String
-logFilePath = "hls-" ++ show ghcVersion ++ ".log"
-
--- | The command to execute the version of hls for the current compiler.
---
--- Both @stack test@ and @cabal new-test@ setup the environment so @hls@ is
--- on PATH. Cabal seems to respond to @build-tool-depends@ specifically while
--- stack just puts all project executables on PATH.
-hlsCommand :: String
-{-# NOINLINE hlsCommand #-}
-hlsCommand = unsafePerformIO $ do
-  testExe <- fromMaybe "haskell-language-server" <$> lookupEnv "HLS_TEST_EXE"
-  pure $ testExe ++ " --lsp -d -j2 -l test-logs/" ++ logFilePath
-
-hlsCommandVomit :: String
-hlsCommandVomit = hlsCommand ++ " --vomit"
-
-hlsCommandExamplePlugin :: String
-hlsCommandExamplePlugin = hlsCommand ++ " --example"
-
 -- ---------------------------------------------------------------------
 
 hieYamlCradleDirectContents :: String

plugins/hls-class-plugin/hls-class-plugin.cabal

@@ -1,10 +1,13 @@
-cabal-version:      2.2
+cabal-version:      2.4
 name:               hls-class-plugin
 version:            1.0.0.0
-synopsis:           Class/instance management plugin for Haskell Language Server
+synopsis:
+  Class/instance management plugin for Haskell Language Server
+
 description:
-    Class/instance management plugin for Haskell Language Server.
-    For usage, please see README of HLS on GitHub at <https://github.com/haskell/haskell-language-server#readme>
+  Class/instance management plugin for Haskell Language Server.
+  For usage, please see README of HLS on GitHub at <https://github.com/haskell/haskell-language-server#readme>
+
 license:            Apache-2.0
 license-file:       LICENSE
 author:             Junyoung Clare Jang
@@ -13,24 +16,60 @@ homepage:           https://github.com/haskell/haskell-language-server#readme
 bug-reports:        https://github.com/haskell/haskell-language-server/issues
 category:           Development
 build-type:         Simple
+extra-source-files:
+  LICENSE
+  test/testdata/*.hs
 
 library
-  exposed-modules:  Ide.Plugin.Class
-  hs-source-dirs:   src
-  build-depends:    aeson
-                  , base           >=4.12 && <5
-                  , containers
-                  , lsp
-                  , hls-plugin-api >= 1.0 && < 1.2
-                  , ghc
-                  , ghc-exactprint
-                  , ghcide         ^>= 1.1.0.0
-                  , lens
-                  , shake
-                  , text
-                  , transformers
-                  , unordered-containers
+  exposed-modules:    Ide.Plugin.Class
+  hs-source-dirs:     src
+  build-depends:
+    , aeson
+    , base                  >=4.12    && <5
+    , containers
+    , ghc
+    , ghc-exactprint
+    , ghcide                ^>=1.1.0.0
+    , hls-plugin-api        >=1.0     && <1.2
+    , lens
+    , lsp
+    , shake
+    , text
+    , transformers
+    , unordered-containers
+
+  default-language:   Haskell2010
+  default-extensions:
+    DataKinds
+    TypeOperators
 
+  ghc-options:        -Wno-unticked-promoted-constructors
+
+executable test-server
   default-language: Haskell2010
-  default-extensions: DataKinds, TypeOperators
-  ghc-options: -Wno-unticked-promoted-constructors
+  build-depends:
+    , base
+    , data-default
+    , ghcide
+    , hls-class-plugin
+    , hls-plugin-api
+
+  main-is:          Server.hs
+  hs-source-dirs:   test
+  ghc-options:      -threaded
+
+test-suite tests
+  type:               exitcode-stdio-1.0
+  default-language:   Haskell2010
+  build-tool-depends: hls-class-plugin:test-server -any
+  hs-source-dirs:     test
+  main-is:            Main.hs
+  build-depends:
+    , base
+    , bytestring
+    , filepath
+    , hls-test-utils
+    , lens
+    , lsp-test
+    , lsp-types
+    , text

test/functional/Class.hs renamed to plugins/hls-class-plugin/test/Main.hs

@@ -2,8 +2,8 @@
 {-# LANGUAGE OverloadedStrings   #-}
 {-# LANGUAGE ScopedTypeVariables #-}
 {-# LANGUAGE TypeOperators       #-}
-module Class
-  ( tests
+module Main
+  ( main
   )
 where
 
@@ -14,19 +14,21 @@ import qualified Language.LSP.Types.Lens as J
 import           System.FilePath
 import           Test.Hls
 
+main :: IO ()
+main = defaultTestRunner tests
+
 tests :: TestTree
 tests = testGroup
   "class"
   [ testCase "Produces addMinimalMethodPlaceholders code actions for one instance" $ do
-      runSession hlsCommand fullCaps classPath $ do
+      runSession testCommand fullCaps classPath $ do
         doc <- openDoc "T1.hs" "haskell"
         _ <- waitForDiagnosticsFromSource doc "typecheck"
         caResults <- getAllCodeActions doc
         liftIO $ map (^? _CACodeAction . J.title) caResults
           @?=
           [ Just "Add placeholders for '=='"
           , Just "Add placeholders for '/='"
-          , Just "Disable \"missing-methods\" warnings"
           ]
   , glodenTest "Creates a placeholder for '=='" "T1" "eq"
     $ \(eqAction:_) -> do
@@ -54,12 +56,12 @@ _CACodeAction = prism' InR $ \case
   _          -> Nothing
 
 classPath :: FilePath
-classPath = "test" </> "testdata" </> "class"
+classPath = "test" </> "testdata"
 
 glodenTest :: String -> FilePath -> FilePath -> ([CodeAction] -> Session ()) -> TestTree
 glodenTest name fp deco execute
   = goldenGitDiff name (classPath </> fpWithDeco <.> "expected" <.> "hs")
-    $ runSession hlsCommand fullCaps classPath
+    $ runSession testCommand fullCaps classPath
     $ do
       doc <- openDoc (fp <.> "hs") "haskell"
       _ <- waitForDiagnosticsFromSource doc "typecheck"

plugins/hls-class-plugin/test/Server.hs

@@ -0,0 +1,18 @@
+
+{-# LANGUAGE OverloadedStrings #-}
+module Main(main) where
+
+import           Data.Default
+import           Development.IDE.Main
+import qualified Development.IDE.Plugin.HLS.GhcIde as Ghcide
+import qualified Ide.Plugin.Class                  as Class
+import           Ide.Plugin.Config
+import           Ide.PluginUtils
+
+main :: IO ()
+main = defaultMain def
+  { argsHlsPlugins = pluginDescToIdePlugins $
+    [ Class.descriptor "class"
+    ] <>
+    Ghcide.descriptors
+  }