cargo-sync-rdme 0.8.0

Cargo subcommand to synchronize README with crate 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

//! Integration test to ensure that package selection arguments work as expected.

use rstest::rstest;
use similar_asserts::assert_eq;
use test_helper::{self as helper, Workspace};

#[rstest]
#[case("workspace", "", &[], &["root"])]
#[case("workspace", "", &["--workspace"], &["pkg-a", "pkg-b", "root"])]
#[case("workspace", "", &["-p", "pkg-a", "-p", "pkg-b"], &["pkg-a", "pkg-b"])]
#[case("workspace", "", &["-p", "pkg-b"], &["pkg-b"])]
#[case("workspace", "pkg-a", &[], &["pkg-a"])]
#[case("workspace", "pkg-a", &["-p", "pkg-b"], &["pkg-b"])]
#[case("workspace", "pkg-b", &[], &["pkg-b"])]
#[case("workspace", "pkg-b/src", &[], &["pkg-b"])]
#[case("workspace", "pkg-b/src", &["--manifest-path", "../../Cargo.toml"], &["root"])]
#[case("workspace", "pkg-b/src", &["-m", "../../Cargo.toml"], &["root"])]
#[case("workspace_default", "", &[], &["pkg-a"])]
#[case("workspace_default", "", &["--workspace"], &["pkg-a", "pkg-b", "root"])]
#[case("workspace_default", "", &["-p", "pkg-a", "-p", "pkg-b"], &["pkg-a", "pkg-b"])]
#[case("workspace_default", "", &["-p", "pkg-b"], &["pkg-b"])]
#[case("workspace_default", "pkg-a", &[], &["pkg-a"])]
#[case("workspace_default", "pkg-a", &["-p", "pkg-b"], &["pkg-b"])]
#[case("workspace_default", "pkg-b", &[], &["pkg-b"])]
#[case("workspace_default", "pkg-b/src", &[], &["pkg-b"])]
#[case("workspace_virtual", "", &[], &["pkg-a", "pkg-b"])]
#[case("workspace_virtual", "", &["--workspace"], &["pkg-a", "pkg-b"])]
#[case("workspace_virtual", "", &["-p", "pkg-a", "-p", "pkg-b"], &["pkg-a", "pkg-b"])]
#[case("workspace_virtual", "", &["-p", "pkg-b"], &["pkg-b"])]
#[case("workspace_virtual", "pkg-a", &[], &["pkg-a"])]
#[case("workspace_virtual", "pkg-a", &["-p", "pkg-b"], &["pkg-b"])]
#[case("workspace_virtual", "pkg-b", &[], &["pkg-b"])]
#[case("workspace_virtual", "pkg-b/src", &[], &["pkg-b"])]
fn select_target_packages_by_flags(
    #[case] fixture_name: &str,
    #[case] cwd: &str,
    #[case] flags: &[&str],
    #[case] expected: &[&str],
) {
    let workspace = Workspace::from_fixture(fixture_name);

    workspace
        .cargo_sync_rdme_default()
        .args(flags)
        .current_dir(cwd)
        .assert()
        .success();

    let mut updated = workspace
        .metadata()
        .workspace_packages()
        .into_iter()
        .filter(|pkg| {
            let readme = pkg.readme().unwrap();
            eprintln!("{}", pkg.name);
            eprintln!("{}", std::fs::read_to_string(&readme).unwrap());
            match helper::collect_list_item_from_markdown_file(&readme).as_slice() {
                [s] if s.trim() == "UPDATED" => true,
                [s] if s.trim() == "NOT_UPDATED" => false,
                items => panic!("Unexpected content `{items:?}` in README: {readme:?}"),
            }
        })
        .map(|pkg| pkg.name.as_ref())
        .collect::<Vec<_>>();

    updated.sort_unstable();

    assert_eq!(updated, expected);
}