Movatterモバイル変換

[0]ホーム
URL:

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

 Sign up
Appearance settings

Commitffbf013

Browse files
authored
Set the XDG_CACHE_HOME for tests (#4572)
* Run all tests with temporary 'XDG_CACHE_HOME'This makes sure each test run is independent.Makes the tests* iface-error-test-1* iface-th-testless flaky locally.Should not have any effect on the CI flakiness issue.---Fix test cases to work with the temporary `XDG_CACHE_HOME`Some tests were launching additional HLS instances for the tests.Fixed, which should make the test slightly faster.* Run ghcide-tests if the hls-test-utils changesGhcide test infrastructure was refactored to depend on `hls-test-utils`.* Always use the same `mkHomeModLocation` for `mAIN_NAME`* Make cabal-add test directories considerably shorter* Make hls-test-root name shorter* Revert `mkHomeModLocation` changes* Overwrite test root dir on windows CI jobAdds support for the `HLS_TEST_ROOTDIR` which allows to overwrite thelocation for the test case artifacts.
1 parentff7a3c3 commitffbf013

File tree

38 files changed

+146
-81
lines changed

38 files changed

+146
-81
lines changed

‎.github/actions/setup-build/action.yml‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,13 @@ runs:
4444
echo "CABAL_PKGS_DIR=C:\\cabal\\packages" >> $GITHUB_ENV
4545
shell:bash
4646

47+
-if:inputs.os == 'Windows'
48+
name:(Windows) Platform config (root test directory)
49+
run:|
50+
mkdir C:\\hls-tests
51+
echo "HLS_TEST_ROOTDIR=C:\\hls-tests" >> $GITHUB_ENV
52+
shell:bash
53+
4754
-if:( inputs.os == 'Linux' ) || ( inputs.os == 'macOS' )
4855
name:(Linux,macOS) Platform config
4956
run:|

‎.github/workflows/test.yml‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -48,8 +48,7 @@ jobs:
4848
uses:fkirc/skip-duplicate-actions@v5.3.1
4949
with:
5050
cancel_others:false
51-
paths_ignore:'[ "hls-test-utils/**"
52-
, "plugins/**"
51+
paths_ignore:'[ "plugins/**"
5352
, "src/**"
5453
, "exe/**"
5554
, "test/**"

‎ghcide-test/exe/BootTests.hs‎

Lines changed: 18 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -27,25 +27,24 @@ tests = testGroup "boot"
2727
let cPath= dir</>"C.hs"
2828
cSource<- liftIO$ readFileUtf8 cPath
2929
-- Dirty the cache
30-
liftIO$ runInDir dir$do
31-
cDoc<- createDoc cPath"haskell" cSource
32-
-- We send a hover request then wait for either the hover response or
33-
-- `ghcide/reference/ready` notification.
34-
-- Once we receive one of the above, we wait for the other that we
35-
-- haven't received yet.
36-
-- If we don't wait for the `ready` notification it is possible
37-
-- that the `getDefinitions` request/response in the outer ghcide
38-
-- session will find no definitions.
39-
let hoverParams=HoverParams cDoc (Position43)Nothing
40-
hoverRequestId<- sendRequestSMethod_TextDocumentHover hoverParams
41-
let parseReadyMessage= isReferenceReady cPath
42-
let parseHoverResponse= responseForIdSMethod_TextDocumentHover hoverRequestId
43-
hoverResponseOrReadyMessage<- skipManyTill anyMessage ((Left<$> parseHoverResponse)<|> (Right<$> parseReadyMessage))
44-
_<- skipManyTill anyMessage$
45-
case hoverResponseOrReadyMessageof
46-
Left _-> void parseReadyMessage
47-
Right _-> void parseHoverResponse
48-
closeDoc cDoc
30+
cDoc<- createDoc cPath"haskell" cSource
31+
-- We send a hover request then wait for either the hover response or
32+
-- `ghcide/reference/ready` notification.
33+
-- Once we receive one of the above, we wait for the other that we
34+
-- haven't received yet.
35+
-- If we don't wait for the `ready` notification it is possible
36+
-- that the `getDefinitions` request/response in the outer ghcide
37+
-- session will find no definitions.
38+
let hoverParams=HoverParams cDoc (Position43)Nothing
39+
hoverRequestId<- sendRequestSMethod_TextDocumentHover hoverParams
40+
let parseReadyMessage= isReferenceReady cPath
41+
let parseHoverResponse= responseForIdSMethod_TextDocumentHover hoverRequestId
42+
hoverResponseOrReadyMessage<- skipManyTill anyMessage ((Left<$> parseHoverResponse)<|> (Right<$> parseReadyMessage))
43+
_<- skipManyTill anyMessage$
44+
case hoverResponseOrReadyMessageof
45+
Left _-> void parseReadyMessage
46+
Right _-> void parseHoverResponse
47+
closeDoc cDoc
4948
cdoc<- createDoc cPath"haskell" cSource
5049
locs<- getDefinitions cdoc (Position74)
5150
let floc= mkR9091

‎ghcide-test/exe/CradleTests.hs‎

Lines changed: 4 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33

44
moduleCradleTests (tests)where
55

6-
importConfig (checkDefs,mkL,runInDir,
6+
importConfig (checkDefs,mkL,
77
runWithExtraFiles,
88
testWithDummyPluginEmpty')
99
importControl.Applicative.Combinators
@@ -180,12 +180,9 @@ simpleMultiDefTest variant = ignoreForWindows $ testCase testName $
180180
runWithExtraFiles variant$\dir->do
181181
let aPath= dir</>"a/A.hs"
182182
bPath= dir</>"b/B.hs"
183-
adoc<- liftIO$ runInDir dir$do
184-
aSource<- liftIO$ readFileUtf8 aPath
185-
adoc<- createDoc aPath"haskell" aSource
186-
skipManyTill anyMessage$ isReferenceReady aPath
187-
closeDoc adoc
188-
pure adoc
183+
adoc<- openDoc aPath"haskell"
184+
skipManyTill anyMessage$ isReferenceReady aPath
185+
closeDoc adoc
189186
bSource<- liftIO$ readFileUtf8 bPath
190187
bdoc<- createDoc bPath"haskell" bSource
191188
locs<- getDefinitions bdoc (Position27)

‎ghcide-test/exe/FindDefinitionAndHoverTests.hs‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -188,7 +188,7 @@ tests = let
188188
cccL17=Position1716 ; docLink= [ExpectHoverTextRegex"\\*Defined in 'GHC.Types'\\*\\*\\(ghc-prim-[0-9.]+\\)\\*\n\n"]
189189
imported=Position5613 ; importedSig= getDocUri"Foo.hs">>=\foo->return [ExpectHoverText ["foo","Foo","Haddock"], mkL foo5053]
190190
reexported=Position5514
191-
reexportedSig= getDocUri"Bar.hs">>=\bar->return [ExpectHoverText ["Bar","Bar","Haddock"],if ghcVersion<GHC910||not isWindowsthen mkL bar3538elsemkL bar30314]
191+
reexportedSig= getDocUri"Bar.hs">>=\bar->return [ExpectHoverText ["Bar","Bar","Haddock"], mkL bar30314]
192192
thLocL57=Position5910 ; thLoc= [ExpectHoverText ["Identity"]]
193193
cmtL68=Position670 ; lackOfdEq= [ExpectHoverExcludeText ["$dEq"]]
194194
import310=Position310; pkgTxt= [ExpectHoverText ["Data.Text\n\ntext-"]]

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

Lines changed: 78 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -507,32 +507,73 @@ runSessionWithServerInTmpDir config plugin tree act =
507507
{testLspConfig=config, testPluginDescriptor= plugin, testDirLocation=Right tree}
508508
(const act)
509509

510-
runWithLockInTempDir::VirtualFileTree-> (FileSystem->IOa)->IOa
511-
runWithLockInTempDir tree act= withLock lockForTempDirs$do
510+
--| Same as 'withTemporaryDataAndCacheDirectory', but materialises the given
511+
-- 'VirtualFileTree' in the temporary directory.
512+
withVfsTestDataDirectory::VirtualFileTree-> (FileSystem->IOa)->IOa
513+
withVfsTestDataDirectory tree act=do
514+
withTemporaryDataAndCacheDirectory$\tmpRoot->do
515+
fs<-FS.materialiseVFT tmpRoot tree
516+
act fs
517+
518+
--| Run an action in a temporary directory.
519+
-- Sets the 'XDG_CACHE_HOME' environment variable to a temporary directory as well.
520+
--
521+
-- This sets up a temporary directory for HLS tests to run.
522+
-- Typically, HLS tests copy their test data into the directory and then launch
523+
-- the HLS session in that directory.
524+
-- This makes sure that the tests are run in isolation, which is good for correctness
525+
-- but also important to have fast tests.
526+
--
527+
-- For improved isolation, we also make sure the 'XDG_CACHE_HOME' environment
528+
-- variable points to a temporary directory. So, we never share interface files
529+
-- or the 'hiedb' across tests.
530+
withTemporaryDataAndCacheDirectory:: (FilePath->IOa)->IOa
531+
withTemporaryDataAndCacheDirectory act= withLock lockForTempDirs$do
512532
testRoot<- setupTestEnvironment
513533
helperRecorder<- hlsHelperTestRecorder
514534
-- Do not clean up the temporary directory if this variable is set to anything but '0'.
515535
-- Aids debugging.
516536
cleanupTempDir<- lookupEnv"HLS_TEST_HARNESS_NO_TESTDIR_CLEANUP"
517537
let runTestInDir action=case cleanupTempDirof
518538
Just val| val/="0"->do
519-
(tempDir, _)<-newTempDirWithin testRoot
520-
a<- action tempDir
539+
(tempDir,cacheHome,_)<-setupTemporaryTestDirectories testRoot
540+
a<-withTempCacheHome cacheHome (action tempDir)
521541
logWith helperRecorderDebugLogNoCleanup
522542
pure a
523543

524544
_->do
525-
(tempDir, cleanup)<-newTempDirWithin testRoot
526-
a<- action tempDir`finally` cleanup
545+
(tempDir,cacheHome,cleanup)<-setupTemporaryTestDirectories testRoot
546+
a<-withTempCacheHome cacheHome (action tempDir)`finally` cleanup
527547
logWith helperRecorderDebugLogCleanup
528548
pure a
529549
runTestInDir$\tmpDir'->do
530550
-- we canonicalize the path, so that we do not need to do
531-
--cannibalization during the test when we compare two paths
551+
--canonicalization during the test when we compare two paths
532552
tmpDir<- canonicalizePath tmpDir'
533553
logWith helperRecorderInfo$LogTestDir tmpDir
534-
fs<-FS.materialiseVFT tmpDir tree
535-
act fs
554+
act tmpDir
555+
where
556+
cache_home_var="XDG_CACHE_HOME"
557+
-- Set the dir for "XDG_CACHE_HOME".
558+
-- When the operation finished, make sure the old value is restored.
559+
withTempCacheHome tempCacheHomeDir act=
560+
bracket
561+
(do
562+
old_cache_home<- lookupEnv cache_home_var
563+
setEnv cache_home_var tempCacheHomeDir
564+
pure old_cache_home)
565+
(\old_cache_home->
566+
maybe (pure()) (setEnv cache_home_var) old_cache_home
567+
)
568+
(\_-> act)
569+
570+
-- Set up a temporary directory for the test files and one for the 'XDG_CACHE_HOME'.
571+
-- The 'XDG_CACHE_HOME' is important for independent test runs, i.e. completely empty
572+
-- caches.
573+
setupTemporaryTestDirectories testRoot=do
574+
(tempTestCaseDir, cleanup1)<- newTempDirWithin testRoot
575+
(tempCacheHomeDir, cleanup2)<- newTempDirWithin testRoot
576+
pure (tempTestCaseDir, tempCacheHomeDir, cleanup1>> cleanup2)
536577

537578
runSessionWithServer::Prettyb=>Config->PluginTestDescriptorb->FilePath->Sessiona->IOa
538579
runSessionWithServer config plugin fp act=
@@ -565,18 +606,18 @@ instance Default (TestConfig b) where
565606
-- It returns the root to the testing directory that tests should use.
566607
-- This directory is not fully cleaned between reruns.
567608
-- However, it is totally safe to delete the directory between runs.
568-
--
569-
-- Additionally, this overwrites the 'XDG_CACHE_HOME' variable to isolate
570-
-- the tests from existing caches. 'hie-bios' and 'ghcide' honour the
571-
-- 'XDG_CACHE_HOME' environment variable and generate their caches there.
572609
setupTestEnvironment::IOFilePath
573610
setupTestEnvironment=do
574-
tmpDirRoot<- getTemporaryDirectory
575-
let testRoot= tmpDirRoot</>"hls-test-root"
576-
testCacheDir= testRoot</>".cache"
577-
createDirectoryIfMissingTrue testCacheDir
578-
setEnv"XDG_CACHE_HOME" testCacheDir
579-
pure testRoot
611+
mRootDir<- lookupEnv"HLS_TEST_ROOTDIR"
612+
case mRootDirof
613+
Nothing->do
614+
tmpDirRoot<- getTemporaryDirectory
615+
let testRoot= tmpDirRoot</>"hls-test-root"
616+
createDirectoryIfMissingTrue testRoot
617+
pure testRoot
618+
Just rootDir->do
619+
createDirectoryIfMissingTrue rootDir
620+
pure rootDir
580621

581622
goldenWithHaskellDocFormatter
582623
::Prettyb
@@ -692,7 +733,6 @@ lockForTempDirs = unsafePerformIO newLock
692733
dataTestConfigb=TestConfig
693734
{
694735
testDirLocation::EitherFilePathVirtualFileTree
695-
--^ Client capabilities
696736
--^ The file tree to use for the test, either a directory or a virtual file tree
697737
-- if using a virtual file tree,
698738
-- Creates a temporary directory, and materializes the VirtualFileTree
@@ -747,8 +787,20 @@ wrapClientLogger logger = do
747787
return (lspLogRecorder<> logger, cb1)
748788

749789
--| Host a server, and run a test session on it.
750-
-- For setting custom timeout, set the environment variable 'LSP_TIMEOUT'
751-
-- * LSP_TIMEOUT=10 cabal test
790+
--
791+
-- Environment variables are used to influence logging verbosity, test cleanup and test execution:
792+
--
793+
-- * @LSP_TIMEOUT@: Set a specific test timeout in seconds.
794+
-- * @LSP_TEST_LOG_MESSAGES@: Log the LSP messages between the client and server.
795+
-- * @LSP_TEST_LOG_STDERR@: Log the stderr of the server to the stderr of this process.
796+
-- * @HLS_TEST_HARNESS_STDERR@: Log test setup messages.
797+
--
798+
-- Test specific environment variables:
799+
--
800+
-- * @HLS_TEST_PLUGIN_LOG_STDERR@: Log all messages of the hls plugin under test to stderr.
801+
-- * @HLS_TEST_LOG_STDERR@: Log all HLS messages to stderr.
802+
-- * @HLS_TEST_HARNESS_NO_TESTDIR_CLEANUP@: Don't remove the test directories after test execution.
803+
--
752804
-- For more detail of the test configuration, see 'TestConfig'
753805
runSessionWithTestConfig::Prettyb=>TestConfigb-> (FilePath->Sessiona)->IOa
754806
runSessionWithTestConfigTestConfig{..} session=
@@ -792,8 +844,10 @@ runSessionWithTestConfig TestConfig{..} session =
792844
else f
793845
runSessionInVFS (Left testConfigRoot) act=do
794846
root<- makeAbsolute testConfigRoot
795-
act root
796-
runSessionInVFS (Right vfs) act= runWithLockInTempDir vfs$\fs-> act (fsRoot fs)
847+
withTemporaryDataAndCacheDirectory (const$ act root)
848+
runSessionInVFS (Right vfs) act=
849+
withVfsTestDataDirectory vfs$\fs->do
850+
act (fsRoot fs)
797851
testingArgs prjRoot recorderIde plugins=
798852
let
799853
arguments@Arguments{ argsHlsPlugins, argsIdeOptions, argsLspOptions }= defaultArguments (cmapWithPrioLogIDEMain recorderIde) prjRoot plugins

‎plugins/hls-cabal-plugin/test/CabalAdd.hs‎

Lines changed: 21 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -83,30 +83,29 @@ cabalAddDependencyTests :: TestTree
8383
cabalAddDependencyTests=
8484
testGroup
8585
"Add dependency"
86-
[ runHaskellTestCaseSession"Add to executable" ("cabal-add-testdata"</>"cabal-add-exe")
87-
(generateAddDependencyTestSession"cabal-add-exe.cabal" ("src"</>"Main.hs")"split" [253])
88-
, runHaskellTestCaseSession"Add to library" ("cabal-add-testdata"</>"cabal-add-lib")
89-
(generateAddDependencyTestSession"cabal-add-lib.cabal" ("src"</>"MyLib.hs")"split" [348])
90-
, runHaskellTestCaseSession"Add to testsuite" ("cabal-add-testdata"</>"cabal-add-tests")
91-
(generateAddDependencyTestSession"cabal-add-tests.cabal" ("test"</>"Main.hs")"split" [478])
92-
, runHaskellTestCaseSession"Add to testsuite with PackageImports" ("cabal-add-testdata"</>"cabal-add-tests")
93-
(generateAddDependencyTestSession"cabal-add-tests.cabal" ("test"</>"MainPackageImports.hs")"split" [731])
94-
, runHaskellTestCaseSession"Add to benchmark" ("cabal-add-testdata"</>"cabal-add-bench")
95-
(generateAddDependencyTestSession"cabal-add-bench.cabal" ("bench"</>"Main.hs")"split" [403])
86+
[ runHaskellTestCaseSession"Add to executable" ("cabal-add-testdata"</>"exe")
87+
(generateAddDependencyTestSession"exe.cabal" ("src"</>"Main.hs")"split" [253])
88+
, runHaskellTestCaseSession"Add to library" ("cabal-add-testdata"</>"lib")
89+
(generateAddDependencyTestSession"lib.cabal" ("src"</>"MyLib.hs")"split" [348])
90+
, runHaskellTestCaseSession"Add to testsuite" ("cabal-add-testdata"</>"tests")
91+
(generateAddDependencyTestSession"tests.cabal" ("test"</>"Main.hs")"split" [478])
92+
, runHaskellTestCaseSession"Add to testsuite with PackageImports" ("cabal-add-testdata"</>"tests")
93+
(generateAddDependencyTestSession"tests.cabal" ("test"</>"MainPackageImports.hs")"split" [731])
94+
, runHaskellTestCaseSession"Add to benchmark" ("cabal-add-testdata"</>"bench")
95+
(generateAddDependencyTestSession"bench.cabal" ("bench"</>"Main.hs")"split" [403])
9696

97-
, runHaskellTestCaseSession"Add to executable, multiple targets" ("cabal-add-testdata"</>"cabal-add-multitarget")
98-
(generateAddDependencyTestSession"cabal-add-multitarget.cabal" ("src"</>"Main.hs")"split" [269])
99-
, runHaskellTestCaseSession"Add to library, multiple targets" ("cabal-add-testdata"</>"cabal-add-multitarget")
100-
(generateAddDependencyTestSession"cabal-add-multitarget.cabal" ("lib"</>"MyLib.hs")"split" [413])
101-
, runHaskellTestCaseSession"Add to internal library, multiple targets" ("cabal-add-testdata"</>"cabal-add-multitarget")
102-
(generateAddDependencyTestSession"cabal-add-multitarget.cabal" ("lib"</>"InternalLib.hs")"split" [413])
103-
, runHaskellTestCaseSession"Add to testsuite, multiple targets" ("cabal-add-testdata"</>"cabal-add-multitarget")
104-
(generateAddDependencyTestSession"cabal-add-multitarget.cabal" ("test"</>"Main.hs")"split" [655])
105-
, runHaskellTestCaseSession"Add to benchmark, multiple targets" ("cabal-add-testdata"</>"cabal-add-multitarget")
106-
(generateAddDependencyTestSession"cabal-add-multitarget.cabal" ("bench"</>"Main.hs")"split" [776])
97+
, runHaskellTestCaseSession"Add to executable, multiple targets" ("cabal-add-testdata"</>"multitarget")
98+
(generateAddDependencyTestSession"multitarget.cabal" ("src"</>"Main.hs")"split" [269])
99+
, runHaskellTestCaseSession"Add to library, multiple targets" ("cabal-add-testdata"</>"multitarget")
100+
(generateAddDependencyTestSession"multitarget.cabal" ("lib"</>"MyLib.hs")"split" [413])
101+
, runHaskellTestCaseSession"Add to internal library, multiple targets" ("cabal-add-testdata"</>"multitarget")
102+
(generateAddDependencyTestSession"multitarget.cabal" ("lib"</>"InternalLib.hs")"split" [413])
103+
, runHaskellTestCaseSession"Add to testsuite, multiple targets" ("cabal-add-testdata"</>"multitarget")
104+
(generateAddDependencyTestSession"multitarget.cabal" ("test"</>"Main.hs")"split" [655])
105+
, runHaskellTestCaseSession"Add to benchmark, multiple targets" ("cabal-add-testdata"</>"multitarget")
106+
(generateAddDependencyTestSession"multitarget.cabal" ("bench"</>"Main.hs")"split" [776])
107107

108-
109-
, runHaskellTestCaseSession"Guard against HPack" ("cabal-add-testdata"</>"cabal-add-packageYaml")
108+
, runHaskellTestCaseSession"Guard against HPack" ("cabal-add-testdata"</>"packageYaml")
110109
(generatePackageYAMLTestSession ("src"</>"Main.hs"))
111110

112111
, testHiddenPackageSuggestions"Check CabalAdd's parser, no version"
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
packages: ./

0 commit comments

Comments
 (0)
[8]ページ先頭
©2009-2025 Movatter.jp