File: Internal.hs

package info (click to toggle)
haskell-base64 0.4.2.4-2
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 252 kB
  • sloc: haskell: 2,145; makefile: 3
file content (262 lines) | stat: -rw-r--r-- 8,225 bytes parent folder | download | duplicates (2)
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
{-# LANGUAGE PackageImports #-}
{-# LANGUAGE RankNTypes #-}
{-# OPTIONS_GHC -fno-warn-orphans #-}
-- |
-- Module       : Main
-- Copyright    : (c) 2019-2020 Emily Pillmore
-- License      : BSD-style
--
-- Maintainer   : Emily Pillmore <emilypi@cohomolo.gy>
-- Stability    : Experimental
-- Portability  : portable
--
-- This module contains internal test harnesses for `base64`
--
module Internal
( Harness(..)
, b64
, lb64
, sb64
, t64
, tl64
, ts64
, TextHarness(..)
, tt64
, ttl64
, tts64
) where


import qualified Data.ByteString as BS
import qualified Data.ByteString.Lazy as LBS
import qualified Data.ByteString.Short as SBS
import "base64" Data.ByteString.Base64 as B64
import "base64" Data.ByteString.Base64.URL as B64U
import "base64" Data.ByteString.Lazy.Base64 as LB64
import "base64" Data.ByteString.Lazy.Base64.URL as LB64U
import "base64" Data.ByteString.Short.Base64 as SB64
import "base64" Data.ByteString.Short.Base64.URL as SB64U
import Data.Text (Text)
import qualified Data.Text as T
import "base64" Data.Text.Encoding.Base64 as T64
import "base64" Data.Text.Encoding.Base64.URL as T64U
import Data.Text.Encoding.Base64.Error (Base64Error(..))
import qualified Data.Text.Lazy as TL
import "base64" Data.Text.Lazy.Encoding.Base64 as TL64
import "base64" Data.Text.Lazy.Encoding.Base64.URL as TL64U
import qualified Data.Text.Short as TS
import "base64" Data.Text.Short.Encoding.Base64 as TS64
import "base64" Data.Text.Short.Encoding.Base64.URL as TS64U

import Test.QuickCheck hiding (label)

-- ------------------------------------------------------------------ --
-- Test Harnesses

-- | This dictionary provides the generic API definition for
-- the base64 std alphabet
--
data Harness bs = Harness
  { label :: String
  , encode :: bs -> bs
  , encodeUrl :: bs -> bs
  , encodeUrlNopad :: bs -> bs
  , decode :: bs -> Either Text bs
  , decodeUrl :: bs -> Either Text bs
  , decodeUrlPad :: bs -> Either Text bs
  , decodeUrlNopad :: bs -> Either Text bs
  , lenientUrl :: bs -> bs
  , lenient :: bs -> bs
  , correct :: bs -> Bool
  , correctUrl :: bs -> Bool
  , validate :: bs -> Bool
  , validateUrl :: bs -> Bool
  }


b64 :: Harness BS.ByteString
b64 = Harness
  { label = "ByteString"
  , encode = B64.encodeBase64'
  , decode = B64.decodeBase64
  , lenient = B64.decodeBase64Lenient
  , correct = B64.isBase64
  , validate = B64.isValidBase64
  , encodeUrl = B64U.encodeBase64'
  , encodeUrlNopad = B64U.encodeBase64Unpadded'
  , decodeUrl = B64U.decodeBase64
  , decodeUrlPad = B64U.decodeBase64Padded
  , decodeUrlNopad = B64U.decodeBase64Unpadded
  , lenientUrl = B64U.decodeBase64Lenient
  , correctUrl = B64U.isBase64Url
  , validateUrl = B64U.isValidBase64Url
  }

lb64 :: Harness LBS.ByteString
lb64 = Harness
  { label = "Lazy ByteString"
  , encode = LB64.encodeBase64'
  , decode = LB64.decodeBase64
  , lenient = LB64.decodeBase64Lenient
  , correct = LB64.isBase64
  , validate = LB64.isValidBase64
  , encodeUrl = LB64U.encodeBase64'
  , encodeUrlNopad = LB64U.encodeBase64Unpadded'
  , decodeUrl = LB64U.decodeBase64
  , decodeUrlPad = LB64U.decodeBase64Padded
  , decodeUrlNopad = LB64U.decodeBase64Unpadded
  , lenientUrl = LB64U.decodeBase64Lenient
  , correctUrl = LB64U.isBase64Url
  , validateUrl = LB64U.isValidBase64Url
  }

sb64 :: Harness SBS.ShortByteString
sb64 = Harness
  { label = "Short ByteString"
  , encode = SB64.encodeBase64'
  , decode = SB64.decodeBase64
  , lenient = SB64.decodeBase64Lenient
  , correct = SB64.isBase64
  , validate = SB64.isValidBase64
  , encodeUrl = SB64U.encodeBase64'
  , encodeUrlNopad = SB64U.encodeBase64Unpadded'
  , decodeUrl = SB64U.decodeBase64
  , decodeUrlPad = SB64U.decodeBase64Padded
  , decodeUrlNopad = SB64U.decodeBase64Unpadded
  , lenientUrl = SB64U.decodeBase64Lenient
  , correctUrl = SB64U.isBase64Url
  , validateUrl = SB64U.isValidBase64Url
  }

t64 :: Harness Text
t64 = Harness
  { label = "Text"
  , encode = T64.encodeBase64
  , decode = T64.decodeBase64
  , lenient = T64.decodeBase64Lenient
  , correct = T64.isBase64
  , validate = T64.isValidBase64
  , encodeUrl = T64U.encodeBase64
  , encodeUrlNopad = T64U.encodeBase64Unpadded
  , decodeUrl = T64U.decodeBase64
  , decodeUrlPad = T64U.decodeBase64Padded
  , decodeUrlNopad = T64U.decodeBase64Unpadded
  , lenientUrl = T64U.decodeBase64Lenient
  , correctUrl = T64U.isBase64Url
  , validateUrl = T64U.isValidBase64Url
  }

tl64 :: Harness TL.Text
tl64 = Harness
  { label = "Lazy Text"
  , encode = TL64.encodeBase64
  , decode = TL64.decodeBase64
  , lenient = TL64.decodeBase64Lenient
  , correct = TL64.isBase64
  , validate = TL64.isValidBase64
  , encodeUrl = TL64U.encodeBase64
  , encodeUrlNopad = TL64U.encodeBase64Unpadded
  , decodeUrl = TL64U.decodeBase64
  , decodeUrlPad = TL64U.decodeBase64Padded
  , decodeUrlNopad = TL64U.decodeBase64Unpadded
  , lenientUrl = TL64U.decodeBase64Lenient
  , correctUrl = TL64U.isBase64Url
  , validateUrl = TL64U.isValidBase64Url
  }

ts64 :: Harness TS.ShortText
ts64 = Harness
  { label = "Short Text"
  , encode = TS64.encodeBase64
  , decode = TS64.decodeBase64
  , lenient = TS64.decodeBase64Lenient
  , correct = TS64.isBase64
  , validate = TS64.isValidBase64
  , encodeUrl = TS64U.encodeBase64
  , encodeUrlNopad = TS64U.encodeBase64Unpadded
  , decodeUrl = TS64U.decodeBase64
  , decodeUrlPad = TS64U.decodeBase64Padded
  , decodeUrlNopad = TS64U.decodeBase64Unpadded
  , lenientUrl = TS64U.decodeBase64Lenient
  , correctUrl = TS64U.isBase64Url
  , validateUrl = TS64U.isValidBase64Url
  }

-- -------------------------------------------------------------------- --
-- Text-specific harness

data TextHarness bs cs = TextHarness
  { decodeWith_ :: forall err. (bs -> Either err cs) -> bs -> Either (Base64Error err) cs
  , decodeUrlWith_ :: forall err. (bs -> Either err cs) -> bs -> Either (Base64Error err) cs
  , decodeUrlPaddedWith_ :: forall err. (bs -> Either err cs) -> bs -> Either (Base64Error err) cs
  , decodeUrlUnpaddedWith_ :: forall err. (bs -> Either err cs) -> bs -> Either (Base64Error err) cs
  }

tt64 :: TextHarness BS.ByteString Text
tt64 = TextHarness
  { decodeWith_ = T64.decodeBase64With
  , decodeUrlWith_ = T64U.decodeBase64With
  , decodeUrlPaddedWith_ = T64U.decodeBase64PaddedWith
  , decodeUrlUnpaddedWith_ = T64U.decodeBase64UnpaddedWith
  }

ttl64 :: TextHarness LBS.ByteString TL.Text
ttl64 = TextHarness
  { decodeWith_ = TL64.decodeBase64With
  , decodeUrlWith_ = TL64U.decodeBase64With
  , decodeUrlPaddedWith_ = TL64U.decodeBase64PaddedWith
  , decodeUrlUnpaddedWith_ = TL64U.decodeBase64UnpaddedWith
  }

tts64 :: TextHarness SBS.ShortByteString TS.ShortText
tts64 = TextHarness
  { decodeWith_ = TS64.decodeBase64With
  , decodeUrlWith_ = TS64U.decodeBase64With
  , decodeUrlPaddedWith_ = TS64U.decodeBase64PaddedWith
  , decodeUrlUnpaddedWith_ = TS64U.decodeBase64UnpaddedWith
  }

-- ------------------------------------------------------------------ --
-- Quickcheck instances

instance Arbitrary BS.ByteString where
    arbitrary = BS.pack <$> arbitrary
    shrink xs = BS.pack <$> shrink (BS.unpack xs)

instance CoArbitrary BS.ByteString where
    coarbitrary = coarbitrary . BS.unpack

instance Arbitrary LBS.ByteString where
    arbitrary = LBS.pack <$> arbitrary
    shrink xs = LBS.pack <$> shrink (LBS.unpack xs)

instance CoArbitrary LBS.ByteString where
    coarbitrary = coarbitrary . LBS.unpack

instance Arbitrary SBS.ShortByteString where
    arbitrary = SBS.pack <$> arbitrary
    shrink xs = SBS.pack <$> shrink (SBS.unpack xs)

instance CoArbitrary SBS.ShortByteString where
    coarbitrary = coarbitrary . SBS.unpack

instance Arbitrary T.Text where
    arbitrary = T.pack <$> arbitrary
    shrink xs = T.pack <$> shrink (T.unpack xs)

instance Arbitrary TL.Text where
    arbitrary = TL.pack <$> arbitrary
    shrink xs = TL.pack <$> shrink (TL.unpack xs)

instance CoArbitrary T.Text where
    coarbitrary = coarbitrary . T.unpack

instance CoArbitrary TL.Text where
    coarbitrary = coarbitrary . TL.unpack

instance Arbitrary TS.ShortText where
  arbitrary = TS.fromText <$> arbitrary
  shrink xs = fmap TS.fromText $ shrink (TS.toText xs)

instance CoArbitrary TS.ShortText where
  coarbitrary = coarbitrary . TS.toText