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
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127

// src/validators/column/stdev_between.rs

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

pub struct StdevBetweenValidator {
    pub min: f64,
    pub max: f64,
}

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

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

        let f64_series = match series.strict_cast(&DataType::Float64) {
            Ok(s) => s,
            Err(_) => {
                return Ok(ValidationReport {
                    status: "skipped",
                    details: Some("column could not be cast to a numeric type".to_string()),
                });
            }
        };

        let values = f64_series.f64()?;

        // The argument `1` specifies a sample standard deviation (ddof=1).
        if let Some(std_dev) = values.std(1) {
            if std_dev >= self.min && std_dev <= self.max {
                Ok(ValidationReport {
                    status: "pass",
                    details: None,
                })
            } else {
                Ok(ValidationReport {
                    status: "fail",
                    details: Some(format!(
                        "observed_stdev={:.2}, min={}, max={}",
                        std_dev, self.min, self.max
                    )),
                })
            }
        } else {
            Ok(ValidationReport {
                status: "skipped",
                details: Some("standard deviation could not be calculated".to_string()),
            })
        }
    }
}

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

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

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

    #[test]
    fn passes_when_stdev_within_range() {
        // values: [1, 2, 3] → stdev ≈ 1.0
        let df = make_f64_df(&[Some(1.0), Some(2.0), Some(3.0)]);
        let validator = StdevBetweenValidator { min: 0.5, max: 2.0 };
        let report = validator.validate(&df, "col").unwrap();
        assert_eq!(report.status, "pass");
    }

    #[test]
    fn fails_when_stdev_below_min() {
        // values: [5, 5, 5] → stdev = 0.0
        let df = make_f64_df(&[Some(5.0), Some(5.0), Some(5.0)]);
        let validator = StdevBetweenValidator { min: 0.1, max: 2.0 };
        let report = validator.validate(&df, "col").unwrap();
        assert_eq!(report.status, "fail");
        assert!(report.details.unwrap().contains("observed_stdev=0.00"));
    }

    #[test]
    fn fails_when_stdev_above_max() {
        // values: [1, 100] → stdev large
        let df = make_f64_df(&[Some(1.0), Some(100.0)]);
        let validator = StdevBetweenValidator { min: 0.0, max: 10.0 };
        let report = validator.validate(&df, "col").unwrap();
        assert_eq!(report.status, "fail");
        assert!(report.details.unwrap().contains("observed_stdev"));
    }

    #[test]
    fn skips_when_column_not_numeric() {
        let df = make_str_df(&[Some("a"), Some("b")]);
        let validator = StdevBetweenValidator { min: 0.0, max: 1.0 };
        let report = validator.validate(&df, "col").unwrap();
        assert_eq!(report.status, "skipped");
        assert!(report.details.unwrap().contains("could not be cast"));
    }

    #[test]
    fn skips_when_all_nulls() {
        let df = make_f64_df(&[None, None, None]);
        let validator = StdevBetweenValidator { min: 0.0, max: 1.0 };
        let report = validator.validate(&df, "col").unwrap();
        assert_eq!(report.status, "skipped");
        assert!(report.details.unwrap().contains("could not be calculated"));
    }

    #[test]
    fn skips_when_empty_column() {
        let s: Series = Series::new("col".into(), Vec::<Option<f64>>::new());
        let df = DataFrame::new(vec![s.into()]).unwrap();
        let validator = StdevBetweenValidator { min: 0.0, max: 1.0 };
        let report = validator.validate(&df, "col").unwrap();
        assert_eq!(report.status, "skipped");
        assert!(report.details.unwrap().contains("could not be calculated"));
    }
}