kimun 0.35.0

Code metrics tool — health score, complexity, duplication, hotspots, ownership
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
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162

use super::*;
use crate::deps::graph::FileGraph;

fn go(path: &str, text: &str) -> Source {
    Source {
        path: PathBuf::from(path),
        language: "Go".to_string(),
        text: text.to_string(),
        templates: Vec::new(),
    }
}

fn layout(modules: &[(&str, &str)]) -> Layout {
    Layout {
        go_modules: modules
            .iter()
            .map(|(dir, module)| (PathBuf::from(dir), module.to_string()))
            .collect(),
        ..Layout::default()
    }
}

/// The paths `from` uses in the graph of `sources`, sorted.
fn used(sources: &[Source], layout: &Layout, from: &str) -> Vec<String> {
    let graph = FileGraph::build(sources, layout, &|_, _| false);
    let mut used: Vec<String> = graph.edges()[Path::new(from)]
        .iter()
        .map(|p| p.to_string_lossy().into_owned())
        .collect();
    used.sort();
    used
}

const MODULE: &[(&str, &str)] = &[("", "example.com/proj")];

#[test]
fn import_leads_to_every_file_directly_in_the_package() {
    let sources = [
        go(
            "main.go",
            "package main\n\nimport \"example.com/proj/pkg/store\"\n",
        ),
        go("pkg/store/store.go", "package store\n"),
        go("pkg/store/index.go", "package store\n"),
        go("pkg/store/sql/query.go", "package sql\n"),
        go("pkg/storefront/page.go", "package storefront\n"),
    ];
    assert_eq!(
        used(&sources, &layout(MODULE), "main.go"),
        ["pkg/store/index.go", "pkg/store/store.go"]
    );
}

#[test]
fn test_files_and_ignored_files_are_not_what_a_package_offers() {
    let sources = [
        go(
            "main.go",
            "package main\n\nimport (\n\t\"fmt\"\n\tst \"example.com/proj/store\"\n)\n",
        ),
        go("store/store.go", "package store\n"),
        go("store/store_test.go", "package store\n"),
        go("store/_draft.go", "package store\n"),
    ];
    assert_eq!(
        used(&sources, &layout(MODULE), "main.go"),
        ["store/store.go"]
    );
}

#[test]
fn external_test_package_uses_the_package_beside_it() {
    let sources = [
        go("store/store.go", "package store\n"),
        go(
            "store/api_test.go",
            "package store_test\n\nimport \"example.com/proj/store\"\n",
        ),
    ];
    assert_eq!(
        used(&sources, &layout(MODULE), "store/api_test.go"),
        ["store/store.go"]
    );
}

#[test]
fn import_of_the_module_path_is_the_package_at_its_root() {
    let sources = [
        go(
            "cmd/tool/main.go",
            "package main\n\nimport \"example.com/proj\"\n",
        ),
        go("proj.go", "package proj\n"),
        go("cmd/other/main.go", "package main\n"),
    ];
    assert_eq!(
        used(&sources, &layout(MODULE), "cmd/tool/main.go"),
        ["proj.go"]
    );
}

#[test]
fn module_path_matches_whole_segments_only() {
    let sources = [
        go(
            "main.go",
            "package main\n\nimport \"example.com/project/store\"\n",
        ),
        go("ect/store/store.go", "package store\n"),
        go("store/store.go", "package store\n"),
    ];
    assert!(used(&sources, &layout(MODULE), "main.go").is_empty());
}

#[test]
fn each_module_of_the_repository_resolves_from_its_own_directory() {
    let modules = [
        ("services/api", "example.com/api"),
        ("libs/core", "example.com/core"),
        ("libs/core/extra", "example.com/core/extra"),
    ];
    let sources = [
        go(
            "services/api/main.go",
            "package main\n\nimport (\n\t\"example.com/core/model\"\n\t\"example.com/core/extra/codec\"\n\t\"example.com/api/internal/db\"\n)\n",
        ),
        go("libs/core/model/model.go", "package model\n"),
        go("libs/core/extra/codec/codec.go", "package codec\n"),
        go("services/api/internal/db/db.go", "package db\n"),
    ];
    assert_eq!(
        used(&sources, &layout(&modules), "services/api/main.go"),
        [
            "libs/core/extra/codec/codec.go",
            "libs/core/model/model.go",
            "services/api/internal/db/db.go"
        ]
    );
}

#[test]
fn nothing_resolves_without_a_module_or_outside_it() {
    let sources = [
        go(
            "main.go",
            "package main\n\nimport (\n\t\"fmt\"\n\t\"example.com/proj/store\"\n)\n",
        ),
        go("store/store.go", "package store\n"),
    ];
    assert!(used(&sources, &layout(&[]), "main.go").is_empty());
    let other = layout(&[("", "example.com/other")]);
    assert!(used(&sources, &other, "main.go").is_empty());
}

#[test]
fn files_of_one_package_have_no_edges_between_them() {
    let sources = [
        go("store/store.go", "package store\n"),
        go("store/index.go", "package store\n"),
    ];
    assert!(used(&sources, &layout(MODULE), "store/store.go").is_empty());
}