-
Notifications
You must be signed in to change notification settings - Fork 250
/
Copy pathtest_app_bot_only.py
260 lines (225 loc) · 8.79 KB
/
test_app_bot_only.py
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
import datetime
import json
import logging
from time import time
from typing import Optional
from slack_sdk import WebClient
from slack_sdk.oauth import InstallationStore
from slack_sdk.oauth.installation_store import Bot, Installation
from slack_sdk.oauth.state_store import FileOAuthStateStore
from slack_sdk.signature import SignatureVerifier
from slack_bolt import App, BoltRequest, Say
from slack_bolt.oauth import OAuthFlow
from slack_bolt.oauth.oauth_settings import OAuthSettings
from tests.mock_web_api_server import (
assert_auth_test_count,
assert_received_request_count,
cleanup_mock_web_api_server,
setup_mock_web_api_server,
)
from tests.utils import remove_os_env_temporarily, restore_os_env
class LegacyMemoryInstallationStore(InstallationStore):
@property
def logger(self) -> logging.Logger:
return logging.getLogger(__name__)
def save(self, installation: Installation):
pass
def find_bot(
self,
*,
enterprise_id: Optional[str],
team_id: Optional[str],
is_enterprise_install: Optional[bool] = False,
) -> Optional[Bot]:
return Bot(
app_id="A111",
enterprise_id="E111",
team_id="T0G9PQBBK",
bot_token="xoxb-valid",
bot_id="B",
bot_user_id="W",
bot_scopes=["commands", "chat:write"],
installed_at=datetime.datetime.now().timestamp(),
)
class MemoryInstallationStore(LegacyMemoryInstallationStore):
def find_installation(
self,
*,
enterprise_id: Optional[str],
team_id: Optional[str],
user_id: Optional[str] = None,
is_enterprise_install: Optional[bool] = False,
) -> Optional[Installation]:
return Installation(
app_id="A111",
enterprise_id="E111",
team_id="T0G9PQBBK",
bot_token="xoxb-valid-2",
bot_id="B",
bot_user_id="W",
bot_scopes=["commands", "chat:write"],
user_id="W11111",
user_token="xoxp-valid",
user_scopes=["search:read"],
installed_at=datetime.datetime.now().timestamp(),
)
class BotOnlyMemoryInstallationStore(LegacyMemoryInstallationStore):
def find_installation(
self,
*,
enterprise_id: Optional[str],
team_id: Optional[str],
user_id: Optional[str] = None,
is_enterprise_install: Optional[bool] = False,
) -> Optional[Installation]:
raise ValueError
class TestApp:
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/json"],
"x-slack-signature": [self.generate_signature(body, timestamp)],
"x-slack-request-timestamp": [timestamp],
}
app_mention_request_body = {
"token": "verification_token",
"team_id": "T111",
"enterprise_id": "E111",
"api_app_id": "A111",
"event": {
"client_msg_id": "9cbd4c5b-7ddf-4ede-b479-ad21fca66d63",
"type": "app_mention",
"text": "<@W111> Hi there!",
"user": "W222",
"ts": "1595926230.009600",
"team": "T111",
"channel": "C111",
"event_ts": "1595926230.009600",
},
"type": "event_callback",
"event_id": "Ev111",
"event_time": 1595926230,
"authed_users": ["W111"],
}
@staticmethod
def handle_app_mention(body, say: Say, payload, event):
assert body["event"] == payload
assert payload == event
say("What's up?")
oauth_settings_bot_only = OAuthSettings(
client_id="111.222",
client_secret="valid",
installation_store=BotOnlyMemoryInstallationStore(),
installation_store_bot_only=True,
state_store=FileOAuthStateStore(expiration_seconds=120),
)
oauth_settings = OAuthSettings(
client_id="111.222",
client_secret="valid",
installation_store=BotOnlyMemoryInstallationStore(),
installation_store_bot_only=False,
state_store=FileOAuthStateStore(expiration_seconds=120),
)
def build_app_mention_request(self):
timestamp, body = str(int(time())), json.dumps(self.app_mention_request_body)
return BoltRequest(body=body, headers=self.build_headers(timestamp, body))
def test_installation_store_bot_only_default(self):
app = App(
client=self.web_client,
signing_secret=self.signing_secret,
installation_store=MemoryInstallationStore(),
)
app.event("app_mention")(self.handle_app_mention)
response = app.dispatch(self.build_app_mention_request())
assert response.status == 200
assert_auth_test_count(self, 2)
assert_received_request_count(self, path="/chat.postMessage", min_count=1)
def test_installation_store_bot_only_false(self):
app = App(
client=self.web_client,
signing_secret=self.signing_secret,
installation_store=MemoryInstallationStore(),
# the default is False
installation_store_bot_only=False,
)
app.event("app_mention")(self.handle_app_mention)
response = app.dispatch(self.build_app_mention_request())
assert response.status == 200
assert_auth_test_count(self, 2)
assert_received_request_count(self, path="/chat.postMessage", min_count=1)
def test_installation_store_bot_only(self):
app = App(
client=self.web_client,
signing_secret=self.signing_secret,
installation_store=BotOnlyMemoryInstallationStore(),
installation_store_bot_only=True,
)
app.event("app_mention")(self.handle_app_mention)
response = app.dispatch(self.build_app_mention_request())
assert response.status == 200
assert_auth_test_count(self, 1)
assert_received_request_count(self, path="/chat.postMessage", min_count=1)
def test_installation_store_bot_only_oauth_settings(self):
app = App(
client=self.web_client,
signing_secret=self.signing_secret,
oauth_settings=self.oauth_settings_bot_only,
)
app.event("app_mention")(self.handle_app_mention)
response = app.dispatch(self.build_app_mention_request())
assert response.status == 200
assert_auth_test_count(self, 1)
assert_received_request_count(self, path="/chat.postMessage", min_count=1)
def test_installation_store_bot_only_oauth_settings_conflicts(self):
app = App(
client=self.web_client,
signing_secret=self.signing_secret,
installation_store_bot_only=True,
oauth_settings=self.oauth_settings,
)
app.event("app_mention")(self.handle_app_mention)
response = app.dispatch(self.build_app_mention_request())
assert response.status == 200
assert_auth_test_count(self, 1)
assert_received_request_count(self, path="/chat.postMessage", min_count=1)
def test_installation_store_bot_only_oauth_flow(self):
app = App(
client=self.web_client,
signing_secret=self.signing_secret,
oauth_flow=OAuthFlow(settings=self.oauth_settings_bot_only),
)
app.event("app_mention")(self.handle_app_mention)
response = app.dispatch(self.build_app_mention_request())
assert response.status == 200
assert_auth_test_count(self, 1)
assert_received_request_count(self, path="/chat.postMessage", min_count=1)
def test_installation_store_bot_only_oauth_flow_conflicts(self):
app = App(
client=self.web_client,
signing_secret=self.signing_secret,
installation_store_bot_only=True,
oauth_flow=OAuthFlow(settings=self.oauth_settings),
)
app.event("app_mention")(self.handle_app_mention)
response = app.dispatch(self.build_app_mention_request())
assert response.status == 200
assert_auth_test_count(self, 1)
assert_received_request_count(self, path="/chat.postMessage", min_count=1)