Migrate tests from trial to pytest + pytest-asyncio

Author: sandhose

.github/workflows/pipeline.yml

@@ -73,14 +73,31 @@ jobs:
     strategy:
       matrix:
         python-version: ['3.10', '3.13']
-        test-dir: ['tests', 'matrix_is_tester']
 
     steps:
       - uses: actions/checkout@v6
       - uses: astral-sh/setup-uv@v5
         with:
           python-version: ${{ matrix.python-version }}
-      - run: uv run trial ${{ matrix.test-dir }}
+      - run: uv run pytest tests/
+
+  # matrix_is_tester is a black-box integration test suite that launches
+  # Sydent as a subprocess and makes HTTP requests against it.
+  run-integration-tests:
+    name: Integration Tests
+    if: ${{ !cancelled() && !failure() }}
+    needs: [check-newsfile, checks]
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ['3.10', '3.13']
+
+    steps:
+      - uses: actions/checkout@v6
+      - uses: astral-sh/setup-uv@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+      - run: uv run pytest --pyargs matrix_is_tester
 
   # a job which runs once all the other jobs are complete, thus allowing PRs to
   # be merged.
@@ -90,6 +107,7 @@ jobs:
       - check-newsfile
       - checks
       - run-tests
+      - run-integration-tests
     runs-on: ubuntu-latest
     steps:
       - uses: matrix-org/done-action@v3

integration-tests/matrix_is_tester/is_api.py

@@ -182,7 +182,7 @@ def agree_to_terms(self, user_accepts):
         return resp.json()
 
     def get_versions(self):
-        resp = requests.get(self.base_url + "/versions")
+        resp = requests.get(self.base_url + "/_matrix/identity/versions")
         return resp.json()
 
     def register(self, matrix_server_name, access_token):

integration-tests/matrix_is_tester/mailsink.py

@@ -12,8 +12,8 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-import asyncio
 import atexit
+import threading
 from multiprocessing import Process, Queue
 
 from aiosmtpd.controller import Controller
@@ -55,23 +55,19 @@ def _run_mail_sink(q):
     handler = _MailSinkHandler(q)
     controller = Controller(handler, hostname="127.0.0.1", port=9925)
     controller.start()
-    # Block forever (the controller runs in a thread)
-    try:
-        asyncio.get_event_loop().run_forever()
-    except KeyboardInterrupt:
-        pass
-    finally:
-        controller.stop()
+    # Block until terminated
+    threading.Event().wait()
 
 
 class MailSink:
     def launch(self):
         self.queue = Queue()
         self.process = Process(target=_run_mail_sink, args=(self.queue,))
+        self.process.daemon = True
         self.process.start()
 
     def get_mail(self):
-        return self.queue.get(timeout=2.0)
+        return self.queue.get(timeout=5.0)
 
     def tearDown(self):
         self.process.terminate()

integration-tests/matrix_is_tester/test_versions.py

@@ -35,7 +35,7 @@ def test_versions(self):
         body = self.api.get_versions()
 
         self.assertIn("versions", body)
-        self.assertIn(["v1.1"], body["versions"])
+        self.assertIn("v1.1", body["versions"])
 
 
 if __name__ == "__main__":

sydent/http/servlets/__init__.py

@@ -88,7 +88,7 @@ async def get_args(
             body = await request.read()
             request_args = json_decoder.decode(body.decode("UTF-8"))
         except ValueError:
-            raise MatrixRestError(400, "M_BAD_JSON", "Malformed JSON")
+            raise MatrixRestError(400, "M_BAD_JSON", "Malformed JSON") from None
 
     # If we didn't get anything from that, and it's a v1 api path, try the request args
     if request_args is None and (v1_path or request.method == "GET"):

sydent/http/servlets/blindlysignstuffservlet.py

@@ -52,6 +52,6 @@ async def handle_blindly_sign_stuff_post(
         signed = signedjson.sign.sign_json(to_sign, server_name, private_key)
     except Exception:
         logger.exception("signing failed")
-        raise MatrixRestError(500, "M_UNKNOWN", "Internal Server Error")
+        raise MatrixRestError(500, "M_UNKNOWN", "Internal Server Error") from None
 
     return json_response(signed)

sydent/http/servlets/replication.py

@@ -85,7 +85,7 @@ async def handle_replication_push_post(request: web.Request) -> web.Response:
         logger.warning(
             "Peer %s made push connection with malformed JSON", peer.servername
         )
-        raise MatrixRestError(400, "M_BAD_JSON", "Malformed JSON")
+        raise MatrixRestError(400, "M_BAD_JSON", "Malformed JSON") from None
 
     if "sgAssocs" not in inJson:
         logger.warning(

sydent/http/servlets/threepidbindservlet.py

@@ -57,19 +57,19 @@ async def handle_threepid_bind_post(
             404,
             "M_NO_VALID_SESSION",
             "No valid session was found matching that sid and client secret",
-        )
+        ) from None
     except SessionExpiredException:
         raise MatrixRestError(
             400,
             "M_SESSION_EXPIRED",
             "This validation session has expired: call requestToken again",
-        )
+        ) from None
     except SessionNotValidatedException:
         raise MatrixRestError(
             400,
             "M_SESSION_NOT_VALIDATED",
             "This validation session has not yet been completed",
-        )
+        ) from None
 
     res = sydent.threepidBinder.addBinding(s.medium, s.address, mxid)
     return json_response(res)

sydent/replication/peer.py

@@ -144,7 +144,7 @@ def __init__(
         if replication_url is None:
             if not port:
                 port = 1001
-            replication_url = "https://%s:%i" % (server_name, port)
+            replication_url = f"https://{server_name}:{port}"
 
         if replication_url[-1:] != "/":
             replication_url += "/"
@@ -176,7 +176,7 @@ def __init__(
             except Exception as e:
                 raise ConfigError(
                     f"Unable to decode public key for peer {server_name}: {e}",
-                )
+                ) from e
 
         self.verify_key = signedjson.key.decode_verify_key_bytes(
             SIGNING_KEY_ALGORITHM + ":", pubkey_decoded
@@ -236,9 +236,8 @@ async def pushUpdates(self, sgAssocs: SignedAssociations) -> aiohttp.ClientRespo
             raise RemotePeerError(errObj)
         except (ValueError, UnicodeDecodeError):
             raise Exception(
-                "Push to %s failed with status %d"
-                % (self.replication_url, response.status)
-            )
+                f"Push to {self.replication_url} failed with status {response.status}"
+            ) from None
 
 
 class NoSignaturesException(Exception):

sydent/sms/openmarket.py

@@ -108,21 +108,12 @@ async def sendTextSMS(
         if resp.status < 200 or resp.status >= 300:
             if response_body is None or "error" not in response_body:
                 raise Exception(
-                    "OpenMarket API responded with status %d (request ID: %s)"
-                    % (
-                        resp.status,
-                        request_id,
-                    ),
+                    f"OpenMarket API responded with status {resp.status} (request ID: {request_id})",
                 )
 
             error = response_body["error"]
             raise Exception(
-                "OpenMarket API responded with status %d (request ID: %s): %s"
-                % (
-                    resp.status,
-                    request_id,
-                    error,
-                ),
+                f"OpenMarket API responded with status {resp.status} (request ID: {request_id}): {error}",
             )
 
         ticket_id = None