forked from slackapi/bolt-python
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathtest_block_suggestion.py
More file actions
298 lines (261 loc) · 9.41 KB
/
test_block_suggestion.py
File metadata and controls
298 lines (261 loc) · 9.41 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
285
286
287
288
289
290
291
292
293
294
295
296
297
298
import copy
import json
from time import time
from urllib.parse import quote
from slack_sdk import WebClient
from slack_sdk.signature import SignatureVerifier
from slack_bolt import BoltRequest
from slack_bolt.app import App
from tests.mock_web_api_server import (
setup_mock_web_api_server,
cleanup_mock_web_api_server,
assert_auth_test_count,
)
from tests.utils import remove_os_env_temporarily, restore_os_env
class TestBlockSuggestion:
signing_secret = "secret"
valid_token = "xoxb-valid"
mock_api_server_base_url = "http://localhost:8888"
signature_verifier = SignatureVerifier(signing_secret)
web_client = WebClient(
token=valid_token,
base_url=mock_api_server_base_url,
)
def setup_method(self):
self.old_os_env = remove_os_env_temporarily()
setup_mock_web_api_server(self)
def teardown_method(self):
cleanup_mock_web_api_server(self)
restore_os_env(self.old_os_env)
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) -> BoltRequest:
timestamp = str(int(time()))
return BoltRequest(
body=raw_body, headers=self.build_headers(timestamp, raw_body)
)
def build_valid_multi_request(self) -> BoltRequest:
timestamp = str(int(time()))
return BoltRequest(
body=raw_multi_body, headers=self.build_headers(timestamp, raw_multi_body)
)
def test_mock_server_is_running(self):
resp = self.web_client.api_test()
assert resp != None
def test_success(self):
app = App(
client=self.web_client,
signing_secret=self.signing_secret,
)
app.options("es_a")(show_options)
request = self.build_valid_request()
response = app.dispatch(request)
assert response.status == 200
assert response.body == expected_response_body
assert response.headers["content-type"][0] == "application/json;charset=utf-8"
assert_auth_test_count(self, 1)
def test_success_2(self):
app = App(
client=self.web_client,
signing_secret=self.signing_secret,
)
app.block_suggestion("es_a")(show_options)
request = self.build_valid_request()
response = app.dispatch(request)
assert response.status == 200
assert response.body == expected_response_body
assert response.headers["content-type"][0] == "application/json;charset=utf-8"
assert_auth_test_count(self, 1)
def test_success_multi(self):
app = App(
client=self.web_client,
signing_secret=self.signing_secret,
)
app.options("mes_a")(show_multi_options)
request = self.build_valid_multi_request()
response = app.dispatch(request)
assert response.status == 200
assert response.body == expected_multi_response_body
assert response.headers["content-type"][0] == "application/json;charset=utf-8"
assert_auth_test_count(self, 1)
def test_process_before_response(self):
app = App(
client=self.web_client,
signing_secret=self.signing_secret,
process_before_response=True,
)
app.options("es_a")(show_options)
request = self.build_valid_request()
response = app.dispatch(request)
assert response.status == 200
assert response.body == expected_response_body
assert response.headers["content-type"][0] == "application/json;charset=utf-8"
assert_auth_test_count(self, 1)
def test_process_before_response_multi(self):
app = App(
client=self.web_client,
signing_secret=self.signing_secret,
process_before_response=True,
)
app.options("mes_a")(show_multi_options)
request = self.build_valid_multi_request()
response = app.dispatch(request)
assert response.status == 200
assert response.body == expected_multi_response_body
assert response.headers["content-type"][0] == "application/json;charset=utf-8"
assert_auth_test_count(self, 1)
def test_failure(self):
app = App(
client=self.web_client,
signing_secret=self.signing_secret,
)
request = self.build_valid_request()
response = app.dispatch(request)
assert response.status == 404
assert_auth_test_count(self, 1)
app.options("mes_a")(show_multi_options)
response = app.dispatch(request)
assert response.status == 404
assert_auth_test_count(self, 1)
def test_failure_2(self):
app = App(
client=self.web_client,
signing_secret=self.signing_secret,
)
request = self.build_valid_request()
response = app.dispatch(request)
assert response.status == 404
assert_auth_test_count(self, 1)
app.block_suggestion("mes_a")(show_multi_options)
response = app.dispatch(request)
assert response.status == 404
assert_auth_test_count(self, 1)
def test_failure_multi(self):
app = App(
client=self.web_client,
signing_secret=self.signing_secret,
)
request = self.build_valid_multi_request()
response = app.dispatch(request)
assert response.status == 404
assert_auth_test_count(self, 1)
app.options("es_a")(show_options)
response = app.dispatch(request)
assert response.status == 404
assert_auth_test_count(self, 1)
body = {
"type": "block_suggestion",
"user": {
"id": "W111",
"username": "primary-owner",
"name": "primary-owner",
"team_id": "T111",
},
"container": {"type": "view", "view_id": "V111"},
"api_app_id": "A111",
"token": "verification_token",
"action_id": "es_a",
"block_id": "es_b",
"value": "search word",
"team": {
"id": "T111",
"domain": "workspace-domain",
"enterprise_id": "E111",
"enterprise_name": "Sandbox Org",
},
"view": {
"id": "V111",
"team_id": "T111",
"type": "modal",
"blocks": [
{
"type": "input",
"block_id": "5ar+",
"label": {"type": "plain_text", "text": "Label"},
"optional": False,
"element": {"type": "plain_text_input", "action_id": "i5IpR"},
},
{
"type": "input",
"block_id": "es_b",
"label": {"type": "plain_text", "text": "Search"},
"optional": False,
"element": {
"type": "external_select",
"action_id": "es_a",
"placeholder": {"type": "plain_text", "text": "Select an item"},
},
},
{
"type": "input",
"block_id": "mes_b",
"label": {"type": "plain_text", "text": "Search (multi)"},
"optional": False,
"element": {
"type": "multi_external_select",
"action_id": "mes_a",
"placeholder": {"type": "plain_text", "text": "Select an item"},
},
},
],
"private_metadata": "",
"callback_id": "view-id",
"state": {"values": {}},
"hash": "111.xxx",
"title": {"type": "plain_text", "text": "My App"},
"clear_on_close": False,
"notify_on_close": False,
"close": {"type": "plain_text", "text": "Cancel"},
"submit": {"type": "plain_text", "text": "Submit"},
"previous_view_id": None,
"root_view_id": "V111",
"app_id": "A111",
"external_id": "",
"app_installed_team_id": "T111",
"bot_id": "B111",
},
}
raw_body = f"payload={quote(json.dumps(body))}"
multi_body = copy.deepcopy(body)
multi_body["block_id"] = "mes_b"
multi_body["action_id"] = "mes_a"
raw_multi_body = f"payload={quote(json.dumps(multi_body))}"
response = {
"options": [{"text": {"type": "plain_text", "text": "Maru"}, "value": "maru"}]
}
expected_response_body = json.dumps(response)
multi_response = {
"option_groups": [
{
"label": {"type": "plain_text", "text": "Group 1"},
"options": [
{"text": {"type": "plain_text", "text": "Option 1"}, "value": "1-1"},
{"text": {"type": "plain_text", "text": "Option 2"}, "value": "1-2"},
],
},
{
"label": {"type": "plain_text", "text": "Group 2"},
"options": [
{"text": {"type": "plain_text", "text": "Option 1"}, "value": "2-1"},
],
},
]
}
expected_multi_response_body = json.dumps(multi_response)
def show_options(ack, body, payload, options):
assert body == options
assert payload == options
ack(response)
def show_multi_options(ack, body, payload, options):
assert body == options
assert payload == options
ack(multi_response)