invr 0.2.1

Declarative data validation engine using invariants executed on Polars DataFrames.
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
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201

/// Integration tests for the full RunSpec pipeline.
///
/// These tests exercise the end-to-end path:
/// Invariant → Spec → RunSpec::run → Report
#[cfg(feature = "polars")]
mod tests {
    use invars::prelude::*;
    use polars::prelude::*;

    fn make_df() -> DataFrame {
        df![
            "id"    => [1i64, 2, 3, 4, 5],
            "name"  => ["alice", "bob", "carol", "dave", "eve"],
            "score" => [85.0f64, 92.0, 78.0, 95.0, 88.0],
        ]
        .unwrap()
    }

    // ----------------------------------------------------------------
    // NotNull
    // ----------------------------------------------------------------

    #[test]
    fn not_null_passes_on_clean_column() {
        let df = make_df();
        let spec = Spec::from_invariants(vec![Invariant::new(
            InvariantId::new("id_not_null").unwrap(),
            PolarsKind::NotNull,
            Scope::column("id"),
        )]);
        let report = RunSpec::new(EnginePolarsDataFrame).run(&df, &spec).unwrap();
        assert!(!report.failed());
        assert_eq!(report.error_count(), 0);
    }

    #[test]
    fn not_null_fires_when_column_has_nulls() {
        let df = df![
            "id" => [Some(1i64), None, Some(3)]
        ]
        .unwrap();
        let spec = Spec::from_invariants(vec![Invariant::new(
            InvariantId::new("id_not_null").unwrap(),
            PolarsKind::NotNull,
            Scope::column("id"),
        )]);
        let report = RunSpec::new(EnginePolarsDataFrame).run(&df, &spec).unwrap();
        assert!(report.failed());
        assert_eq!(report.error_count(), 1);
    }

    // ----------------------------------------------------------------
    // Unique
    // ----------------------------------------------------------------

    #[test]
    fn unique_passes_on_unique_column() {
        let df = make_df();
        let spec = Spec::from_invariants(vec![Invariant::new(
            InvariantId::new("id_unique").unwrap(),
            PolarsKind::Unique,
            Scope::column("id"),
        )]);
        let report = RunSpec::new(EnginePolarsDataFrame).run(&df, &spec).unwrap();
        assert!(!report.failed());
    }

    #[test]
    fn unique_fires_on_duplicate_values() {
        let df = df!["id" => [1i64, 2, 2, 4]].unwrap();
        let spec = Spec::from_invariants(vec![Invariant::new(
            InvariantId::new("id_unique").unwrap(),
            PolarsKind::Unique,
            Scope::column("id"),
        )]);
        let report = RunSpec::new(EnginePolarsDataFrame).run(&df, &spec).unwrap();
        assert!(report.failed());
    }

    // ----------------------------------------------------------------
    // RowCountMin
    // ----------------------------------------------------------------

    #[test]
    fn row_count_min_passes() {
        let df = make_df();
        let spec = Spec::from_invariants(vec![
            Invariant::new(
                InvariantId::new("min_rows").unwrap(),
                PolarsKind::RowCountMin,
                Scope::Dataset,
            )
            .with_param_value("min", "3"),
        ]);
        let report = RunSpec::new(EnginePolarsDataFrame).run(&df, &spec).unwrap();
        assert!(!report.failed());
    }

    #[test]
    fn row_count_min_fires_when_too_few_rows() {
        let df = df!["x" => [1i32, 2]].unwrap();
        let spec = Spec::from_invariants(vec![
            Invariant::new(
                InvariantId::new("min_rows").unwrap(),
                PolarsKind::RowCountMin,
                Scope::Dataset,
            )
            .with_param_value("min", "5"),
        ]);
        let report = RunSpec::new(EnginePolarsDataFrame).run(&df, &spec).unwrap();
        assert!(report.failed());
    }

    // ----------------------------------------------------------------
    // Severity: warn does not make report.failed() == true
    // ----------------------------------------------------------------

    #[test]
    fn warn_severity_does_not_fail_report() {
        let df = df!["x" => [Some(1i64), None]].unwrap();
        let spec = Spec::from_invariants(vec![
            Invariant::new(
                InvariantId::new("x_not_null").unwrap(),
                PolarsKind::NotNull,
                Scope::column("x"),
            )
            .with_severity(Severity::Warn),
        ]);
        let report = RunSpec::new(EnginePolarsDataFrame).run(&df, &spec).unwrap();
        assert!(
            !report.failed(),
            "warn violation should not fail the report"
        );
        assert!(report.has_warnings());
        assert_eq!(report.warn_count(), 1);
    }

    // ----------------------------------------------------------------
    // Report serialization
    // ----------------------------------------------------------------

    #[test]
    fn report_serializes_to_json() {
        let df = df!["id" => [Some(1i64), None]].unwrap();
        let spec = Spec::from_invariants(vec![Invariant::new(
            InvariantId::new("id_not_null").unwrap(),
            PolarsKind::NotNull,
            Scope::column("id"),
        )]);
        let report = RunSpec::new(EnginePolarsDataFrame).run(&df, &spec).unwrap();
        let json = serde_json::to_string(&report).expect("report must be serializable");
        assert!(json.contains("id_not_null"));
    }

    // ----------------------------------------------------------------
    // Multiple invariants in one spec
    // ----------------------------------------------------------------

    #[test]
    fn multiple_invariants_accumulate_violations() {
        let df = df![
            "id"   => [Some(1i64), None],
            "code" => [Some("a"), Some("b")]
        ]
        .unwrap();

        let spec = Spec::from_invariants(vec![
            Invariant::new(
                InvariantId::new("id_not_null").unwrap(),
                PolarsKind::NotNull,
                Scope::column("id"),
            ),
            Invariant::new(
                InvariantId::new("row_count").unwrap(),
                PolarsKind::RowCountMin,
                Scope::Dataset,
            )
            .with_param_value("min", "10"),
        ]);
        let report = RunSpec::new(EnginePolarsDataFrame).run(&df, &spec).unwrap();
        assert_eq!(report.error_count(), 2);
    }

    // ----------------------------------------------------------------
    // Report metrics
    // ----------------------------------------------------------------

    #[test]
    fn report_metrics_are_populated() {
        let df = make_df();
        let spec = Spec::from_invariants(vec![Invariant::new(
            InvariantId::new("id_not_null").unwrap(),
            PolarsKind::NotNull,
            Scope::column("id"),
        )]);
        let report = RunSpec::new(EnginePolarsDataFrame).run(&df, &spec).unwrap();
        assert_eq!(report.metrics().total_invariants, 1);
        assert_eq!(report.metrics().violations, 0);
        assert!(report.metrics().execution_time_ms < 60_000);
    }
}