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

use crate::engine::Engine;
use crate::error::{ApplicationError, ApplicationResult};
use crate::report::Report;
use crate::spec::Spec;
use std::time::Instant;

pub struct RunSpec<E>
where
    E: Engine,
{
    engine: E,
}

impl<E> RunSpec<E>
where
    E: Engine,
{
    pub fn new(engine: E) -> Self {
        Self { engine }
    }

    /// # Errors
    ///
    /// Returns [`ApplicationError`](crate::error::ApplicationError) if the spec is invalid,
    /// the engine fails to execute, or the resulting report is invalid.
    pub fn run(&self, dataset: &E::Dataset, spec: &Spec<E::Kind>) -> ApplicationResult<Report> {
        spec.validate().map_err(ApplicationError::InvalidSpec)?;
        let start = Instant::now();

        let mut report = self.engine.execute(dataset, spec)?;

        report.validate().map_err(ApplicationError::InvalidReport)?;

        let elapsed = start.elapsed().as_millis();

        {
            let violations_count = report.violations().len();

            let metrics = report.metrics_mut();
            metrics.execution_time_ms = elapsed;
            metrics.total_invariants = spec.invariants().len();
            metrics.violations = violations_count;
        }

        Ok(report)
    }
}