cargo-about 0.9.0

Cargo plugin for generating a listing of all of the crates and the the terms under which they are licensed
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

use crate::utils::*;

use anyhow::Result;
use assert_fs::prelude::*;
use predicates::prelude::*;

#[test]
fn fails_when_manifest_absent() -> Result<()> {
    let package = Package::builder().no_manifest().build()?;

    CargoAbout::new(&package)?
        .init()
        .assert()
        .failure()
        .stderr(predicate::str::contains("could not find `Cargo.toml`"));
    Ok(())
}

#[test]
fn fails_when_manifest_empty() -> Result<()> {
    let package = Package::builder().file("Cargo.toml", "").build()?;

    CargoAbout::new(&package)?
        .init()
        .assert()
        .failure()
        .stderr(predicate::str::contains("failed to parse manifest"));

    Ok(())
}

#[test]
fn writes_config_and_template_by_default() -> Result<()> {
    let package = Package::builder().no_template().no_about_config().build()?;

    CargoAbout::new(&package)?.init().assert().success();

    let dir = &package.dir;
    dir.child(ABOUT_CONFIG_FILENAME)
        .assert(predicate::path::exists());
    dir.child(ABOUT_TEMPLATE_FILENAME)
        .assert(predicate::path::exists());

    Ok(())
}

#[test]
fn writes_config_only_when_no_handlebars_specifed() -> Result<()> {
    let package = Package::builder().no_template().no_about_config().build()?;

    CargoAbout::new(&package)?
        .init()
        .arg("--no-handlebars")
        .assert()
        .success()
        .stdout("")
        .stderr("");

    let dir = &package.dir;
    dir.child(ABOUT_CONFIG_FILENAME)
        .assert(predicate::path::exists());
    dir.child(ABOUT_TEMPLATE_FILENAME)
        .assert(predicate::path::missing());

    Ok(())
}

#[test]
fn does_not_overwrite_by_default() -> Result<()> {
    let template_content = "A useless custom template";
    let config_content = "A useless invalid config";

    let package = Package::builder()
        .file(ABOUT_TEMPLATE_FILENAME, template_content)
        .file(ABOUT_CONFIG_FILENAME, config_content)
        .build()?;

    CargoAbout::new(&package)?
        .init()
        .assert()
        .success()
        .stdout("")
        .stderr("");

    let config = &package.dir.child(ABOUT_CONFIG_FILENAME);
    let template = &package.dir.child(ABOUT_TEMPLATE_FILENAME);

    assert_eq!(std::fs::read_to_string(config)?, config_content);
    assert_eq!(std::fs::read_to_string(template)?, template_content);

    Ok(())
}

#[test]
fn overwrites_config_and_template_when_overwrite_specified() -> Result<()> {
    let template_content = "A useless custom template";
    let config_content = "A useless invalid config";

    let package = Package::builder()
        .file(ABOUT_TEMPLATE_FILENAME, template_content)
        .file(ABOUT_CONFIG_FILENAME, config_content)
        .build()?;

    CargoAbout::new(&package)?
        .init()
        .arg("--overwrite")
        .assert()
        .success()
        .stdout("")
        .stderr("");

    let config = &package.dir.child(ABOUT_CONFIG_FILENAME);
    let template = &package.dir.child(ABOUT_TEMPLATE_FILENAME);

    assert_ne!(std::fs::read_to_string(config)?, config_content);
    assert_ne!(std::fs::read_to_string(template)?, template_content);

    Ok(())
}

#[test]
fn overwrites_config_only_when_no_handlebars_and_overwrite_specified() -> Result<()> {
    let template_content = "A useless custom template";
    let config_content = "A useless invalid config";

    let package = Package::builder()
        .file(ABOUT_TEMPLATE_FILENAME, template_content)
        .file(ABOUT_CONFIG_FILENAME, config_content)
        .build()?;

    CargoAbout::new(&package)?
        .init()
        .arg("--no-handlebars")
        .arg("--overwrite")
        .assert()
        .success()
        .stdout("")
        .stderr("");

    let config = &package.dir.child(ABOUT_CONFIG_FILENAME);
    let template = &package.dir.child(ABOUT_TEMPLATE_FILENAME);

    assert_ne!(std::fs::read_to_string(config)?, config_content);
    assert_eq!(std::fs::read_to_string(template)?, template_content);

    Ok(())
}