glide-logger 0.1.1

Logging for Valkey GLIDE. This crate isn't intended to be used directly.
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

/**
 * Copyright Valkey GLIDE Project Contributors - SPDX Identifier: Apache-2.0
 */
use test_env_helpers::*;

#[cfg(test)]
#[after_all]
#[before_all]
mod tests {
    use glide_logger::{init, log_debug, log_trace};
    use rand::{Rng, distributions::Alphanumeric};
    use std::{
        fs::{read_dir, read_to_string, remove_dir_all},
        path::Path,
    };
    const FILE_DIRECTORY: &str = "glide-logs";

    fn generate_random_string(length: usize) -> String {
        rand::thread_rng()
            .sample_iter(&Alphanumeric)
            .take(length)
            .map(char::from)
            .collect()
    }

    fn get_file_contents(file_name: &str) -> String {
        let files = read_dir(FILE_DIRECTORY).unwrap();
        let file = files
            .into_iter()
            .find(|path| {
                path.as_ref()
                    .unwrap()
                    .path()
                    .file_name()
                    .unwrap()
                    .to_str()
                    .unwrap()
                    .starts_with(file_name)
            })
            .unwrap();
        read_to_string(file.unwrap().path()).unwrap()
    }

    #[test]
    fn init_does_not_create_log_directory_when_console_init() {
        init(Some(glide_logger::Level::Trace), None);
        let dir_exists = Path::new(FILE_DIRECTORY).is_dir();
        assert!(!dir_exists);
    }

    #[test]
    fn log_to_console_works_after_multiple_inits_diff_log_level() {
        let identifier = generate_random_string(10);
        init(Some(glide_logger::Level::Trace), None);
        init(Some(glide_logger::Level::Debug), None);
        // you should see in the console something like '2023-07-07T06:57:54.446236Z DEBUG glide_logger: e49NaJ5J41 - foo'
        log_debug(identifier.clone(), "foo");
        // make sure that something like '2023-07-07T06:57:54.446236Z DEBUG glide_logger: e49NaJ5J41 - boo' does not appear
        log_trace(identifier, "boo");
    }

    #[test]
    fn log_to_console_does_not_create_log_directory_when_console_init() {
        let identifier = generate_random_string(10);
        init(Some(glide_logger::Level::Trace), None);
        // you should see in the console something like '2023-07-07T06:57:54.446236Z TRACE glide_logger: e49NaJ5J41 - foo'
        log_trace(identifier.clone(), "foo");
        let dir_exists = Path::new(FILE_DIRECTORY).is_dir();
        assert!(!dir_exists);
    }

    #[test]
    fn log_to_file_works_after_multiple_inits() {
        let identifier = generate_random_string(10);
        init(Some(glide_logger::Level::Trace), Some(identifier.as_str()));
        init(Some(glide_logger::Level::Debug), Some(identifier.as_str()));
        log_debug(identifier.clone(), "foo");
        let contents = get_file_contents(identifier.as_str());
        assert!(
            contents.contains(identifier.as_str()),
            "Contents: {contents}"
        );
        assert!(contents.contains("foo"), "Contents: {contents}");
    }

    #[test]
    fn log_to_file_works_after_console_init() {
        let identifier = generate_random_string(10);
        init(Some(glide_logger::Level::Trace), None);
        init(Some(glide_logger::Level::Trace), Some(identifier.as_str()));
        let identifier = generate_random_string(10);
        init(Some(glide_logger::Level::Debug), Some(identifier.as_str()));
        log_debug(identifier.clone(), "foo");
        log_trace(identifier.clone(), "boo");
        let contents = get_file_contents(identifier.as_str());
        assert!(
            contents.contains(identifier.as_str()),
            "Contents: {contents}"
        );
        assert!(contents.contains("foo"), "Contents: {contents}");
        assert!(!contents.contains("boo"));
    }

    #[test]
    fn log_to_file_disabled_after_console_init() {
        let identifier = generate_random_string(10);
        init(Some(glide_logger::Level::Trace), Some(identifier.as_str()));
        log_trace(identifier.clone(), "foo");
        init(Some(glide_logger::Level::Trace), None);
        log_trace(identifier.clone(), "boo");
        let contents = get_file_contents(identifier.as_str());
        assert!(
            contents.contains(identifier.as_str()),
            "Contents: {contents}"
        );
        assert!(contents.contains("foo"), "Contents: {contents}");
        assert!(!contents.contains("boo"), "Contents: {contents}");
    }

    fn clean() -> Result<(), std::io::Error> {
        remove_dir_all(FILE_DIRECTORY)
    }

    fn after_all() {
        clean().expect("Cannot remove log directory");
    }

    fn before_all() {
        let _ = clean();
    }
}