Merge pull request #1696 from Kobzol/codeowners

Add CODEOWNERS

Author: marcoieni

.github/CODEOWNERS

@@ -0,0 +1,19 @@
+# This is an automatically generated file
+# Run `cargo run ci generate-codeowners` to regenerate it.
+
+/.github/ @Mark-Simulacrum @pietroalbini @jdno @marcoieni
+/src/ @Mark-Simulacrum @pietroalbini @jdno @marcoieni
+/rust_team_data/ @Mark-Simulacrum @pietroalbini @jdno @marcoieni
+/repos/rust-lang/team.toml @Mark-Simulacrum @pietroalbini @jdno @marcoieni
+/repos/rust-lang/sync-team.toml @Mark-Simulacrum @pietroalbini @jdno @marcoieni
+/teams/infra-admins.toml @Mark-Simulacrum @pietroalbini @jdno @marcoieni
+/teams/team-repo-admins.toml @Mark-Simulacrum @pietroalbini @jdno @marcoieni
+.cargo @Mark-Simulacrum @pietroalbini @jdno @marcoieni
+target @Mark-Simulacrum @pietroalbini @jdno @marcoieni
+Cargo.lock @Mark-Simulacrum @pietroalbini @jdno @marcoieni
+Cargo.toml @Mark-Simulacrum @pietroalbini @jdno @marcoieni
+config.toml @Mark-Simulacrum @pietroalbini @jdno @marcoieni
+/people/Mark-Simulacrum.toml @Mark-Simulacrum @pietroalbini @jdno @marcoieni
+/people/pietroalbini.toml @Mark-Simulacrum @pietroalbini @jdno @marcoieni
+/people/jdno.toml @Mark-Simulacrum @pietroalbini @jdno @marcoieni
+/people/marcoieni.toml @Mark-Simulacrum @pietroalbini @jdno @marcoieni

.github/workflows/main.yml

@@ -38,6 +38,9 @@ jobs:
       - name: Run tests
         run: cargo test --workspace --all-features
 
+      - name: Check CODEOWNERS
+        run: cargo run ci check-codeowners
+
       - name: Build the contents of the static API
         run: |
           cargo run -- static-api build

src/ci.rs

@@ -0,0 +1,91 @@
+use crate::schema::Team;
+use anyhow::Context;
+use std::path::{Path, PathBuf};
+
+/// Generates the contents of `.github/CODEOWNERS`, based on
+/// the infra admins in `infra-admins.toml`.
+pub fn generate_codeowners_file() -> anyhow::Result<()> {
+    let admins = load_infra_admins()?;
+    let codeowners_content = generate_codeowners_content(admins);
+    std::fs::write(codeowners_path(), codeowners_content).context("cannot write CODEOWNERS")?;
+    Ok(())
+}
+
+/// Check if `.github/CODEOWNERS` are up-to-date, based on the
+/// `infra-admins.toml` file.
+pub fn check_codeowners() -> anyhow::Result<()> {
+    let admins = load_infra_admins()?;
+    let expected_codeowners = generate_codeowners_content(admins);
+    let actual_codeowners =
+        std::fs::read_to_string(codeowners_path()).context("cannot read CODEOWNERS")?;
+    if expected_codeowners != actual_codeowners {
+        return Err(anyhow::anyhow!("CODEOWNERS content is not up-to-date. Regenerate it using `cargo run ci generate-codeowners`."));
+    }
+
+    Ok(())
+}
+
+fn generate_codeowners_content(admins: Vec<String>) -> String {
+    use std::fmt::Write;
+
+    let mut output = String::new();
+    writeln!(
+        output,
+        r#"# This is an automatically generated file
+# Run `cargo run ci generate-codeowners` to regenerate it.
+"#
+    )
+    .unwrap();
+
+    let admin_list = admins
+        .iter()
+        .map(|admin| format!("@{admin}"))
+        .collect::<Vec<_>>()
+        .join(" ");
+
+    // Set of paths that should only be modifiable by infra-admins
+    let mut secure_paths = vec![
+        "/.github/".to_string(),
+        "/src/".to_string(),
+        "/rust_team_data/".to_string(),
+        "/repos/rust-lang/team.toml".to_string(),
+        "/repos/rust-lang/sync-team.toml".to_string(),
+        "/teams/infra-admins.toml".to_string(),
+        "/teams/team-repo-admins.toml".to_string(),
+        ".cargo".to_string(),
+        "target".to_string(),
+        "Cargo.lock".to_string(),
+        "Cargo.toml".to_string(),
+        "config.toml".to_string(),
+    ];
+    for admin in admins {
+        secure_paths.push(format!("/people/{admin}.toml"));
+    }
+
+    for path in secure_paths {
+        writeln!(output, "{path} {admin_list}").unwrap();
+    }
+    output
+}
+
+fn codeowners_path() -> PathBuf {
+    Path::new(&env!("CARGO_MANIFEST_DIR"))
+        .join(".github")
+        .join("CODEOWNERS")
+}
+
+fn load_infra_admins() -> anyhow::Result<Vec<String>> {
+    let admins = std::fs::read_to_string(
+        Path::new(&env!("CARGO_MANIFEST_DIR"))
+            .join("teams")
+            .join("infra-admins.toml"),
+    )
+    .context("cannot load infra-admins.toml")?;
+    let team: Team = toml::from_str(&admins).context("cannot deserialize infra-admins")?;
+    Ok(team
+        .raw_people()
+        .members
+        .iter()
+        .map(|member| member.github.clone())
+        .collect())
+}

src/main.rs

@@ -3,6 +3,7 @@
 mod data;
 #[macro_use]
 mod permissions;
+mod ci;
 mod github;
 mod schema;
 mod static_api;
@@ -15,6 +16,7 @@ use data::Data;
 use schema::{Email, Team, TeamKind};
 use zulip::ZulipApi;
 
+use crate::ci::{check_codeowners, generate_codeowners_file};
 use crate::schema::RepoPermission;
 use anyhow::{bail, format_err, Error};
 use log::{error, info, warn};
@@ -111,6 +113,16 @@ enum Cli {
     EncryptEmail,
     #[structopt(name = "decrypt-email", help = "decrypt an email address")]
     DecryptEmail,
+    #[structopt(name = "ci", help = "CI scripts")]
+    Ci(CiOpts),
+}
+
+#[derive(structopt::StructOpt)]
+enum CiOpts {
+    #[structopt(help = "Generate the .github/CODEOWNERS file")]
+    GenerateCodeowners,
+    #[structopt(help = "Check if the .github/CODEOWNERS file is up-to-date")]
+    CheckCodeowners,
 }
 
 fn main() {
@@ -422,6 +434,10 @@ fn run() -> Result<(), Error> {
                 rust_team_data::email_encryption::try_decrypt(&key, &encrypted)?
             );
         }
+        Cli::Ci(opts) => match opts {
+            CiOpts::GenerateCodeowners => generate_codeowners_file()?,
+            CiOpts::CheckCodeowners => check_codeowners()?,
+        },
     }
 
     Ok(())