gomod-parser 0.5.2

Simple go.mod parser
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
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141

use gomod_parser::GoMod;
use std::collections::HashMap;
use std::fs::read_to_string;
use std::path::PathBuf;
use std::str::FromStr;

fn get_test_file_path(file_name: &str) -> PathBuf {
    let d = PathBuf::from(env!("CARGO_MANIFEST_DIR"));
    d.join(format!("tests/data/{file_name}"))
}

fn get_test_file_content(file_name: &str) -> String {
    let path = get_test_file_path(file_name);
    read_to_string(path).unwrap()
}

#[test]
fn test_parse_on_compress() {
    let file_content = get_test_file_content("compress.mod");
    let gomod = file_content.parse::<GoMod>().unwrap();

    assert_eq!(gomod.module, "github.com/klauspost/compress".to_string());
}

#[test]
fn test_parse_on_docker_docs() {
    let file_content = get_test_file_content("docker_docs.mod");
    let gomod = file_content.parse::<GoMod>().unwrap();

    assert_eq!(gomod.module, "github.com/docker/docs".to_string());
}

#[test]
fn test_from_str_on_docker_docs() {
    let file_content = get_test_file_content("docker_docs.mod");
    let gomod = GoMod::from_str(&file_content).unwrap();

    assert_eq!(gomod.module, "github.com/docker/docs".to_string());
}

#[test]
fn test_parse_on_iris() {
    let file_content = get_test_file_content("iris.mod");
    let gomod = file_content.parse::<GoMod>().unwrap();

    assert_eq!(gomod.module, "github.com/kataras/iris/v12".to_string());
}

#[test]
fn test_parse_on_kubernetes() {
    let file_content = get_test_file_content("kubernetes.mod");
    let gomod = file_content.parse::<GoMod>().unwrap();

    assert_eq!(gomod.module, "k8s.io/kubernetes".to_string());
}

#[test]
fn test_parse_on_prometheus() {
    let file_content = get_test_file_content("prometheus.mod");
    let gomod = file_content.parse::<GoMod>().unwrap();

    assert_eq!(gomod.module, "github.com/prometheus/prometheus".to_string());
}

#[test]
fn test_parse_godebug() {
    let file_content = get_test_file_content("godebug.mod");
    let gomod = file_content.parse::<GoMod>().unwrap();

    assert_eq!(
        gomod.godebug,
        HashMap::from_iter([
            ("asynctimerchan".into(), "0".into()),
            ("default".into(), "go1.21".into()),
            ("panicnil".into(), "1".into()),
        ])
    );
}

#[test]
fn test_parse_tool() {
    let file_content = get_test_file_content("tool.mod");
    let gomod = file_content.parse::<GoMod>().unwrap();

    assert_eq!(
        gomod.tool,
        vec![
            "example.com/mymodule/cmd/mytool1",
            "example.com/mymodule/cmd/mytool2",
            "github.com/golangci/golangci-lint/v2/cmd/golangci-lint",
            "github.com/sqlc-dev/sqlc/cmd/sqlc",
            "go.temporal.io/sdk/contrib/tools/workflowcheck",
        ]
    );
}

#[test]
fn test_parse_ignore() {
    let file_content = get_test_file_content("ignore.mod");
    let gomod = file_content.parse::<GoMod>().unwrap();

    assert_eq!(gomod.module, "github.com/example/ignore".to_string());
    assert_eq!(
        gomod.ignore,
        vec![
            "./build".to_string(),
            "./testdata".to_string(),
            "./vendor/temp".to_string(),
            "./node_modules".to_string(),
        ]
    );
}

#[test]
fn test_carriage_return() {
    let file_content = get_test_file_content("compress.mod")
        .replace("\r", "") // Replace any current CR
        .replace("\n", "\r\n"); // Replace LF with CRLF

    let gomod = file_content.parse::<GoMod>().unwrap();

    assert_eq!(gomod.module, "github.com/klauspost/compress".to_string());
}

#[test]
fn test_no_trailing_newline() {
    let file_content = get_test_file_content("tool.mod").trim().to_string(); // remove trailing newline

    let gomod = file_content.parse::<GoMod>().unwrap();

    assert_eq!(
        gomod.tool,
        vec![
            "example.com/mymodule/cmd/mytool1",
            "example.com/mymodule/cmd/mytool2",
            "github.com/golangci/golangci-lint/v2/cmd/golangci-lint",
            "github.com/sqlc-dev/sqlc/cmd/sqlc",
            "go.temporal.io/sdk/contrib/tools/workflowcheck",
        ]
    );
}