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
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
|
{-# LANGUAGE BangPatterns #-}
{-# LANGUAGE OverloadedStrings #-}
{-# LANGUAGE Rank2Types #-}
{-# LANGUAGE ScopedTypeVariables #-}
module Snap.Util.GZip.Tests
( tests ) where
import Blaze.ByteString.Builder
import qualified Codec.Compression.GZip as GZip
import qualified Codec.Compression.Zlib as Zlib
import Control.Exception hiding (assert)
import Control.Monad (liftM)
import Data.ByteString.Char8 (ByteString)
import qualified Data.ByteString.Lazy.Char8 as L
import Data.Digest.Pure.MD5
import Data.IORef
import qualified Data.Map as Map
import Data.Monoid
import Data.Serialize (encode)
import Test.Framework
import Test.Framework.Providers.QuickCheck2
import Test.QuickCheck
import qualified Test.QuickCheck.Monadic as QC
import Test.QuickCheck.Monadic hiding (run)
import Test.Framework.Providers.HUnit
import qualified Test.HUnit as H
import Snap.Core
import Snap.Internal.Http.Types
import Snap.Iteratee
import Snap.Test.Common ()
import Snap.Util.GZip
import qualified Snap.Types.Headers as H
stream2stream
:: Iteratee Builder IO L.ByteString
stream2stream = liftM (toLazyByteString . mconcat) consume
------------------------------------------------------------------------------
tests :: [Test]
tests = [ testIdentity1
, testIdentity1_charset
, testIdentity2
, testIdentity3
, testIdentity4
, testIdentity5
, testNoHeaders
, testNoAcceptEncoding
, testNopWhenContentEncodingSet
, testCompositionDoesn'tExplode
, testGzipLotsaChunks
, testNoCompression
, testBadHeaders ]
------------------------------------------------------------------------------
expectException :: IO a -> PropertyM IO ()
expectException m = do
e <- liftQ $ try m
case e of
Left (z::SomeException) -> (show z) `seq` return ()
Right _ -> fail "expected exception, didn't get one"
------------------------------------------------------------------------------
liftQ :: forall a m . (Monad m) => m a -> PropertyM m a
liftQ = QC.run
------------------------------------------------------------------------------
gzipHdrs, xGzipHdrs, badHdrs, compressHdrs, xCompressHdrs, emptyHdrs :: Headers
emptyHdrs = H.empty
gzipHdrs = setHeader "Accept-Encoding" "froz,gzip, x-gzip" emptyHdrs
xGzipHdrs = setHeader "Accept-Encoding" "x-gzip;q=1.0" emptyHdrs
badHdrs = setHeader "Accept-Encoding" "*&%^&^$%&%&*^\023" emptyHdrs
compressHdrs = setHeader "Accept-Encoding" "compress" emptyHdrs
xCompressHdrs = setHeader "Accept-Encoding" "x-compress" emptyHdrs
------------------------------------------------------------------------------
mkNoHeaders :: IO Request
mkNoHeaders = do
enum <- newIORef $ SomeEnumerator returnI
return $ Request "foo" 80 "foo" 999 "foo" 1000 "foo" False emptyHdrs
enum Nothing GET (1,1) [] "/" "/" "/" ""
Map.empty Map.empty Map.empty
mkGzipRq :: IO Request
mkGzipRq = do
enum <- newIORef $ SomeEnumerator returnI
return $ Request "foo" 80 "foo" 999 "foo" 1000 "foo" False gzipHdrs
enum Nothing GET (1,1) [] "/" "/" "/" ""
Map.empty Map.empty Map.empty
mkXGzipRq :: IO Request
mkXGzipRq = do
enum <- newIORef $ SomeEnumerator returnI
return $ Request "foo" 80 "foo" 999 "foo" 1000 "foo" False xGzipHdrs
enum Nothing GET (1,1) [] "/" "/" "/" ""
Map.empty Map.empty Map.empty
------------------------------------------------------------------------------
mkCompressRq :: IO Request
mkCompressRq = do
enum <- newIORef $ SomeEnumerator returnI
return $ Request "foo" 80 "foo" 999 "foo" 1000 "foo" False compressHdrs
enum Nothing GET (1,1) [] "/" "/" "/" ""
Map.empty Map.empty Map.empty
mkXCompressRq :: IO Request
mkXCompressRq = do
enum <- newIORef $ SomeEnumerator returnI
return $ Request "foo" 80 "foo" 999 "foo" 1000 "foo" False xCompressHdrs
enum Nothing GET (1,1) [] "/" "/" "/" ""
Map.empty Map.empty Map.empty
------------------------------------------------------------------------------
mkBadRq :: IO Request
mkBadRq = do
enum <- newIORef $ SomeEnumerator returnI
return $ Request "foo" 80 "foo" 999 "foo" 1000 "foo" False badHdrs
enum Nothing GET (1,1) [] "/" "/" "/" ""
Map.empty Map.empty Map.empty
------------------------------------------------------------------------------
seqSnap :: Snap a -> Snap a
seqSnap m = do
!x <- m
return $! x `seq` x
------------------------------------------------------------------------------
goGeneric :: IO Request -> Snap a -> IO (Request, Response)
goGeneric mkRq m = do
rq <- mkRq
run_ $! runSnap (seqSnap m) d d rq
where
d = (const $ return ())
goGZip, goCompress, goXGZip :: Snap a -> IO (Request,Response)
goNoHeaders, goXCompress, goBad :: Snap a -> IO (Request,Response)
goGZip = goGeneric mkGzipRq
goCompress = goGeneric mkCompressRq
goXGZip = goGeneric mkXGzipRq
goXCompress = goGeneric mkXCompressRq
goBad = goGeneric mkBadRq
goNoHeaders = goGeneric mkNoHeaders
------------------------------------------------------------------------------
noContentType :: L.ByteString -> Snap ()
noContentType s = modifyResponse $ setResponseBody $
enumBuilder $ fromLazyByteString s
------------------------------------------------------------------------------
withContentType :: ByteString -> L.ByteString -> Snap ()
withContentType ct body =
modifyResponse $
setResponseBody (enumBuilder $ fromLazyByteString body) .
setContentType ct
------------------------------------------------------------------------------
textPlain :: L.ByteString -> Snap ()
textPlain = withContentType "text/plain"
------------------------------------------------------------------------------
binary :: L.ByteString -> Snap ()
binary = withContentType "application/octet-stream"
------------------------------------------------------------------------------
testNoHeaders :: Test
testNoHeaders = testProperty "gzip/noheaders" $
monadicIO $
forAllM arbitrary prop
where
prop :: L.ByteString -> PropertyM IO ()
prop s = do
-- if there's no content-type, withCompression should be a no-op
(!_,!rsp) <- liftQ $ goNoHeaders (seqSnap $ withCompression
$ noContentType s)
assert $ getHeader "Content-Encoding" rsp == Nothing
assert $ getHeader "Vary" rsp == Nothing
let body = rspBodyToEnum $ rspBody rsp
c <- liftQ $
runIteratee stream2stream >>= run_ . body
assert $ s == c
------------------------------------------------------------------------------
testNoAcceptEncoding :: Test
testNoAcceptEncoding = testProperty "gzip/noAcceptEncoding" $
monadicIO $
forAllM arbitrary prop
where
prop :: L.ByteString -> PropertyM IO ()
prop s = do
-- if there's no accept-encoding, withCompression should be a no-op
(!_,!rsp) <- liftQ $ goNoHeaders (seqSnap $ withCompression
$ textPlain s)
assert $ getHeader "Content-Encoding" rsp == Nothing
assert $ getHeader "Vary" rsp == Nothing
let body = rspBodyToEnum $ rspBody rsp
c <- liftQ $
runIteratee stream2stream >>= run_ . body
assert $ s == c
------------------------------------------------------------------------------
testIdentity1 :: Test
testIdentity1 = testProperty "gzip/identity1" $ monadicIO $ forAllM arbitrary prop
where
prop :: L.ByteString -> PropertyM IO ()
prop s = do
(!_,!rsp) <- liftQ $ goGZip (seqSnap $ withCompression $ textPlain s)
assert $ getHeader "Content-Encoding" rsp == Just "gzip"
assert $ getHeader "Vary" rsp == Just "Accept-Encoding"
let body = rspBodyToEnum $ rspBody rsp
c <- liftQ $
runIteratee stream2stream >>= run_ . body
let s1 = GZip.decompress c
assert $ s == s1
------------------------------------------------------------------------------
testIdentity1_charset :: Test
testIdentity1_charset = testProperty "gzip/identity1_charset" $
monadicIO $ forAllM arbitrary prop
where
prop :: L.ByteString -> PropertyM IO ()
prop s = do
(!_,!rsp) <- liftQ $
goGZip (seqSnap $ withCompression $
withContentType "text/plain; charset=utf-8" s)
assert $ getHeader "Content-Encoding" rsp == Just "gzip"
assert $ getHeader "Vary" rsp == Just "Accept-Encoding"
let body = rspBodyToEnum $ rspBody rsp
c <- liftQ $
runIteratee stream2stream >>= run_ . body
let s1 = GZip.decompress c
assert $ s == s1
------------------------------------------------------------------------------
testIdentity2 :: Test
testIdentity2 = testProperty "gzip/identity2" $ monadicIO $ forAllM arbitrary prop
where
prop :: L.ByteString -> PropertyM IO ()
prop s = do
(!_,!rsp) <- liftQ $ goCompress (seqSnap $ withCompression $ textPlain s)
assert $ getHeader "Content-Encoding" rsp == Just "compress"
assert $ getHeader "Vary" rsp == Just "Accept-Encoding"
let body = rspBodyToEnum $ rspBody rsp
c <- liftQ $
runIteratee stream2stream >>= run_ . body
let s' = Zlib.decompress c
assert $ s == s'
------------------------------------------------------------------------------
testIdentity3 :: Test
testIdentity3 = testProperty "gzip/identity3" $ monadicIO $ forAllM arbitrary prop
where
prop :: L.ByteString -> PropertyM IO ()
prop s = do
(!_,!rsp3) <- liftQ $ goGZip (seqSnap $ withCompression $ binary s)
let body3 = rspBodyToEnum $ rspBody rsp3
s3 <- liftQ $
runIteratee stream2stream >>= run_ . body3
assert $ s == s3
------------------------------------------------------------------------------
testIdentity4 :: Test
testIdentity4 = testProperty "gzip/identity4" $ monadicIO $ forAllM arbitrary prop
where
prop :: L.ByteString -> PropertyM IO ()
prop s = do
(!_,!rsp) <- liftQ $ goXGZip (seqSnap $ withCompression $ textPlain s)
assert $ getHeader "Content-Encoding" rsp == Just "x-gzip"
let body = rspBodyToEnum $ rspBody rsp
c <- liftQ $
runIteratee stream2stream >>= run_ . body
let s1 = GZip.decompress c
assert $ s == s1
------------------------------------------------------------------------------
testIdentity5 :: Test
testIdentity5 = testProperty "gzip/identity5" $ monadicIO $ forAllM arbitrary prop
where
prop :: L.ByteString -> PropertyM IO ()
prop s = do
(!_,!rsp2) <- liftQ $ goXCompress (seqSnap $ withCompression $ textPlain s)
assert $ getHeader "Content-Encoding" rsp2 == Just "x-compress"
let body2 = rspBodyToEnum $ rspBody rsp2
c2 <- liftQ $
runIteratee stream2stream >>= run_ . body2
let s2 = Zlib.decompress c2
assert $ s == s2
------------------------------------------------------------------------------
testBadHeaders :: Test
testBadHeaders = testProperty "gzip/bad headers" $ monadicIO $ forAllM arbitrary prop
where
prop :: L.ByteString -> PropertyM IO ()
prop s = expectException $ do
(!_,!rsp) <- goBad (seqSnap $ withCompression $ textPlain s)
let body = rspBodyToEnum $ rspBody rsp
runIteratee stream2stream >>= run_ . body
------------------------------------------------------------------------------
testNopWhenContentEncodingSet :: Test
testNopWhenContentEncodingSet =
testProperty "gzip/testNopWhenContentEncodingSet" $
monadicIO $
forAllM arbitrary prop
where
prop :: L.ByteString -> PropertyM IO ()
prop s = do
(!_,!rsp) <- liftQ $ goGZip $ f s
assert $ getHeader "Content-Encoding" rsp == Just "identity"
f !s = seqSnap $ withCompression $ do
modifyResponse $ setHeader "Content-Encoding" "identity"
textPlain s
------------------------------------------------------------------------------
testCompositionDoesn'tExplode :: Test
testCompositionDoesn'tExplode =
testProperty "gzip/testCompositionDoesn'tExplode" $
monadicIO $
forAllM arbitrary prop
where
prop :: L.ByteString -> PropertyM IO ()
prop s = do
(!_,!rsp) <- liftQ $ goGZip (seqSnap $
withCompression $
withCompression $
withCompression $ textPlain s)
assert $ getHeader "Content-Encoding" rsp == Just "gzip"
let body = rspBodyToEnum $ rspBody rsp
c <- liftQ $
runIteratee stream2stream >>= run_ . body
let s1 = GZip.decompress c
assert $ s == s1
------------------------------------------------------------------------------
testGzipLotsaChunks :: Test
testGzipLotsaChunks = testCase "gzip/lotsOfChunks" prop
where
prop = do
let s = L.take 120000 $ L.fromChunks $ frobnicate "dshflkahdflkdhsaflk"
(!_,!rsp) <- goGZip (seqSnap $ withCompression $ textPlain s)
let body = rspBodyToEnum $ rspBody rsp
c <- runIteratee stream2stream >>= run_ . body
let s1 = GZip.decompress c
H.assertBool "streams equal" $ s == s1
-- in order to get incompressible text (so that we can test whether the
-- gzip thread is streaming properly!) we'll iteratively md5 the source
-- string
frobnicate s = let s' = encode $ md5 $ L.fromChunks [s]
in (s:frobnicate s')
------------------------------------------------------------------------------
testNoCompression :: Test
testNoCompression = testProperty "gzip/noCompression" $
monadicIO $ forAllM arbitrary prop
where
prop :: L.ByteString -> PropertyM IO ()
prop s = do
(!_,!rsp) <- liftQ $ goGZip (seqSnap $ withCompression $
(noCompression >> textPlain s))
assert $ getHeader "Content-Encoding" rsp == Just "identity"
let body = rspBodyToEnum $ rspBody rsp
s1 <- liftQ $
runIteratee stream2stream >>= run_ . body
assert $ s == s1
|
