big-code-analysis-cli 1.1.0

Tool to compute and export code metrics
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

//! End-to-end integration tests for `bca report html`.
//!
//! Drives the CLI binary against a real fixture and validates the
//! emitted HTML with the same `quick-xml` walker the per-file metrics
//! HTML output uses (see `tests/common/validators.rs`).

use assert_cmd::Command;
use predicates::prelude::*;
use tempfile::TempDir;

mod common;
use common::validators::assert_html_well_formed;

fn cli() -> Command {
    Command::cargo_bin("bca").expect("binary builds")
}

fn fixture_path() -> String {
    let manifest = env!("CARGO_MANIFEST_DIR");
    let workspace = std::path::Path::new(manifest)
        .parent()
        .expect("manifest dir has parent");
    workspace
        .join("tests/repositories/DeepSpeech/stats.py")
        .to_str()
        .expect("path is utf-8")
        .to_string()
}

#[test]
fn report_html_help_lists_format_top_and_strip_prefix() {
    cli()
        .args(["report", "--help"])
        .assert()
        .success()
        .stdout(predicate::str::contains("html"))
        .stdout(predicate::str::contains("markdown"))
        .stdout(predicate::str::contains("--top"))
        .stdout(predicate::str::contains("--strip-prefix"));
}

#[test]
fn report_html_to_stdout_is_well_formed() {
    let output = cli()
        .args(["--paths", &fixture_path(), "report", "html"])
        .output()
        .expect("invocation succeeds");
    assert!(
        output.status.success(),
        "stderr: {}",
        String::from_utf8_lossy(&output.stderr)
    );
    let body = String::from_utf8(output.stdout).expect("output is UTF-8");
    assert!(body.contains("<!doctype html>"));
    assert!(body.contains("<h1>Code Quality Metrics Summary</h1>"));
    assert!(body.contains("<h2>Python</h2>"));
    assert_html_well_formed(&body);
}

#[test]
fn report_html_to_file_is_well_formed() {
    let dir = TempDir::new().expect("tempdir");
    let out = dir.path().join("report.html");
    cli()
        .args([
            "--paths",
            &fixture_path(),
            "report",
            "html",
            "--output",
            out.to_str().expect("utf-8"),
        ])
        .assert()
        .success();
    let body = std::fs::read_to_string(&out).expect("read report");
    assert!(body.contains("<!doctype html>"));
    assert!(body.contains("class=\"hotspot\""));
    assert_html_well_formed(&body);
}

#[test]
fn report_html_top_zero_rejected() {
    cli()
        .args(["report", "html", "--top", "0", "--paths", &fixture_path()])
        .assert()
        .failure()
        .stderr(predicate::str::contains("--top"));
}

#[test]
fn report_html_with_no_paths_is_well_formed() {
    let output = cli()
        .args(["report", "html"])
        .output()
        .expect("invocation succeeds");
    assert!(output.status.success());
    let body = String::from_utf8(output.stdout).expect("utf-8");
    assert!(body.contains("<h1>Code Quality Metrics Summary</h1>"));
    // No tables when there is nothing to report.
    assert!(!body.contains("class=\"hotspot\""));
    assert_html_well_formed(&body);
}

#[test]
fn report_html_is_deterministic_across_runs() {
    let fp = fixture_path();
    let outputs: Vec<Vec<u8>> = (0..3)
        .map(|_| {
            cli()
                .args(["--paths", &fp, "report", "html"])
                .output()
                .expect("invocation")
                .stdout
        })
        .collect();
    assert!(
        outputs.windows(2).all(|w| w[0] == w[1]),
        "non-deterministic HTML report across 3 runs"
    );
}

#[test]
fn report_html_strip_prefix_removes_path_prefix() {
    let fp = fixture_path();
    let prefix = {
        let idx = fp
            .find("DeepSpeech/")
            .expect("fixture contains DeepSpeech/");
        &fp[..idx]
    };
    let output = cli()
        .args(["--paths", &fp, "report", "html", "--strip-prefix", prefix])
        .output()
        .expect("invocation");
    assert!(output.status.success());
    let body = String::from_utf8(output.stdout).expect("utf-8");
    assert!(
        body.contains("DeepSpeech/stats.py"),
        "stripped path should appear in HTML report"
    );
    assert!(
        !body.contains(&fp),
        "full unstripped path should not appear: {fp}"
    );
    assert_html_well_formed(&body);
}