portaki-cli 9.2.2

Portaki module CLI (portaki) — init, build, test, hosted sandbox, OCI publish and registry announcement
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
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182

//! `check` as the gate of `release`, the `add` family, `upgrade`, the hidden former names, and
//! the CLI's language — on the real binary.

mod common;

use common::{document, module, text, Home};

fn bundles(dir: &std::path::Path, fr: &str, en: &str) {
    std::fs::create_dir_all(dir.join("i18n")).unwrap();
    std::fs::write(dir.join("i18n/fr-FR.json"), fr).unwrap();
    std::fs::write(dir.join("i18n/en-US.json"), en).unwrap();
}

/// A module whose conformance battery fails, formatted as rustfmt wants it.
fn failing_module() -> tempfile::TempDir {
    let dir = tempfile::tempdir().unwrap();
    std::fs::write(
        dir.path().join("Cargo.toml"),
        "[package]\nname = \"failing-check\"\nversion = \"0.1.0\"\nedition = \"2021\"\n\n[workspace]\n",
    )
    .unwrap();
    std::fs::create_dir_all(dir.path().join("src")).unwrap();
    std::fs::write(dir.path().join("src/lib.rs"), "//! Fixture.\n").unwrap();
    std::fs::create_dir_all(dir.path().join("tests")).unwrap();
    std::fs::write(
        dir.path().join("tests/conformance.rs"),
        "mod portaki_conformance {\n    #[test]\n    fn surfaces() {\n        panic!(\"home.card panicked\")\n    }\n}\n",
    )
    .unwrap();
    dir
}

/// `check` stops where `release` stops, with the same refusal.
#[test]
fn check_refuses_what_release_refuses() {
    let home = Home::new();
    let dir = failing_module();

    let output = home.run(dir.path(), &["--plain", "check"]);
    assert_eq!(output.status.code(), Some(1), "{}", text(&output.stdout));
    let stderr = text(&output.stderr);
    assert!(stderr.contains("tests before publish"), "{stderr}");
    assert!(stderr.contains("tests fail"), "{stderr}");
}

#[test]
fn check_only_runs_the_controls_named() {
    let home = Home::new();
    let dir = tempfile::tempdir().unwrap();
    module(dir.path(), "nuki");
    bundles(dir.path(), r#"{"a":"x","b":"y"}"#, r#"{"a":"x"}"#);

    let output = home.run(dir.path(), &["--json", "check", "--only", "i18n"]);
    assert_eq!(output.status.code(), Some(1));
    let check = document(&output);
    assert_eq!(check["controls"], serde_json::json!(["i18n"]));
    assert_eq!(check["modules"][0]["ok"], false);
    assert!(text(&output.stderr).contains("en-US.json: `b` missing"));

    let unknown = home.run(dir.path(), &["--plain", "check", "--only", "nope"]);
    assert_eq!(unknown.status.code(), Some(2));

    // The former name still runs the same control, and says the new one.
    let former = home.run(dir.path(), &["--plain", "i18n", "check"]);
    assert_eq!(former.status.code(), Some(1));
    assert!(text(&former.stderr).contains("portaki check --only i18n"));
}

#[test]
fn add_permission_connector_and_language() {
    let home = Home::new();
    let dir = tempfile::tempdir().unwrap();
    module(dir.path(), "nuki");
    bundles(dir.path(), r#"{"a":"x"}"#, r#"{"a":"y"}"#);

    let added = home.run(dir.path(), &["--plain", "add", "permission", "events"]);
    assert_eq!(added.status.code(), Some(0), "{}", text(&added.stderr));
    let cargo = std::fs::read_to_string(dir.path().join("Cargo.toml")).unwrap();
    assert!(cargo.contains("\"events\""), "{cargo}");
    let again = home.run(dir.path(), &["--plain", "add", "permission", "events"]);
    assert_eq!(again.status.code(), Some(3));
    let former = home.run(dir.path(), &["--plain", "permissions", "add", "email"]);
    assert_eq!(former.status.code(), Some(0));
    assert!(text(&former.stderr).contains("portaki add permission"));

    let connector = home.run(dir.path(), &["--plain", "add", "connector", "open-weather"]);
    assert_eq!(
        connector.status.code(),
        Some(0),
        "{}",
        text(&connector.stderr)
    );
    let lib = std::fs::read_to_string(dir.path().join("src/lib.rs")).unwrap();
    assert!(
        lib.contains("#[portaki_sdk::connector(builtin = \"open-weather\")]"),
        "{lib}"
    );
    let again = home.run(dir.path(), &["--plain", "add", "connector", "open-weather"]);
    assert_eq!(again.status.code(), Some(3));
    let unknown = home.run(dir.path(), &["--plain", "add", "connector", "my-api"]);
    assert_eq!(unknown.status.code(), Some(2));
    assert!(text(&unknown.stderr).contains("custom_connector"));

    let language = home.run(dir.path(), &["--plain", "add", "language", "de"]);
    assert_eq!(
        language.status.code(),
        Some(0),
        "{}",
        text(&language.stderr)
    );
    let de = std::fs::read_to_string(dir.path().join("i18n/de-DE.json")).unwrap();
    assert_eq!(
        serde_json::from_str::<serde_json::Value>(&de).unwrap(),
        serde_json::json!({ "a": "" })
    );
    // What is left to write is what the gate refuses.
    let check = home.run(dir.path(), &["--plain", "check", "--only", "i18n"]);
    assert!(text(&check.stdout).contains("de-DE.json: `a` empty"));
}

/// The former names run, hidden from the root help.
#[test]
fn the_root_help_shows_the_new_names_only() {
    let home = Home::new();
    let dir = tempfile::tempdir().unwrap();

    let help = text(&home.run(dir.path(), &["--plain", "--help"]).stdout);
    for shown in ["check", "add", "upgrade", "run", "preview", "reports"] {
        assert!(help.contains(&format!("\n  {shown} ")), "{shown}: {help}");
    }
    for hidden in ["lint", "i18n", "permissions", "sdk", "publish"] {
        assert!(
            !help.contains(&format!("\n  {hidden} ")),
            "{hidden}: {help}"
        );
    }
    let upgrade = home.run(dir.path(), &["--plain", "upgrade", "--help"]);
    assert!(text(&upgrade.stdout).contains("--to"));
}

/// The system's language decides what a person reads; `--json` and exit codes do not move.
#[test]
fn a_french_system_reads_french_and_json_stays_the_same() {
    let home = Home::new();
    let dir = tempfile::tempdir().unwrap();
    module(dir.path(), "nuki");
    bundles(dir.path(), r#"{"a":"x","b":"y"}"#, r#"{"a":"x"}"#);

    let french = home.run_in("fr_FR.UTF-8", dir.path(), &["check", "--only", "i18n"]);
    assert_eq!(french.status.code(), Some(1));
    let said = text(&french.stdout) + &text(&french.stderr);
    assert!(
        said.contains("La porte que portaki release applique"),
        "{said}"
    );
    assert!(said.contains("texte(s) manquant(s)"), "{said}");

    let english = home.run_in("en_US.UTF-8", dir.path(), &["check", "--only", "i18n"]);
    assert!(text(&english.stderr).contains("text(s) missing"));

    let json_fr = home.run_in(
        "fr_FR.UTF-8",
        dir.path(),
        &["--json", "check", "--only", "i18n"],
    );
    let json_en = home.run_in(
        "en_US.UTF-8",
        dir.path(),
        &["--json", "check", "--only", "i18n"],
    );
    assert_eq!(json_fr.status.code(), json_en.status.code());
    assert_eq!(document(&json_fr), document(&json_en));

    // A usage error keeps its code in both languages.
    let usage = home.run_in(
        "fr_FR.UTF-8",
        dir.path(),
        &["--plain", "add", "language", "1"],
    );
    assert_eq!(usage.status.code(), Some(2));
    assert!(text(&usage.stderr).contains("n'est pas une langue"));
}