cargo-bylaw 0.1.0

Cargo subcommand for enforcing Rust architecture rules
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

use serde_json::Value;
use std::path::{Path, PathBuf};
use std::process::Command;

fn repository_root() -> PathBuf {
    Path::new(env!("CARGO_MANIFEST_DIR"))
        .join("../..")
        .canonicalize()
        .unwrap()
}

fn fixture(name: &str) -> PathBuf {
    repository_root().join("fixtures").join(name)
}

#[test]
fn valid_fixture_passes_with_versioned_json() {
    let output = Command::new(env!("CARGO_BIN_EXE_cargo-bylaw"))
        .current_dir(fixture("model-boundaries-modules-valid"))
        .args(["check", "--format", "json"])
        .output()
        .unwrap();

    assert!(
        output.status.success(),
        "{}",
        String::from_utf8_lossy(&output.stderr)
    );
    let json: Value = serde_json::from_slice(&output.stdout).unwrap();
    assert_eq!(json["version"], 1);
    assert_eq!(json["report"]["rule_results"].as_array().unwrap().len(), 4);
}

#[test]
fn invalid_fixture_returns_violation_exit_code() {
    let output = Command::new(env!("CARGO_BIN_EXE_cargo-bylaw"))
        .current_dir(fixture("model-boundaries-modules-invalid"))
        .arg("check")
        .output()
        .unwrap();

    assert_eq!(output.status.code(), Some(1));
    let stdout = String::from_utf8_lossy(&output.stdout);
    assert!(stdout.contains("domain-is-internal"));
    assert!(stdout.contains("model-modules-are-acyclic"));
}

#[test]
fn cargo_external_subcommand_argument_is_accepted() {
    let config = repository_root().join("fixtures/config-invalid/bylaw.toml");
    let output = Command::new(env!("CARGO_BIN_EXE_cargo-bylaw"))
        .current_dir(repository_root())
        .arg("bylaw")
        .arg("check")
        .arg("--config")
        .arg(config)
        .args(["--format", "json"])
        .output()
        .unwrap();

    assert_eq!(output.status.code(), Some(2));
    let json: Value = serde_json::from_slice(&output.stderr).unwrap();
    assert_eq!(json["version"], 1);
    assert_eq!(json["error"]["kind"], "configuration");
}

#[test]
fn invalid_configuration_returns_configuration_exit_code() {
    let config = repository_root().join("fixtures/config-invalid/bylaw.toml");
    let output = Command::new(env!("CARGO_BIN_EXE_cargo-bylaw"))
        .current_dir(repository_root())
        .arg("check")
        .arg("--config")
        .arg(config)
        .output()
        .unwrap();

    assert_eq!(output.status.code(), Some(2));
    assert!(String::from_utf8_lossy(&output.stderr).contains("configuration:"));
}

#[test]
fn analyzer_failure_returns_analysis_exit_code() {
    let config = repository_root().join("fixtures/analysis-invalid/bylaw.toml");
    let output = Command::new(env!("CARGO_BIN_EXE_cargo-bylaw"))
        .current_dir(repository_root())
        .arg("check")
        .arg("--config")
        .arg(config)
        .output()
        .unwrap();

    assert_eq!(output.status.code(), Some(3));
    let json: Value = serde_json::from_slice(&output.stderr).unwrap();
    assert_eq!(json["error"]["kind"], "analysis");
}