FIXME: partially functional improvements

- need to fix CLI formatting

Author: jackboberg

src/main.rs

@@ -139,7 +139,11 @@ fn cli() -> Result<(), Error> {
             }
         }
         Command::ForTeam { name } => {
-            println!("Team: {name}")
+            let team_ownership = ownership.for_team(&name);
+            match team_ownership {
+                Ok(output) => println!("{:?}", output),
+                Err(err) => eprintln!("{}", err),
+            }
         }
     }
 

src/ownership.rs

@@ -32,6 +32,12 @@ pub struct FileOwner {
     pub sources: Vec<Source>,
 }
 
+#[derive(Debug, Default, Clone, PartialEq)]
+pub struct TeamOwnership {
+    pub heading: String,
+    pub globs: Vec<String>,
+}
+
 impl Display for FileOwner {
     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
         let sources = self
@@ -121,6 +127,14 @@ impl Ownership {
             .collect())
     }
 
+    #[instrument(level = "debug", skip_all)]
+    pub fn for_team(&self, team_name: &str) -> Result<Vec<TeamOwnership>, Box<dyn std::error::Error>> {
+        info!("getting team ownership for {}", team_name);
+        let team = self.project.get_team(team_name).ok_or("Team not found")?;
+
+        parse_for_team(team.github_team, &self.project.codeowners_file)
+    }
+
     #[instrument(level = "debug", skip_all)]
     pub fn generate_file(&self) -> String {
         info!("generating codeowners file");
@@ -141,9 +155,42 @@ impl Ownership {
     }
 }
 
+fn parse_for_team(team_name: String, codeowners_file: &str) -> Result<Vec<TeamOwnership>, Box<dyn std::error::Error>> {
+    let mut output = vec![];
+    let mut current_section = TeamOwnership::default();
+    let input: String = codeowners_file.replace(&FileGenerator::disclaimer().join("\n"), "");
+
+    for line in input.trim_start().lines() {
+        match line {
+            comment if comment.starts_with("#") => {
+                current_section.heading = comment.to_string();
+            }
+            "" => {
+                if current_section != TeamOwnership::default() {
+                    output.push(current_section.clone());
+                    current_section = TeamOwnership::default();
+                }
+            }
+            team_line if team_line.ends_with(&team_name) => {
+                let v: Vec<&str> = team_line.split(' ').collect();
+                let s = v.first().ok_or("malformed team line")?;
+
+                current_section.globs.push(s.to_string());
+            }
+            _ => {}
+        }
+    }
+    if current_section != TeamOwnership::default() {
+        output.push(current_section.clone());
+    }
+
+    Ok(output)
+}
+
 #[cfg(test)]
 mod tests {
-    use crate::common_test::tests::build_ownership_with_all_mappers;
+    use super::*;
+    use crate::common_test::tests::{build_ownership_with_all_mappers, vecs_match};
 
     #[test]
     fn test_for_file_owner() -> Result<(), Box<dyn std::error::Error>> {
@@ -162,4 +209,133 @@ mod tests {
         assert_eq!(file_owners.len(), 0);
         Ok(())
     }
+
+    #[test]
+    fn test_for_team_not_found() -> Result<(), Box<dyn std::error::Error>> {
+        let ownership = build_ownership_with_all_mappers()?;
+        let team_ownership = ownership.for_team("Nope");
+        assert!(team_ownership.is_err(), "Team not found");
+        Ok(())
+    }
+
+    #[test]
+    fn test_for_team() -> Result<(), Box<dyn std::error::Error>> {
+        let ownership = build_ownership_with_all_mappers()?;
+        let team_ownership = ownership.for_team("Bar");
+        assert!(team_ownership.is_ok());
+        Ok(())
+    }
+
+    #[test]
+    fn test_parse_for_team_trims_header() -> Result<(), Box<dyn std::error::Error>> {
+        let codeownership_file = r#"
+# STOP! - DO NOT EDIT THIS FILE MANUALLY
+# This file was automatically generated by "bin/codeownership validate".
+#
+# CODEOWNERS is used for GitHub to suggest code/file owners to various GitHub
+# teams. This is useful when developers create Pull Requests since the
+# code/file owner is notified. Reference GitHub docs for more details:
+# https://help.github.com/en/articles/about-code-owners
+
+
+"#;
+
+        let team_ownership = parse_for_team("@Bar".to_string(), &codeownership_file)?;
+        assert!(team_ownership.is_empty());
+        Ok(())
+    }
+
+    #[test]
+    fn test_parse_for_team_includes_owned_globs() -> Result<(), Box<dyn std::error::Error>> {
+        let codeownership_file = r#"
+# First Section
+/path/to/owned/**/* @Foo
+/path/to/not/owned/**/* @Bar
+
+# Last Section
+/another/owned/path @Foo
+"#;
+
+        let team_ownership = parse_for_team("@Foo".to_string(), &codeownership_file)?;
+        vecs_match(
+            &team_ownership,
+            &vec![
+                TeamOwnership {
+                    heading: "# First Section".to_string(),
+                    globs: vec!["/path/to/owned/**/*".to_string()],
+                },
+                TeamOwnership {
+                    heading: "# Last Section".to_string(),
+                    globs: vec!["/another/owned/path".to_string()],
+                },
+            ],
+        );
+        Ok(())
+    }
+
+    #[test]
+    fn test_parse_for_team_with_partial_team_match() -> Result<(), Box<dyn std::error::Error>> {
+        let codeownership_file = r#"
+# First Section
+/path/to/owned @Foo
+/path/to/not/owned @FooBar
+"#;
+
+        let team_ownership = parse_for_team("@Foo".to_string(), &codeownership_file)?;
+        vecs_match(
+            &team_ownership,
+            &vec![TeamOwnership {
+                heading: "# First Section".to_string(),
+                globs: vec!["/path/to/owned".to_string()],
+            }],
+        );
+        Ok(())
+    }
+
+    #[test]
+    fn test_parse_for_team_with_trailing_newlines() -> Result<(), Box<dyn std::error::Error>> {
+        let codeownership_file = r#"
+# First Section
+/path/to/owned @Foo
+
+# Last Section
+/another/owned/path @Foo
+
+
+
+"#;
+
+        let team_ownership = parse_for_team("@Foo".to_string(), &codeownership_file)?;
+        vecs_match(
+            &team_ownership,
+            &vec![
+                TeamOwnership {
+                    heading: "# First Section".to_string(),
+                    globs: vec!["/path/to/owned".to_string()],
+                },
+                TeamOwnership {
+                    heading: "# Last Section".to_string(),
+                    globs: vec!["/another/owned/path".to_string()],
+                },
+            ],
+        );
+        Ok(())
+    }
+
+    #[test]
+    fn test_parse_for_team_without_trailing_newline() -> Result<(), Box<dyn std::error::Error>> {
+        let codeownership_file = r#"
+# First Section
+/path/to/owned @Foo"#;
+
+        let team_ownership = parse_for_team("@Foo".to_string(), &codeownership_file)?;
+        vecs_match(
+            &team_ownership,
+            &vec![TeamOwnership {
+                heading: "# First Section".to_string(),
+                globs: vec!["/path/to/owned".to_string()],
+            }],
+        );
+        Ok(())
+    }
 }

tests/valid_project_test.rs

@@ -50,14 +50,55 @@ fn test_for_file() -> Result<(), Box<dyn Error>> {
 
 #[test]
 fn test_for_team() -> Result<(), Box<dyn Error>> {
+    let expected_stdout = r#"
+# Code Ownership Report for `Payroll` Team
+
+## Annotations at the top of file
+/javascript/packages/PayrollFlow/index.tsx
+/ruby/app/models/payroll.rb
+
+## Team-specific owned globs
+
+## Owner in .codeowner
+/ruby/app/payroll/**/**
+
+## Owner metadata key in package.yml
+/ruby/packages/payroll_flow/**/**
+
+## Owner metadata key in package.json
+/javascript/packages/PayrollFlow/**/**
+
+## Team YML ownership
+/config/teams/payroll.yml
+
+## Team owned gems
+/gems/payroll_calculator/**/**
+
+"#
+    .trim_start();
+
     Command::cargo_bin("codeowners")?
         .arg("--project-root")
         .arg("tests/fixtures/valid_project")
         .arg("for-team")
         .arg("Payroll")
         .assert()
         .success()
-        .stdout(predicate::str::contains("Team: Payroll"));
+        .stdout(predicate::eq(expected_stdout));
+
+    Ok(())
+}
+
+#[test]
+fn test_for_missing_team() -> Result<(), Box<dyn Error>> {
+    Command::cargo_bin("codeowners")?
+        .arg("--project-root")
+        .arg("tests/fixtures/valid_project")
+        .arg("for-team")
+        .arg("Nope")
+        .assert()
+        .success()
+        .stderr(predicate::str::contains("Team not found"));
 
     Ok(())
 }