Move hlint tests to its own package (and other clean ups) (#2284)

* Move hlint tests to its package

* Move hlint config tests to its package

* Update extra-source-files

* Remove unused cabal-helper test data

* Add hlint test suite

* Make diganostic tests work without hlint

* Make progressCap test work without hlint files

* No cabal files in hlint test data

* Fix progress test

* Fix parent folder name

* Correct test data dir

* Correct extra-source dir and update maintainer

* Use sendConfigurationChanged everywhere

Author: jneira

.github/workflows/test.yml

@@ -215,3 +215,7 @@ jobs:
       - if: ${{ needs.pre_job.outputs.should_skip != 'true' && matrix.test}}
         name: Test hls-rename-plugin test suite
         run: cabal test hls-rename-plugin --test-options="-j1 --rerun-update" || cabal test hls-rename-plugin --test-options="-j1 --rerun" || LSP_TEST_LOG_COLOR=0 LSP_TEST_LOG_MESSAGES=true LSP_TEST_LOG_STDERR=true cabal test hls-rename-plugin --test-options="-j1 --rerun"
+
+      - if: ${{ needs.pre_job.outputs.should_skip != 'true' && matrix.test}}
+        name: Test hls-hlint-plugin test suite
+        run: cabal test hls-hlint-plugin --test-options="-j1 --rerun-update" || cabal test hls-hlint-plugin --test-options="-j1 --rerun" || LSP_TEST_LOG_COLOR=0 LSP_TEST_LOG_MESSAGES=true LSP_TEST_LOG_STDERR=true cabal test hls-hlint-plugin --test-options="-j1 --rerun"

haskell-language-server.cabal

@@ -21,9 +21,6 @@ extra-source-files:
   test/testdata/**/*.project
   test/testdata/**/*.cabal
   test/testdata/**/*.yaml
-  -- this one is not matched by the previous glob
-  test/testdata/hlint/ignore/.hlint.yaml
-  test/testdata/**/*.h
   test/testdata/**/*.hs
 
 flag pedantic

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

@@ -24,8 +24,10 @@ module Test.Hls
     waitForAllProgressDone,
     PluginDescriptor,
     IdeState,
-    waitForBuildQueue
-    ,waitForTypecheck,waitForAction)
+    waitForBuildQueue,
+    waitForTypecheck,
+    waitForAction,
+    sendConfigurationChanged)
 where
 
 import           Control.Applicative.Combinators
@@ -222,8 +224,12 @@ waitForAction key TextDocumentIdentifier{_uri} = do
     return $ do
       e <- _result
       case A.fromJSON e of
-        A.Error e   -> Left $ ResponseError InternalError (T.pack e) Nothing
+        A.Error err   -> Left $ ResponseError InternalError (T.pack err) Nothing
         A.Success a -> pure a
 
 waitForTypecheck :: TextDocumentIdentifier -> Session (Either ResponseError Bool)
 waitForTypecheck tid = fmap ideResultSuccess <$> waitForAction "typecheck" tid
+
+sendConfigurationChanged :: Value -> Session ()
+sendConfigurationChanged config =
+  sendNotification SWorkspaceDidChangeConfiguration (DidChangeConfigurationParams config)

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

@@ -22,6 +22,7 @@ module Test.Hls.Util
     , ghcVersion, GhcVersion(..)
     , hostOS, OS(..)
     , matchesCurrentEnv, EnvSpec(..)
+    , noLiteralCaps
     , ignoreForGhcVersions
     , ignoreInEnv
     , inspectCodeAction
@@ -74,6 +75,12 @@ import           Test.Tasty.HUnit                (Assertion, assertFailure,
 import           Text.Blaze.Internal             hiding (null)
 import           Text.Blaze.Renderer.String      (renderMarkup)
 
+noLiteralCaps :: C.ClientCapabilities
+noLiteralCaps = def { C._textDocument = Just textDocumentCaps }
+  where
+    textDocumentCaps = def { C._codeAction = Just codeActionCaps }
+    codeActionCaps = CodeActionClientCapabilities (Just True) Nothing Nothing Nothing Nothing Nothing Nothing
+
 codeActionSupportCaps :: C.ClientCapabilities
 codeActionSupportCaps = def { C._textDocument = Just textDocumentCaps }
   where

plugins/hls-hlint-plugin/hls-hlint-plugin.cabal

@@ -1,4 +1,4 @@
-cabal-version: 2.2
+cabal-version: 2.4
 name:          hls-hlint-plugin
 version:       1.0.1.1
 synopsis:      Hlint integration plugin with Haskell Language Server
@@ -8,10 +8,17 @@ description:
 license:       Apache-2.0
 license-file:  LICENSE
 author:        The Haskell IDE Team
-maintainer:    alan.zimm@gmail.com
+maintainer:    atreyu.bbb@gmail.com
 copyright:     The Haskell IDE Team
 category:      Development
 build-type:    Simple
+extra-source-files:
+  LICENSE
+  test/testdata/**/*.yaml
+  -- this one is not matched by the previous glob
+  test/testdata/ignore/.hlint.yaml
+  test/testdata/**/*.hs
+  test/testdata/**/*.h
 
 flag pedantic
   description: Enable -Werror
@@ -101,3 +108,21 @@ library
   default-extensions:
     DataKinds
     TypeOperators
+
+test-suite tests
+  type:             exitcode-stdio-1.0
+  default-language: Haskell2010
+  hs-source-dirs:   test
+  main-is:          Main.hs
+  ghc-options:      -threaded -rtsopts -with-rtsopts=-N
+  build-depends:
+      aeson
+    , base
+    , containers
+    , filepath
+    , hls-hlint-plugin
+    , hls-plugin-api
+    , hls-test-utils      >=1.0 && <1.2
+    , lens
+    , lsp-types
+    , text