Skip to content

Commit 2d1a588

Browse files
berbermanjneira
berberman
and
jneira
authoredApr 6, 2021
Run plugins' test suites with server in the same process (haskell#1628)
* Run plugins' test suites with server in the same process * Use async * Update CI * Add rts options * Sleep 0.5s after running a session * Update CI * Don't use withAsync * Add timeout * Cancel the server action when timeout * Fix cwd * Close input stream manually, add a lock * cleanup * tactics plugin * Remove sleep Co-authored-by: Javier Neira <atreyu.bbb@gmail.com>
·
v1.8.0.21.1.0
1 parent c6421fd commit 2d1a588

File tree

25 files changed

+243
-362
lines changed

25 files changed

+243
-362
lines changed
 

‎.github/workflows/test.yml

+6-6
Original file line numberDiff line numberDiff line change
@@ -142,27 +142,27 @@ jobs:
142142

143143
- if: ${{ needs.pre_job.outputs.should_skip != 'true' && matrix.test }}
144144
name: Test hls-brittany-plugin
145-
run: cabal test hls-brittany-plugin || cabal test hls-brittany-plugin --test-options="-j1"
145+
run: cabal test hls-brittany-plugin --test-options="-j1 --rerun-update" || cabal test hls-brittany-plugin --test-options="-j1 --rerun" || LSP_TEST_LOG_COLOR=0 LSP_TEST_LOG_MESSAGES=true LSP_TEST_LOG_STDERR=true cabal test hls-brittany-plugin --test-options="-j1 --rerun"
146146

147147
- if: ${{ needs.pre_job.outputs.should_skip != 'true' && matrix.test }}
148148
name: Test hls-class-plugin
149-
run: cabal test hls-class-plugin || cabal test hls-class-plugin --test-options="-j1"
149+
run: cabal test hls-class-plugin --test-options="-j1 --rerun-update" || cabal test hls-class-plugin --test-options="-j1 --rerun" || LSP_TEST_LOG_COLOR=0 LSP_TEST_LOG_MESSAGES=true LSP_TEST_LOG_STDERR=true cabal test hls-class-plugin --test-options="-j1 --rerun"
150150

151151
- if: ${{ needs.pre_job.outputs.should_skip != 'true' && matrix.test }}
152152
name: Test hls-eval-plugin
153-
run: cabal test hls-eval-plugin --test-options="-j1 --rerun" || cabal test hls-eval-plugin --test-options="-j1 --rerun"
153+
run: cabal test hls-eval-plugin --test-options="-j1 --rerun-update" || cabal test hls-eval-plugin --test-options="-j1 --rerun" || LSP_TEST_LOG_COLOR=0 LSP_TEST_LOG_MESSAGES=true LSP_TEST_LOG_STDERR=true cabal test hls-eval-plugin --test-options="-j1 --rerun"
154154

155155
- if: ${{ needs.pre_job.outputs.should_skip != 'true' && matrix.test }}
156156
name: Test hls-haddock-comments-plugin
157-
run: cabal test hls-haddock-comments-plugin || cabal test hls-haddock-comments-plugin --test-options="-j1"
157+
run: cabal test hls-haddock-comments-plugin --test-options="-j1 --rerun-update" || cabal test hls-haddock-comments-plugin --test-options="-j1 --rerun" || LSP_TEST_LOG_COLOR=0 LSP_TEST_LOG_MESSAGES=true LSP_TEST_LOG_STDERR=true cabal test hls-haddock-comments-plugin --test-options="-j1 --rerun"
158158

159159
- if: ${{ needs.pre_job.outputs.should_skip != 'true' && matrix.test }}
160160
name: Test hls-splice-plugin
161-
run: cabal test hls-splice-plugin || cabal test hls-splice-plugin --test-options="-j1"
161+
run: cabal test hls-splice-plugin --test-options="-j1 --rerun-update" || cabal test hls-splice-plugin --test-options="-j1 --rerun" || LSP_TEST_LOG_COLOR=0 LSP_TEST_LOG_MESSAGES=true LSP_TEST_LOG_STDERR=true cabal test hls-splice-plugin --test-options="-j1 --rerun"
162162

163163
- if: ${{ needs.pre_job.outputs.should_skip != 'true' && matrix.test }}
164164
name: Test hls-stylish-haskell-plugin
165-
run: cabal test hls-stylish-haskell-plugin || cabal test hls-stylish-haskell-plugin --test-options="-j1"
165+
run: cabal test hls-stylish-haskell-plugin --test-options="-j1 --rerun-update" || cabal test hls-stylish-haskell-plugin --test-options="-j1 --rerun" || LSP_TEST_LOG_COLOR=0 LSP_TEST_LOG_MESSAGES=true LSP_TEST_LOG_STDERR=true cabal test hls-stylish-haskell-plugin --test-options="-j1 --rerun"
166166

167167
- if: ${{ needs.pre_job.outputs.should_skip != 'true' && matrix.test }}
168168
name: Test hls-tactics-plugin test suite

‎cabal.project

-4
Original file line numberDiff line numberDiff line change
@@ -19,10 +19,6 @@ tests: true
1919

2020
package *
2121
ghc-options: -haddock
22-
23-
package haskell-language-server
24-
test-show-details: direct
25-
package ghcide
2622
test-show-details: direct
2723

2824
write-ghc-environment-files: never

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

+5-1
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,7 @@ library
3434
hs-source-dirs: src
3535
build-depends:
3636
, aeson
37+
, async
3738
, base
3839
, blaze-markup
3940
, bytestring
@@ -42,13 +43,16 @@ library
4243
, directory
4344
, extra
4445
, filepath
46+
, ghcide ^>=1.1.0.0
47+
, hls-plugin-api ^>=1.1.0.0
4548
, hspec
4649
, hspec-core
4750
, lens
51+
, lsp ^>=1.2
4852
, lsp-test ==0.14.0.0
4953
, lsp-types ^>=1.2
54+
, shake
5055
, tasty
51-
, tasty-ant-xml >=1.1.6
5256
, tasty-expected-failure
5357
, tasty-golden
5458
, tasty-hunit

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

+103-13
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
{-# LANGUAGE LambdaCase #-}
12
module Test.Hls
23
( module Test.Tasty.HUnit,
34
module Test.Tasty,
@@ -9,38 +10,127 @@ module Test.Hls
910
module Control.Applicative.Combinators,
1011
defaultTestRunner,
1112
goldenGitDiff,
12-
testCommand,
1313
def,
14+
runSessionWithServer,
15+
runSessionWithServerFormatter,
16+
runSessionWithServer',
17+
PluginDescriptor,
18+
IdeState,
1419
)
1520
where
1621

1722
import Control.Applicative.Combinators
23+
import Control.Concurrent.Async (async, cancel, wait)
24+
import Control.Concurrent.Extra
25+
import Control.Exception.Base
1826
import Control.Monad.IO.Class
19-
import Data.ByteString.Lazy (ByteString)
20-
import Data.Default (def)
27+
import Data.ByteString.Lazy (ByteString)
28+
import Data.Default (def)
29+
import qualified Data.Text as T
30+
import Development.IDE (IdeState, hDuplicateTo',
31+
noLogging)
32+
import Development.IDE.Main
33+
import qualified Development.IDE.Main as Ghcide
34+
import qualified Development.IDE.Plugin.HLS.GhcIde as Ghcide
35+
import Development.IDE.Types.Options
36+
import Development.Shake (ShakeOptions (shakeThreads))
37+
import GHC.IO.Handle
38+
import Ide.Plugin.Config (Config, formattingProvider)
39+
import Ide.PluginUtils (pluginDescToIdePlugins)
40+
import Ide.Types
2141
import Language.LSP.Test
2242
import Language.LSP.Types
43+
import Language.LSP.Types.Capabilities (ClientCapabilities)
44+
import System.Directory (getCurrentDirectory,
45+
setCurrentDirectory)
46+
import System.IO.Extra
47+
import System.IO.Unsafe (unsafePerformIO)
48+
import System.Process.Extra (createPipe)
49+
import System.Time.Extra
2350
import Test.Hls.Util
24-
import Test.Tasty hiding (Timeout)
51+
import Test.Tasty hiding (Timeout)
2552
import Test.Tasty.ExpectedFailure
2653
import Test.Tasty.Golden
2754
import Test.Tasty.HUnit
2855
import Test.Tasty.Ingredients.Rerun
29-
import Test.Tasty.Runners
30-
import Test.Tasty.Runners.AntXML
3156

32-
-- | ingredient: xml runner writes json file of test results (https://github.com/ocharles/tasty-ant-xml/blob/master/Test/Tasty/Runners/AntXML.hs)
33-
-- rerunningTests allow rerun of failed tests (https://github.com/ocharles/tasty-rerun/blob/master/src/Test/Tasty/Ingredients/Rerun.hs)
57+
-- | Run 'defaultMainWithRerun', limiting each single test case running at most 10 minutes
3458
defaultTestRunner :: TestTree -> IO ()
35-
defaultTestRunner =
36-
defaultMainWithIngredients
37-
[antXMLRunner, rerunningTests [listingTests, consoleTestReporter]]
59+
defaultTestRunner = defaultMainWithRerun . adjustOption (const $ mkTimeout 600000000)
3860

3961
gitDiff :: FilePath -> FilePath -> [String]
4062
gitDiff fRef fNew = ["git", "diff", "--no-index", "--text", "--exit-code", fRef, fNew]
4163

4264
goldenGitDiff :: TestName -> FilePath -> IO ByteString -> TestTree
4365
goldenGitDiff name = goldenVsStringDiff name gitDiff
4466

45-
testCommand :: String
46-
testCommand = "test-server"
67+
runSessionWithServer :: PluginDescriptor IdeState -> FilePath -> Session a -> IO a
68+
runSessionWithServer plugin = runSessionWithServer' [plugin] def def fullCaps
69+
70+
runSessionWithServerFormatter :: PluginDescriptor IdeState -> String -> FilePath -> Session a -> IO a
71+
runSessionWithServerFormatter plugin formatter =
72+
runSessionWithServer'
73+
[plugin]
74+
def {formattingProvider = T.pack formatter}
75+
def
76+
fullCaps
77+
78+
-- | Run an action, with stderr silenced
79+
silenceStderr :: IO a -> IO a
80+
silenceStderr action = withTempFile $ \temp ->
81+
bracket (openFile temp ReadWriteMode) hClose $ \h -> do
82+
old <- hDuplicate stderr
83+
buf <- hGetBuffering stderr
84+
h `hDuplicateTo'` stderr
85+
action `finally` do
86+
old `hDuplicateTo'` stderr
87+
hSetBuffering stderr buf
88+
hClose old
89+
90+
-- | Restore cwd after running an action
91+
keepCurrentDirectory :: IO a -> IO a
92+
keepCurrentDirectory = bracket getCurrentDirectory setCurrentDirectory . const
93+
94+
{-# NOINLINE lock #-}
95+
-- | Never run in parallel
96+
lock :: Lock
97+
lock = unsafePerformIO newLock
98+
99+
-- | Host a server, and run a test session on it
100+
-- Note: cwd will be shifted into @root@ in @Session a@
101+
runSessionWithServer' ::
102+
-- | plugins to load on the server
103+
[PluginDescriptor IdeState] ->
104+
-- | lsp config for the server
105+
Config ->
106+
-- | config for the test session
107+
SessionConfig ->
108+
ClientCapabilities ->
109+
FilePath ->
110+
Session a ->
111+
IO a
112+
runSessionWithServer' plugin conf sconf caps root s = withLock lock $ keepCurrentDirectory $ silenceStderr $ do
113+
(inR, inW) <- createPipe
114+
(outR, outW) <- createPipe
115+
server <-
116+
async $
117+
Ghcide.defaultMain
118+
def
119+
{ argsHandleIn = pure inR,
120+
argsHandleOut = pure outW,
121+
argsDefaultHlsConfig = conf,
122+
argsLogger = pure noLogging,
123+
argsIdeOptions = \config sessionLoader ->
124+
let ideOptions = (argsIdeOptions def config sessionLoader) {optTesting = IdeTesting True}
125+
in ideOptions {optShakeOptions = (optShakeOptions ideOptions) {shakeThreads = 2}},
126+
argsHlsPlugins = pluginDescToIdePlugins $ plugin ++ Ghcide.descriptors
127+
}
128+
x <- runSessionWithHandles inW outR sconf caps root s
129+
hClose inW
130+
timeout 3 (wait server) >>= \case
131+
Just () -> pure ()
132+
Nothing -> do
133+
putStrLn "Server does not exit in 3s, canceling the async task..."
134+
(t, _) <- duration $ cancel server
135+
putStrLn $ "Finishing canceling (took " <> showDuration t <> "s)"
136+
pure x

‎plugins/hls-brittany-plugin/hls-brittany-plugin.cabal

+32-43
Original file line numberDiff line numberDiff line change
@@ -1,59 +1,48 @@
1-
cabal-version: 2.4
2-
name: hls-brittany-plugin
3-
version: 1.0.0.0
4-
synopsis: Integration with the Brittany code formatter
5-
description: Please see the README on GitHub at <https://github.com/haskell/haskell-language-server#readme>
6-
license: Apache-2.0
7-
license-file: LICENSE
8-
author: The Haskell IDE Team
9-
copyright: The Haskell IDE Team
10-
maintainer: alan.zimm@gmail.com
11-
category: Development
12-
build-type: Simple
1+
cabal-version: 2.4
2+
name: hls-brittany-plugin
3+
version: 1.0.0.0
4+
synopsis: Integration with the Brittany code formatter
5+
description:
6+
Please see the README on GitHub at <https://github.com/haskell/haskell-language-server#readme>
7+
8+
license: Apache-2.0
9+
license-file: LICENSE
10+
author: The Haskell IDE Team
11+
copyright: The Haskell IDE Team
12+
maintainer: alan.zimm@gmail.com
13+
category: Development
14+
build-type: Simple
1315
extra-source-files:
1416
LICENSE
1517
test/testdata/**/*.hs
1618

1719
library
1820
exposed-modules: Ide.Plugin.Brittany
1921
hs-source-dirs: src
20-
build-depends: base >=4.12 && <5
21-
, brittany >= 0.13.1.0
22-
, filepath
23-
, ghc
24-
, ghc-boot-th
25-
, ghcide ^>= 1.1.0.0
26-
, lsp-types
27-
, hls-plugin-api >= 1.0 && < 1.2
28-
, lens
29-
, text
30-
, transformers
22+
build-depends:
23+
, base >=4.12 && <5
24+
, brittany >=0.13.1.0
25+
, filepath
26+
, ghc
27+
, ghc-boot-th
28+
, ghcide ^>=1.1.0.0
29+
, hls-plugin-api >=1.0 && <1.2
30+
, lens
31+
, lsp-types
32+
, text
33+
, transformers
3134

3235
default-language: Haskell2010
3336

34-
executable test-server
35-
default-language: Haskell2010
36-
build-depends:
37-
, base
38-
, data-default
39-
, ghcide
40-
, hls-brittany-plugin
41-
, hls-plugin-api
42-
, shake
43-
main-is: Server.hs
44-
hs-source-dirs: test
45-
ghc-options: -threaded
46-
4737
test-suite tests
48-
type: exitcode-stdio-1.0
49-
default-language: Haskell2010
50-
build-tool-depends:
51-
hls-brittany-plugin:test-server -any,
52-
hs-source-dirs: test
53-
main-is: Main.hs
38+
type: exitcode-stdio-1.0
39+
default-language: Haskell2010
40+
hs-source-dirs: test
41+
main-is: Main.hs
42+
ghc-options: -threaded -rtsopts -with-rtsopts=-N
5443
build-depends:
5544
, base
5645
, bytestring
5746
, hls-brittany-plugin
58-
, text
5947
, hls-test-utils
48+
, text

‎plugins/hls-brittany-plugin/test/Main.hs

+11-7
Original file line numberDiff line numberDiff line change
@@ -2,32 +2,36 @@
22
module Main(main) where
33

44
import qualified Data.ByteString.Lazy as BS
5-
import qualified Data.Text.Encoding as T
6-
import qualified Data.Text.IO as T
7-
import Test.Hls
5+
import qualified Data.Text.Encoding as T
6+
import qualified Data.Text.IO as T
7+
import qualified Ide.Plugin.Brittany as Brittany
8+
import Test.Hls
89

910
main :: IO ()
1011
main = defaultTestRunner tests
1112

13+
plugin :: PluginDescriptor IdeState
14+
plugin = Brittany.descriptor "brittany"
15+
1216
tests :: TestTree
1317
tests = testGroup "brittany" [
14-
goldenGitDiff "formats a document with LF endings" "test/testdata/BrittanyLF.formatted_document.hs" $ runSession testCommand fullCaps "test/testdata" $ do
18+
goldenGitDiff "formats a document with LF endings" "test/testdata/BrittanyLF.formatted_document.hs" $ runSessionWithServerFormatter plugin "brittany" "test/testdata" $ do
1519
doc <- openDoc "BrittanyLF.hs" "haskell"
1620
formatDoc doc (FormattingOptions 4 True Nothing Nothing Nothing)
1721
BS.fromStrict . T.encodeUtf8 <$> documentContents doc
1822

19-
, goldenGitDiff "formats a document with CRLF endings" "test/testdata/BrittanyCRLF.formatted_document.hs" $ runSession testCommand fullCaps "test/testdata" $ do
23+
, goldenGitDiff "formats a document with CRLF endings" "test/testdata/BrittanyCRLF.formatted_document.hs" $ runSessionWithServerFormatter plugin "brittany" "test/testdata" $ do
2024
doc <- openDoc "BrittanyCRLF.hs" "haskell"
2125
formatDoc doc (FormattingOptions 4 True Nothing Nothing Nothing)
2226
BS.fromStrict . T.encodeUtf8 <$> documentContents doc
2327

24-
, goldenGitDiff "formats a range with LF endings" "test/testdata/BrittanyLF.formatted_range.hs" $ runSession testCommand fullCaps "test/testdata" $ do
28+
, goldenGitDiff "formats a range with LF endings" "test/testdata/BrittanyLF.formatted_range.hs" $ runSessionWithServerFormatter plugin "brittany" "test/testdata" $ do
2529
doc <- openDoc "BrittanyLF.hs" "haskell"
2630
let range = Range (Position 1 0) (Position 2 22)
2731
formatRange doc (FormattingOptions 4 True Nothing Nothing Nothing) range
2832
BS.fromStrict . T.encodeUtf8 <$> documentContents doc
2933

30-
, goldenGitDiff "formats a range with CRLF endings" "test/testdata/BrittanyCRLF.formatted_range.hs" $ runSession testCommand fullCaps "test/testdata" $ do
34+
, goldenGitDiff "formats a range with CRLF endings" "test/testdata/BrittanyCRLF.formatted_range.hs" $ runSessionWithServerFormatter plugin "brittany" "test/testdata" $ do
3135
doc <- openDoc "BrittanyCRLF.hs" "haskell"
3236
let range = Range (Position 1 0) (Position 2 22)
3337
formatRange doc (FormattingOptions 4 True Nothing Nothing Nothing) range

‎plugins/hls-brittany-plugin/test/Server.hs

-19
This file was deleted.

0 commit comments

Comments
 (0)
Please sign in to comment.