test: adjust testing for deactivation to compensate for new behavior

And refactor a test helper that was mostly duplicated code

Author: jason-famedly

tests/rest/client/test_account.py

@@ -31,7 +31,7 @@
 
 import synapse.rest.admin
 from synapse.api.constants import LoginType, Membership
-from synapse.api.errors import Codes, HttpResponseException
+from synapse.api.errors import Codes, HttpResponseException, SynapseError
 from synapse.appservice import ApplicationService
 from synapse.rest import admin
 from synapse.rest.client import account, login, register, room
@@ -515,20 +515,24 @@ def test_deactivate_erase_account(self) -> None:
                 user_id, create_requester(user_id), "http://test/Kermit.jpg"
             )
         )
-        self.erase(mxid, tok)
+        self.deactivate(mxid, tok, erase=True)
 
         store = self.hs.get_datastores().main
 
         # Check that the user has been marked as deactivated.
         self.assertTrue(self.get_success(store.get_user_deactivated_status(mxid)))
 
-        # On deactivation with 'erase', a displayname and avatar_url are set to an empty
-        # string through the handler, but are turned into `None` for the database
-        display_name = self.get_success(profile_handler.get_displayname(user_id))
-        assert display_name is None, f"{display_name}"
+        # On deactivation with 'erase', the entire database row is erased. Both of these
+        # should raise a 404(Not Found) SynapseError
+        display_name_failure = self.get_failure(
+            profile_handler.get_displayname(user_id), SynapseError
+        )
+        assert display_name_failure.value.code == HTTPStatus.NOT_FOUND
 
-        avatar_url = self.get_success(profile_handler.get_avatar_url(user_id))
-        assert avatar_url is None, f"{avatar_url}"
+        avatar_url_failure = self.get_failure(
+            profile_handler.get_avatar_url(user_id), SynapseError
+        )
+        assert avatar_url_failure.value.code == HTTPStatus.NOT_FOUND
 
         # Check that this access token has been invalidated.
         channel = self.make_request("GET", "account/whoami", access_token=tok)
@@ -558,18 +562,22 @@ def test_deactivate_erase_account_with_disabled_profile_changes(self) -> None:
         )
 
         # self.get_success(profile_handler.set_displayname(user_id, create_requester(user_id), ))
-        self.erase(mxid, tok)
+        self.deactivate(mxid, tok, erase=True)
 
         # Check that the user has been marked as deactivated.
         self.assertTrue(self.get_success(store.get_user_deactivated_status(mxid)))
 
-        # On deactivation with 'erase', a displayname and avatar_url are set to an empty
-        # string through the handler, but are turned into `None` for the database
-        display_name = self.get_success(profile_handler.get_displayname(user_id))
-        assert display_name is None, f"{display_name}"
+        # On deactivation with 'erase', the entire database row is erased. Both of these
+        # should raise a 404(Not Found) SynapseError
+        display_name_failure = self.get_failure(
+            profile_handler.get_displayname(user_id), SynapseError
+        )
+        assert display_name_failure.value.code == HTTPStatus.NOT_FOUND
 
-        avatar_url = self.get_success(profile_handler.get_avatar_url(user_id))
-        assert avatar_url is None, f"{avatar_url}"
+        avatar_url_failure = self.get_failure(
+            profile_handler.get_avatar_url(user_id), SynapseError
+        )
+        assert avatar_url_failure.value.code == HTTPStatus.NOT_FOUND
 
         # Check that this access token has been invalidated.
         channel = self.make_request("GET", "account/whoami", access_token=tok)
@@ -773,28 +781,14 @@ def test_background_update_deletes_deactivated_users_server_side_backup_keys(
         )
         self.assertEqual(len(res2), 4)
 
-    def deactivate(self, user_id: str, tok: str) -> None:
-        request_data = {
-            "auth": {
-                "type": "m.login.password",
-                "user": user_id,
-                "password": "test",
-            },
-            "erase": False,
-        }
-        channel = self.make_request(
-            "POST", "account/deactivate", request_data, access_token=tok
-        )
-        self.assertEqual(channel.code, 200, channel.json_body)
-
-    def erase(self, user_id: str, tok: str) -> None:
+    def deactivate(self, user_id: str, tok: str, erase: bool = False) -> None:
         request_data = {
             "auth": {
                 "type": "m.login.password",
                 "user": user_id,
                 "password": "test",
             },
-            "erase": True,
+            "erase": erase,
         }
         channel = self.make_request(
             "POST", "account/deactivate", request_data, access_token=tok