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

use serde::{Deserialize, Serialize};

/// Function or method definition discovered in source.
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct Function {
    pub id: String,
    pub name: String,
    pub file: String,
    pub line: usize,
}

/// Resolved call expression between two discovered functions.
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct Call {
    pub caller: String,
    pub callee: String,
    pub file: String,
    pub line: usize,
}

/// Complete analysis result.
#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)]
pub struct Analysis {
    pub functions: Vec<Function>,
    pub calls: Vec<Call>,
}

#[cfg(test)]
mod tests {
    use super::{Analysis, Function};

    #[test]
    fn analysis_defaults_to_empty_graph() {
        let analysis = Analysis::default();
        assert!(analysis.functions.is_empty());
        assert!(analysis.calls.is_empty());
    }

    #[test]
    fn model_serializes_expected_fields() {
        let function = Function {
            id: "f0".to_string(),
            name: "main".to_string(),
            file: "main.go".to_string(),
            line: 3,
        };
        let json = serde_json::to_string(&function).unwrap();
        assert!(json.contains("\"id\":\"f0\""));
        assert!(json.contains("\"name\":\"main\""));
    }
}