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

use serde::{Deserialize, Serialize};

/// Top-level audit log entry.
/// Each line in `audit-YYYY-MM-DD.jsonl` will be one of these.
///
/// This is the canonical structure for all audit events:
/// - timestamped
/// - leveled (INFO, AUDIT, ERROR, etc.)
/// - typed by `event`
/// - optionally tied to a contract, target, results, or summary
#[derive(Serialize)]
pub struct AuditLogEntry<'a> {
    pub timestamp: String, // RFC3339 timestamp
    pub level: &'a str,    // e.g. "AUDIT", "INFO", "ERROR"
    pub event: &'a str,    // semantic event name ("movement_success", "contract_validated")
    #[serde(skip_serializing_if = "Option::is_none")]
    pub contract: Option<Contract<'a>>, // contract metadata
    #[serde(skip_serializing_if = "Option::is_none")]
    pub target: Option<Target<'a>>, // file/column/rule context
    #[serde(skip_serializing_if = "Option::is_none")]
    pub results: Option<Vec<RuleResult>>, // validation results (owned, no lifetime)
    pub executor: Executor, // who/where ran this
    #[serde(skip_serializing_if = "Option::is_none")]
    pub details: Option<&'a str>, // freeform detail string
    #[serde(skip_serializing_if = "Option::is_none")]
    pub summary: Option<ProcessSummary>, // summary of a full run
}

/// Contract metadata (embedded in AuditLogEntry)
#[derive(Serialize)]
pub struct Contract<'a> {
    pub name: &'a str,
    pub version: &'a str,
}

/// Target of validation (file, column, rule)
#[derive(Serialize)]
pub struct Target<'a> {
    pub file: &'a str,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub column: Option<&'a str>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub rule: Option<&'a str>,
}

/// Result of a single rule evaluation
#[derive(Clone, Debug, Serialize, Deserialize)]
pub struct RuleResult {
    pub column: String,          // which column was validated
    pub rule: String,            // rule name (e.g. "not_null")
    pub result: String,          // "pass" | "fail"
    pub details: Option<String>, // optional failure details
}

/// Executor metadata (who/where ran the validation)
#[derive(Clone, Serialize)]
pub struct Executor {
    pub user: String, // user ID or system account
    pub host: String, // hostname or container ID
}

/// Summary of a full process run
#[derive(Serialize)]
pub struct ProcessSummary {
    pub contracts_run: usize,
    pub contracts_failed: usize,
    pub status: String, // "SUCCESS" | "FAIL"
}