Check that Zulip user groups are properly synced

Author: rylev

src/check_synced.rs

@@ -2,12 +2,81 @@
 
 use crate::data::Data;
 use crate::github::{self, GitHubApi};
-use crate::schema;
+use crate::schema::{self, ZulipGroupMember};
+use crate::zulip::ZulipApi;
 use log::{error, warn};
 use rayon::prelude::*;
-use std::collections::HashMap;
+use std::collections::{HashMap, HashSet};
 
 pub(crate) fn check(data: &Data) -> Result<(), failure::Error> {
+    check_github(data)?;
+    check_zulip(data)?;
+    Ok(())
+}
+
+fn check_zulip(data: &Data) -> Result<(), failure::Error> {
+    let zulip = ZulipApi::new();
+    zulip.require_auth()?;
+    let mut remote_groups = zulip
+        .get_user_groups()?
+        .into_iter()
+        .filter(|g| !g.is_system_group)
+        .map(|g| (g.name.clone(), g))
+        .collect::<HashMap<_, _>>();
+    let users = zulip
+        .get_users()?
+        .into_iter()
+        .map(|u| (u.email, u.user_id))
+        .collect::<HashMap<_, _>>();
+    let mut checked = HashSet::new();
+    for (_, local_group) in &data.zulip_groups()? {
+        match remote_groups.remove(local_group.name()) {
+            Some(rg) => {
+                for local_member in local_group.members() {
+                    if checked.contains(local_member) {
+                        continue;
+                    }
+
+                    let i = match local_member {
+                        ZulipGroupMember::Id(i) => *i,
+                        ZulipGroupMember::Email(e) => match users.get(e) {
+                            Some(i) => *i,
+                            None => {
+                                error!("User email '{e}' is not on Zulip");
+                                continue;
+                            }
+                        },
+                        ZulipGroupMember::Missing => {
+                            error!("Member of Zulip user group '{}' does not have an email or Zulip id", local_group.name());
+                            continue;
+                        }
+                    };
+                    checked.insert(local_member);
+                    if !rg.members.contains(&i) {
+                        error!(
+                            "Zulip user '{:?}' is not on the remote Zulip user group",
+                            local_member
+                        )
+                    }
+                }
+            }
+            None => error!(
+                "User group '{}' is in the team repo but not on Zulip",
+                local_group.name()
+            ),
+        }
+    }
+
+    for (_, remote_group) in remote_groups {
+        error!(
+            "Zulip group '{}' is on Zulip but not in team repo",
+            remote_group.name
+        )
+    }
+    Ok(())
+}
+
+pub(crate) fn check_github(data: &Data) -> Result<(), failure::Error> {
     const BOT_TEAMS: &[&str] = &["bors", "bots", "rfcbot", "highfive"];
     let github = GitHubApi::new();
     let pending_invites = github.pending_org_invites()?;

src/schema.rs

@@ -619,7 +619,7 @@ impl ZulipGroup {
     }
 }
 
-#[derive(Debug, Clone, Ord, PartialOrd, Eq, PartialEq)]
+#[derive(Debug, Clone, Ord, PartialOrd, Eq, PartialEq, Hash)]
 pub(crate) enum ZulipGroupMember {
     Id(usize),
     Email(String),

src/zulip.rs

@@ -56,6 +56,17 @@ impl ZulipApi {
         Ok(response)
     }
 
+    /// Get all user groups of the Rust Zulip instance
+    pub(crate) fn get_user_groups(&self) -> Result<Vec<ZulipUserGroup>, Error> {
+        let response = self
+            .req(Method::GET, "/user_groups", None)?
+            .error_for_status()?
+            .json::<ZulipUserGroups>()?
+            .user_groups;
+
+        Ok(response)
+    }
+
     /// Perform a request against the Zulip API
     fn req(
         &self,
@@ -91,3 +102,17 @@ pub(crate) struct ZulipUser {
     pub(crate) email: String,
     pub(crate) user_id: usize,
 }
+
+/// A collection of Zulip user groups
+#[derive(Deserialize)]
+struct ZulipUserGroups {
+    user_groups: Vec<ZulipUserGroup>,
+}
+
+/// A single Zulip user group
+#[derive(Deserialize)]
+pub(crate) struct ZulipUserGroup {
+    pub(crate) name: String,
+    pub(crate) members: Vec<usize>,
+    pub(crate) is_system_group: bool,
+}