test coverage for error messages (#5)

Author: mzruya

Cargo.lock

@@ -24,3 +24,4 @@ tracing-subscriber = { version = "0.3.16", features = ["env-filter"] }
 [dev-dependencies]
 assert_cmd = "2.0.10"
 rusty-hook = "^0.11.2"
+predicates = "3.0.2"

Cargo.toml

@@ -1,4 +1,4 @@
-use ext::IntoContext;
+use error_stack_ext::IntoContext;
 use ownership::Ownership;
 
 use crate::project::Project;
@@ -13,7 +13,7 @@ use std::{
 };
 
 mod config;
-mod ext;
+mod error_stack_ext;
 mod ownership;
 mod project;
 
@@ -85,7 +85,7 @@ impl Context for Error {}
 
 fn main() -> Result<(), Error> {
     install_logger();
-    print_validation_errors_to_stdout(cli())?;
+    maybe_print_errors(cli())?;
 
     Ok(())
 }
@@ -99,14 +99,13 @@ fn cli() -> Result<(), Error> {
 
     let config_file = File::open(&config_path)
         .into_context(Error::Io)
-        .attach_printable(format!("{}", config_path.to_string_lossy()))?;
+        .attach_printable(format!("Can't open config file: {}", config_path.to_string_lossy()))?;
 
     let config = serde_yaml::from_reader(config_file).into_context(Error::Io)?;
 
     let ownership = Ownership::build(Project::build(&project_root, &codeowners_file_path, &config).change_context(Error::Io)?);
-    let command = args.command;
 
-    match command {
+    match args.command {
         Command::Validate => ownership.validate().into_context(Error::ValidationFailed)?,
         Command::Generate => {
             std::fs::write(codeowners_file_path, ownership.generate_file()).into_context(Error::Io)?;
@@ -120,7 +119,7 @@ fn cli() -> Result<(), Error> {
     Ok(())
 }
 
-fn print_validation_errors_to_stdout(result: Result<(), Error>) -> Result<(), Error> {
+fn maybe_print_errors(result: Result<(), Error>) -> Result<(), Error> {
     if let Err(error) = result {
         if let Some(validation_errors) = error.downcast_ref::<ownership::ValidatorErrors>() {
             println!("{}", validation_errors);

src/ext.rs src/error_stack_ext.rssrc/ext.rs renamed to src/error_stack_ext.rs

@@ -157,6 +157,8 @@ impl Error {
 impl Display for Errors {
     fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
         let grouped_errors = self.0.iter().into_group_map_by(|error| error.error_category_message());
+        let grouped_errors = Vec::from_iter(grouped_errors.iter());
+
         for (error_category_message, errors) in grouped_errors {
             write!(f, "\n{}", error_category_message)?;
 

src/main.rs

@@ -13,7 +13,7 @@ use rayon::prelude::{IntoParallelIterator, ParallelIterator};
 use regex::Regex;
 use tracing::{debug, instrument};
 
-use crate::{config::Config, ext::IntoContext};
+use crate::{config::Config, error_stack_ext::IntoContext};
 use glob_match::glob_match;
 
 pub struct Project {
@@ -131,7 +131,7 @@ impl Context for Error {}
 impl Project {
     #[instrument(level = "debug", skip_all)]
     pub fn build(base_path: &Path, codeowners_file_path: &Path, config: &Config) -> Result<Self, Error> {
-        debug!("scanning project ({})", base_path.to_string_lossy());
+        debug!(base_path = base_path.to_str(), "scanning project");
 
         let mut owned_file_paths: Vec<PathBuf> = Vec::new();
         let mut packages: Vec<Package> = Vec::new();

src/ownership/validator.rs

@@ -0,0 +1 @@
+

src/project.rs

@@ -0,0 +1,10 @@
+owned_globs:
+  - "**/*.{rb,tsx}"
+ruby_package_paths:
+  - ruby/packages/**/*
+javascript_package_paths:
+  - javascript/packages/**
+team_file_glob:
+  - config/teams/**/*.yml
+vendored_gems_path: gems
+unowned_globs:

tests/fixtures/invalid_project/.github/CODEOWNERS

@@ -0,0 +1,5 @@
+name: Payments
+github:
+  team: '@PaymentTeam'
+owned_globs:
+  - ruby/app/payments/**/*

tests/fixtures/invalid_project/config/code_ownership.yml

@@ -0,0 +1,9 @@
+name: Payroll
+github:
+  team: '@PayrollTeam'
+ruby:
+  owned_gems:
+    - payroll_calculator
+javascript:
+  owned_packages:
+    - 'PayrollFlow'