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
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
|
{-# OPTIONS_GHC -fno-warn-incomplete-uni-patterns #-}
module Test.Hspec.Core.Config.OptionsSpec (spec) where
import Prelude ()
import Helper
import System.Exit
import Test.Hspec.Core.Config
import Test.Hspec.Core.Config.Options hiding (parseOptions)
import qualified Test.Hspec.Core.Config.Options as Options
fromLeft :: Either a b -> a
fromLeft (Left a) = a
fromLeft _ = error "fromLeft: No left value!"
spec :: Spec
spec = do
describe "parseOptions" $ do
let parseOptions configFiles envVar env args = snd <$> Options.parseOptions defaultConfig "my-spec" configFiles envVar env args
it "rejects unexpected arguments" $ do
fromLeft (parseOptions [] Nothing [] ["foo"]) `shouldBe` (ExitFailure 1, "my-spec: unexpected argument `foo'\nTry `my-spec --help' for more information.\n")
it "rejects unrecognized options" $ do
fromLeft (parseOptions [] Nothing [] ["--foo"]) `shouldBe` (ExitFailure 1, "my-spec: unrecognized option `--foo'\nTry `my-spec --help' for more information.\n")
it "sets configColorMode to ColorAuto" $ do
configColorMode <$> parseOptions [] Nothing [] [] `shouldBe` Right ColorAuto
context "when the same option is specified multiple times" $ do
it "gives later occurrences precedence" $ do
configColorMode <$> parseOptions [] Nothing [] ["--color", "--no-color"] `shouldBe` Right ColorNever
context "with --help" $ do
let Left (code, help) = Options.parseOptions defaultConfig "spec" [] Nothing [] ["--help"]
it "returns ExitSuccess" $ do
code `shouldBe` ExitSuccess
it "prints help" $ do
expected <- readFile "help.txt"
help `shouldBe` expected
describe "RUNNER OPTIONS" $ do
let parseOptions_ args = snd <$> Options.parseOptions defaultConfig "my-spec" [] Nothing [] args
it "gives HSPEC_FAIL_ON precedence over HSPEC_STRICT" $ do
(configFailOnFocused &&& configFailOnPending) <$> parseOptions [] Nothing [("HSPEC_STRICT", "no"), ("HSPEC_FAIL_ON", "focused")] []
`shouldBe` Right (True, False)
it "gives HSPEC_NO_FAIL_ON precedence over HSPEC_STRICT" $ do
(configFailOnFocused &&& configFailOnPending) <$> parseOptions [] Nothing [("HSPEC_STRICT", "yes"), ("HSPEC_NO_FAIL_ON", "focused")] []
`shouldBe` Right (False, True)
context "with --fail-on-focused" $ do
it "sets configFailOnFocused to True" $ do
configFailOnFocused <$> parseOptions_ ["--fail-on-focused"] `shouldBe` Right True
context "with --fail-on-pending" $ do
it "sets configFailOnPending to True" $ do
configFailOnPending <$> parseOptions_ ["--fail-on-pending"] `shouldBe` Right True
context "with --fail-on" $ do
it "accepts a list of values" $ do
let config = parseOptions_ ["--fail-on=focused,pending"]
configFailOnFocused <$> config `shouldBe` Right True
configFailOnPending <$> config `shouldBe` Right True
context "with focused" $ do
it "sets configFailOnFocused to True" $ do
configFailOnFocused <$> parseOptions_ ["--fail-on=focused"] `shouldBe` Right True
context "with pending" $ do
it "sets configFailOnPending to True" $ do
configFailOnPending <$> parseOptions_ ["--fail-on=pending"] `shouldBe` Right True
context "with --no-fail-on" $ do
it "inverts --fail-on" $ do
let config = parseOptions_ ["--fail-on=focused,pending", "--no-fail-on=focused,pending"]
configFailOnFocused <$> config `shouldBe` Right False
configFailOnPending <$> config `shouldBe` Right False
context "with --color" $ do
it "sets configColorMode to ColorAlways" $ do
configColorMode <$> parseOptions [] Nothing [] ["--color"] `shouldBe` Right ColorAlways
context "with --no-color" $ do
it "sets configColorMode to ColorNever" $ do
configColorMode <$> parseOptions [] Nothing [] ["--no-color"] `shouldBe` Right ColorNever
context "with --diff" $ do
it "sets configDiff to True" $ do
configDiff <$> parseOptions [] Nothing [] ["--diff"] `shouldBe` Right True
context "with --no-diff" $ do
it "sets configDiff to False" $ do
configDiff <$> parseOptions [] Nothing [] ["--no-diff"] `shouldBe` Right False
context "with --diff-context" $ do
it "accepts 0" $ do
configDiffContext <$> parseOptions [] Nothing [] ["--diff-context=0"] `shouldBe` Right (Just 0)
it "accepts positive values" $ do
configDiffContext <$> parseOptions [] Nothing [] ["--diff-context=5"] `shouldBe` Right (Just 5)
it "rejects invalid values" $ do
let msg = "my-spec: invalid argument `foo' for `--diff-context'\nTry `my-spec --help' for more information.\n"
void (parseOptions [] Nothing [] ["--diff-context=foo"]) `shouldBe` Left (ExitFailure 1, msg)
context "with negative values" $ do
it "disables the option" $ do
configDiffContext <$> parseOptions [] Nothing [] ["--diff-context=-1"] `shouldBe` Right Nothing
context "with 'full'" $ do
it "disables the option" $ do
configDiffContext <$> parseOptions [] Nothing [] ["--diff-context=full"] `shouldBe` Right Nothing
context "with --diff-command=" $ do
it "sets configExternalDiff to Nothing" $ do
fmap (const ()) . configExternalDiff <$> parseOptions [] Nothing [] ["--diff-command="] `shouldBe` Right Nothing
context "with --print-slow-items" $ do
it "sets configPrintSlowItems to N" $ do
configPrintSlowItems <$> parseOptions [] Nothing [] ["--print-slow-items=5"] `shouldBe` Right (Just 5)
it "defaults N to 10" $ do
configPrintSlowItems <$> parseOptions [] Nothing [] ["--print-slow-items"] `shouldBe` Right (Just 10)
it "rejects invalid values" $ do
let msg = "my-spec: invalid argument `foo' for `--print-slow-items'\nTry `my-spec --help' for more information.\n"
void (parseOptions [] Nothing [] ["--print-slow-items=foo"]) `shouldBe` Left (ExitFailure 1, msg)
context "when N is 0" $ do
it "disables the option" $ do
configPrintSlowItems <$> parseOptions [] Nothing [] ["-p0"] `shouldBe` Right Nothing
context "when N is negative" $ do
it "disables the option" $ do
configPrintSlowItems <$> parseOptions [] Nothing [] ["--print-slow-items=-23"] `shouldBe` Right Nothing
context "with --qc-max-success" $ do
it "sets QuickCheck maxSuccess" $ do
maxSuccess . configQuickCheckArgs <$> (parseOptions [] Nothing [] ["--qc-max-success", "23"]) `shouldBe` Right 23
context "when given an invalid argument" $ do
it "returns an error message" $ do
fromLeft (parseOptions [] Nothing [] ["--qc-max-success", "foo"]) `shouldBe` (ExitFailure 1, "my-spec: invalid argument `foo' for `--qc-max-success'\nTry `my-spec --help' for more information.\n")
context "with --qc-max-shrinks" $ do
it "sets QuickCheck maxShrinks" $ do
maxShrinks . configQuickCheckArgs <$> (parseOptions [] Nothing [] ["--qc-max-shrinks", "23"]) `shouldBe` Right 23
context "with --depth" $ do
it "sets depth parameter for SmallCheck" $ do
configSmallCheckDepth <$> parseOptions [] Nothing [] ["--depth", "23"] `shouldBe` Right (Just 23)
context "with --jobs" $ do
it "sets number of concurrent jobs" $ do
configConcurrentJobs <$> parseOptions [] Nothing [] ["--jobs=23"] `shouldBe` Right (Just 23)
it "rejects values < 1" $ do
let msg = "my-spec: invalid argument `0' for `--jobs'\nTry `my-spec --help' for more information.\n"
void (parseOptions [] Nothing [] ["--jobs=0"]) `shouldBe` Left (ExitFailure 1, msg)
context "when given a config file" $ do
it "uses options from config file" $ do
configColorMode <$> parseOptions [("~/.hspec", ["--no-color"])] Nothing [] [] `shouldBe` Right ColorNever
it "gives command-line options precedence" $ do
configColorMode <$> parseOptions [("~/.hspec", ["--no-color"])] Nothing [] ["--color"] `shouldBe` Right ColorAlways
it "rejects --help" $ do
fromLeft (parseOptions [("~/.hspec", ["--help"])] Nothing [] []) `shouldBe` (ExitFailure 1, "my-spec: unrecognized option `--help' in config file ~/.hspec\n")
it "rejects unrecognized options" $ do
fromLeft (parseOptions [("~/.hspec", ["--invalid"])] Nothing [] []) `shouldBe` (ExitFailure 1, "my-spec: unrecognized option `--invalid' in config file ~/.hspec\n")
it "rejects ambiguous options" $ do
fromLeft (parseOptions [("~/.hspec", ["--print"])] Nothing [] []) `shouldBe` (ExitFailure 1,
unlines [
"my-spec: option `--print' is ambiguous; could be one of:"
, " --print-cpu-time include used CPU time in summary"
, " -p[N] --print-slow-items[=N] print the N slowest spec items (default: 10)"
, "in config file ~/.hspec"
]
)
context "when the same option is specified multiple times" $ do
it "gives later occurrences precedence" $ do
configColorMode <$> parseOptions [("~/.hspec", ["--color", "--no-color"])] Nothing [] [] `shouldBe` Right ColorNever
context "when given multiple config files" $ do
it "gives later config files precedence" $ do
configColorMode <$> parseOptions [("~/.hspec", ["--no-color"]), (".hspec", ["--color"])] Nothing [] [] `shouldBe` Right ColorAlways
context "when given HSPEC_OPTIONS (deprecated)" $ do
it "uses options from HSPEC_OPTIONS" $ do
configColorMode <$> parseOptions [] (Just ["--no-color"]) [] [] `shouldBe` Right ColorNever
it "gives command-line options precedence" $ do
configColorMode <$> parseOptions [] (Just ["--no-color"]) [] ["--color"] `shouldBe` Right ColorAlways
it "rejects unrecognized options" $ do
fromLeft (parseOptions [] (Just ["--invalid"]) [] []) `shouldBe` (ExitFailure 1, "my-spec: unrecognized option `--invalid' from environment variable HSPEC_OPTIONS\n")
context "when given an option as an environment variable" $ do
it "sets config value from environment variable" $ do
configColorMode <$> parseOptions [] Nothing [("HSPEC_COLOR", "no")] [] `shouldBe` Right ColorNever
it "gives command-line options precedence" $ do
configColorMode <$> parseOptions [] Nothing [("HSPEC_COLOR", "no")] ["--color"] `shouldBe` Right ColorAlways
it "warns on unrecognized option values" $ do
fmap configColorMode <$> Options.parseOptions defaultConfig "my-spec" [] Nothing [("HSPEC_COLOR", "foo")] [] `shouldBe` Right (["invalid value `foo' for environment variable HSPEC_COLOR"], ColorAuto)
describe "ignoreConfigFile" $ around_ (withEnvironment []) $ do
context "by default" $ do
it "returns False" $ do
ignoreConfigFile defaultConfig [] `shouldReturn` False
context "with --ignore-dot-hspec" $ do
it "returns True" $ do
ignoreConfigFile defaultConfig ["--ignore-dot-hspec"] `shouldReturn` True
context "with IGNORE_DOT_HSPEC" $ do
it "returns True" $ do
withEnvironment [("IGNORE_DOT_HSPEC", "yes")] $ do
ignoreConfigFile defaultConfig [] `shouldReturn` True
|
