[Migrate OutlineTests.hs ferenceTests.hs] part of 4173 Migrate ghcide tests to hls test utils

[soulomoon]

part of #4173
OutlineTests result is really good speed improvement: (13.51s) -> (3.62s)

from

Running 1 test suites...
Test suite ghcide-tests: RUNNING...
ghcide
  outline
    type class:                  OK (0.79s)
    type class instance :        OK (0.75s)
    type family:                 OK (0.80s)
    type family instance :       OK (0.77s)
    data family:                 OK (0.80s)
    data family instance :       OK (0.78s)
    constant:                    OK (0.80s)
    pattern:                     OK (0.81s)
    pattern with type signature: OK (0.81s)
    function:                    OK (0.81s)
    type synonym:                OK (0.79s)
    datatype:                    OK (0.81s)
    record fields:               OK (0.79s)
    import:                      OK (0.81s)
    multiple import:             OK (0.80s)
    foreign import:              OK (0.80s)
    foreign export:              OK (0.80s)

All 17 tests passed (13.51s)

to

Running 1 test suites...
Test suite ghcide-tests: RUNNING...
ghcide
  outline
    type class:                      OK (0.38s)
    type class instance :        OK (0.21s)
    type family:                 OK (0.20s)
    type family instance :       OK (0.21s)
    data family:                 OK (0.20s)
    data family instance :       OK (0.20s)
    constant:                    OK (0.20s)
    pattern:                     OK (0.20s)
    pattern with type signature: OK (0.20s)
    function:                    OK (0.20s)
    type synonym:                OK (0.20s)
    datatype:                    OK (0.20s)
    record fields:               OK (0.20s)
    import:                      OK (0.20s)
    multiple import:             OK (0.20s)
    foreign import:              OK (0.21s)
    foreign export:              OK (0.20s)

All 17 tests passed (3.62s)

[michaelpj]

ghcide test changes look good, I'm a little unsure about the refactoring of the test support functions

[michaelpj]

Why do we need this? I can see you're abstracting over some common patterns, but I would have thought we could do that with a wrapper function or similar rather than needing a typeclass?

[soulomoon]

It provides us a way to expose the vsf during the test.
Some test in ghcide test need that.

[soulomoon]

It might not be a good idea to do it with wrapper since it need to be exposed from the very inside, down to the materialization of the vfs.
It might introduce a lot of duplicated code🤔

[michaelpj]

Could we just expose it to all tests and mostly ignore it?

[soulomoon]

I updated to use wrapper version. But not sure if it is better than typeclass version🤔
several wrapper functions need to be introduced. aadf028
WDYT

[michaelpj]

how is this different? some haddock would be helpful

[fendor]

Looks like it corresponds to a directory glob.

[michaelpj]

I guess I'm confused about how it differs from the previous entry 🤔 Do we need two ways of specifying directories?

[soulomoon]

we have have to manually specify the whole file tree down to the file levels in the second entry.
CopiedDirectory allows us to simply copied an existing folder to vfs.
Matching those tests in ghcide depend on the whole folder in the test/data.(Right, something like directory glob)
Yep, maybe a doc comment need to be added

[soulomoon]

added

[fendor]

I think we should only copy files that have been added to the git index. Cabal testsuite does something similar: https://github.com/haskell/cabal/blob/master/cabal-testsuite/src/Test/Cabal/Monad.hs#L417

[soulomoon]

Great, let's copy some of the cabal code

[soulomoon]

One concern though, does it mean we have to stage the new test files to get a correct behaviour when we run the tests

[soulomoon]

Right the --modified should list unstaged files
--others should list unstaged files, and still ignore .gitignores'

[soulomoon]

I have done some update base on the reviews, see what is still need to be improve?

[michaelpj]

I like this version better, thanks :)