Check teams names are valid (#186)

Signed-off-by: Sergio Castaño Arteaga <[email protected]>
cncf · Apr 11, 2024 · 3cfb81b · 3cfb81b
1 parent f61dccc
commit 3cfb81b
Show file tree

Hide file tree

Showing 2 changed files with 27 additions and 0 deletions.
diff --git a/clowarden-core/src/directory/legacy.rs b/clowarden-core/src/directory/legacy.rs
@@ -8,8 +8,15 @@ use crate::{
     multierror::MultiError,
 };
 use anyhow::Result;
+use lazy_static::lazy_static;
+use regex::Regex;
 use serde::{Deserialize, Serialize};
 
+lazy_static! {
+    pub(crate) static ref VALID_TEAM_NAME: Regex =
+        Regex::new(r"^[a-z0-9\-]+$").expect("expr in VALID_TEAM_NAME to be valid");
+}
+
 /// Legacy configuration.
 #[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
 pub(crate) struct Cfg {
@@ -51,6 +58,7 @@ impl Cfg {
 }
 
 pub mod sheriff {
+    use super::VALID_TEAM_NAME;
     use crate::{
         directory::{TeamName, UserName},
         github::{DynGH, Source},
@@ -149,6 +157,13 @@ pub mod sheriff {
                     merr.push(format_err!("team[{id}: name must be provided"));
                 }
 
+                // Name must be valid
+                if !VALID_TEAM_NAME.is_match(&team.name) {
+                    merr.push(format_err!(
+                        "team[{id}]: name must be lowercase alphanumeric with dashes (team slug)"
+                    ));
+                }
+
                 // No duplicate config per team
                 if !team.name.is_empty() {
                     if teams_seen.contains(&&team.name) {

diff --git a/clowarden-core/src/services/github/legacy.rs b/clowarden-core/src/services/github/legacy.rs
@@ -4,6 +4,7 @@
 
 pub(crate) mod sheriff {
     use crate::{
+        directory::legacy::VALID_TEAM_NAME,
         github::{DynGH, Source},
         multierror::MultiError,
         services::github::state::Repository,
@@ -61,6 +62,17 @@ pub(crate) mod sheriff {
                     }
                     repos_seen.push(&repo.name);
                 }
+
+                // Teams names must be valid
+                if let Some(teams) = &repo.teams {
+                    for team_name in teams.keys() {
+                        if !VALID_TEAM_NAME.is_match(team_name) {
+                            merr.push(format_err!(
+                                "repo[{id}]: team[{team_name}] name must be lowercase alphanumeric with dashes (team slug)",
+                            ));
+                        }
+                    }
+                }
             }
 
             if merr.contains_errors() {