Support directory ownership (#14)

* write failing test

* first attempt to make tests pass

* add dependency

* use pretty assertions

* fix failing test

* bump version

* fix merge conflict

* clippy

Author: alexevanczuk

Cargo.lock

@@ -1,6 +1,6 @@
 [package]
 name = "codeowners"
-version = "0.1.0"
+version = "0.1.1"
 edition = "2021"
 
 [profile.release]
@@ -26,3 +26,4 @@ tracing-subscriber = { version = "0.3.16", features = ["env-filter"] }
 assert_cmd = "2.0.10"
 rusty-hook = "^0.11.2"
 predicates = "3.0.2"
+pretty_assertions = "1.3.0" # Shows a more readable diff when comparing objects

Cargo.toml

@@ -8,7 +8,7 @@ mod validator;
 #[cfg(test)]
 mod tests;
 
-use crate::project::Project;
+use crate::{ownership::mapper::DirectoryMapper, project::Project};
 
 pub use validator::Errors as ValidatorErrors;
 
@@ -70,6 +70,7 @@ impl Ownership {
         vec![
             Box::new(TeamFileMapper::build(self.project.clone())),
             Box::new(TeamGlobMapper::build(self.project.clone())),
+            Box::new(DirectoryMapper::build(self.project.clone())),
             Box::new(RubyPackageMapper::build(self.project.clone())),
             Box::new(JavascriptPackageMapper::build(self.project.clone())),
             Box::new(TeamYmlMapper::build(self.project.clone())),

src/ownership.rs

@@ -4,12 +4,14 @@ use std::{
     path::{Path, PathBuf},
 };
 
+mod directory_mapper;
 mod package_mapper;
 mod team_file_mapper;
 mod team_gem_mapper;
 mod team_glob_mapper;
 mod team_yml_mapper;
 
+pub use directory_mapper::DirectoryMapper;
 pub use package_mapper::JavascriptPackageMapper;
 pub use package_mapper::RubyPackageMapper;
 pub use team_file_mapper::TeamFileMapper;

src/ownership/mapper.rs

@@ -0,0 +1,55 @@
+use std::sync::Arc;
+
+use super::Entry;
+use super::{Mapper, OwnerMatcher};
+use crate::project::Project;
+
+pub struct DirectoryMapper {
+    project: Arc<Project>,
+}
+
+impl DirectoryMapper {
+    pub fn build(project: Arc<Project>) -> Self {
+        Self { project }
+    }
+}
+
+impl Mapper for DirectoryMapper {
+    fn entries(&self) -> Vec<Entry> {
+        let mut entries: Vec<Entry> = Vec::new();
+        let team_by_name = self.project.team_by_name();
+
+        for directory_codeowner_file in &self.project.directory_codeowner_files {
+            let dir_root = directory_codeowner_file.directory_root().to_string_lossy();
+            let team = team_by_name.get(&directory_codeowner_file.owner);
+            if let Some(team) = team {
+                entries.push(Entry {
+                    path: format!("{}/**/**", dir_root),
+                    github_team: team.github_team.to_owned(),
+                    team_name: team.name.to_owned(),
+                    disabled: team.avoid_ownership,
+                });
+            }
+        }
+
+        entries
+    }
+
+    fn owner_matchers(&self) -> Vec<OwnerMatcher> {
+        let mut owner_matchers = Vec::new();
+
+        for file in &self.project.directory_codeowner_files {
+            owner_matchers.push(OwnerMatcher::Glob {
+                glob: format!("{}/**/**", file.directory_root().to_string_lossy()),
+                team_name: file.owner.to_owned(),
+                source: format!("directory_mapper ({:?})", &file.directory_root()),
+            });
+        }
+
+        owner_matchers
+    }
+
+    fn name(&self) -> String {
+        "Owner in .codeowner".to_owned()
+    }
+}

src/ownership/mapper/directory_mapper.rs

@@ -3,6 +3,7 @@ use std::path::Path;
 use crate::project::{Package, PackageType, Project, ProjectFile, Team, VendoredGem};
 
 use super::Ownership;
+use pretty_assertions::assert_eq;
 
 fn build_payroll_team() -> Team {
     Team {
@@ -48,6 +49,7 @@ fn build_project_with_annotated_file() -> Project {
         teams: vec![build_payroll_team()],
         vendored_gems: vec![],
         codeowners_file: "".to_owned(),
+        directory_codeowner_files: vec![],
     }
 }
 
@@ -70,6 +72,7 @@ fn build_project_with_team_specific_owned_globs() -> Project {
         teams: vec![build_payroll_team_with_owned_glob()],
         vendored_gems: vec![],
         codeowners_file: "".to_owned(),
+        directory_codeowner_files: vec![],
     }
 }
 
@@ -92,6 +95,7 @@ fn build_project_with_packages() -> Project {
         teams: vec![build_payroll_team()],
         vendored_gems: vec![],
         codeowners_file: "".to_owned(),
+        directory_codeowner_files: vec![],
     }
 }
 
@@ -106,6 +110,7 @@ fn build_project_with_team_owned_gems() -> Project {
             name: "payroll_calculator".to_owned(),
         }],
         codeowners_file: "".to_owned(),
+        directory_codeowner_files: vec![],
     }
 }
 
@@ -121,6 +126,8 @@ fn test_annotations_at_the_top_of_file() {
             "",
             "# Team-specific owned globs",
             "",
+            "# Owner in .codeowner",
+            "",
             "# Owner metadata key in package.yml",
             "",
             "# Owner metadata key in package.json",
@@ -147,6 +154,8 @@ fn test_team_specific_owned_globs() {
             "# Team-specific owned globs",
             "/packs/payroll/** @Payroll-Eng",
             "",
+            "# Owner in .codeowner",
+            "",
             "# Owner metadata key in package.yml",
             "",
             "# Owner metadata key in package.json",
@@ -172,6 +181,8 @@ fn test_owner_metadata_in_package() {
             "",
             "# Team-specific owned globs",
             "",
+            "# Owner in .codeowner",
+            "",
             "# Owner metadata key in package.yml",
             "/packs/payroll_package/**/** @Payroll-Eng",
             "",
@@ -199,6 +210,8 @@ fn test_team_owned_gems() {
             "",
             "# Team-specific owned globs",
             "",
+            "# Owner in .codeowner",
+            "",
             "# Owner metadata key in package.yml",
             "",
             "# Owner metadata key in package.json",

src/ownership/tests.rs

@@ -8,7 +8,7 @@ use std::{
 
 use error_stack::{Context, Result};
 
-use ignore::Walk;
+use ignore::WalkBuilder;
 use rayon::prelude::{IntoParallelIterator, ParallelIterator};
 use regex::Regex;
 use tracing::{info, instrument};
@@ -23,6 +23,7 @@ pub struct Project {
     pub vendored_gems: Vec<VendoredGem>,
     pub teams: Vec<Team>,
     pub codeowners_file: String,
+    pub directory_codeowner_files: Vec<DirectoryCodeownersFile>,
 }
 
 #[derive(Clone)]
@@ -37,7 +38,7 @@ pub struct ProjectFile {
     pub path: PathBuf,
 }
 
-#[derive(Clone)]
+#[derive(Clone, Debug)]
 pub struct Team {
     pub path: PathBuf,
     pub name: String,
@@ -59,6 +60,18 @@ impl Package {
     }
 }
 
+#[derive(Clone, Debug)]
+pub struct DirectoryCodeownersFile {
+    pub path: PathBuf,
+    pub owner: String,
+}
+
+impl DirectoryCodeownersFile {
+    pub fn directory_root(&self) -> &Path {
+        self.path.parent().unwrap()
+    }
+}
+
 #[derive(PartialEq, Eq, Debug)]
 pub enum PackageType {
     Ruby,
@@ -143,8 +156,13 @@ impl Project {
         let mut packages: Vec<Package> = Vec::new();
         let mut teams: Vec<Team> = Vec::new();
         let mut vendored_gems: Vec<VendoredGem> = Vec::new();
+        let mut directory_codeowner_files: Vec<DirectoryCodeownersFile> = Vec::new();
 
-        for entry in Walk::new(base_path) {
+        let mut builder = WalkBuilder::new(base_path);
+        builder.hidden(false);
+        let walkdir = builder.build();
+
+        for entry in walkdir {
             let entry = entry.into_context(Error::Io)?;
 
             let absolute_path = entry.path();
@@ -186,6 +204,17 @@ impl Project {
                 }
             }
 
+            if file_name.eq_ignore_ascii_case(".codeowner") {
+                let owner = std::fs::read_to_string(absolute_path).into_context(Error::Io)?;
+                let owner = owner.trim().to_owned();
+
+                let relative_path = relative_path.to_owned();
+                directory_codeowner_files.push(DirectoryCodeownersFile {
+                    path: relative_path,
+                    owner,
+                })
+            }
+
             if matches_globs(&relative_path, &config.team_file_glob) {
                 let file = File::open(absolute_path).into_context(Error::Io)?;
                 let deserializer: deserializers::Team = serde_yaml::from_reader(file).into_context(Error::SerdeYaml)?;
@@ -228,6 +257,7 @@ impl Project {
             teams,
             packages,
             codeowners_file,
+            directory_codeowner_files,
         })
     }
 

src/project.rs

@@ -15,6 +15,9 @@
 # Team-specific owned globs
 /ruby/app/payments/**/* @PaymentsTeam
 
+# Owner in .codeowner
+/ruby/app/payroll/**/** @PayrollTeam
+
 # Owner metadata key in package.yml
 /ruby/packages/payroll_flow/**/** @PayrollTeam
 

tests/fixtures/valid_project/.github/CODEOWNERS

@@ -0,0 +1 @@
+Payroll

tests/fixtures/valid_project/ruby/app/payroll/.codeowner

@@ -0,0 +1 @@
+class Payroll; end