forked from slackapi/bolt-python
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathtest_error_handler.py
More file actions
284 lines (239 loc) · 9.27 KB
/
test_error_handler.py
File metadata and controls
284 lines (239 loc) · 9.27 KB
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
import asyncio
import json
from time import time
from urllib.parse import quote
import pytest
from slack_sdk.signature import SignatureVerifier
from slack_sdk.web.async_client import AsyncWebClient
from slack_bolt import BoltResponse
from slack_bolt.async_app import AsyncApp
from slack_bolt.error import BoltUnhandledRequestError
from slack_bolt.request.async_request import AsyncBoltRequest
from tests.mock_web_api_server import (
setup_mock_web_api_server,
cleanup_mock_web_api_server,
)
from tests.utils import remove_os_env_temporarily, restore_os_env
class TestAsyncErrorHandler:
signing_secret = "secret"
valid_token = "xoxb-valid"
mock_api_server_base_url = "http://localhost:8888"
signature_verifier = SignatureVerifier(signing_secret)
web_client = AsyncWebClient(
token=valid_token,
base_url=mock_api_server_base_url,
)
@pytest.fixture
def event_loop(self):
old_os_env = remove_os_env_temporarily()
try:
setup_mock_web_api_server(self)
loop = asyncio.get_event_loop()
yield loop
loop.close()
cleanup_mock_web_api_server(self)
finally:
restore_os_env(old_os_env)
# ----------------
# utilities
# ----------------
def generate_signature(self, body: str, timestamp: str):
return self.signature_verifier.generate_signature(
body=body,
timestamp=timestamp,
)
def build_headers(self, timestamp: str, body: str):
return {
"content-type": ["application/x-www-form-urlencoded"],
"x-slack-signature": [self.generate_signature(body, timestamp)],
"x-slack-request-timestamp": [timestamp],
}
def build_valid_request(self) -> AsyncBoltRequest:
body = {
"type": "block_actions",
"user": {
"id": "W111",
},
"api_app_id": "A111",
"token": "verification_token",
"trigger_id": "111.222.valid",
"team": {
"id": "T111",
},
"channel": {"id": "C111", "name": "test-channel"},
"response_url": "https://hooks.slack.com/actions/T111/111/random-value",
"actions": [
{
"action_id": "a",
"block_id": "b",
"text": {"type": "plain_text", "text": "Button"},
"value": "click_me_123",
"type": "button",
"action_ts": "1596530385.194939",
}
],
}
raw_body = f"payload={quote(json.dumps(body))}"
timestamp = str(int(time()))
return AsyncBoltRequest(body=raw_body, headers=self.build_headers(timestamp, raw_body))
# ----------------
# tests
# ----------------
@pytest.mark.asyncio
async def test_default(self):
async def failing_listener():
raise Exception("Something wrong!")
app = AsyncApp(
client=self.web_client,
signing_secret=self.signing_secret,
)
app.action("a")(failing_listener)
request = self.build_valid_request()
response = await app.async_dispatch(request)
assert response.status == 500
@pytest.mark.asyncio
async def test_custom(self):
async def error_handler(logger, payload, response):
logger.info(payload)
response.headers["x-test-result"] = ["1"]
async def failing_listener():
raise Exception("Something wrong!")
app = AsyncApp(
client=self.web_client,
signing_secret=self.signing_secret,
)
app.error(error_handler)
app.action("a")(failing_listener)
request = self.build_valid_request()
response = await app.async_dispatch(request)
assert response.status == 500
assert response.headers["x-test-result"] == ["1"]
@pytest.mark.asyncio
async def test_process_before_response_default(self):
async def failing_listener():
raise Exception("Something wrong!")
app = AsyncApp(
client=self.web_client,
signing_secret=self.signing_secret,
process_before_response=True,
)
app.action("a")(failing_listener)
request = self.build_valid_request()
response = await app.async_dispatch(request)
assert response.status == 500
@pytest.mark.asyncio
async def test_process_before_response_custom(self):
async def error_handler(logger, payload, response):
logger.info(payload)
response.headers["x-test-result"] = ["1"]
async def failing_listener():
raise Exception("Something wrong!")
app = AsyncApp(
client=self.web_client,
signing_secret=self.signing_secret,
process_before_response=True,
)
app.error(error_handler)
app.action("a")(failing_listener)
request = self.build_valid_request()
response = await app.async_dispatch(request)
assert response.status == 500
assert response.headers["x-test-result"] == ["1"]
@pytest.mark.asyncio
async def test_unhandled_errors(self):
app = AsyncApp(
client=self.web_client,
signing_secret=self.signing_secret,
raise_error_for_unhandled_request=True,
)
response = await app.async_dispatch(self.build_valid_request())
assert response.status == 404
assert response.body == '{"error": "unhandled request"}'
@app.error
async def handle_errors(error):
assert isinstance(error, BoltUnhandledRequestError)
return BoltResponse(status=404, body="TODO")
response = await app.async_dispatch(self.build_valid_request())
assert response.status == 404
assert response.body == "TODO"
@pytest.mark.asyncio
async def test_unhandled_errors_process_before_response(self):
app = AsyncApp(
client=self.web_client,
signing_secret=self.signing_secret,
raise_error_for_unhandled_request=True,
process_before_response=True,
)
response = await app.async_dispatch(self.build_valid_request())
assert response.status == 404
assert response.body == '{"error": "unhandled request"}'
@app.error
async def handle_errors(error):
assert isinstance(error, BoltUnhandledRequestError)
return BoltResponse(status=404, body="TODO")
response = await app.async_dispatch(self.build_valid_request())
assert response.status == 404
assert response.body == "TODO"
@pytest.mark.asyncio
async def test_unhandled_errors_no_next(self):
app = AsyncApp(
client=self.web_client,
signing_secret=self.signing_secret,
raise_error_for_unhandled_request=True,
)
@app.middleware
async def broken_middleware():
pass
response = await app.async_dispatch(self.build_valid_request())
assert response.status == 404
assert response.body == '{"error": "no next() calls in middleware"}'
@app.error
async def handle_errors(error):
assert isinstance(error, BoltUnhandledRequestError)
return BoltResponse(status=404, body="TODO")
response = await app.async_dispatch(self.build_valid_request())
assert response.status == 404
assert response.body == "TODO"
@pytest.mark.asyncio
async def test_unhandled_errors_process_before_response_no_next(self):
app = AsyncApp(
client=self.web_client,
signing_secret=self.signing_secret,
raise_error_for_unhandled_request=True,
process_before_response=True,
)
@app.middleware
async def broken_middleware():
pass
response = await app.async_dispatch(self.build_valid_request())
assert response.status == 404
assert response.body == '{"error": "no next() calls in middleware"}'
@app.error
async def handle_errors(error):
assert isinstance(error, BoltUnhandledRequestError)
return BoltResponse(status=404, body="TODO")
response = await app.async_dispatch(self.build_valid_request())
assert response.status == 404
assert response.body == "TODO"
@pytest.mark.asyncio
async def test_middleware_errors(self):
app = AsyncApp(
client=self.web_client,
signing_secret=self.signing_secret,
)
@app.middleware
async def broken_middleware(next_):
assert next_ is not None
raise RuntimeError("Something wrong!")
response = await app.async_dispatch(self.build_valid_request())
assert response.status == 500
assert response.body == ""
@app.error
async def handle_errors(body, next_, error):
assert next_ is None
assert body is not None
assert isinstance(error, RuntimeError)
return BoltResponse(status=503, body="as expected")
response = await app.async_dispatch(self.build_valid_request())
assert response.status == 503
assert response.body == "as expected"