Add have_same_errors filter and some tests (#21)

Signed-off-by: Sergio Castaño Arteaga <[email protected]>
cncf · Sep 3, 2024 · a1c40a5 · a1c40a5
1 parent fe13fe0
commit a1c40a5
Show file tree

Hide file tree

Showing 2 changed files with 183 additions and 0 deletions.
diff --git a/dco2/src/dco/check/filters.rs b/dco2/src/dco/check/filters.rs
@@ -10,3 +10,182 @@ pub(crate) fn contains_error(
 ) -> askama::Result<bool> {
     Ok(commits_with_errors.iter().any(|c| c.errors.iter().any(|e| errors.contains(e))))
 }
+
+/// Template filter to check if all the commits contain the same errors.
+pub(crate) fn have_same_errors(commits_with_errors: &[CommitCheckOutput]) -> askama::Result<bool> {
+    for i in 1..commits_with_errors.len() {
+        if commits_with_errors[i].errors != commits_with_errors[0].errors {
+            return Ok(false);
+        }
+    }
+    Ok(true)
+}
+
+#[cfg(test)]
+mod tests {
+    use crate::dco::check::{
+        filters::{contains_error, have_same_errors},
+        CommitCheckOutput, CommitError,
+    };
+
+    #[test]
+    fn contains_error_one_commit_error_found() {
+        let commits_with_errors = vec![CommitCheckOutput {
+            commit: Default::default(),
+            errors: vec![CommitError::InvalidAuthorEmail],
+        }];
+
+        assert!(contains_error(&commits_with_errors, &[CommitError::InvalidAuthorEmail]).unwrap());
+    }
+
+    #[test]
+    fn contains_error_one_commit_error_not_found() {
+        let commits_with_errors = vec![CommitCheckOutput {
+            commit: Default::default(),
+            errors: vec![CommitError::InvalidAuthorEmail],
+        }];
+
+        assert!(!contains_error(&commits_with_errors, &[CommitError::InvalidCommitterEmail]).unwrap());
+    }
+
+    #[test]
+    fn contains_error_two_commits_error_found() {
+        let commits_with_errors = vec![
+            CommitCheckOutput {
+                commit: Default::default(),
+                errors: vec![CommitError::InvalidAuthorEmail],
+            },
+            CommitCheckOutput {
+                commit: Default::default(),
+                errors: vec![CommitError::InvalidCommitterEmail],
+            },
+        ];
+
+        assert!(contains_error(
+            &commits_with_errors,
+            &[CommitError::InvalidAuthorEmail, CommitError::SignOffNotFound]
+        )
+        .unwrap());
+    }
+
+    #[test]
+    fn contains_error_two_commits_error_not_found() {
+        let commits_with_errors = vec![
+            CommitCheckOutput {
+                commit: Default::default(),
+                errors: vec![CommitError::InvalidAuthorEmail],
+            },
+            CommitCheckOutput {
+                commit: Default::default(),
+                errors: vec![CommitError::InvalidCommitterEmail],
+            },
+        ];
+
+        assert!(!contains_error(
+            &commits_with_errors,
+            &[CommitError::SignOffNotFound, CommitError::SignOffMismatch]
+        )
+        .unwrap());
+    }
+
+    #[test]
+    fn have_same_errors_one_commit_always_true() {
+        let commits_with_errors = vec![CommitCheckOutput {
+            commit: Default::default(),
+            errors: vec![CommitError::InvalidAuthorEmail],
+        }];
+
+        assert!(have_same_errors(&commits_with_errors).unwrap());
+    }
+
+    #[test]
+    fn have_same_errors_two_commits_one_error_matches() {
+        let commits_with_errors = vec![
+            CommitCheckOutput {
+                commit: Default::default(),
+                errors: vec![CommitError::InvalidAuthorEmail],
+            },
+            CommitCheckOutput {
+                commit: Default::default(),
+                errors: vec![CommitError::InvalidAuthorEmail],
+            },
+        ];
+
+        assert!(have_same_errors(&commits_with_errors).unwrap());
+    }
+
+    #[test]
+    fn have_same_errors_two_commits_two_errors_match() {
+        let commits_with_errors = vec![
+            CommitCheckOutput {
+                commit: Default::default(),
+                errors: vec![CommitError::InvalidAuthorEmail, CommitError::SignOffNotFound],
+            },
+            CommitCheckOutput {
+                commit: Default::default(),
+                errors: vec![CommitError::InvalidAuthorEmail, CommitError::SignOffNotFound],
+            },
+        ];
+
+        assert!(have_same_errors(&commits_with_errors).unwrap());
+    }
+
+    #[test]
+    fn have_same_errors_two_commits_two_errors_do_not_match() {
+        let commits_with_errors = vec![
+            CommitCheckOutput {
+                commit: Default::default(),
+                errors: vec![
+                    CommitError::InvalidAuthorEmail,
+                    CommitError::InvalidCommitterEmail,
+                ],
+            },
+            CommitCheckOutput {
+                commit: Default::default(),
+                errors: vec![CommitError::InvalidAuthorEmail, CommitError::SignOffNotFound],
+            },
+        ];
+
+        assert!(!have_same_errors(&commits_with_errors).unwrap());
+    }
+
+    #[test]
+    fn have_same_errors_three_commits_two_errors_match() {
+        let commits_with_errors = vec![
+            CommitCheckOutput {
+                commit: Default::default(),
+                errors: vec![CommitError::InvalidAuthorEmail, CommitError::SignOffNotFound],
+            },
+            CommitCheckOutput {
+                commit: Default::default(),
+                errors: vec![CommitError::InvalidAuthorEmail, CommitError::SignOffNotFound],
+            },
+            CommitCheckOutput {
+                commit: Default::default(),
+                errors: vec![CommitError::InvalidAuthorEmail, CommitError::SignOffNotFound],
+            },
+        ];
+
+        assert!(have_same_errors(&commits_with_errors).unwrap());
+    }
+
+    #[test]
+    fn have_same_errors_three_commits_one_error_does_not_match() {
+        let commits_with_errors = vec![
+            CommitCheckOutput {
+                commit: Default::default(),
+                errors: vec![CommitError::InvalidAuthorEmail],
+            },
+            CommitCheckOutput {
+                commit: Default::default(),
+                errors: vec![CommitError::SignOffNotFound],
+            },
+            CommitCheckOutput {
+                commit: Default::default(),
+                errors: vec![CommitError::InvalidAuthorEmail],
+            },
+        ];
+
+        assert!(!have_same_errors(&commits_with_errors).unwrap());
+    }
+}
diff --git a/dco2/templates/output.md b/dco2/templates/output.md
@@ -7,3 +7,7 @@ There is at least one commit incorrectly signed off. This means that the author
 {% if commits_with_errors|contains_error([CommitError::SignOffNotFound, CommitError::SignOffMismatch]) %}
 Tada!
 {% endif %}
+
+{% if commits_with_errors|have_same_errors %}
+Tada!
+{% endif %}