pipe-audit-core 0.1.3

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

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

pub struct NotNullValidator;

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

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

        let null_count = series.null_count();

        if null_count > 0 {
            Ok(ValidationReport {
                status: "fail",
                details: Some(format!("null_count={}", null_count)),
            })
        } else {
            Ok(ValidationReport {
                status: "pass",
                details: None,
            })
        }
    }
}

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

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

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

    #[test]
    fn passes_when_no_nulls() {
        let df = make_str_df(&[Some("a"), Some("b"), Some("c")]);
        let validator = NotNullValidator;
        let report = validator.validate(&df, "col").unwrap();
        assert_eq!(report.status, "pass");
        assert!(report.details.is_none());
    }

    #[test]
    fn fails_when_some_nulls() {
        let df = make_str_df(&[Some("a"), None, Some("b")]);
        let validator = NotNullValidator;
        let report = validator.validate(&df, "col").unwrap();
        assert_eq!(report.status, "fail");
        assert!(report.details.unwrap().contains("null_count=1"));
    }

    #[test]
    fn fails_when_all_nulls() {
        let df = make_str_df(&[None, None, None]);
        let validator = NotNullValidator;
        let report = validator.validate(&df, "col").unwrap();
        assert_eq!(report.status, "fail");
        assert!(report.details.unwrap().contains("null_count=3"));
    }

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

    #[test]
    fn works_with_integer_column() {
        let df = make_int_df(&[Some(1), None, Some(2), Some(3)]);
        let validator = NotNullValidator;
        let report = validator.validate(&df, "col").unwrap();
        assert_eq!(report.status, "fail");
        assert!(report.details.unwrap().contains("null_count=1"));
    }
}