athena_rs 3.23.0

Hyper performant polyglot Database driver
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
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

//! Logging-client schema diagnostics report builder.
//!
//! This module preserves a stable report-building entrypoint while intermediate
//! diagnostics pipeline staging is delegated to
//! `debug_report_stage_input_assembly`,
//! `debug_report_stage_output_assembly`, and final payload projection/sorting
//! assembly is delegated to `debug_report_from_stage_output_assembly` (which
//! delegates to `debug_report_stage_output_handoff_assembly`).

use super::debug_contracts::LoggingSchemaDebugReport;
use super::debug_report_from_stage_output_assembly::build_logging_schema_debug_report_from_stage_output_assembly;
use super::debug_report_input_contracts::LoggingSchemaDebugReportBuilderInput;
use super::debug_report_stage_input_assembly::build_debug_report_stage_input_assembly;
use super::debug_report_stage_output_assembly::build_debug_report_stage_output_assembly;

/// Builds a logging-client schema diagnostics report from one typed builder input payload.
pub fn build_logging_schema_debug_report_from_input(
    input: LoggingSchemaDebugReportBuilderInput,
) -> LoggingSchemaDebugReport {
    let stage_input = build_debug_report_stage_input_assembly(input);
    let stage = build_debug_report_stage_output_assembly(stage_input);
    build_logging_schema_debug_report_from_stage_output_assembly(stage)
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::api::schema::debug_contracts::LoggingSchemaDebugReport;
    use crate::api::schema::debug_report_test_fixtures::{
        build_expected_logging_schema_columns_for_tests,
        build_expected_logging_schema_relations_for_tests,
    };

    /// Asserts summary counters remain consistent with canonical report payload lists.
    fn assert_summary_matches_report_payload(report: &LoggingSchemaDebugReport) {
        let found_table_count = report
            .expected_tables
            .iter()
            .filter(|row| row.found)
            .count();

        assert_eq!(
            report.summary.expected_table_count,
            report.expected_tables.len()
        );
        assert_eq!(report.summary.found_table_count, found_table_count);
        assert_eq!(
            report.summary.required_missing_table_count,
            report.still_needed.required_missing_tables.len()
        );
        assert_eq!(
            report.summary.optional_missing_table_count,
            report.still_needed.optional_missing_tables.len()
        );
        assert_eq!(
            report.summary.required_missing_column_count,
            report.still_needed.required_missing_columns.len()
        );
        assert_eq!(
            report.summary.optional_missing_column_count,
            report.still_needed.optional_missing_columns.len()
        );
        assert_eq!(
            report.summary.relation_type_mismatch_count,
            report.still_needed.relation_type_mismatches.len()
        );
        assert_eq!(
            report.missing_required_tables,
            report.still_needed.required_missing_tables
        );
        assert_eq!(
            report.missing_optional_tables,
            report.still_needed.optional_missing_tables
        );
    }

    #[test]
    /// Ensures a fully present expected schema yields `healthy`.
    fn report_is_healthy_when_every_expected_table_and_column_exists() {
        let report =
            build_logging_schema_debug_report_from_input(LoggingSchemaDebugReportBuilderInput {
                logging_client: "athena_logging".to_string(),
                relations: build_expected_logging_schema_relations_for_tests(true),
                columns: build_expected_logging_schema_columns_for_tests(true),
            });

        assert_summary_matches_report_payload(&report);
        assert_eq!(report.summary.health, "healthy");
        assert_eq!(report.summary.required_missing_table_count, 0);
        assert_eq!(report.summary.optional_missing_table_count, 0);
        assert_eq!(report.summary.required_missing_column_count, 0);
        assert_eq!(report.summary.optional_missing_column_count, 0);
        assert_eq!(report.summary.relation_type_mismatch_count, 0);
        assert!(report.still_needed.required_missing_tables.is_empty());
        assert!(report.still_needed.optional_missing_tables.is_empty());
        assert!(report.still_needed.required_missing_columns.is_empty());
        assert!(report.still_needed.optional_missing_columns.is_empty());
        assert!(report.still_needed.relation_type_mismatches.is_empty());
    }

    #[test]
    /// Ensures missing only optional expected tables yields `warning`.
    fn report_is_warning_when_only_optional_tables_are_missing() {
        let report =
            build_logging_schema_debug_report_from_input(LoggingSchemaDebugReportBuilderInput {
                logging_client: "athena_logging".to_string(),
                relations: build_expected_logging_schema_relations_for_tests(false),
                columns: build_expected_logging_schema_columns_for_tests(false),
            });

        assert_summary_matches_report_payload(&report);
        assert_eq!(report.summary.health, "warning");
        assert_eq!(report.summary.required_missing_table_count, 0);
        assert!(report.summary.optional_missing_table_count >= 1);
        assert_eq!(report.summary.required_missing_column_count, 0);
        assert!(report.still_needed.required_missing_tables.is_empty());
        assert!(!report.still_needed.optional_missing_tables.is_empty());
        assert_eq!(
            report.missing_required_tables,
            report.still_needed.required_missing_tables
        );
        assert_eq!(
            report.missing_optional_tables,
            report.still_needed.optional_missing_tables
        );
    }

    #[test]
    /// Ensures missing a required expected table yields `degraded`.
    fn report_is_degraded_when_a_required_table_is_missing() {
        let mut relations = build_expected_logging_schema_relations_for_tests(true);
        relations.retain(|entry| entry.table_name != "gateway_request_log");
        let mut columns = build_expected_logging_schema_columns_for_tests(true);
        columns.retain(|entry| entry.table_name != "gateway_request_log");

        let report =
            build_logging_schema_debug_report_from_input(LoggingSchemaDebugReportBuilderInput {
                logging_client: "athena_logging".to_string(),
                relations,
                columns,
            });

        assert_summary_matches_report_payload(&report);
        assert_eq!(report.summary.health, "degraded");
        assert_eq!(report.summary.required_missing_table_count, 1);
        assert!(!report.missing_required_tables.is_empty());
        assert!(!report.still_needed.required_missing_tables.is_empty());
        assert!(!report.still_needed.required_missing_columns.is_empty());
        assert_eq!(
            report.missing_required_tables,
            report.still_needed.required_missing_tables
        );
        assert_eq!(
            report.missing_optional_tables,
            report.still_needed.optional_missing_tables
        );
    }
}