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
|
module Language.Haskell.Stylish.Config.Tests
( tests
) where
--------------------------------------------------------------------------------
import Control.Exception hiding (assert)
import qualified Data.Set as Set
import System.Directory
import System.FilePath ((</>))
import System.IO.Error
import System.Random
import Test.Framework (Test, testGroup)
import Test.Framework.Providers.HUnit (testCase)
import Test.HUnit (Assertion, assert)
--------------------------------------------------------------------------------
import Language.Haskell.Stylish.Config
--------------------------------------------------------------------------------
tests :: Test
tests = testGroup "Language.Haskell.Stylish.Config"
[ testCase "Extensions extracted correctly from .cabal file"
testExtensionsFromDotCabal
, testCase "Extensions extracted correctly from .stylish-haskell.yaml file"
testExtensionsFromDotStylish
, testCase "Extensions extracted correctly from .stylish-haskell.yaml and .cabal files"
testExtensionsFromBoth
]
--------------------------------------------------------------------------------
-- | Create a temporary directory with a randomised name built from the template provided
createTempDirectory :: String -> IO FilePath
createTempDirectory template = do
tmpRootDir <- getTemporaryDirectory
dirId <- randomIO :: IO Word
findTempName tmpRootDir dirId
where
findTempName :: FilePath -> Word -> IO FilePath
findTempName tmpRootDir x = do
let dirpath = tmpRootDir </> template ++ show x
r <- try $ createDirectory dirpath
case r of
Right _ -> return dirpath
Left e | isAlreadyExistsError e -> findTempName tmpRootDir (x+1)
| otherwise -> ioError e
-- | Perform an action inside a temporary directory tree and purge the tree afterwords
withTestDirTree :: IO a -> IO a
withTestDirTree action = bracket
((,) <$> getCurrentDirectory <*> createTempDirectory "stylish_haskell")
(\(current, temp) ->
setCurrentDirectory current *>
removeDirectoryRecursive temp)
(\(_, temp) -> setCurrentDirectory temp *> action)
-- | Put an example config files (.cabal/.stylish-haskell.yaml/both)
-- into the current directory and extract extensions from it.
createFilesAndGetExtensions :: [(FilePath, String)] -> IO Extensions
createFilesAndGetExtensions files = withTestDirTree $ do
mapM_ (\(k, v) -> writeFile k v) files
-- create an empty directory and change into it
createDirectory "src"
setCurrentDirectory "src"
-- from that directory read the config file and extract extensions
-- to make sure the search for .cabal file works
config <- loadConfig (const (pure ())) Nothing
pure $ configLanguageExtensions config
--------------------------------------------------------------------------------
testExtensionsFromDotCabal :: Assertion
testExtensionsFromDotCabal =
assert $ (expected ==) . Set.fromList <$>
createFilesAndGetExtensions [("test.cabal", dotCabal True)]
where
expected = Set.fromList ["ScopedTypeVariables", "DataKinds"]
--------------------------------------------------------------------------------
testExtensionsFromDotStylish :: Assertion
testExtensionsFromDotStylish =
assert $ (expected ==) . Set.fromList <$>
createFilesAndGetExtensions [(".stylish-haskell.yaml", dotStylish)]
where
expected = Set.fromList ["TemplateHaskell", "QuasiQuotes"]
--------------------------------------------------------------------------------
testExtensionsFromBoth :: Assertion
testExtensionsFromBoth =
assert $ (expected ==) . Set.fromList <$>
createFilesAndGetExtensions [ ("test.cabal", dotCabal True)
, (".stylish-haskell.yaml", dotStylish)]
where
expected = Set.fromList
["ScopedTypeVariables", "DataKinds", "TemplateHaskell", "QuasiQuotes"]
-- | Example cabal file borrowed from
-- https://www.haskell.org/cabal/users-guide/developing-packages.html
-- with some default-extensions added
dotCabal :: Bool -> String
dotCabal includeExtensions = unlines $
[ "name: TestPackage"
, "version: 0.0"
, "synopsis: Package with library and two programs"
, "license: BSD3"
, "author: Angela Author"
, "build-type: Simple"
, "cabal-version: >= 1.2"
, ""
, "library"
, " build-depends: HUnit"
, " exposed-modules: A, B, C"
] ++
[if includeExtensions then " default-extensions: ScopedTypeVariables"
else ""]
++
[ ""
, "executable program1"
, " main-is: Main.hs"
, " hs-source-dirs: prog1"
, " other-modules: A, B"
] ++
[if includeExtensions then " default-extensions: DataKinds"
else ""]
-- | Example .stylish-haskell.yaml
dotStylish :: String
dotStylish = unlines $
[ "steps:"
, " - imports:"
, " align: none"
, " list_align: after_alias"
, " long_list_align: inline"
, " separate_lists: true"
, " - language_pragmas:"
, " style: vertical"
, " align: false"
, " remove_redundant: true"
, " - trailing_whitespace: {}"
, "columns: 110"
, "language_extensions:"
, " - TemplateHaskell"
, " - QuasiQuotes"
]
|
