netsuke-build 0.1.0-beta3

A YAML-powered Ninja/Jinja hybrid build system.
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

//! Verify bounded legacy-recipe operation metric registrations.

use super::{ConfigMetricsRecorder, SnapshotEntry};
use metrics::{counter, histogram};
use metrics_util::MetricKind;
use netsuke::runner::{LEGACY_RECIPE_EXECUTION_DURATION, LEGACY_RECIPE_EXECUTIONS_TOTAL};

/// Fixed four-label layout used by legacy-recipe operation metrics.
type LegacyMetricLabels = [(&'static str, &'static str); 4];

/// Record valid and invalid legacy-recipe operation metric registrations.
fn record_legacy_recipe_operation_series() {
    counter!(
        LEGACY_RECIPE_EXECUTIONS_TOTAL,
        "operation" => "build",
        "recipe_shell" => "powershell",
        "outcome" => "success",
        "failure_category" => "none"
    )
    .increment(1);
    histogram!(
        LEGACY_RECIPE_EXECUTION_DURATION,
        "operation" => "ninja_tool",
        "recipe_shell" => "bash",
        "outcome" => "error",
        "failure_category" => "ninja_io"
    )
    .record(0.01);
    counter!(
        LEGACY_RECIPE_EXECUTIONS_TOTAL,
        "operation" => "build",
        "recipe_shell" => "powershell",
        "outcome" => "success"
    )
    .increment(1);
    counter!(
        LEGACY_RECIPE_EXECUTIONS_TOTAL,
        "operation" => "build",
        "recipe_shell" => "powershell",
        "outcome" => "success",
        "failure_category" => "none",
        "extra" => "rejected"
    )
    .increment(1);
    histogram!(
        LEGACY_RECIPE_EXECUTION_DURATION,
        "operation" => "unbounded",
        "recipe_shell" => "powershell",
        "outcome" => "success",
        "failure_category" => "none"
    )
    .record(0.02);
}

/// Retain only exact bounded legacy-recipe operation metric registrations.
#[test]
fn recorder_retains_bounded_legacy_recipe_operation_series() {
    let recorder = ConfigMetricsRecorder::new();
    let snapshotter = recorder.snapshotter();

    metrics::with_local_recorder(&recorder, record_legacy_recipe_operation_series);

    let snapshot = snapshotter.snapshot().into_vec();
    assert_eq!(
        snapshot.len(),
        2,
        "only exact bounded legacy-recipe operation series are retained"
    );
    assert_legacy_recipe_metric(
        &snapshot,
        MetricKind::Counter,
        LEGACY_RECIPE_EXECUTIONS_TOTAL,
        [
            ("operation", "build"),
            ("recipe_shell", "powershell"),
            ("outcome", "success"),
            ("failure_category", "none"),
        ],
    );
    assert_legacy_recipe_metric(
        &snapshot,
        MetricKind::Histogram,
        LEGACY_RECIPE_EXECUTION_DURATION,
        [
            ("operation", "ninja_tool"),
            ("recipe_shell", "bash"),
            ("outcome", "error"),
            ("failure_category", "ninja_io"),
        ],
    );
}

/// Assert that one retained legacy-recipe metric has exactly `labels`.
fn assert_legacy_recipe_metric(
    snapshot: &[SnapshotEntry],
    kind: MetricKind,
    metric_name: &str,
    labels: LegacyMetricLabels,
) {
    assert!(
        snapshot.iter().any(|entry| {
            entry.0.kind() == kind
                && entry.0.key().name() == metric_name
                && entry.0.key().labels().count() == labels.len()
                && labels.iter().all(|(key, value)| {
                    entry
                        .0
                        .key()
                        .labels()
                        .any(|label| label.key() == *key && label.value() == *value)
                })
        }),
        "expected retained {metric_name} with bounded labels {labels:?}: {snapshot:?}"
    );
}