Merge pull request #1988 from Kobzol/deterministic-static-api

Make the output of the static API deterministic

Author: pietroalbini

Cargo.lock

@@ -29,6 +29,7 @@ atty.workspace = true
 difference.workspace = true
 duct.workspace = true
 walkdir.workspace = true
+dir-diff = "0.3"
 
 [workspace]
 members = [

Cargo.toml

@@ -4,7 +4,7 @@ use anyhow::{ensure, Context as _, Error};
 use indexmap::IndexMap;
 use log::info;
 use rust_team_data::v1;
-use rust_team_data::v1::BranchProtectionMode;
+use rust_team_data::v1::{BranchProtectionMode, RepoMember};
 use std::collections::HashMap;
 use std::path::Path;
 
@@ -121,25 +121,30 @@ impl<'a> Generator<'a> {
                             }
                         }
                     }
+                    teams.sort_by_key(|t| t.name.clone());
                     teams
                 },
-                members: r
-                    .access
-                    .individuals
-                    .iter()
-                    .map(|(name, permission)| {
-                        let permission = match permission {
-                            RepoPermission::Admin => v1::RepoPermission::Admin,
-                            RepoPermission::Write => v1::RepoPermission::Write,
-                            RepoPermission::Maintain => v1::RepoPermission::Maintain,
-                            RepoPermission::Triage => v1::RepoPermission::Triage,
-                        };
-                        v1::RepoMember {
-                            name: name.clone(),
-                            permission,
-                        }
-                    })
-                    .collect(),
+                members: {
+                    let mut members: Vec<RepoMember> = r
+                        .access
+                        .individuals
+                        .iter()
+                        .map(|(name, permission)| {
+                            let permission = match permission {
+                                RepoPermission::Admin => v1::RepoPermission::Admin,
+                                RepoPermission::Write => v1::RepoPermission::Write,
+                                RepoPermission::Maintain => v1::RepoPermission::Maintain,
+                                RepoPermission::Triage => v1::RepoPermission::Triage,
+                            };
+                            v1::RepoMember {
+                                name: name.clone(),
+                                permission,
+                            }
+                        })
+                        .collect();
+                    members.sort_by_key(|m| m.name.clone());
+                    members
+                },
                 branch_protections,
                 archived,
                 auto_merge_enabled: !managed_by_bors,
@@ -204,7 +209,8 @@ impl<'a> Generator<'a> {
             let mut github_teams = team.github_teams(self.data)?;
             github_teams.sort();
 
-            let member_discord_ids = team.discord_ids(self.data)?;
+            let mut member_discord_ids = team.discord_ids(self.data)?;
+            member_discord_ids.sort();
 
             let team_data = v1::Team {
                 name: team.name().into(),

src/static_api.rs

@@ -77,6 +77,24 @@ fn static_api() -> Result<(), Error> {
     Ok(())
 }
 
+#[test]
+fn static_api_determinism() -> Result<(), Error> {
+    // Ensure that the output of `static-api` is deterministic
+    let dir = tempfile::TempDir::new()?;
+    let reference_dir = dir.path().join("reference");
+    cmd!(bin(), "static-api", &reference_dir).assert_success()?;
+
+    for i in 0..10 {
+        let out = dir.path().join(format!("output-{i}"));
+        cmd!(bin(), "static-api", &out).assert_success()?;
+        assert!(
+            !dir_diff::is_different(&reference_dir, &out)?,
+            "static-api produced non-deterministic output"
+        );
+    }
+    Ok(())
+}
+
 fn bin() -> &'static str {
     env!("CARGO_BIN_EXE_rust-team")
 }