Add a test for the syn2mas SynapseReader

Author: reivilibre

crates/syn2mas/src/synapse_reader/fixtures/user_alice.sql

@@ -0,0 +1,40 @@
+-- 
+INSERT INTO users
+  (
+    name,
+    password_hash,
+    creation_ts,
+    admin,
+    upgrade_ts,
+    is_guest,
+    appservice_id,
+    consent_version,
+    consent_server_notice_sent,
+    user_type,
+    deactivated,
+    shadow_banned,
+    consent_ts,
+    approved,
+    locked,
+    suspended
+  )
+  VALUES
+  (
+    '@alice:example.com',
+    '$2b$12$aaa/aaaaaaaaaa.aaaaaaaaaaaaaaa./aaaaaaaaaaaaaaaaaaa/A',
+    1530393962,
+    0,
+    NULL,
+    0,
+    NULL,
+    '1.0',
+    '1.0',
+    NULL,
+    0,
+    NULL,
+    NULL,
+    NULL,
+    false,
+    false
+  );
+

crates/syn2mas/src/synapse_reader.rs renamed to crates/syn2mas/src/synapse_reader/mod.rs

@@ -26,7 +26,7 @@ pub enum Error {
     },
 }
 
-#[derive(Clone, Debug, sqlx::Decode)]
+#[derive(Clone, Debug, sqlx::Decode, PartialEq, Eq, PartialOrd, Ord)]
 pub struct FullUserId(pub String);
 
 impl Type<Postgres> for FullUserId {
@@ -82,7 +82,7 @@ impl FullUserId {
 /// A Synapse boolean.
 /// Synapse stores booleans as 0 or 1, due to compatibility with old SQLite versions
 /// that did not have native boolean support.
-#[derive(Copy, Clone, Debug)]
+#[derive(Copy, Clone, Debug, PartialEq, Eq, PartialOrd, Ord)]
 pub struct SynapseBool(bool);
 
 impl<'r> sqlx::Decode<'r, Postgres> for SynapseBool {
@@ -109,7 +109,7 @@ impl From<SynapseBool> for bool {
 /// A timestamp stored as the number of seconds since the Unix epoch.
 /// Note that Synapse stores MOST timestamps as numbers of **milliseconds** since the Unix epoch.
 /// But some timestamps are still stored in seconds.
-#[derive(Copy, Clone, Debug)]
+#[derive(Copy, Clone, Debug, PartialEq, Eq, PartialOrd, Ord)]
 pub struct SecondsTimestamp(DateTime<Utc>);
 
 impl From<SecondsTimestamp> for DateTime<Utc> {
@@ -136,7 +136,7 @@ impl sqlx::Type<Postgres> for SecondsTimestamp {
     }
 }
 
-#[derive(Clone, Debug, FromRow)]
+#[derive(Clone, Debug, FromRow, PartialEq, Eq, PartialOrd, Ord)]
 pub struct SynapseUser {
     /// Full User ID of the user
     pub name: FullUserId,
@@ -264,5 +264,30 @@ impl<'conn> SynapseReader<'conn> {
 
 #[cfg(test)]
 mod test {
+    use std::collections::BTreeSet;
+
+    use futures_util::TryStreamExt;
+    use insta::assert_debug_snapshot;
+    use sqlx::{migrate::Migrator, PgPool};
+
+    use crate::{synapse_reader::SynapseUser, SynapseReader};
+
     // TODO test me
+    static MIGRATOR: Migrator = sqlx::migrate!("./test_synapse_migrations");
+
+    #[sqlx::test(migrator = "MIGRATOR", fixtures("user_alice"))]
+    async fn test_read_users(pool: PgPool) {
+        let mut conn = pool.acquire().await.expect("failed to get connection");
+        let mut reader = SynapseReader::new(&mut conn, false)
+            .await
+            .expect("failed to make SynapseReader");
+
+        let users: BTreeSet<SynapseUser> = reader
+            .read_users()
+            .try_collect()
+            .await
+            .expect("failed to read Synapse users");
+
+        assert_debug_snapshot!(users);
+    }
 }

crates/syn2mas/src/synapse_reader/snapshots/syn2mas__synapse_reader__test__read_users.snap

@@ -0,0 +1,23 @@
+---
+source: crates/syn2mas/src/synapse_reader/mod.rs
+expression: users
+---
+{
+    SynapseUser {
+        name: FullUserId(
+            "@alice:example.com",
+        ),
+        password_hash: Some(
+            "$2b$12$aaa/aaaaaaaaaa.aaaaaaaaaaaaaaa./aaaaaaaaaaaaaaaaaaa/A",
+        ),
+        admin: SynapseBool(
+            false,
+        ),
+        deactivated: SynapseBool(
+            false,
+        ),
+        creation_ts: SecondsTimestamp(
+            2018-06-30T21:26:02Z,
+        ),
+    },
+}

crates/syn2mas/test_synapse_migrations/20250117064958_users.sql

@@ -0,0 +1,26 @@
+-- Copyright 2025 New Vector Ltd.
+--
+-- SPDX-License-Identifier: AGPL-3.0-only
+-- Please see LICENSE in the repository root for full details.
+
+-- Brings in the `users` table from Synapse
+
+CREATE TABLE users (
+    name text,
+    password_hash text,
+    creation_ts bigint,
+    admin smallint DEFAULT 0 NOT NULL,
+    upgrade_ts bigint,
+    is_guest smallint DEFAULT 0 NOT NULL,
+    appservice_id text,
+    consent_version text,
+    consent_server_notice_sent text,
+    user_type text,
+    deactivated smallint DEFAULT 0 NOT NULL,
+    shadow_banned boolean,
+    consent_ts bigint,
+    approved boolean,
+    locked boolean DEFAULT false NOT NULL,
+    suspended boolean DEFAULT false NOT NULL
+);
+