projd 0.1.0

Scan software projects and generate structured reports.
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

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

#[test]
fn prints_help() {
    let mut cmd = Command::cargo_bin("projd").expect("binary exists");

    cmd.arg("--help")
        .assert()
        .success()
        .stdout(predicate::str::contains("Scan software projects"));
}

#[test]
fn scan_prints_markdown_to_stdout_by_default() {
    let fixture = ProjectFixture::new();

    let mut cmd = Command::cargo_bin("projd").expect("binary exists");

    cmd.arg("scan")
        .arg(fixture.path())
        .assert()
        .success()
        .stdout(predicate::str::contains("# Project Report"));
}

#[test]
fn scan_prints_json_to_stdout() {
    let fixture = ProjectFixture::new();

    let mut cmd = Command::cargo_bin("projd").expect("binary exists");

    cmd.arg("scan")
        .arg(fixture.path())
        .arg("--format")
        .arg("json")
        .assert()
        .success()
        .stdout(predicate::str::contains("\"identity\""));
}

#[test]
fn scan_writes_markdown_output_file() {
    let fixture = ProjectFixture::new();
    let output = fixture.path().join("report.md");

    let mut cmd = Command::cargo_bin("projd").expect("binary exists");

    cmd.arg("scan")
        .arg(fixture.path())
        .arg("--output")
        .arg(&output)
        .assert()
        .success()
        .stdout(predicate::str::is_empty());

    let content = fs::read_to_string(output).expect("read report");
    assert!(content.contains("# Project Report"));
}

#[test]
fn scan_infers_json_output_from_extension() {
    let fixture = ProjectFixture::new();
    let output = fixture.path().join("scan.json");

    let mut cmd = Command::cargo_bin("projd").expect("binary exists");

    cmd.arg("scan")
        .arg(fixture.path())
        .arg("--output")
        .arg(&output)
        .assert()
        .success()
        .stdout(predicate::str::is_empty());

    let content = fs::read_to_string(output).expect("read json");
    assert!(content.contains("\"identity\""));
}

#[test]
fn scan_refuses_to_overwrite_existing_output_file() {
    let fixture = ProjectFixture::new();
    let output = fixture.path().join("report.md");
    fs::write(&output, "existing").expect("write existing output");

    let mut cmd = Command::cargo_bin("projd").expect("binary exists");

    cmd.arg("scan")
        .arg(fixture.path())
        .arg("--output")
        .arg(&output)
        .assert()
        .failure()
        .stderr(predicate::str::contains("refusing to overwrite"));

    assert_eq!(fs::read_to_string(output).expect("read output"), "existing");
}

#[test]
fn scan_overwrites_existing_output_file_when_requested() {
    let fixture = ProjectFixture::new();
    let output = fixture.path().join("report.md");
    fs::write(&output, "existing").expect("write existing output");

    let mut cmd = Command::cargo_bin("projd").expect("binary exists");

    cmd.arg("scan")
        .arg(fixture.path())
        .arg("--output")
        .arg(&output)
        .arg("--overwrite")
        .assert()
        .success();

    let content = fs::read_to_string(output).expect("read output");
    assert!(content.contains("# Project Report"));
    assert_ne!(content, "existing");
}

#[test]
fn explicit_format_overrides_output_extension() {
    let fixture = ProjectFixture::new();
    let output = fixture.path().join("report.txt");

    let mut cmd = Command::cargo_bin("projd").expect("binary exists");

    cmd.arg("scan")
        .arg(fixture.path())
        .arg("--format")
        .arg("json")
        .arg("--output")
        .arg(&output)
        .assert()
        .success();

    let content = fs::read_to_string(output).expect("read output");
    assert!(content.contains("\"identity\""));
}

struct ProjectFixture {
    temp_dir: TempDir,
}

impl ProjectFixture {
    fn new() -> Self {
        let temp_dir = tempfile::tempdir().expect("create temp dir");
        fs::write(
            temp_dir.path().join("Cargo.toml"),
            "[package]\nname = \"fixture\"\nversion = \"0.1.0\"\n",
        )
        .expect("write manifest");
        fs::write(temp_dir.path().join("README.md"), "# Fixture\n").expect("write readme");
        fs::write(temp_dir.path().join("LICENSE"), "MIT\n").expect("write license");

        Self { temp_dir }
    }

    fn path(&self) -> &std::path::Path {
        self.temp_dir.path()
    }
}