setu-cli 0.1.6

A quick markdown link checker
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
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165

use setu_cli::{
    LinkCheckResult, LinkStatus, LocalLinkStatus, MarkdownCheckResult, RemoteLinkStatus,
    get_markdowns, parse_markdown,
};

#[test]
fn test_get_markdowns() {
    let markdowns = get_markdowns("./tests");

    assert!(markdowns.iter().count() == 1);
}

#[tokio::test]
async fn test_parse_markdown_no_concerns() {
    let markdowns = get_markdowns("./tests");

    assert_eq!(markdowns.len(), 1);

    let result = parse_markdown(markdowns.first().unwrap(), &Some(vec![])).await;

    assert!(result.success, "The file parsing operation itself failed");
    assert_eq!(
        result.checks.len(),
        6,
        "Should have found exactly 5 links in test.md"
    );

    let valid_local_check = get_result(
        &result,
        "./real.txt".to_owned(),
        "Could not find the link to ./real.txt in results",
    );

    assert!(
        matches!(
            valid_local_check.status,
            LinkStatus::Local(LocalLinkStatus::Valid)
        ),
        "Expected ./real.txt to be classified as a Valid Local link"
    );

    let broken_local_check = get_result(
        &result,
        "./does_not_exist.png".to_owned(),
        "Could not find the link to ./does_not_exist.png in results",
    );
    assert!(
        matches!(
            broken_local_check.status,
            LinkStatus::Local(LocalLinkStatus::DoesNotExist)
        ),
        "Expected ./does_not_exist.png to be flagged as an Invalid Local link"
    );

    let remote_check_ok = get_result(
        &result,
        "https://www.google.com".to_owned(),
        "Could not find the link to google in results",
    );

    if let LinkStatus::Remote(RemoteLinkStatus::Invalid(err)) = &remote_check_ok.status {
        panic!("Google link failed unexpectedly with status: {}", err);
    }

    let remote_check_404 = get_result(
        &result,
        "https://simulatehttpcode.vercel.app/statuscode?q=404".to_owned(),
        "Could not find the link to the 404 page in results",
    );

    if let LinkStatus::Remote(RemoteLinkStatus::Invalid(err)) = &remote_check_404.status {
        panic!("404 link failed unexpectedly with status: {}", err);
    }
}

#[tokio::test]
async fn test_parse_markdown_with_404_concerns() {
    let markdowns = get_markdowns("./tests");

    assert_eq!(markdowns.len(), 1);

    let concerns = vec![404];

    let result = parse_markdown(markdowns.first().unwrap(), &Some(concerns.clone())).await;

    let remote_check_ok = get_result(
        &result,
        "https://www.google.com".to_owned(),
        "Could not find the link to google in results",
    );

    if let LinkStatus::Remote(RemoteLinkStatus::Invalid(err)) = &remote_check_ok.status {
        panic!("Google link failed unexpectedly with status: {}", err);
    }

    // This should fail
    let remote_check_404 = get_result(
        &result,
        "https://simulatehttpcode.vercel.app/statuscode?q=404".to_owned(),
        "Could not find the link to the 404 page in results",
    );

    if let LinkStatus::Remote(RemoteLinkStatus::Reachable) = &remote_check_404.status {
        panic!(
            "404 link failed unexpectedly with concerns: {:?}",
            &concerns
        );
    }
}

#[tokio::test]
async fn test_parse_markdown_with_many_concerns() {
    let markdowns = get_markdowns("./tests");

    assert_eq!(markdowns.len(), 1);

    let concerns = vec![404, 500];

    let result = parse_markdown(markdowns.first().unwrap(), &Some(concerns.clone())).await;

    let remote_check_ok = get_result(
        &result,
        "https://www.google.com".to_owned(),
        "Could not find the link to google in results",
    );

    if let LinkStatus::Remote(RemoteLinkStatus::Invalid(err)) = &remote_check_ok.status {
        panic!("Google link failed unexpectedly with status: {}", err);
    }

    let remote_check_404 = get_result(
        &result,
        "https://simulatehttpcode.vercel.app/statuscode?q=404".to_owned(),
        "Could not find the link to the 404 page in results",
    );

    if let LinkStatus::Remote(RemoteLinkStatus::Reachable) = &remote_check_404.status {
        panic!(
            "404 link failed unexpectedly with concerns: {:?}",
            &concerns
        );
    }

    let remote_check_500 = get_result(
        &result,
        "https://simulatehttpcode.vercel.app/statuscode?q=500".to_owned(),
        "Could not find the link to the 500 page in results",
    );

    if let LinkStatus::Remote(RemoteLinkStatus::Reachable) = &remote_check_500.status {
        panic!(
            "500 link failed unexpectedly with concerns: {:?}",
            &concerns
        );
    }
}

fn get_result(result: &MarkdownCheckResult, raw_link: String, expect: &str) -> LinkCheckResult {
    result
        .checks
        .iter()
        .find(|c| c.raw_link == raw_link)
        .expect(expect)
        .clone()
}