pipe-audit-core 0.1.9

Universal data validation and compliance audit engine
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96

// src/validators/column/unique.rs

use crate::validators::{ValidationReport, ValidationResult, Validator};
use polars::prelude::*;

pub struct UniqueValidator;

impl Validator for UniqueValidator {
    fn name(&self) -> &'static str {
        "Unique"
    }

    fn validate(&self, df: &DataFrame, column_name: &str) -> ValidationResult<ValidationReport> {
        let series = df.column(column_name)?;

        let unique_count = series.n_unique()?;
        let total_count = series.len();

        if unique_count == total_count {
            Ok(ValidationReport {
                status: "pass",
                details: None,
            })
        } else {
            Ok(ValidationReport {
                status: "fail",
                details: Some(format!(
                    "found {} unique values in {} total rows",
                    unique_count, total_count
                )),
            })
        }
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    fn make_i64_df(values: &[Option<i64>]) -> DataFrame {
        let s = Series::new("col".into(), values.to_vec());
        DataFrame::new(vec![s.into()]).unwrap()
    }

    #[test]
    fn passes_when_all_values_unique() {
        let df = make_i64_df(&[Some(1), Some(2), Some(3)]);
        let validator = UniqueValidator;
        let report = validator.validate(&df, "col").unwrap();
        assert_eq!(report.status, "pass");
    }

    #[test]
    fn fails_when_duplicates_present() {
        let df = make_i64_df(&[Some(1), Some(2), Some(1)]);
        let validator = UniqueValidator;
        let report = validator.validate(&df, "col").unwrap();
        assert_eq!(report.status, "fail");
        assert!(report.details.unwrap().contains("found 2 unique values in 3 total rows"));
    }

    #[test]
    fn fails_when_all_values_same() {
        let df = make_i64_df(&[Some(5), Some(5), Some(5)]);
        let validator = UniqueValidator;
        let report = validator.validate(&df, "col").unwrap();
        assert_eq!(report.status, "fail");
        assert!(report.details.unwrap().contains("found 1 unique values in 3 total rows"));
    }

    #[test]
    fn passes_on_empty_column() {
        let s: Series = Series::new("col".into(), Vec::<Option<i64>>::new());
        let df = DataFrame::new(vec![s.into()]).unwrap();
        let validator = UniqueValidator;
        let report = validator.validate(&df, "col").unwrap();
        assert_eq!(report.status, "pass");
    }

    #[test]
    fn passes_with_nulls_but_unique_non_nulls() {
        let df = make_i64_df(&[Some(1), Some(2), None]);
        let validator = UniqueValidator;
        let report = validator.validate(&df, "col").unwrap();
        assert_eq!(report.status, "pass");
    }

    #[test]
    fn fails_with_duplicate_nulls() {
        let df = make_i64_df(&[Some(1), None, None]);
        let validator = UniqueValidator;
        let report = validator.validate(&df, "col").unwrap();
        assert_eq!(report.status, "fail");
        assert!(report.details.unwrap().contains("found 2 unique values in 3 total rows"));
    }
}