Include testdata hie.yaml cradles

[isovector]

My tests were mysteriously failing on CI but not locally. Turns out the cradle is necessary for getting tests to run.

This also correlates with how the context functional tests are timing out (no hie.yaml checked in) but eval works just fine (has a hie.yaml).

[fendor]

Shouldn't these be generated as needed?

[isovector]

@fendor if they should be, they currently aren't.

[fendor]

Since you are not adding them to the git repo, I am wondering why it works when you stop ignoring them?

[fendor]

I think the issue is here: https://github.com/haskell/haskell-language-server/blob/master/test/utils/Test/Hls/Util.hs#L71

We did not have time to get our existing test-setup into shape since the merge with ghcide.

[isovector]

I'm not adding them to the git repo, but this gitignore caused me to spend 3 hours chasing my tail trying to figure out why the hell CI was broken but my tests worked locally. This PR doesn't fix anything, but it brings attention and will save future plugin authors pain.

[fendor]

But you should not commit them right?

I am sorry this caused so much pain for you, could you explain why it was hard to debug? We should improve this situation for everyone!

[fendor]

I am fine with it, but we should tackle the issue of getting the tests up-to-date

[lukel97]

Should we be calling setupBuildToolFiles at the start of these tests instead to fix this?

[fendor]

Isnt it called?
oh well. Yes, we should.

[jneira]

I infer from the discussion that this pr should be closed o changed to add setupBuildToolFiles instead unignore hie.yaml files, right?
//cc @isovector

[lukel97]

@jneira yes that would seem like the root cause. But now I'm stumped as to how the tests are working in the first place even

[jneira]

But now I'm stumped as to how the tests are working in the first place even

@bubba @fendor @isovector me too, analyzing the test code and data:

• Most tests are being ignored so although there is no hie.yaml, they pass
• Working tests (eval, tactic, etc) have a hie.yaml in its subdirectory, despite they were intended to be ignored with

haskell-language-server/.gitignore

Lines 23 to 24 in 438f699

	# ignore hie.yaml's for testdata
	test/testdata/**/hie.yaml

I suppose they were added with git add --force. 😺

• Moreover the hie.yaml generated by setupBuildToolFiles will not work anymore, as they should include modules explicitly

So, i would ignore hie.yaml's but:

• setupBuildToolFiles has to include auto all modules in the directory where it is about to be created (not sure if it would be feasible)
• specific tests should call a version of setupDirectFilesIn with a new parameter with the modules to add in the direct cradle
  • and remove the generic setupBuildToolFiles

[jneira]

I am gonna implement the second appoach in the hlint pull request, if you agree (but without touching existing working tests)

Finally i've added hie.yaml forcily in the pr to go forward. The fix should be in another pr.

[jneira]

Opened #517 to track the issue with testdata hie.yaml.
@isovector what do you think about close this pr as, hopefully, another one will be opened to fix the issue taking another path?