dbpulse 0.9.1

command line tool to monitor that database is available for read & write
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

pub mod mysql;
pub mod postgres;

use crate::tls::TlsMetadata;

/// Result from database health check including TLS metadata
#[derive(Debug, Clone)]
pub struct HealthCheckResult {
    /// Database version string
    pub version: String,
    /// Database host currently serving the connection (if available)
    pub db_host: Option<String>,
    /// Database uptime in seconds (if available)
    pub uptime_seconds: Option<i64>,
    /// TLS metadata (if TLS is enabled)
    pub tls_metadata: Option<TlsMetadata>,
}

#[cfg(test)]
mod tests {
    #![allow(clippy::unwrap_used, clippy::expect_used, clippy::panic)]

    use super::*;

    #[test]
    fn test_health_check_result_without_tls() {
        let result = HealthCheckResult {
            version: "PostgreSQL 15.0".to_string(),
            db_host: Some("db-1".to_string()),
            uptime_seconds: Some(1_000),
            tls_metadata: None,
        };

        assert_eq!(result.version, "PostgreSQL 15.0");
        assert_eq!(result.db_host, Some("db-1".to_string()));
        assert_eq!(result.uptime_seconds, Some(1_000));
        assert!(result.tls_metadata.is_none());
    }

    #[test]
    fn test_health_check_result_with_tls() {
        let tls_metadata = TlsMetadata {
            version: Some("TLSv1.3".to_string()),
            cipher: Some("AES256-GCM-SHA384".to_string()),
            cert_subject: None,
            cert_issuer: None,
            cert_expiry_days: None,
        };

        let result = HealthCheckResult {
            version: "MySQL 8.0.33".to_string(),
            db_host: Some("db-2".to_string()),
            uptime_seconds: Some(42),
            tls_metadata: Some(tls_metadata),
        };

        assert_eq!(result.version, "MySQL 8.0.33");
        assert_eq!(result.db_host, Some("db-2".to_string()));
        assert_eq!(result.uptime_seconds, Some(42));
        assert!(result.tls_metadata.is_some());
        let tls = result.tls_metadata.as_ref().unwrap();
        assert_eq!(tls.version.as_ref().unwrap(), "TLSv1.3");
        assert_eq!(tls.cipher.as_ref().unwrap(), "AES256-GCM-SHA384");
    }

    #[test]
    fn test_health_check_result_clone() {
        let result = HealthCheckResult {
            version: "PostgreSQL 14.5".to_string(),
            db_host: None,
            uptime_seconds: None,
            tls_metadata: None,
        };

        let cloned = result.clone();
        assert_eq!(cloned.version, result.version);
        assert_eq!(cloned.uptime_seconds, result.uptime_seconds);
        assert!(cloned.tls_metadata.is_none());
    }

    #[test]
    fn test_health_check_result_debug() {
        let result = HealthCheckResult {
            version: "MySQL 8.0".to_string(),
            db_host: None,
            uptime_seconds: None,
            tls_metadata: None,
        };

        let debug_str = format!("{result:?}");
        assert!(debug_str.contains("HealthCheckResult"));
        assert!(debug_str.contains("MySQL 8.0"));
    }

    #[test]
    fn test_health_check_result_empty_version() {
        let result = HealthCheckResult {
            version: String::new(),
            db_host: None,
            uptime_seconds: None,
            tls_metadata: None,
        };

        assert_eq!(result.version, "");
        assert!(result.tls_metadata.is_none());
    }

    #[test]
    fn test_health_check_result_with_full_tls_metadata() {
        let tls_metadata = TlsMetadata {
            version: Some("TLSv1.2".to_string()),
            cipher: Some("ECDHE-RSA-AES128-GCM-SHA256".to_string()),
            cert_subject: Some("CN=db.example.com".to_string()),
            cert_issuer: Some("CN=Example CA".to_string()),
            cert_expiry_days: Some(90),
        };

        let result = HealthCheckResult {
            version: "PostgreSQL 13.0 in recovery mode".to_string(),
            db_host: Some("replica-1".to_string()),
            uptime_seconds: Some(900),
            tls_metadata: Some(tls_metadata),
        };

        assert!(result.version.contains("recovery mode"));
        assert_eq!(result.db_host, Some("replica-1".to_string()));
        let tls = result.tls_metadata.as_ref().unwrap();
        assert_eq!(tls.cert_subject.as_ref().unwrap(), "CN=db.example.com");
        assert_eq!(tls.cert_issuer.as_ref().unwrap(), "CN=Example CA");
        assert_eq!(tls.cert_expiry_days.unwrap(), 90);
    }

    #[test]
    fn test_health_check_result_mysql_read_only() {
        let result = HealthCheckResult {
            version: "MySQL 8.0.30 read-only".to_string(),
            db_host: None,
            uptime_seconds: None,
            tls_metadata: None,
        };

        assert!(result.version.contains("read-only"));
    }

    #[test]
    fn test_health_check_result_version_with_special_chars() {
        let result = HealthCheckResult {
            version: "PostgreSQL 15.0 (Ubuntu 15.0-1.pgdg22.04+1)".to_string(),
            db_host: None,
            uptime_seconds: None,
            tls_metadata: None,
        };

        assert!(result.version.contains("Ubuntu"));
        assert!(result.version.contains("pgdg22.04"));
    }
}