coviz 0.1.0

Source code logic and call graph visualizer for Go and Rust.
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

use coviz::{
    AnalysisOptions, Language, analyze_path, analyze_path_with_options, render_dot, render_json,
};

#[test]
fn analyzes_go_fixture() {
    let analysis = analyze_path("tests/fixtures/go", Some(Language::Go)).unwrap();

    let names: Vec<_> = analysis
        .functions
        .iter()
        .map(|function| function.name.as_str())
        .collect();
    assert_eq!(names, ["main", "serve", "worker", "ignored"]);

    let call_names: Vec<_> = analysis
        .calls
        .iter()
        .map(|call| {
            let caller = function_name(&analysis, &call.caller);
            let callee = function_name(&analysis, &call.callee);
            (caller, callee, call.line)
        })
        .collect();
    assert_eq!(
        call_names,
        [
            ("main", "serve", 4),
            ("main", "worker", 5),
            ("serve", "worker", 9),
        ]
    );
}

#[test]
fn analyzes_rust_fixture() {
    let analysis = analyze_path("tests/fixtures/rust", Some(Language::Rust)).unwrap();

    let names: Vec<_> = analysis
        .functions
        .iter()
        .map(|function| function.name.as_str())
        .collect();
    assert_eq!(names, ["entry", "helper", "target", "target"]);

    let call_names: Vec<_> = analysis
        .calls
        .iter()
        .map(|call| {
            let caller = function_name(&analysis, &call.caller);
            let callee = function_name(&analysis, &call.callee);
            (caller, callee, call.line)
        })
        .collect();
    assert_eq!(
        call_names,
        [
            ("entry", "helper", 2),
            ("entry", "target", 3),
            ("helper", "target", 7),
        ]
    );
}

#[test]
fn renders_outputs_from_analysis() {
    let analysis = analyze_path("tests/fixtures/go", Some(Language::Go)).unwrap();

    let dot = render_dot(&analysis);
    assert!(dot.starts_with("digraph coviz {\n"));
    assert!(dot.contains("\"f0\" -> \"f1\""));

    let json = render_json(&analysis).unwrap();
    assert!(json.contains("\"functions\""));
    assert!(json.contains("\"calls\""));
}

#[test]
fn analyzes_mixed_directory_when_language_is_unspecified() {
    let analysis = analyze_path("tests/fixtures", None).unwrap();

    assert_eq!(analysis.functions.len(), 14);
    assert_eq!(analysis.calls.len(), 10);
}

#[test]
fn can_exclude_test_files_and_cfg_test_code() {
    let analysis = analyze_path_with_options(
        "tests/fixtures/filter-tests",
        None,
        AnalysisOptions::without_tests(),
    )
    .unwrap();

    let names: Vec<_> = analysis
        .functions
        .iter()
        .map(|function| function.name.as_str())
        .collect();
    assert_eq!(names, ["main", "helper", "production", "shared"]);
    assert!(
        analysis
            .functions
            .iter()
            .all(|function| !function.file.ends_with("_test.go"))
    );
    assert!(
        analysis
            .functions
            .iter()
            .all(|function| function.name != "hidden_test")
    );
}

fn function_name<'a>(analysis: &'a coviz::Analysis, id: &str) -> &'a str {
    analysis
        .functions
        .iter()
        .find(|function| function.id == id)
        .map(|function| function.name.as_str())
        .unwrap()
}