-
Notifications
You must be signed in to change notification settings - Fork 3.2k
/
test_user.py
463 lines (384 loc) · 15.4 KB
/
test_user.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
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
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
# Copyright (c) 2015, Frappe Technologies Pvt. Ltd. and Contributors
# License: MIT. See LICENSE
import json
import time
from unittest.mock import patch
import frappe
import frappe.exceptions
from frappe.core.doctype.user.user import (
handle_password_test_fail,
reset_password,
sign_up,
test_password_strength,
update_password,
verify_password,
)
from frappe.desk.notifications import extract_mentions
from frappe.frappeclient import FrappeClient
from frappe.model.delete_doc import delete_doc
from frappe.tests.utils import FrappeTestCase
from frappe.utils import get_url
user_module = frappe.core.doctype.user.user
test_records = frappe.get_test_records("User")
class TestUser(FrappeTestCase):
def tearDown(self):
# disable password strength test
frappe.db.set_value("System Settings", "System Settings", "enable_password_policy", 0)
frappe.db.set_value("System Settings", "System Settings", "minimum_password_score", "")
frappe.db.set_value("System Settings", "System Settings", "password_reset_limit", 3)
frappe.set_user("Administrator")
def test_user_type(self):
new_user = frappe.get_doc(
dict(doctype="User", email="test-for-type@example.com", first_name="Tester")
).insert(ignore_if_duplicate=True)
self.assertEqual(new_user.user_type, "Website User")
# social login userid for frappe
self.assertTrue(new_user.social_logins[0].userid)
self.assertEqual(new_user.social_logins[0].provider, "frappe")
# role with desk access
new_user.add_roles("_Test Role 2")
new_user.save()
self.assertEqual(new_user.user_type, "System User")
# clear role
new_user.roles = []
new_user.save()
self.assertEqual(new_user.user_type, "Website User")
# role without desk access
new_user.add_roles("_Test Role 4")
new_user.save()
self.assertEqual(new_user.user_type, "Website User")
delete_contact(new_user.name)
frappe.delete_doc("User", new_user.name)
def test_delete(self):
frappe.get_doc("User", "test@example.com").add_roles("_Test Role 2")
self.assertRaises(frappe.LinkExistsError, delete_doc, "Role", "_Test Role 2")
frappe.db.delete("Has Role", {"role": "_Test Role 2"})
delete_doc("Role", "_Test Role 2")
if frappe.db.exists("User", "_test@example.com"):
delete_contact("_test@example.com")
delete_doc("User", "_test@example.com")
user = frappe.copy_doc(test_records[1])
user.email = "_test@example.com"
user.insert()
frappe.get_doc({"doctype": "ToDo", "description": "_Test"}).insert()
delete_contact("_test@example.com")
delete_doc("User", "_test@example.com")
self.assertTrue(
not frappe.db.sql("""select * from `tabToDo` where allocated_to=%s""", ("_test@example.com",))
)
from frappe.core.doctype.role.test_role import test_records as role_records
frappe.copy_doc(role_records[1]).insert()
def test_get_value(self):
self.assertEqual(frappe.db.get_value("User", "test@example.com"), "test@example.com")
self.assertEqual(frappe.db.get_value("User", {"email": "test@example.com"}), "test@example.com")
self.assertEqual(
frappe.db.get_value("User", {"email": "test@example.com"}, "email"), "test@example.com"
)
self.assertEqual(
frappe.db.get_value("User", {"email": "test@example.com"}, ["first_name", "email"]),
("_Test", "test@example.com"),
)
self.assertEqual(
frappe.db.get_value(
"User", {"email": "test@example.com", "first_name": "_Test"}, ["first_name", "email"]
),
("_Test", "test@example.com"),
)
test_user = frappe.db.sql("select * from tabUser where name='test@example.com'", as_dict=True)[0]
self.assertEqual(
frappe.db.get_value("User", {"email": "test@example.com"}, "*", as_dict=True), test_user
)
self.assertEqual(frappe.db.get_value("User", "xxxtest@example.com"), None)
frappe.db.set_value("Website Settings", "Website Settings", "_test", "_test_val")
self.assertEqual(frappe.db.get_value("Website Settings", None, "_test"), "_test_val")
self.assertEqual(
frappe.db.get_value("Website Settings", "Website Settings", "_test"), "_test_val"
)
def test_high_permlevel_validations(self):
user = frappe.get_meta("User")
self.assertTrue("roles" in [d.fieldname for d in user.get_high_permlevel_fields()])
me = frappe.get_doc("User", "testperm@example.com")
me.remove_roles("System Manager")
frappe.set_user("testperm@example.com")
me = frappe.get_doc("User", "testperm@example.com")
me.add_roles("System Manager")
# system manager is not added (it is reset)
self.assertFalse("System Manager" in [d.role for d in me.roles])
# ignore permlevel using flags
me.flags.ignore_permlevel_for_fields = ["roles"]
me.add_roles("System Manager")
# system manager now added due to flags
self.assertTrue("System Manager" in [d.role for d in me.get("roles")])
# reset flags
me.flags.ignore_permlevel_for_fields = None
# change user
frappe.set_user("Administrator")
me = frappe.get_doc("User", "testperm@example.com")
me.add_roles("System Manager")
# system manager now added by Administrator
self.assertTrue("System Manager" in [d.role for d in me.get("roles")])
def test_delete_user(self):
new_user = frappe.get_doc(
dict(doctype="User", email="test-for-delete@example.com", first_name="Tester Delete User")
).insert(ignore_if_duplicate=True)
self.assertEqual(new_user.user_type, "Website User")
# role with desk access
new_user.add_roles("_Test Role 2")
new_user.save()
self.assertEqual(new_user.user_type, "System User")
comm = frappe.get_doc(
{
"doctype": "Communication",
"subject": "To check user able to delete even if linked with communication",
"content": "To check user able to delete even if linked with communication",
"sent_or_received": "Sent",
"user": new_user.name,
}
)
comm.insert(ignore_permissions=True)
delete_contact(new_user.name)
frappe.delete_doc("User", new_user.name)
self.assertFalse(frappe.db.exists("User", new_user.name))
def test_password_strength(self):
# Test Password without Password Strength Policy
frappe.db.set_value("System Settings", "System Settings", "enable_password_policy", 0)
# password policy is disabled, test_password_strength should be ignored
result = test_password_strength("test_password")
self.assertFalse(result.get("feedback", None))
# Test Password with Password Strenth Policy Set
frappe.db.set_value("System Settings", "System Settings", "enable_password_policy", 1)
frappe.db.set_value("System Settings", "System Settings", "minimum_password_score", 2)
# Score 1; should now fail
result = test_password_strength("bee2ve")
self.assertEqual(result["feedback"]["password_policy_validation_passed"], False)
self.assertRaises(
frappe.exceptions.ValidationError, handle_password_test_fail, result["feedback"]
)
self.assertRaises(
frappe.exceptions.ValidationError, handle_password_test_fail, result
) # test backwards compatibility
# Score 4; should pass
result = test_password_strength("Eastern_43A1W")
self.assertEqual(result["feedback"]["password_policy_validation_passed"], True)
# test password strength while saving user with new password
user = frappe.get_doc("User", "test@example.com")
frappe.flags.in_test = False
user.new_password = "password"
self.assertRaises(frappe.exceptions.ValidationError, user.save)
user.reload()
user.new_password = "Eastern_43A1W"
user.save()
frappe.flags.in_test = True
def test_comment_mentions(self):
comment = """
<span class="mention" data-id="test.comment@example.com" data-value="Test" data-denotation-char="@">
<span><span class="ql-mention-denotation-char">@</span>Test</span>
</span>
"""
self.assertEqual(extract_mentions(comment)[0], "test.comment@example.com")
comment = """
<div>
Testing comment,
<span class="mention" data-id="test.comment@example.com" data-value="Test" data-denotation-char="@">
<span><span class="ql-mention-denotation-char">@</span>Test</span>
</span>
please check
</div>
"""
self.assertEqual(extract_mentions(comment)[0], "test.comment@example.com")
comment = """
<div>
Testing comment for
<span class="mention" data-id="test_user@example.com" data-value="Test" data-denotation-char="@">
<span><span class="ql-mention-denotation-char">@</span>Test</span>
</span>
and
<span class="mention" data-id="test.again@example1.com" data-value="Test" data-denotation-char="@">
<span><span class="ql-mention-denotation-char">@</span>Test</span>
</span>
please check
</div>
"""
self.assertEqual(extract_mentions(comment)[0], "test_user@example.com")
self.assertEqual(extract_mentions(comment)[1], "test.again@example1.com")
frappe.delete_doc("User Group", "Team")
doc = frappe.get_doc(
{
"doctype": "User Group",
"name": "Team",
"user_group_members": [{"user": "test@example.com"}, {"user": "test1@example.com"}],
}
)
doc.insert()
comment = """
<div>
Testing comment for
<span class="mention" data-id="Team" data-value="Team" data-is-group="true" data-denotation-char="@">
<span><span class="ql-mention-denotation-char">@</span>Team</span>
</span> and
<span class="mention" data-id="Unknown Team" data-value="Unknown Team" data-is-group="true"
data-denotation-char="@">
<span><span class="ql-mention-denotation-char">@</span>Unknown Team</span>
</span><!-- this should be ignored-->
please check
</div>
"""
self.assertListEqual(extract_mentions(comment), ["test@example.com", "test1@example.com"])
def test_rate_limiting_for_reset_password(self):
# Allow only one reset request for a day
frappe.db.set_value("System Settings", "System Settings", "password_reset_limit", 1)
frappe.db.commit()
url = get_url()
data = {"cmd": "frappe.core.doctype.user.user.reset_password", "user": "test@test.com"}
# Clear rate limit tracker to start fresh
key = f"rl:{data['cmd']}:{data['user']}"
frappe.cache().delete(key)
c = FrappeClient(url)
res1 = c.session.post(url, data=data, verify=c.verify, headers=c.headers)
res2 = c.session.post(url, data=data, verify=c.verify, headers=c.headers)
self.assertEqual(res1.status_code, 404)
self.assertEqual(res2.status_code, 417)
def test_user_rename(self):
old_name = "test_user_rename@example.com"
new_name = "test_user_rename_new@example.com"
user = frappe.get_doc(
{
"doctype": "User",
"email": old_name,
"enabled": 1,
"first_name": "_Test",
"new_password": "Eastern_43A1W",
"roles": [{"doctype": "Has Role", "parentfield": "roles", "role": "System Manager"}],
}
).insert(ignore_permissions=True, ignore_if_duplicate=True)
frappe.rename_doc("User", user.name, new_name)
self.assertTrue(frappe.db.exists("Notification Settings", new_name))
frappe.delete_doc("User", new_name)
def test_signup(self):
import frappe.website.utils
random_user = frappe.mock("email")
random_user_name = frappe.mock("name")
# disabled signup
with patch.object(user_module, "is_signup_disabled", return_value=True):
self.assertRaisesRegex(
frappe.exceptions.ValidationError,
"Sign Up is disabled",
sign_up,
random_user,
random_user_name,
"/signup",
)
self.assertTupleEqual(
sign_up(random_user, random_user_name, "/welcome"),
(1, "Please check your email for verification"),
)
self.assertEqual(frappe.cache().hget("redirect_after_login", random_user), "/welcome")
# re-register
self.assertTupleEqual(
sign_up(random_user, random_user_name, "/welcome"), (0, "Already Registered")
)
# disabled user
user = frappe.get_doc("User", random_user)
user.enabled = 0
user.save()
self.assertTupleEqual(
sign_up(random_user, random_user_name, "/welcome"), (0, "Registered but disabled")
)
# throttle user creation
with patch.object(user_module.frappe.db, "get_creation_count", return_value=301):
self.assertRaisesRegex(
frappe.exceptions.ValidationError,
"Throttled",
sign_up,
frappe.mock("email"),
random_user_name,
"/signup",
)
def test_reset_password(self):
from frappe.auth import CookieManager, LoginManager
from frappe.utils import set_request
old_password = "Eastern_43A1W"
new_password = "easy_password"
set_request(path="/random")
frappe.local.cookie_manager = CookieManager()
frappe.local.login_manager = LoginManager()
frappe.set_user("testpassword@example.com")
test_user = frappe.get_doc("User", "testpassword@example.com")
test_user.reset_password()
self.assertEqual(update_password(new_password, key=test_user.reset_password_key), "/app")
self.assertEqual(
update_password(new_password, key="wrong_key"),
"The reset password link has either been used before or is invalid",
)
# password verification should fail with old password
self.assertRaises(frappe.exceptions.AuthenticationError, verify_password, old_password)
verify_password(new_password)
# reset password
update_password(old_password, old_password=new_password)
self.assertRaisesRegex(
frappe.exceptions.ValidationError, "Invalid key type", update_password, "test", 1, ["like", "%"]
)
password_strength_response = {
"feedback": {"password_policy_validation_passed": False, "suggestions": ["Fix password"]}
}
# password strength failure test
with patch.object(
user_module, "test_password_strength", return_value=password_strength_response
):
self.assertRaisesRegex(
frappe.exceptions.ValidationError,
"Fix password",
update_password,
new_password,
0,
test_user.reset_password_key,
)
# test redirect URL for website users
frappe.set_user("test2@example.com")
self.assertEqual(update_password(new_password, old_password=old_password), "/")
# reset password
update_password(old_password, old_password=new_password)
# test API endpoint
with patch.object(user_module.frappe, "sendmail") as sendmail:
frappe.clear_messages()
test_user = frappe.get_doc("User", "test2@example.com")
self.assertEqual(reset_password(user="test2@example.com"), None)
test_user.reload()
self.assertEqual(update_password(new_password, key=test_user.reset_password_key), "/")
update_password(old_password, old_password=new_password)
self.assertEqual(
json.loads(frappe.message_log[0]).get("message"),
"Password reset instructions have been sent to your email",
)
sendmail.assert_called_once()
self.assertEqual(sendmail.call_args[1]["recipients"], "test2@example.com")
self.assertEqual(reset_password(user="test2@example.com"), None)
self.assertEqual(reset_password(user="Administrator"), "not allowed")
self.assertEqual(reset_password(user="random"), "not found")
def test_user_onload_modules(self):
from frappe.config import get_modules_from_all_apps
from frappe.desk.form.load import getdoc
frappe.response.docs = []
getdoc("User", "Administrator")
doc = frappe.response.docs[0]
self.assertListEqual(
doc.get("__onload").get("all_modules", []),
[m.get("module_name") for m in get_modules_from_all_apps()],
)
def test_reset_password_link_expiry(self):
new_password = "new_password"
# set the reset password expiry to 1 second
frappe.db.set_value(
"System Settings", "System Settings", "reset_password_link_expiry_duration", 1
)
frappe.set_user("testpassword@example.com")
test_user = frappe.get_doc("User", "testpassword@example.com")
test_user.reset_password()
time.sleep(1) # sleep for 1 sec to expire the reset link
self.assertEqual(
update_password(new_password, key=test_user.reset_password_key),
"The reset password link has been expired",
)
def delete_contact(user):
frappe.db.delete("Contact", {"email_id": user})
frappe.db.delete("Contact Email", {"email_id": user})