bfree 0.1.21

bfree - memory stats for humans
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

use bfree::core::memory_stats::MemoryStats;
use bfree::render::structured::{StructuredFormat, StructuredView, render};
use serde_json::Value as JsonValue;
use serde_yaml::Value as YamlValue;

#[test]
fn renders_compact_json_shape_and_values() {
    let gib = 1024_u64.pow(3);
    let stats = MemoryStats {
        mem_total: 10 * gib,
        mem_available: 6 * gib,
        mem_cached: 2 * gib,
        mem_sreclaimable: 1024,
        mem_shmem: 512,
        swap_total: 2 * gib,
        swap_free: gib,
    };

    let out = render(&stats, StructuredFormat::Json, StructuredView::Compact)
        .expect("compact json should render");
    let json: JsonValue = serde_json::from_str(&out).expect("json should parse");

    assert_eq!(json["memory"]["total_bytes"], 10 * gib);
    assert_eq!(json["memory"]["used_bytes"], 4 * gib);
    assert_eq!(json["memory"]["available_bytes"], 6 * gib);
    assert_eq!(json["memory"]["used"]["percent"], 40.0);
    assert_eq!(json["memory"]["available"]["percent"], 60.0);

    assert_eq!(json["swap"]["total_bytes"], 2 * gib);
    assert_eq!(json["swap"]["used_bytes"], gib);
    assert_eq!(json["swap"]["used"]["percent"], 50.0);
}

#[test]
fn renders_extended_json_includes_cache_breakdown_and_swap_free() {
    let gib = 1024_u64.pow(3);
    let stats = MemoryStats {
        mem_total: 10 * gib,
        mem_available: 6 * gib,
        mem_cached: 2 * gib,
        mem_sreclaimable: gib,
        mem_shmem: 512 * 1024 * 1024,
        swap_total: 2 * gib,
        swap_free: gib,
    };

    let out = render(&stats, StructuredFormat::Json, StructuredView::Extended)
        .expect("extended json should render");
    let json: JsonValue = serde_json::from_str(&out).expect("json should parse");

    assert_eq!(json["memory"]["cache_bytes"], 2684354560_u64);
    assert_eq!(json["memory"]["cache"]["percent"], 25.0);
    assert_eq!(json["swap"]["free_bytes"], gib);
    assert_eq!(json["swap"]["free"]["percent"], 50.0);
    assert_eq!(json["cache_breakdown"]["cached_bytes"], 2 * gib);
    assert_eq!(json["cache_breakdown"]["sreclaimable_bytes"], gib);
    assert_eq!(json["cache_breakdown"]["shmem_bytes"], 512 * 1024 * 1024);
}

#[test]
fn renders_compact_yaml_shape_and_values() {
    let mib = 1024_u64.pow(2);
    let stats = MemoryStats {
        mem_total: 900 * mib,
        mem_available: 300 * mib,
        mem_cached: 0,
        mem_sreclaimable: 0,
        mem_shmem: 0,
        swap_total: 0,
        swap_free: 0,
    };

    let out = render(&stats, StructuredFormat::Yaml, StructuredView::Compact)
        .expect("compact yaml should render");
    let yaml: YamlValue = serde_yaml::from_str(&out).expect("yaml should parse");

    assert_eq!(yaml["memory"]["total_bytes"], 900 * mib);
    assert_eq!(yaml["memory"]["used_bytes"], 600 * mib);
    assert_eq!(yaml["memory"]["used"]["percent"], 66.66666666666667_f64);
    assert_eq!(yaml["swap"]["total_bytes"], 0);
    assert_eq!(yaml["swap"]["used"]["percent"], 0.0_f64);
}

#[test]
fn renders_extended_yaml_with_zero_swap_free_percent() {
    let stats = MemoryStats {
        mem_total: 1024,
        mem_available: 512,
        mem_cached: 256,
        mem_sreclaimable: 128,
        mem_shmem: 64,
        swap_total: 0,
        swap_free: 0,
    };

    let out = render(&stats, StructuredFormat::Yaml, StructuredView::Extended)
        .expect("extended yaml should render");
    let yaml: YamlValue = serde_yaml::from_str(&out).expect("yaml should parse");

    assert_eq!(yaml["swap"]["free"]["percent"], 0.0_f64);
    assert_eq!(yaml["cache_breakdown"]["cached_bytes"], 256);
}