knope 0.7.0

A command line tool for automating common development tasks
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

use std::fs::{copy, read_to_string, remove_file, write};
use std::path::Path;

use rstest::rstest;
use snapbox::assert_eq_path;
use snapbox::cmd::{cargo_bin, Command};

use git_repo_helpers::*;

mod git_repo_helpers;

/// Run `--generate` on a repo with no remote.
#[test]
fn generate_no_remote() {
    // Arrange
    let temp_dir = tempfile::tempdir().unwrap();
    let temp_path = temp_dir.path();
    let source_path = Path::new("tests/generate/no_remote");
    init(temp_path);

    // Act
    let assert = Command::new(cargo_bin!("knope"))
        .arg("--generate")
        .current_dir(temp_path)
        .assert();

    // Assert
    assert.success().stdout_eq("Generating a knope.toml file\n");
    assert_eq_path(
        source_path.join("knope.toml"),
        read_to_string(temp_path.join("knope.toml")).unwrap(),
    );
}

/// Run `--generate` on a repo with supported metadata files.
#[rstest]
#[case(&["Cargo.toml"], "Cargo.toml_knope.toml")]
#[case(&["pyproject.toml"], "pyproject.toml_knope.toml")]
#[case(&["package.json"], "package.json_knope.toml")]
#[case(&["Cargo.toml", "pyproject.toml", "package.json"], "multiple_knope.toml")]
fn generate_packages(#[case] source_files: &[&str], #[case] target_file: &str) {
    // Arrange
    let temp_dir = tempfile::tempdir().unwrap();
    let temp_path = temp_dir.path();
    let source_path = Path::new("tests/generate/packages");
    init(temp_path);
    commit(temp_path, "feat: Existing Feature");
    tag(temp_path, "v1.0.0");
    copy(
        source_path.join("no_package_knope.toml"),
        temp_path.join("knope.toml"),
    )
    .unwrap();
    for source_file in source_files {
        copy(source_path.join(source_file), temp_path.join(source_file)).unwrap();
    }

    // Act
    // Validate should give a useful error message similar to generate
    let validate_assert = Command::new(cargo_bin!("knope"))
        .arg("--validate")
        .current_dir(temp_path)
        .assert();
    remove_file(temp_path.join("knope.toml")).unwrap();
    let assert = Command::new(cargo_bin!("knope"))
        .arg("--generate")
        .current_dir(temp_path)
        .assert();

    // Assert
    validate_assert
        .failure()
        .stderr_eq_path(source_path.join(format!("{case}_stderr.txt", case = target_file)));
    assert.success().stdout_eq("Generating a knope.toml file\n");
    assert_eq_path(
        source_path.join(target_file),
        read_to_string(temp_path.join("knope.toml")).unwrap(),
    );
}

/// Run `--generate` on a repo with supported metadata and optional CHANGELOG.md.
#[rstest]
#[case(true, "changelog_knope.toml")]
#[case(false, "no_changelog_knope.toml")]
fn generate_packages_changelog(#[case] has_changelog: bool, #[case] target_file: &str) {
    // Arrange
    let temp_dir = tempfile::tempdir().unwrap();
    let temp_path = temp_dir.path();
    let source_path = Path::new("tests/generate/package_changelog");
    init(temp_path);
    copy(source_path.join("Cargo.toml"), temp_path.join("Cargo.toml")).unwrap();
    if has_changelog {
        write(temp_path.join("CHANGELOG.md"), "").unwrap();
    }

    // Act
    let assert = Command::new(cargo_bin!("knope"))
        .arg("--generate")
        .current_dir(temp_path)
        .assert();

    // Assert
    assert.success().stdout_eq("Generating a knope.toml file\n");
    assert_eq_path(
        source_path.join(target_file),
        read_to_string(temp_path.join("knope.toml")).unwrap(),
    );
}

/// Run `--generate` on a repo with a GitHub remote.
#[rstest]
#[case::ssh("git@github.com:knope-dev/knope.git")]
#[case::https("https://github.com/knope-dev/knope.git")]
fn generate_github(#[case] remote: &str) {
    // Arrange
    let temp_dir = tempfile::tempdir().unwrap();
    let temp_path = temp_dir.path();
    let source_path = Path::new("tests/generate/github");
    init(temp_path);
    add_remote(temp_path, remote);

    // Act
    let assert = Command::new(cargo_bin!("knope"))
        .arg("--generate")
        .current_dir(temp_path)
        .assert();

    // Assert
    assert
        .success()
        .stdout_eq("Generating a knope.toml file\n")
        .stderr_eq("");
    assert_eq_path(
        source_path.join("knope.toml"),
        read_to_string(temp_path.join("knope.toml")).unwrap(),
    );
}