tests: Add set_user_role helper method to ZulipTestCase. #37000
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
timabbott
reviewed
Dec 11, 2025
corporate/tests/test_stripe.py
Outdated
| do_change_user_role(hamlet, UserProfile.ROLE_REALM_OWNER, acting_user=None) | ||
| do_change_user_role(iago, UserProfile.ROLE_REALM_OWNER, acting_user=None) | ||
| self.set_user_role(hamlet, UserProfile.ROLE_REALM_OWNER, acting_user=None) | ||
| self.set_user_role(iago, UserProfile.ROLE_REALM_OWNER, acting_user=None) |
Member
There was a problem hiding this comment.
The intent was for this new test helper to have acting_user=None be the default, so all these tests don't need to spell that out either.
0xthedance
force-pushed
the
test_helper_change_role
branch
from
7697d6d to
abac33f
Compare
Member
|
@0xthedance just a small note: You should always post a comment explaining how you addressed the feedback on GitHub PR threads; that can help a lot with explicit handoffs and results in faster review. |
timabbott
reviewed
Dec 12, 2025
zerver/tests/test_example.py
Outdated
| # It is a good idea for your tests to clearly demonstrate a | ||
| # **change** to a value. So here we want to make sure that | ||
| # do_change_user_role will change Hamlet such that | ||
| # self.set_user_role will change Hamlet such that |
Member
There was a problem hiding this comment.
This looks to be incorrectly changed.
Member
|
Looks great, merging with these changes: diff --git a/zerver/lib/test_classes.py b/zerver/lib/test_classes.py
index 64af88a707..cef674a94f 100644
--- a/zerver/lib/test_classes.py
+++ b/zerver/lib/test_classes.py
@@ -2369,6 +2369,16 @@ class ZulipTestCase(ZulipTestCaseMixin, TestCase):
)
def set_user_role(self, user: UserProfile, role: int) -> None:
+ """
+ Test helper for switching a user to a given role. Hardcodes
+ acting_user=None, which means the change is treated as
+ though it was done by a management command, not another
+ user.
+
+ Tests using this should consider using users who have the
+ appropriate initial role; this is usually more readable and
+ a bit faster.
+ """
do_change_user_role(user, role, acting_user=None)
diff --git a/zerver/tests/test_example.py b/zerver/tests/test_example.py
index b19d03dd6e..f74b5d892f 100644
--- a/zerver/tests/test_example.py
+++ b/zerver/tests/test_example.py
@@ -60,7 +60,7 @@ class TestBasicUserStuff(ZulipTestCase):
# It is a good idea for your tests to clearly demonstrate a
# **change** to a value. So here we want to make sure that
- # self.set_user_role will change Hamlet such that
+ # do_change_user_role will change Hamlet such that
# is_administrator_role becomes True, but we first assert it's
# False.
self.assertFalse(is_administrator_role(hamlet.role)) |
This commit adds a set_user_role helper method to ZulipTestCase with acting_user defaulting to None, and updates all test files to use this helper. This is a prep commit for PR zulip#36208.
timabbott
force-pushed
the
test_helper_change_role
branch
from
abac33f to
1b82537
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This adds a helper method that wraps
do_change_user_rolefor use in tests. This is a preparatory commit for PR #36208.In PR #36208, a variable
notifyis added todo_change_user_role. This PR will make it easy to update all the tests withnotify=False.Updates all existing test files to use the new helper method instead of calling
do_change_user_roledirectly.Self-review checklist
(variable names, code reuse, readability, etc.).
Communicate decisions, questions, and potential concerns.
Individual commits are ready for review (see commit discipline).
Completed manual review and testing of the following: