File: logging.rs

package info (click to toggle)
sccache 0.12.0-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 3,028 kB
  • sloc: sh: 358; cpp: 112; perl: 68; makefile: 35; ansic: 31
file content (117 lines) | stat: -rw-r--r-- 4,006 bytes parent folder | download
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
// Tests for logging functionality.
//
// Copyright 2025 Mozilla Foundation
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

#![deny(rust_2018_idioms)]

use regex::Regex;
use std::env;
use std::path::PathBuf;
use std::process::Command;
use tempfile::TempDir;

// Get the path to the sccache binary
fn sccache_bin() -> PathBuf {
    PathBuf::from(env!("CARGO_BIN_EXE_sccache"))
}

#[test]
#[serial_test::serial]
fn test_log_timestamp_format_without_millis() {
    // Test that without SCCACHE_LOG_MILLIS, timestamps have second precision
    let tempdir = TempDir::new().unwrap();

    let mut cmd = Command::new(sccache_bin());
    cmd.arg("--show-stats")
        .env("SCCACHE_LOG", "debug")
        .env("SCCACHE_DIR", tempdir.path())
        .env_remove("SCCACHE_LOG_MILLIS");

    let output = cmd.output().unwrap();
    let stderr = String::from_utf8_lossy(&output.stderr);

    // Pattern for timestamp without milliseconds: [2025-10-09T14:42:35Z DEBUG ...]
    let timestamp_regex = Regex::new(r"\[\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}Z\s+\w+\s+").unwrap();

    // Check that we have at least one log line with the expected format
    assert!(
        timestamp_regex.is_match(&stderr),
        "Expected timestamp format without milliseconds not found in stderr:\n{}",
        stderr
    );

    // Ensure NO milliseconds are present (no decimal point after seconds)
    let millis_regex = Regex::new(r"\[\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.\d+Z").unwrap();
    assert!(
        !millis_regex.is_match(&stderr),
        "Unexpected milliseconds found in timestamp when SCCACHE_LOG_MILLIS not set:\n{}",
        stderr
    );
}

#[test]
#[serial_test::serial]
fn test_log_timestamp_format_with_millis() {
    // Test that with SCCACHE_LOG_MILLIS, timestamps have millisecond precision
    let tempdir = TempDir::new().unwrap();

    let mut cmd = Command::new(sccache_bin());
    cmd.arg("--show-stats")
        .env("SCCACHE_LOG", "debug")
        .env("SCCACHE_LOG_MILLIS", "1")
        .env("SCCACHE_DIR", tempdir.path());

    let output = cmd.output().unwrap();
    let stderr = String::from_utf8_lossy(&output.stderr);

    // Pattern for timestamp with milliseconds: [2025-10-09T14:44:56.628Z DEBUG ...]
    let millis_regex =
        Regex::new(r"\[\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.\d{3}Z\s+\w+\s+").unwrap();

    // Check that we have at least one log line with millisecond precision
    assert!(
        millis_regex.is_match(&stderr),
        "Expected timestamp format with milliseconds not found in stderr:\n{}",
        stderr
    );
}

#[test]
#[serial_test::serial]
fn test_log_millis_flag_with_various_values() {
    // Test that SCCACHE_LOG_MILLIS accepts any value (not just "1")
    let tempdir = TempDir::new().unwrap();

    // Pattern for timestamp with milliseconds
    let millis_regex = Regex::new(r"\[\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.\d{3}Z").unwrap();

    for value in &["1", "true", "yes", "anything"] {
        let mut cmd = Command::new(sccache_bin());
        cmd.arg("--show-stats")
            .env("SCCACHE_LOG", "debug")
            .env("SCCACHE_LOG_MILLIS", value)
            .env("SCCACHE_DIR", tempdir.path());

        let output = cmd.output().unwrap();
        let stderr = String::from_utf8_lossy(&output.stderr);

        assert!(
            millis_regex.is_match(&stderr),
            "Expected timestamp with milliseconds for SCCACHE_LOG_MILLIS={}, but not found in:\n{}",
            value,
            stderr
        );
    }
}