This repository has been archived by the owner on Sep 27, 2018. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 2
/
storage_key_spec.lua
251 lines (213 loc) · 10 KB
/
storage_key_spec.lua
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
describe('storage_keys', function()
local storage_keys = require 'xc/storage_keys'
local auth_responses_channel_prefix = 'xc_channel_auth_response:'
describe('get_auth_key', function()
local service_id = 'a_service_id'
describe('when only one credential is specified', function()
local credential_name = 'user_key'
local credentials = { [credential_name] = 'a_user_key' }
it('returns the key with the expected format', function()
local expected = 'auth,' ..
'service_id:' .. service_id .. ',' ..
credential_name .. ':' .. credentials[credential_name]
local actual = storage_keys.get_auth_key(service_id, credentials)
assert.are.same(expected, actual)
end)
end)
describe('when several credentials are specified', function()
local credential_1 = 'credential_1'
local credential_2 = 'credential_2'
local credential_3 = 'credential_3'
local credentials = { [credential_2] = 'second',
[credential_1] = 'first',
[credential_3] = 'third' }
it('returns the key with the expected format', function()
local expected = 'auth,' ..
'service_id:' .. service_id .. ',' ..
credential_1 .. ':' .. credentials[credential_1] .. ',' ..
credential_2 .. ':' .. credentials[credential_2] .. ',' ..
credential_3 .. ':' .. credentials[credential_3]
local actual = storage_keys.get_auth_key(service_id, credentials)
assert.are.same(expected, actual)
end)
end)
describe('when some field contains characters that need to be escaped', function()
local cred = 'user_key'
-- ':' and ',' should be escaped
local credentials = { [cred] = 'a:user,key' }
it('returns the key with the expected format', function()
local expected = 'auth,' ..
'service_id:' .. service_id .. ',' ..
cred .. ':' .. credentials[cred]:gsub(':', '\\:'):gsub(',', '\\,')
local actual = storage_keys.get_auth_key(service_id, credentials)
assert.are.same(expected, actual)
end)
end)
end)
describe('get_report_key', function()
local service_id = 'a_service_id'
describe('when only one credential is specified', function()
local credential_name = 'user_key'
local credentials = { [credential_name] = 'a_user_key' }
it('returns the key with the expected format', function()
local expected = 'report,' ..
'service_id:' .. service_id .. ',' ..
credential_name .. ':' .. credentials[credential_name]
local actual = storage_keys.get_report_key(service_id, credentials)
assert.are.same(expected, actual)
end)
end)
describe('when several credentials are specified', function()
local credential_1 = 'app_id'
local credential_2 = 'user_id'
local credentials = { [credential_2] = 'an_app_key',
[credential_1] = 'a_user_id' }
it('returns the key with the expected format', function()
local expected = 'report,' ..
'service_id:' .. service_id .. ',' ..
credential_1 .. ':' .. credentials[credential_1] .. ',' ..
credential_2 .. ':' .. credentials[credential_2]
local actual = storage_keys.get_report_key(service_id, credentials)
assert.are.same(expected, actual)
end)
end)
describe('when some field contains characters that need to be escaped', function()
local cred = 'user_key'
-- ':' and ',' should be escaped
local credentials = { [cred] = 'a:user,key' }
it('returns the key with the expected format', function()
local expected = 'report,' ..
'service_id:' .. service_id .. ',' ..
cred .. ':' .. credentials[cred]:gsub(':', '\\:'):gsub(',', '\\,')
local actual = storage_keys.get_report_key(service_id, credentials)
assert.are.same(expected, actual)
end)
end)
describe('and credentials contains some that are not needed', function()
local credential_name = 'user_key'
local not_needed_1 = 'not_needed_1'
local not_needed_2 = 'not_needed_2'
local credentials = { [credential_name] = 'a_user_key',
[not_needed_1] = 'not_needed_1',
[not_needed_2] = 'not_needed_2' }
it('returns the key with the expected format', function()
local expected = 'report,' ..
'service_id:' .. service_id .. ',' ..
credential_name .. ':' .. credentials[credential_name]
local actual = storage_keys.get_report_key(service_id, credentials)
assert.are.same(expected, actual)
end)
end)
it('includes all the credentials needed to identify a report', function()
-- These are all the credentials that we can find in a report key.
local all_report_creds = { ['access_token'] = 'an_access_token',
['app_id'] = 'an_app_id',
['app_key'] = 'an_app_key',
['user_id'] = 'a_user_id',
['user_key'] = 'a_user_key' }
local encoded_creds = {}
for key, value in pairs(all_report_creds) do
table.insert(encoded_creds, key .. ':' .. value)
end
table.sort(encoded_creds) -- Credentials appear sorted in the key
encoded_creds = table.concat(encoded_creds, ',')
local expected = 'report,' .. 'service_id:' .. service_id .. ',' .. encoded_creds
local actual = storage_keys.get_report_key(service_id, all_report_creds)
assert.are.same(expected, actual)
end)
end)
describe('get_pubsub_req_msg', function()
local service_id = 'a_service_id'
local metric = 'a_metric'
describe('when only one credential is specified', function()
local cred = 'user_key'
local credentials = { [cred] = 'a_user_key' }
it('returns the message with the expected format', function()
local expected = 'service_id:' .. service_id .. ',' ..
cred .. ':' .. credentials[cred] .. ',' ..
'metric:' .. metric
local actual = storage_keys.get_pubsub_req_msg(service_id, credentials, metric)
assert.are.same(expected, actual)
end)
end)
describe('when several credentials are specified', function()
local credential_1 = 'credential_1'
local credential_2 = 'credential_2'
local credential_3 = 'credential_3'
local credentials = { [credential_2] = 'second',
[credential_1] = 'first',
[credential_3] = 'third' }
it('returns the message with the expected format', function()
local expected = 'service_id:' .. service_id .. ',' ..
credential_1 .. ':' .. credentials[credential_1] .. ',' ..
credential_2 .. ':' .. credentials[credential_2] .. ',' ..
credential_3 .. ':' .. credentials[credential_3] .. ',' ..
'metric:' .. metric
local actual = storage_keys.get_pubsub_req_msg(service_id, credentials, metric)
assert.are.same(expected, actual)
end)
end)
describe('when some field contains characters that need to be escaped', function()
local cred = 'user_key'
-- ':' and ',' should be escaped
local credentials = { [cred] = 'a:user,key' }
it('returns the message with the expected format', function()
local expected = 'service_id:' .. service_id .. ',' ..
cred .. ':' .. credentials[cred]:gsub(':', '\\:'):gsub(',', '\\,') .. ',' ..
'metric:' .. metric
local actual = storage_keys.get_pubsub_req_msg(service_id, credentials, metric)
assert.are.same(expected, actual)
end)
end)
end)
describe('get_pubsub_auths_resp_channel', function()
local service_id = 'a_service_id'
local metric = 'a_metric'
describe('when only one credential is specified', function()
local cred = 'user_key'
local credentials = { [cred] = 'a_user_key' }
it('returns the channel with the expected format', function()
local expected = auth_responses_channel_prefix ..
'service_id:' .. service_id .. ',' ..
cred .. ':' .. credentials[cred] .. ',' ..
'metric:' .. metric
local actual = storage_keys.get_pubsub_auths_resp_channel(
service_id, credentials, metric)
assert.are.same(expected, actual)
end)
end)
describe('when several credentials are specified', function()
local credential_1 = 'credential_1'
local credential_2 = 'credential_2'
local credential_3 = 'credential_3'
local credentials = { [credential_2] = 'second',
[credential_1] = 'first',
[credential_3] = 'third' }
it('returns the channel with the expected format', function()
local expected = auth_responses_channel_prefix ..
'service_id:' .. service_id .. ',' ..
credential_1 .. ':' .. credentials[credential_1] .. ',' ..
credential_2 .. ':' .. credentials[credential_2] .. ',' ..
credential_3 .. ':' .. credentials[credential_3] .. ',' ..
'metric:' .. metric
local actual = storage_keys.get_pubsub_auths_resp_channel(
service_id, credentials, metric)
assert.are.same(expected, actual)
end)
end)
describe('when some field contains characters that need to be escaped', function()
local cred = 'user_key'
-- ':' and ',' should be escaped
local credentials = { [cred] = 'a:user,key' }
it('returns the channel with the expected format', function()
local expected = auth_responses_channel_prefix ..
'service_id:' .. service_id .. ',' ..
cred .. ':' .. credentials[cred]:gsub(':', '\\:'):gsub(',', '\\,') .. ',' ..
'metric:' .. metric
local actual = storage_keys.get_pubsub_auths_resp_channel(
service_id, credentials, metric)
assert.are.same(expected, actual)
end)
end)
end)
end)