Extracts ghcide-tests and migrate it to use hls-test-utils

[soulomoon]

I think we should pick up #3315,
This can be served as part of #3736,
Extracts ghcide-tests, and migrate the test to use hls-test-utils. This can be served as a pre-step to move the all the functionalities of ghcide to the stand alone plugin #2979

Some benifits:

1. Removal of code duplication.
2. Test speed up, we can refactor the test that is doing unconditional wait along the way.
3. Test correctness, we can refactor some tests that are not designed properly.

When I have done a proof of concept of #2979,
I migrate some of the tests to use hls-test-utils, I have some positive result, some tests can be run 2 to 3 times faster.

Jobs that need to be done

• merging ghcide-test-utils and hls-test-utils
  • [merge hls-test-utils and ghcide-test-utils] part of #4173 Migrate ghcide tests to hls test utils #4197
  • Delete library ghcide test utils #4274
  • Delete testUtil from ghcide-tests #4272
• move ghcide-tests to haskell-language-server.cabal and make it depend on hls-test-utils move ghcide-tests to haskell-language-server.cabal and make it depend on hls-test-utils #4176
• fix up each test to use hls-test-utils.
  • AsyncTests [Migrate AsyncTests] part of 4173 Migrate ghcide tests to hls test utils #4199
  • BootTests [Migrate BootTests] part of #4173 Migrate ghcide tests to hls test utils #4227
  • ClientSettingsTests Migrate ClientSettingsTests #4258
  • CodeLensTests Refactor hls-test-util and reduce getCurrentDirectory after initilization #4231
  • CompletionTests [Migrate CompletionTests] part of 4173 Migrate ghcide tests to hls test utils  #4192
  • CPPTests Refactor hls-test-util and reduce getCurrentDirectory after initilization #4231
  • CradleTests Refactor hls-test-util and reduce getCurrentDirectory after initilization #4231
  • DependentFileTest [Migrate DependentFileTest] part of #4173 Migrate ghcide tests to hls test utils #4195
  • DiagnosticTests [Migrate diagnosticTests] part of #4173 Migrate ghcide tests to hls test utils  #4207
  • ExceptionTests Refactor hls-test-util and reduce getCurrentDirectory after initilization #4231
  • FindDefinitionAndHoverTests Migrate FindDefinitionAndHoverTests and HighlightTests part of #4173 and fix HighlightTests #4202
  • FuzzySearch
  • GarbageCollectionTests Refactor hls-test-util and reduce getCurrentDirectory after initilization #4231
  • HaddockTests
  • HieDbRetry
  • HighlightTests Migrate FindDefinitionAndHoverTests and HighlightTests part of #4173 and fix HighlightTests #4202
  • IfaceTests [Migrate IfaceTests] part of #4173 Migrate ghcide tests to hls test utils and use canonicalizePath path in tmp dir in hls-test-utils #4201
  • InitializeResponseTests
  • LogType
  • NonLspCommandLine
  • OpenCloseTest [Migrate diagnosticTests] part of #4173 Migrate ghcide tests to hls test utils  #4207
  • OutlineTests [Migrate OutlineTests.hs ferenceTests.hs] part of 4173 Migrate ghcide tests to hls test utils  #4182
  • PluginSimpleTests Migrate PluginSimpleTests #4259
  • PositionMappingTests
  • PreprocessorTests Migrate PreprocessorTests #4260
  • Progress
  • ReferenceTests [Migrate OutlineTests.hs ferenceTests.hs] part of 4173 Migrate ghcide tests to hls test utils  #4182
  • RootUriTests Migrate RootUriTests #4261
  • SafeTests Migrate SafeTests #4267
  • SymlinkTests Migrate SymlinkTests #4266
  • THTests Refactor hls-test-util and reduce getCurrentDirectory after initilization #4231
  • UnitTests Migrate UnitTests #4268
  • WatchedFileTests Migrate WatchedFileTests #4269

[soulomoon]

Since the number of test are so large.
IMO, a workable solution is that we refactor one test file at a time, smooth the transition from ghcide-test-util to hls-test-util.