# # This file is licensed under the Affero General Public License (AGPL) version 3. # # Copyright (C) 2023 New Vector, Ltd # # This program is free software: you can redistribute it and/or modify # it under the terms of the GNU Affero General Public License as # published by the Free Software Foundation, either version 3 of the # License, or (at your option) any later version. # # See the GNU Affero General Public License for more details: # . # # Originally licensed under the Apache License, Version 2.0: # . # # [This file includes modifications made by New Vector Limited] # # from typing import List, Optional from unittest.mock import Mock, patch from synapse._scripts.register_new_matrix_user import request_registration from synapse.types import JsonDict from tests.unittest import TestCase class RegisterTestCase(TestCase): def test_success(self) -> None: """ The script will fetch a nonce, and then generate a MAC with it, and then post that MAC. """ def get(url: str, verify: Optional[bool] = None) -> Mock: r = Mock() r.status_code = 200 r.json = lambda: {"nonce": "a"} return r def post( url: str, json: Optional[JsonDict] = None, verify: Optional[bool] = None ) -> Mock: # Make sure we are sent the correct info assert json is not None self.assertEqual(json["username"], "user") self.assertEqual(json["password"], "pass") self.assertEqual(json["nonce"], "a") # We want a 40-char hex MAC self.assertEqual(len(json["mac"]), 40) r = Mock() r.status_code = 200 return r requests = Mock() requests.get = get requests.post = post # The fake stdout will be written here out: List[str] = [] err_code: List[int] = [] with patch("synapse._scripts.register_new_matrix_user.requests", requests): request_registration( "user", "pass", "matrix.org", "shared", admin=False, _print=out.append, exit=err_code.append, ) # We should get the success message making sure everything is OK. self.assertIn("Success!", out) # sys.exit shouldn't have been called. self.assertEqual(err_code, []) def test_failure_nonce(self) -> None: """ If the script fails to fetch a nonce, it throws an error and quits. """ def get(url: str, verify: Optional[bool] = None) -> Mock: r = Mock() r.status_code = 404 r.reason = "Not Found" r.json = lambda: {"not": "error"} return r requests = Mock() requests.get = get # The fake stdout will be written here out: List[str] = [] err_code: List[int] = [] with patch("synapse._scripts.register_new_matrix_user.requests", requests): request_registration( "user", "pass", "matrix.org", "shared", admin=False, _print=out.append, exit=err_code.append, ) # Exit was called self.assertEqual(err_code, [1]) # We got an error message self.assertIn("ERROR! Received 404 Not Found", out) self.assertNotIn("Success!", out) def test_failure_post(self) -> None: """ The script will fetch a nonce, and then if the final POST fails, will report an error and quit. """ def get(url: str, verify: Optional[bool] = None) -> Mock: r = Mock() r.status_code = 200 r.json = lambda: {"nonce": "a"} return r def post( url: str, json: Optional[JsonDict] = None, verify: Optional[bool] = None ) -> Mock: # Make sure we are sent the correct info assert json is not None self.assertEqual(json["username"], "user") self.assertEqual(json["password"], "pass") self.assertEqual(json["nonce"], "a") # We want a 40-char hex MAC self.assertEqual(len(json["mac"]), 40) r = Mock() # Then 500 because we're jerks r.status_code = 500 r.reason = "Broken" return r requests = Mock() requests.get = get requests.post = post # The fake stdout will be written here out: List[str] = [] err_code: List[int] = [] with patch("synapse._scripts.register_new_matrix_user.requests", requests): request_registration( "user", "pass", "matrix.org", "shared", admin=False, _print=out.append, exit=err_code.append, ) # Exit was called self.assertEqual(err_code, [1]) # We got an error message self.assertIn("ERROR! Received 500 Broken", out) self.assertNotIn("Success!", out)