Skip to content

Set the XDG_CACHE_HOME for tests #4572

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 7 commits into from
Oct 28, 2025
Merged

Set the XDG_CACHE_HOME for tests #4572

merged 7 commits into from
Oct 28, 2025

Conversation

@fendor
Copy link
Collaborator

@fendor fendor commented Apr 27, 2025 •
edited
Loading

This makes sure each test run is independent.

Makes the tests

  • iface-error-test-1
  • iface-th-test

less flaky locally. On my machine, these tests were consistently failing after the first successful execution (due to caching the hiedb afaict.)
Should not have any effect on the CI flakiness issue.

@fendor fendor force-pushed the fix/tests-xdg-cache-home branch from 1a34302 to 7df2e36 Compare April 27, 2025 13:54
@fendor fendor requested review from jhrcek and soulomoon April 27, 2025 14:26
soulomoon
soulomoon reviewed Apr 27, 2025
View reviewed changes
Copy link
Collaborator

@soulomoon soulomoon left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. But ghcide test is not running for this PR, do you know why it is skipped

@fendor
Copy link
Collaborator Author

fendor commented Apr 27, 2025

https://github.com/haskell/haskell-language-server/blob/master/.github/workflows/test.yml#L51

Outdated skip in CI. Gonna fix that!

@fendor fendor requested a review from michaelpj as a code owner April 27, 2025 15:13
@fendor
Copy link
Collaborator Author

fendor commented Apr 27, 2025

Test failures all look genuine, so more investigation is required.

@fendor fendor requested a review from wz1000 as a code owner May 5, 2025 16:33
@fendor fendor force-pushed the fix/tests-xdg-cache-home branch from 3be9351 to 8dcd861 Compare May 7, 2025 16:53
fendor
fendor commented May 7, 2025
View reviewed changes
ghcide/src/Development/IDE/Core/Compile.hs Outdated
-- specially in tests it's common to have lots of nameless modules
-- mkHomeModLocation will map them to the same hi/hie locations
then mkHomeModLocation dflags (pathToModuleName fp) fp
then mkHomeModLocation dflags mod fp
Copy link
Collaborator Author

@fendor fendor May 7, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This seems to be causing long-path issues on windows.
I am unsure how relevant this still is... Anybody an idea?

Copy link
Collaborator Author

@fendor fendor Jun 11, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In a test cabal project, it seems we always create separate .hi/.hie files

image

Copy link
Collaborator Author

@fendor fendor Jun 11, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

But not, if there are multiple "main" scripts:
image

Copy link
Collaborator Author

@fendor fendor Jun 11, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is unfortunately a case we have to support, so this change can't be applied as is.

fendor
fendor commented May 7, 2025
View reviewed changes
jian-lin
jian-lin reviewed May 7, 2025
View reviewed changes
@fendor fendor force-pushed the fix/tests-xdg-cache-home branch 5 times, most recently from 7729e73 to a7ad2c6 Compare May 14, 2025 15:40
@fendor fendor force-pushed the fix/tests-xdg-cache-home branch from bb55dd7 to b27f3d2 Compare June 9, 2025 15:57
fendor
fendor commented Jun 14, 2025
View reviewed changes
@fendor fendor mentioned this pull request Aug 18, 2025
Open
@soulomoon
Copy link
Collaborator

soulomoon commented Aug 19, 2025 •
edited
Loading

Is it blocking by the long path issue for windows? Can we shrink the test cache dir path?

@fendor
Copy link
Collaborator Author

fendor commented Aug 19, 2025 •
edited
Loading

@soulomoon Yes, it is blocking :(

I have no idea how to further shrink down the test cache dir path, without either reimplementing createTemporaryDirectory, or mangling test-case names.
I am further confused why this even is an issue, as the CI runners allegedly enable long file paths.

@soulomoon soulomoon mentioned this pull request Aug 20, 2025
Open
@soulomoon
Copy link
Collaborator

soulomoon commented Aug 21, 2025 •
edited
Loading

That seems to be ghc's issue ? see https://gitlab.haskell.org/ghc/ghc/-/issues/13373 @fendor

So to workaround this, we might have to customize our createTemporaryDirectory ?

@fendor
Copy link
Collaborator Author

fendor commented Aug 21, 2025

I am not sure if the issue is still relevant

fendor and others added 3 commits October 28, 2025 09:18
@fendor
Run all tests with temporary 'XDG_CACHE_HOME'
c967b68 
This makes sure each test run is independent.

Makes the tests
* iface-error-test-1
* iface-th-test

less 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.
@fendor
Run ghcide-tests if the hls-test-utils changes
3944409 
Ghcide test infrastructure was refactored to depend on `hls-test-utils`.
@fendor
Always use the same mkHomeModLocation for mAIN_NAME
9295cfb
@fendor fendor force-pushed the fix/tests-xdg-cache-home branch from c873852 to f5371bc Compare October 28, 2025 08:34
@fendor fendor force-pushed the fix/tests-xdg-cache-home branch 2 times, most recently from 17c54f8 to b625c58 Compare October 28, 2025 09:22
fendor and others added 4 commits October 28, 2025 10:55
@fendor fendor force-pushed the fix/tests-xdg-cache-home branch from b625c58 to 88c5687 Compare October 28, 2025 09:55
@fendor
Copy link
Collaborator Author

fendor commented Oct 28, 2025 •
edited
Loading

The lazy solution to set a shorter test directory on windows seems to be working. Finally!

@guibou, @soulomoon perhaps a final review? Otherwise, Ill just merge it.

soulomoon
soulomoon approved these changes Oct 28, 2025
View reviewed changes
Copy link
Collaborator

@soulomoon soulomoon left a comment •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Look good to me, I can't reproduce the long path problem in a local windows machine, so it must be a CI machine problem. So set a shorter path in .github/actions/setup-build/action.yml look like a good idea to me.

@fendor fendor added the merge me Label to trigger pull request merge label Oct 28, 2025
@fendor fendor merged commit ffbf013 into haskell:master Oct 28, 2025
81 of 91 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@jian-lin jian-lin jian-lin left review comments

@michaelpj michaelpj michaelpj approved these changes

@soulomoon soulomoon soulomoon approved these changes

@jhrcek jhrcek Awaiting requested review from jhrcek

@wz1000 wz1000 Awaiting requested review from wz1000

Assignees

No one assigned

Labels

merge me Label to trigger pull request merge

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@fendor @soulomoon @michaelpj @jian-lin