hls-test-utils 2.1.0.0 → 2.2.0.0

raw patch · 2 files changed

+53/−61 lines, 2 filesdep ~ghcidedep ~hls-plugin-apidep ~lspPVP ok

version bump matches the API change (PVP)

Dependency ranges changed: ghcide, hls-plugin-api, lsp, lsp-test, lsp-types

API changes (from Hackage documentation)

Files

• hls-test-utils.cabal +6/−6
• src/Test/Hls.hs +47/−55

@@ -1,6 +1,6 @@ cabal-version: 2.4 name:          hls-test-utils-version:       2.1.0.0+version:       2.2.0.0 synopsis:      Utilities used in the tests of Haskell Language Server description:   Please see the README on GitHub at <https://github.com/haskell/haskell-language-server#readme>@@ -41,13 +41,13 @@     , directory     , extra     , filepath-    , ghcide                  == 2.1.0.0+    , ghcide                  == 2.2.0.0     , hls-graph-    , hls-plugin-api          == 2.1.0.0+    , hls-plugin-api          == 2.2.0.0     , lens-    , lsp                     ^>=2.1.0.0-    , lsp-test                ^>=0.15.0.1-    , lsp-types               ^>=2.0.1.0+    , lsp                     ^>=2.2+    , lsp-test                ^>=0.16+    , lsp-types               ^>=2.0.2     , tasty     , tasty-expected-failure     , tasty-golden

@@ -3,6 +3,7 @@ {-# LANGUAGE GADTs                    #-} {-# LANGUAGE LambdaCase               #-} {-# LANGUAGE NamedFieldPuns           #-}+{-# LANGUAGE OverloadedLists          #-} {-# LANGUAGE OverloadedStrings        #-} {-# LANGUAGE PolyKinds                #-} {-# LANGUAGE RankNTypes               #-}@@ -28,8 +29,6 @@     -- * Running HLS for integration tests     runSessionWithServer,     runSessionWithServerAndCaps,-    runSessionWithServerFormatter,-    runSessionWithCabalServerFormatter,     runSessionWithServer',     -- * Helpful re-exports     PluginDescriptor,@@ -40,7 +39,8 @@     waitForBuildQueue,     waitForTypecheck,     waitForAction,-    sendConfigurationChanged,+    hlsConfigToClientConfig,+    setHlsConfig,     getLastBuildKeys,     waitForKickDone,     waitForKickStart,@@ -134,7 +134,8 @@  goldenWithHaskellDoc   :: Pretty b-  => PluginTestDescriptor b+  => Config+  -> PluginTestDescriptor b   -> TestName   -> FilePath   -> FilePath@@ -146,7 +147,8 @@  goldenWithHaskellAndCaps   :: Pretty b-  => ClientCapabilities+  => Config+  -> ClientCapabilities   -> PluginTestDescriptor b   -> TestName   -> FilePath@@ -155,9 +157,9 @@   -> FilePath   -> (TextDocumentIdentifier -> Session ())   -> TestTree-goldenWithHaskellAndCaps clientCaps plugin title testDataDir path desc ext act =+goldenWithHaskellAndCaps config clientCaps plugin title testDataDir path desc ext act =   goldenGitDiff title (testDataDir </> path <.> desc <.> ext)-  $ runSessionWithServerAndCaps plugin clientCaps testDataDir+  $ runSessionWithServerAndCaps config plugin clientCaps testDataDir   $ TL.encodeUtf8 . TL.fromStrict   <$> do     doc <- openDoc (path <.> ext) "haskell"@@ -167,7 +169,8 @@  goldenWithCabalDoc   :: Pretty b-  => PluginTestDescriptor b+  => Config+  -> PluginTestDescriptor b   -> TestName   -> FilePath   -> FilePath@@ -180,6 +183,7 @@ goldenWithDoc   :: Pretty b   => T.Text+  -> Config   -> PluginTestDescriptor b   -> TestName   -> FilePath@@ -188,9 +192,9 @@   -> FilePath   -> (TextDocumentIdentifier -> Session ())   -> TestTree-goldenWithDoc fileType plugin title testDataDir path desc ext act =+goldenWithDoc fileType config plugin title testDataDir path desc ext act =   goldenGitDiff title (testDataDir </> path <.> desc <.> ext)-  $ runSessionWithServer plugin testDataDir+  $ runSessionWithServer config plugin testDataDir   $ TL.encodeUtf8 . TL.fromStrict   <$> do     doc <- openDoc (path <.> ext) fileType@@ -284,33 +288,20 @@ -- Run an HLS server testing a specific plugin -- ------------------------------------------------------------ -runSessionWithServer :: Pretty b => PluginTestDescriptor b -> FilePath -> Session a -> IO a-runSessionWithServer plugin fp act = do-  recorder <- pluginTestRecorder-  runSessionWithServer' (plugin recorder) def def fullCaps fp act--runSessionWithServerAndCaps :: Pretty b => PluginTestDescriptor b -> ClientCapabilities -> FilePath -> Session a -> IO a-runSessionWithServerAndCaps plugin caps fp act = do+runSessionWithServer :: Pretty b => Config -> PluginTestDescriptor b -> FilePath -> Session a -> IO a+runSessionWithServer config plugin fp act = do   recorder <- pluginTestRecorder-  runSessionWithServer' (plugin recorder) def def caps fp act+  runSessionWithServer' (plugin recorder) config def fullCaps fp act -runSessionWithServerFormatter :: Pretty b => PluginTestDescriptor b -> String -> PluginConfig -> FilePath -> Session a -> IO a-runSessionWithServerFormatter plugin formatter conf fp act = do+runSessionWithServerAndCaps :: Pretty b => Config -> PluginTestDescriptor b -> ClientCapabilities -> FilePath -> Session a -> IO a+runSessionWithServerAndCaps config plugin caps fp act = do   recorder <- pluginTestRecorder-  runSessionWithServer'-    (plugin recorder)-    def-      { formattingProvider = T.pack formatter-      , plugins = M.singleton (PluginId $ T.pack formatter) conf-      }-    def-    fullCaps-    fp-    act+  runSessionWithServer' (plugin recorder) config def caps fp act  goldenWithHaskellDocFormatter   :: Pretty b-  => PluginTestDescriptor b -- ^ Formatter plugin to be used+  => Config+  -> PluginTestDescriptor b -- ^ Formatter plugin to be used   -> String -- ^ Name of the formatter to be used   -> PluginConfig   -> TestName -- ^ Title of the test@@ -320,9 +311,10 @@   -> FilePath -- ^ Extension of the output file   -> (TextDocumentIdentifier -> Session ())   -> TestTree-goldenWithHaskellDocFormatter plugin formatter conf title testDataDir path desc ext act =-  goldenGitDiff title (testDataDir </> path <.> desc <.> ext)-  $ runSessionWithServerFormatter plugin formatter conf testDataDir+goldenWithHaskellDocFormatter config plugin formatter conf title testDataDir path desc ext act =+  let config' = config { formattingProvider = T.pack formatter , plugins = M.singleton (PluginId $ T.pack formatter) conf }+  in goldenGitDiff title (testDataDir </> path <.> desc <.> ext)+  $ runSessionWithServer config' plugin testDataDir   $ TL.encodeUtf8 . TL.fromStrict   <$> do     doc <- openDoc (path <.> ext) "haskell"@@ -332,7 +324,8 @@  goldenWithCabalDocFormatter   :: Pretty b-  => PluginTestDescriptor b -- ^ Formatter plugin to be used+  => Config+  -> PluginTestDescriptor b -- ^ Formatter plugin to be used   -> String -- ^ Name of the formatter to be used   -> PluginConfig   -> TestName -- ^ Title of the test@@ -342,9 +335,10 @@   -> FilePath -- ^ Extension of the output file   -> (TextDocumentIdentifier -> Session ())   -> TestTree-goldenWithCabalDocFormatter plugin formatter conf title testDataDir path desc ext act =-  goldenGitDiff title (testDataDir </> path <.> desc <.> ext)-  $ runSessionWithCabalServerFormatter plugin formatter conf testDataDir+goldenWithCabalDocFormatter config plugin formatter conf title testDataDir path desc ext act =+  let config' = config { cabalFormattingProvider = T.pack formatter , plugins = M.singleton (PluginId $ T.pack formatter) conf }+  in goldenGitDiff title (testDataDir </> path <.> desc <.> ext)+  $ runSessionWithServer config' plugin testDataDir   $ TL.encodeUtf8 . TL.fromStrict   <$> do     doc <- openDoc (path <.> ext) "cabal"@@ -352,19 +346,6 @@     act doc     documentContents doc -runSessionWithCabalServerFormatter :: Pretty b => PluginTestDescriptor b -> String -> PluginConfig -> FilePath -> Session a -> IO a-runSessionWithCabalServerFormatter plugin formatter conf fp act = do-  recorder <- pluginTestRecorder-  runSessionWithServer'-    (plugin recorder)-    def-      { cabalFormattingProvider = T.pack formatter-      , plugins = M.singleton (PluginId $ T.pack formatter) conf-      }-    def-    fullCaps-    fp act- -- | Restore cwd after running an action keepCurrentDirectory :: IO a -> IO a keepCurrentDirectory = bracket getCurrentDirectory setCurrentDirectory . const@@ -404,6 +385,7 @@       ["LSP_TEST_LOG_STDERR", "HLS_TEST_SERVER_LOG_STDERR", "HLS_TEST_LOG_STDERR"]      let+        sconf' = sconf { lspConfig = hlsConfigToClientConfig conf }         -- exists until old logging style is phased out         logger = Logger $ \p m -> logger_ (WithPriority p emptyCallStack (pretty m)) @@ -429,7 +411,7 @@                 , argsIdeOptions = ideOptions                 } -    x <- runSessionWithHandles inW outR sconf caps root s+    x <- runSessionWithHandles inW outR sconf' caps root s     hClose inW     timeout 3 (wait server) >>= \case         Just () -> pure ()@@ -489,9 +471,19 @@ getLastBuildKeys :: Session (Either ResponseError [T.Text]) getLastBuildKeys = callTestPlugin GetBuildKeysBuilt -sendConfigurationChanged :: Value -> Session ()-sendConfigurationChanged config =-  sendNotification SMethod_WorkspaceDidChangeConfiguration (DidChangeConfigurationParams config)+hlsConfigToClientConfig :: Config -> A.Object+hlsConfigToClientConfig config = [("haskell", toJSON config)]++-- | Set the HLS client configuration, and wait for the server to update to use it.+-- Note that this will only work if we are not ignoring configuration requests, you+-- may need to call @setIgnoringConfigurationRequests False@ first.+setHlsConfig :: Config -> Session ()+setHlsConfig config = do+  setConfig $ hlsConfigToClientConfig config+  -- wait until we get the workspace/configuration request from the server, so+  -- we know things are settling. This only works if we're not skipping config+  -- requests!+  skipManyTill anyMessage (void configurationRequest)  waitForKickDone :: Session () waitForKickDone = void $ skipManyTill anyMessage nonTrivialKickDone