This repository was archived by the owner on Oct 7, 2020. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 206
/
Copy pathHsImportSpec.hs
199 lines (176 loc) · 8.96 KB
/
HsImportSpec.hs
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
{-# LANGUAGE OverloadedStrings #-}
module HsImportSpec where
import Control.Monad.IO.Class
import qualified Data.Text as T
import qualified Data.HashMap.Strict as Map
import Haskell.Ide.Engine.MonadTypes
import Haskell.Ide.Engine.PluginUtils
import Haskell.Ide.Engine.Plugin.HsImport
import qualified Haskell.Ide.Engine.Config as Config
import qualified Haskell.Ide.Engine.Plugin.Brittany as Brittany
import qualified Haskell.Ide.Engine.Plugin.Ormolu as Ormolu
import qualified Haskell.Ide.Engine.Plugin.Floskell as Floskell
import System.Directory
import System.FilePath
import Test.Hspec
import TestUtils
main :: IO ()
main = hspec spec
spec :: Spec
spec =
describe "hsimport plugin" hsImportSpec
-- ---------------------------------------------------------------------
testPlugins :: IdePlugins
testPlugins = pluginDescToIdePlugins
[ Brittany.brittanyDescriptor "brittany"
, Floskell.floskellDescriptor "floskell"
, Ormolu.ormoluDescriptor "ormolu"
]
codeActionImportList :: FilePath
codeActionImportList = "test" </> "testdata" </> "CodeActionImportList.hs"
codeActionBigImportList :: FilePath
codeActionBigImportList = "test" </> "testdata" </> "CodeActionImportListElaborate.hs"
dispatchRequestP :: IdeGhcM a -> IO a
dispatchRequestP act = do
cwd <- liftIO getCurrentDirectory
runIGM testPlugins (cwd </> "test" </> "testdata" </> "File.hs") act
-- ---------------------------------------------------------------------
hsImportSpec :: Spec
hsImportSpec = do
describe "formats with brittany" $ hsImportSpecRunner "brittany"
[ -- Expected output for simple format.
[ TextEdit (Range (toPos (2, 1)) (toPos (2, 1))) "import Control.Monad\n"
]
, [ TextEdit (Range (toPos (2, 1)) (toPos (2, 1))) "import Control.Monad ( when )\n"
]
, [ TextEdit (Range (toPos (2, 1)) (toPos (2, 1))) "import Data.Maybe ( Maybe )\n"
]
, [ TextEdit (Range (toPos (2, 1)) (toPos (2, 1))) "import Data.Maybe ( Maybe(..) )\n"
]
, [ TextEdit (Range (toPos (2, 1)) (toPos (2, 1))) "import Data.Maybe ( Maybe(Nothing) )\n"
]
, [ TextEdit (Range (toPos (2, 1)) (toPos (2, 1))) "import Data.Function ( ($) )\n"
]
, [ TextEdit (Range (toPos (2, 1)) (toPos (2, 32))) $
"import System.IO ( IO\n" <>
" , hPutStrLn\n" <>
" )"
]
, [ TextEdit (Range (toPos (3, 1)) (toPos (3, 99))) $
"import Data.List ( find\n" <>
" , head\n" <>
" , last\n" <>
" , tail\n" <>
" , init\n" <>
" , union\n" <>
" , (\\\\)\n" <>
" , null\n" <>
" , length\n" <>
" , cons\n" <>
" , uncons\n" <>
" , reverse\n" <>
" )"
]
]
describe "formats with floskell" $ hsImportSpecRunner "floskell"
[ -- Expected output for simple format.
[ TextEdit (Range (toPos (2, 1)) (toPos (2, 1))) "import Control.Monad\n"
]
, [ TextEdit (Range (toPos (2, 1)) (toPos (2, 1))) "import Control.Monad (when)\n"
]
, [ TextEdit (Range (toPos (2, 1)) (toPos (2, 1))) "import Data.Maybe (Maybe)\n"
]
, [ TextEdit (Range (toPos (2, 1)) (toPos (2, 1))) "import Data.Maybe (Maybe(..))\n"
]
, [ TextEdit (Range (toPos (2, 1)) (toPos (2, 1))) "import Data.Maybe (Maybe(Nothing))\n"
]
, [ TextEdit (Range (toPos (2, 1)) (toPos (2, 1))) "import Data.Function (($))\n"
]
, [ TextEdit (Range (toPos (2, 1)) (toPos (2, 32))) "import System.IO (IO, hPutStrLn)"
]
, [ TextEdit (Range (toPos (3, 1)) (toPos (3, 99))) $
"import Data.List (find, head, last, tail, init, union, (\\\\), null\n" <>
" , length, cons, uncons, reverse)"
]
]
describe "formats with ormolu" $ case ghcVersion of
GHC86 -> hsImportSpecRunner "ormolu"
[ -- Expected output for simple format.
[ TextEdit (Range (toPos (2, 1)) (toPos (2, 1))) "import Control.Monad\n"
]
, [ TextEdit (Range (toPos (2, 1)) (toPos (2, 1))) "import Control.Monad (when)\n"
]
, [ TextEdit (Range (toPos (2, 1)) (toPos (2, 1))) "import Data.Maybe (Maybe)\n"
]
, [ TextEdit (Range (toPos (2, 1)) (toPos (2, 1))) "import Data.Maybe (Maybe (..))\n"
]
, [ TextEdit (Range (toPos (2, 1)) (toPos (2, 1))) "import Data.Maybe (Maybe (Nothing))\n"
]
, [ TextEdit (Range (toPos (2, 1)) (toPos (2, 1))) "import Data.Function (($))\n"
]
, [ TextEdit (Range (toPos (2, 1)) (toPos (2, 32))) "import System.IO (IO, hPutStrLn)"
]
, [ TextEdit (Range (toPos (3, 1)) (toPos (3, 99))) "import Data.List ((\\\\), cons, find, head, init, last, length, null, reverse, tail, uncons, union)"
]
]
_ -> it "is NOP formatter" $
pendingWith "Ormolu only supported by GHC >= 8.6. Need to restore this."
-- ---------------------------------------------------------------------
-- Parameterized HsImport Spec.
-- ---------------------------------------------------------------------
hsImportSpecRunner :: T.Text -> [[TextEdit]] -> Spec
hsImportSpecRunner formatterName [e1, e2, e3, e4, e5, e6, e7, e8] = do
it "formats" $ do
fp <- makeAbsolute codeActionImportList
let uri = filePathToUri fp
let act = importModule (ImportParams uri Simple "Control.Monad")
expectHsImportResult formatterName fp uri e1 act
it "import-list formats" $ do
fp <- makeAbsolute codeActionImportList
let uri = filePathToUri fp
let act = importModule (ImportParams uri (Complex (Import $ Only "when")) "Control.Monad")
expectHsImportResult formatterName fp uri e2 act
it "import-list type formats" $ do
fp <- makeAbsolute codeActionImportList
let uri = filePathToUri fp
let act = importModule (ImportParams uri (Complex (Import $ Only "Maybe")) "Data.Maybe")
expectHsImportResult formatterName fp uri e3 act
it "import-list constructor formats" $ do
fp <- makeAbsolute codeActionImportList
let uri = filePathToUri fp
let act = importModule (ImportParams uri (Complex (Import $ AllOf "Maybe")) "Data.Maybe")
expectHsImportResult formatterName fp uri e4 act
it "import-list constructor formats" $ do
fp <- makeAbsolute codeActionImportList
let uri = filePathToUri fp
let act = importModule (ImportParams uri (Complex (Import $ OneOf "Maybe" "Nothing")) "Data.Maybe")
expectHsImportResult formatterName fp uri e5 act
it "import-list infix function formats" $ do
fp <- makeAbsolute codeActionImportList
let uri = filePathToUri fp
let act = importModule (ImportParams uri (Complex (Import $ Only "$")) "Data.Function")
expectHsImportResult formatterName fp uri e6 act
it "import-list with existing entry formats" $ do
fp <- makeAbsolute codeActionBigImportList
let uri = filePathToUri fp
let act = importModule (ImportParams uri (Complex (Import $ Only "hPutStrLn")) "System.IO")
expectHsImportResult formatterName fp uri e7 act
it "import-list with forced overflow formats" $ do
fp <- makeAbsolute codeActionBigImportList
let uri = filePathToUri fp
let act = importModule (ImportParams uri (Complex (Import $ Only "reverse")) "Data.List")
expectHsImportResult formatterName fp uri e8 act
-- Silence warnings
hsImportSpecRunner formatter args =
error $ "Not the right amount of arguments for \"hsImportSpec ("
++ T.unpack formatter
++ ")\", got "
++ show (length args)
setFormatter :: T.Text -> Config.Config -> Config.Config
setFormatter formatterName cfg = cfg { Config.formattingProvider = formatterName }
expectHsImportResult :: T.Text -> FilePath -> Uri -> [TextEdit] -> IdeGhcM (IdeResult WorkspaceEdit) -> IO ()
expectHsImportResult formatterName fp uri expectedChanges act = do
IdeResultOk (WorkspaceEdit (Just changes) _) <- runSingle' (setFormatter formatterName) testPlugins fp act
case Map.lookup uri changes of
Just (List val) -> val `shouldBe` expectedChanges
Nothing -> fail "No Change found"