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
|
"""Tests for the SmartApp file."""
import asyncio
import pytest
from pysmartapp.dispatch import Dispatcher
from pysmartapp.errors import (
SignatureVerificationError, SmartAppNotRegisteredError)
from pysmartapp.smartapp import SmartApp, SmartAppManager
from .utilities import get_dispatch_handler, get_fixture
INSTALLED_APP_ID = '8a0dcdc9-1ab4-4c60-9de7-cb78f59a1121'
APP_ID = 'f6c071aa-6ae7-463f-b0ad-8620ac23140f'
class TestSmartApp:
"""Tests for the SmartApp class."""
@staticmethod
def test_initialize():
"""Tests the property initialization."""
# Arrange
path = '/my/test/path'
public_key = 'test'
dispatcher = Dispatcher()
# Act
app = SmartApp(path=path, public_key=public_key,
dispatcher=dispatcher)
# Assert
assert app.path == path
assert app.public_key == public_key
assert app.dispatcher == dispatcher
assert not app.permissions
assert app.config_app_id == 'app'
@staticmethod
def test_setters():
"""Tests the property setters."""
# Arrange
app = SmartApp()
# Act
app.app_id = "Test"
app.config_app_id = "Test Config Id"
app.description = "Description"
app.name = "Name"
# Assert
assert app.app_id == "Test"
assert app.config_app_id == "Test Config Id"
assert app.description == "Description"
assert app.name == "Name"
@staticmethod
@pytest.mark.asyncio
async def test_ping(smartapp):
"""Tests the ping lifecycle event."""
# Arrange
request = get_fixture("ping_request")
expected_response = get_fixture("ping_response")
handler = get_dispatch_handler(smartapp)
smartapp.connect_ping(handler)
# Act
response = await smartapp.handle_request(request)
# ensure dispatched tasks complete
await asyncio.gather(*smartapp.dispatcher.last_sent)
# Assert
assert handler.fired
assert response == expected_response
@staticmethod
@pytest.mark.asyncio
async def test_config_init(smartapp):
"""Tests the configuration initialization lifecycle event."""
# Arrange
request = get_fixture("config_init_request")
expected_response = get_fixture("config_init_response")
handler = get_dispatch_handler(smartapp)
smartapp.connect_config(handler)
# Act
response = await smartapp.handle_request(request, None, False)
# ensure dispatched tasks complete
await asyncio.gather(*smartapp.dispatcher.last_sent)
# Assert
assert handler.fired
assert response == expected_response
@staticmethod
@pytest.mark.asyncio
async def test_config_page(smartapp):
"""Tests the configuration initialization page event."""
# Arrange
request = get_fixture("config_page_request")
expected_response = get_fixture("config_page_response")
handler = get_dispatch_handler(smartapp)
smartapp.connect_config(handler)
# Act
response = await smartapp.handle_request(request, None, False)
# ensure dispatched tasks complete
await asyncio.gather(*smartapp.dispatcher.last_sent)
# Assert
assert handler.fired
assert response == expected_response
@staticmethod
@pytest.mark.asyncio
async def test_install(smartapp):
"""Tests the install lifecycle event."""
# Arrange
request = get_fixture("install_request")
expected_response = get_fixture("install_response")
handler = get_dispatch_handler(smartapp)
smartapp.connect_install(handler)
# Act
response = await smartapp.handle_request(request, None, False)
# ensure dispatched tasks complete
await asyncio.gather(*smartapp.dispatcher.last_sent)
# Assert
assert handler.fired
assert response == expected_response
@staticmethod
@pytest.mark.asyncio
async def test_update(smartapp):
"""Tests the update lifecycle event."""
# Arrange
request = get_fixture("update_request")
expected_response = get_fixture("update_response")
handler = get_dispatch_handler(smartapp)
smartapp.connect_update(handler)
# Act
response = await smartapp.handle_request(request, None, False)
# ensure dispatched tasks complete
await asyncio.gather(*smartapp.dispatcher.last_sent)
# Assert
assert handler.fired
assert response == expected_response
@staticmethod
@pytest.mark.asyncio
async def test_event(smartapp):
"""Tests the event lifecycle event."""
# Arrange
request = get_fixture("event_request")
expected_response = get_fixture("event_response")
handler = get_dispatch_handler(smartapp)
smartapp.connect_event(handler)
# Act
response = await smartapp.handle_request(request, None, False)
# ensure dispatched tasks complete
await asyncio.gather(*smartapp.dispatcher.last_sent)
# Assert
assert handler.fired
assert response == expected_response
@staticmethod
@pytest.mark.asyncio
async def test_oauth_callback(smartapp):
"""Tests the oauth_callback lifecycle event."""
# Arrange
request = get_fixture("oauth_callback_request")
expected_response = get_fixture("oauth_callback_response")
handler = get_dispatch_handler(smartapp)
smartapp.connect_oauth_callback(handler)
# Act
response = await smartapp.handle_request(request, None, False)
# ensure dispatched tasks complete
await asyncio.gather(*smartapp.dispatcher.last_sent)
# Assert
assert handler.fired
assert response == expected_response
@staticmethod
@pytest.mark.asyncio
async def test_uninstall(smartapp):
"""Tests the uninstall lifecycle event."""
# Arrange
request = get_fixture("uninstall_request")
expected_response = get_fixture("uninstall_response")
handler = get_dispatch_handler(smartapp)
smartapp.connect_uninstall(handler)
# Act
response = await smartapp.handle_request(request, None, False)
# ensure dispatched tasks complete
await asyncio.gather(*smartapp.dispatcher.last_sent)
# Assert
assert handler.fired
assert response == expected_response
@staticmethod
@pytest.mark.asyncio
async def test_handle_request_sig_verification():
"""Tests handle_request with sig verification."""
# Arrange
public_key = get_fixture('public_key', 'pem')
data = get_fixture('config_init_sig_pass_request')
smartapp = SmartApp(public_key=public_key)
# Act
resp = await smartapp.handle_request(
data['body'], data['headers'], True)
# Assert
assert resp
@staticmethod
@pytest.mark.asyncio
async def test_handle_request_sig_verification_missing_headers():
"""Tests handle_request with sig verification."""
# Arrange
public_key = get_fixture('public_key', 'pem')
data = get_fixture('config_init_sig_pass_request')
smartapp = SmartApp(public_key=public_key)
# Act/Assert
with pytest.raises(SignatureVerificationError):
await smartapp.handle_request(data['body'], [], True)
@staticmethod
@pytest.mark.asyncio
async def test_handle_request_sig_verification_fails():
"""Tests handle_request with sig verification."""
# Arrange
public_key = get_fixture('public_key', 'pem')
data = get_fixture('config_init_sig_fail_request')
smartapp = SmartApp(public_key=public_key)
# Act/Assert
with pytest.raises(SignatureVerificationError):
await smartapp.handle_request(data['body'], data['headers'], True)
class TestSmartAppManager:
"""Tests for the SmartAppManager class."""
@staticmethod
@pytest.mark.asyncio
async def test_handle_request_ping_not_registered(manager):
"""Tests the ping lifecycle event with no registered apps."""
# Arrange
request = get_fixture("ping_request")
expected_response = get_fixture("ping_response")
handler = get_dispatch_handler(manager)
manager.connect_ping(handler)
# Act
response = await manager.handle_request(request)
# ensure dispatched tasks complete
await asyncio.gather(*manager.dispatcher.last_sent)
# Assert
assert handler.fired
assert response == expected_response
@staticmethod
@pytest.mark.asyncio
async def test_handle_request_not_registered(manager: SmartAppManager):
"""Tests processing a request when no SmartApp has been registered."""
# Arrange
request = get_fixture("config_init_request")
# Act
with pytest.raises(SmartAppNotRegisteredError) as e_info:
await manager.handle_request(request, None, False)
# Assert
assert e_info.value.installed_app_id == INSTALLED_APP_ID
@staticmethod
@pytest.mark.asyncio
async def test_handle_request_not_app_id(manager: SmartAppManager):
"""Tests processing a request when no SmartApp has been registered."""
# Arrange
request = get_fixture("config_init_sig_fail_request")['body']
# Act
with pytest.raises(SmartAppNotRegisteredError) as e_info:
await manager.handle_request(request, None, False)
# Assert
assert e_info.value.installed_app_id == INSTALLED_APP_ID
@staticmethod
def test_register(manager: SmartAppManager):
"""Test register."""
public_key = '123'
# Act
app = manager.register(APP_ID, public_key)
# Assert
assert app.app_id == APP_ID
assert app.public_key == public_key
assert app.path == manager.path
assert APP_ID in manager.smartapps
@staticmethod
def test_register_no_app_id(manager: SmartAppManager):
"""Test register with no SmartApp app id."""
# Act
with pytest.raises(ValueError) as e_info:
manager.register(None, '')
# Assert
assert str(e_info.value) == 'smartapp must have an app_id.'
@staticmethod
def test_register_twice(manager: SmartAppManager):
"""Test register with the same app twice."""
# Arrange
public_key = '123'
manager.register(APP_ID, public_key)
# Act
with pytest.raises(ValueError) as e_info:
manager.register(APP_ID, public_key)
# Assert
assert str(e_info.value) == 'smartapp already registered.'
@staticmethod
def test_unregister(manager: SmartAppManager):
"""Test unregister."""
# Arrange'
manager.register(APP_ID, '123')
# Act
manager.unregister(APP_ID)
# Assert
assert APP_ID not in manager.smartapps
@staticmethod
def test_unregister_no_app_id(manager: SmartAppManager):
"""Test unregister with no SmartApp app id."""
# Act
with pytest.raises(ValueError) as e_info:
manager.unregister(None)
# Assert
assert str(e_info.value) == 'smartapp must have an app_id.'
@staticmethod
def test_unregister_not_registered(manager: SmartAppManager):
"""Test register with the same app twice."""
# Act
with pytest.raises(ValueError) as e_info:
manager.unregister(APP_ID)
# Assert
assert str(e_info.value) == 'smartapp was not previously registered.'
@staticmethod
@pytest.mark.asyncio
async def test_on_config(manager: SmartAppManager):
"""Tests the config event handler at the manager level."""
# Arrange
request = get_fixture("config_init_request")
app = manager.register(APP_ID, 'none')
handler = get_dispatch_handler(app)
manager.connect_config(handler)
# Act
await manager.handle_request(request, None, False)
# ensure dispatched tasks complete
await asyncio.gather(*manager.dispatcher.last_sent)
# Assert
assert handler.fired
@staticmethod
@pytest.mark.asyncio
async def test_on_install(manager: SmartAppManager):
"""Tests the config event handler at the manager level."""
# Arrange
request = get_fixture("install_request")
app = manager.register(APP_ID, 'none')
handler = get_dispatch_handler(app)
manager.connect_install(handler)
# Act
await manager.handle_request(request, None, False)
# ensure dispatched tasks complete
await asyncio.gather(*manager.dispatcher.last_sent)
# Assert
assert handler.fired
@staticmethod
@pytest.mark.asyncio
async def test_on_update(manager: SmartAppManager):
"""Tests the config event handler at the manager level."""
# Arrange
request = get_fixture("update_request")
app = manager.register(APP_ID, 'none')
handler = get_dispatch_handler(app)
manager.connect_update(handler)
# Act
await manager.handle_request(request, None, False)
# ensure dispatched tasks complete
await asyncio.gather(*manager.dispatcher.last_sent)
# Assert
assert handler.fired
@staticmethod
@pytest.mark.asyncio
async def test_on_event(manager: SmartAppManager):
"""Tests the config event handler at the manager level."""
# Arrange
request = get_fixture("event_request")
app = manager.register(APP_ID, 'none')
handler = get_dispatch_handler(app)
manager.connect_event(handler)
# Act
await manager.handle_request(request, None, False)
# ensure dispatched tasks complete
await asyncio.gather(*manager.dispatcher.last_sent)
# Assert
assert handler.fired
@staticmethod
@pytest.mark.asyncio
async def test_on_oauth_callback(manager: SmartAppManager):
"""Tests the config event handler at the manager level."""
# Arrange
request = get_fixture("oauth_callback_request")
app = manager.register(APP_ID, 'none')
handler = get_dispatch_handler(app)
manager.connect_oauth_callback(handler)
# Act
await manager.handle_request(request, None, False)
# ensure dispatched tasks complete
await asyncio.gather(*manager.dispatcher.last_sent)
# Assert
assert handler.fired
@staticmethod
@pytest.mark.asyncio
async def test_on_uninstall(manager: SmartAppManager):
"""Tests the config event handler at the manager level."""
# Arrange
request = get_fixture("uninstall_request")
app = manager.register(APP_ID, 'none')
handler = get_dispatch_handler(app)
manager.connect_uninstall(handler)
# Act
await manager.handle_request(request, None, False)
# ensure dispatched tasks complete
await asyncio.gather(*manager.dispatcher.last_sent)
# Assert
assert handler.fired
|
