Skip to content

Refactor hls-refactor-plugin-tests to use VirtualFileTree #32

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

Draft
wants to merge 5 commits into
base: improve-hls-graph
Choose a base branch
from
Draft

Refactor hls-refactor-plugin-tests to use VirtualFileTree #32

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
f4a8e08
Initial plan
Copilot Oct 31, 2025
0f4dd67
Refactor test helpers to use VirtualFileTree instead of manual file c…
Copilot Oct 31, 2025
f33f1e0
Fix trailing whitespace in test helpers
Copilot Oct 31, 2025
20c9181
Match ghcide test pattern with explicit testDataDir constant
Copilot Nov 2, 2025
18f68dc
Fix import: remove incorrect readFileUtf8 import from System.IO.Extra
Copilot Nov 4, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
50 changes: 18 additions & 32 deletions plugins/hls-refactor-plugin/test/Main.hs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,17 +26,13 @@ import Development.IDE.GHC.Util
import Development.IDE.Plugin.Completions.Types (extendImportCommandId)
import Development.IDE.Test
import Development.IDE.Types.Location
import Development.Shake (getDirectoryFilesIO)
import qualified Language.LSP.Protocol.Lens as L
import Language.LSP.Protocol.Message
import Language.LSP.Protocol.Types hiding
(SemanticTokensEdit (_start),
mkRange)
import Language.LSP.Test
import System.Directory
import System.FilePath
import qualified System.IO.Extra
import System.IO.Extra hiding (withTempDir)
import System.Time.Extra
import Test.Tasty
import Test.Tasty.HUnit
Expand All @@ -45,6 +41,7 @@ import Text.Regex.TDFA ((=~))

import Development.IDE.Plugin.CodeAction (matchRegExMultipleImports)
import Test.Hls
import qualified Test.Hls.FileSystem as FS

import qualified Development.IDE.GHC.ExactPrint
import Development.IDE.Plugin.CodeAction (NotInScope (..))
Expand Down Expand Up @@ -4031,40 +4028,29 @@ testSessionWithExtraFiles :: HasCallStack => FilePath -> TestName -> (FilePath -
testSessionWithExtraFiles prefix name = testCase name . runWithExtraFiles prefix

runWithExtraFiles :: HasCallStack => FilePath -> (FilePath -> Session a) -> IO a
runWithExtraFiles prefix s = withTempDir $ \dir -> do
copyTestDataFiles dir prefix
runInDir dir (s dir)

copyTestDataFiles :: HasCallStack => FilePath -> FilePath -> IO ()
copyTestDataFiles dir prefix = do
-- Copy all the test data files to the temporary workspace
testDataFiles <- getDirectoryFilesIO ("plugins/hls-refactor-plugin/test/data" </> prefix) ["//*"]
for_ testDataFiles $ \f -> do
createDirectoryIfMissing True $ dir </> takeDirectory f
copyFile ("plugins/hls-refactor-plugin/test/data" </> prefix </> f) (dir </> f)

run :: Session a -> IO a
run s = run' (const s)

run' :: (FilePath -> Session a) -> IO a
run' s = withTempDir $ \dir -> runInDir dir (s dir)

runInDir :: FilePath -> Session a -> IO a
runInDir dir act =
runWithExtraFiles prefix s =
runSessionWithTestConfig def
{ testDirLocation = Left dir
{ testDirLocation = Right $ mkVirtualFileTreeWithPrefix prefix
, testPluginDescriptor = refactorPlugin
, testConfigCaps = lspTestCaps }
$ const act
s

testDataDir :: FilePath
testDataDir = "plugins/hls-refactor-plugin/test/data"

mkVirtualFileTreeWithPrefix :: FilePath -> FS.VirtualFileTree
mkVirtualFileTreeWithPrefix prefix =
FS.mkVirtualFileTree testDataDir [FS.copyDir prefix]

run :: Session a -> IO a
run s = runSessionWithTestConfig def
{ testDirLocation = Right $ FS.mkVirtualFileTree testDataDir []
, testPluginDescriptor = refactorPlugin
, testConfigCaps = lspTestCaps }
(const s)

lspTestCaps :: ClientCapabilities
lspTestCaps = fullLatestClientCaps { _window = Just $ WindowClientCapabilities (Just True) Nothing Nothing }

pattern R :: UInt -> UInt -> UInt -> UInt -> Range
pattern R x y x' y' = Range (Position x y) (Position x' y')

-- | Version of 'System.IO.Extra.withTempDir' that canonicalizes the path
-- Which we need to do on macOS since the $TMPDIR can be in @/private/var@ or
-- @/var@
withTempDir :: (FilePath -> IO a) -> IO a
withTempDir f = System.IO.Extra.withTempDir $ (canonicalizePath >=> f)